PFX is used to provide a user friendly interface for editing Application parameters.
PFX is an xml file with extension .vpfx
To create a PFX file, you can make a copy of the parameter definition file and rename the extension to .vpfx
Content and structure of PFX file is very much similar to PDX file. You need to provide values for additional attributes for each Parameter that define its user friendly name, description, rendering controls, data type, validation rules etc.
NOTE: Core XML elements and attributes in the PFX file are same as that in PDX file. For more details on these elements/attributes, refer to the Parameter Definition File section.
|
XML Entity/Attribute |
Description |
|
Param |
Parameter |
|
DisplayName |
User friendly display name of the parameter to be shown in the GUI. Some of the Application parameters may have cryptic names. |
|
Default |
Default value of the parameter. |
|
Description |
Description of the parameter. This will be shown along with the parameter in GUI |
|
ValueType |
This element defines datatype, validation rules and mapping rules for Enumerations. This element contains different elements and attributes based on value of the Type attribute. Refer below table for details |
|
Type |
Data type of the parameter. Below are supported values Enumeration: Predefined set of values Example: For a Parameter Day the values can be one of the fixed values Mon, Tue, Wed, Thu, Fri, Sat, Sun Numeric: Integer data types. String: Alphanumeric character types Date: Date type |
For ValueType > Type = Enumeration
|
Enumeration |
Define all possible valid Parameter values and corresponding user friendly name to be shown in the GUI |
|
EnumIndex |
Value of the Parameter to be shown in the GUI |
|
EnumValue |
Value of the Parameter to be stored in an Application Parameter file. Parameter file gets downloaded to the Device. Application on Device uses this Parameter value. Example: Enable Tip parameter can have values 0 or 1 0 means Tip is Enabled , 1 means Tip is Disabled GUI will show options to the user to select either Disable or Enable. The default value is defined in the PDX file for each parameter. |
For ValueType > Type = String
|
MinLen |
Minimum length of the parameter value. |
|
MaxLen |
Maximum length of the parameter value. |
|
ValidChars |
Valid characters allowed as part of the parameter value. You need to specify a regular expression to define set of valid characters allowed as part of the parameter value. |
|
ErrorOnValidationFailure |
Error to be shown in case user has specified invalid value. This should be a generic message that indicates all the allowed valid characters. |
For ValueType > Type = Numeric
|
MinVal |
Minimum allowed value of the parameter. |
|
MaxVal |
Maximum allowed value of the parameter. |
For ValueType > Type = DateTime
|
DateFormat |
Format of date value. Example MM/DD/YYYY HH:MI:SS [TBD:JS] Validate this with Srinivas. Need to list all the valid options like MM – Month, DD – Day etc. |
