Property form: General tab — Configuring validation

1. About
2. New
3. General
4. Advanced
5. More...

Providing validation of input data is a best practice to prevent invalid data from entering a work item or the business process. One way of doing that is to specify a set of acceptable values for a field. At runtime, the system compares the input value to the specified set, verifies whether the value has a match, and potentially formats the value (as appropriate) for the property.

A property of mode Single Value, Value List or Value Group can use table validation to constrain an input value to match one of the specified values or a pattern of values. You define a table of data that describes what values are valid for this property.

To use table validation:

1. Select one of the values in the Table type drop-down list (other than the None value). The appropriate fields for that type appear in the form.
2. Complete the fields appropriate for the selected Table type value. These fields define the set (table) of acceptable values. See the following sections for details of the fields used for each type of table validation.

Basics

Although the value is compared with the table elements a case-insensitive way, the system corrects the case. For example, if the values recorded in a Local List on this tab are all lowercase, a user can enter at runtime the value in uppercase, mixed case, or lowercase letters. The system accepts a matching value but converts it to lowercase.

Display-only option

Local List table validation

Select Local List as the Table Type when your property value is permanently limited to a modest number of known values in a single language. (To accomplish a similar presentation with localized values, specify Prompt List instead of Local List.)

If there are to be a large list of values that are expected to change frequently, rather than having to maintain a long list here, use the field value table validation method instead.

Typically when using this option, the Control field is set to either the PromptSelect or RadioButtons standard control, so that at runtime, a selection list displaying the specified acceptable values is presented to the user.

You cannot use a Local List if the Property Type field is Password, TrueFalse, Date, or DateTime.

Using Local List is the simplest way to show a list to the user at runtime for the user to make a selection. Localization of the values is not supported for a Local List. The value displayed at runtime is the value stored in the clipboard.

Field Value table validation

Select Field Value as the Table Type when the set of valid values:

• Contains more than a few hundred values or the values are expected to change frequently, and
• The values are available at runtime within the keys of field value rules

For this method, you specify only the first two key parts of the set of field value rules. At runtime, the system locates the actual literal values by using the specified two key parts to locate the field value rules that contain the values. If a match for the input value is not found among the field values, the validation fails and the system returns an error.

Typically when using this option, the Control field is set to PromptFieldValue, to present a user with a fixed list of selection values to select from at runtime.

Field value examples

For example, the standard property Work-.pyRootCause uses field value rules to define possible root causes for an exception-oriented work item.

The first key part of the field value rules that provides the acceptable values is Work- (the Applies To class for these rules). The second key part is the literal pyRootCause (the Field Name for these rules).

The final key part of these field value rules varies to provide specific values. Recommended values for the pyRootCause property are Conduct, Duplicate, Facilities, Finance, Policy, Product, Service, and User Error. These values are predefined through standard field value rules.

You can add field values as the application evolves, and the values can be updated without having to edit the pyRootCause property itself.

In comparison, the standard property Work-.pyStatusWork also is restricted to values defined by field value rules. However, for this property, an activity and a control enforces the restriction, rather than table validation.

Reviewing field value rules for the property

After you save the property, you can open the Property Explorer from the Property form's Advanced tab to locate and review the list of existing field value rules that match the specified field value class and field name:

1. Click the Advanced tab. Click the Explore button at the bottom of the tab to start the Property Explorer in a new window
2. On the Property Explorer, click the Field Values tab.

Class Key Value table validation

Use Class Key Value to use a concrete class, rather than field value rules, as the source of acceptable values for the property. Class Key Value specifies a class to validate the input values against.

When you select Class Key Value, Table Description fields appear. Complete them to identify a range of keys in a class other than the Applies To class of the property you are defining.

Class Key Value examples

Single key example: The standard class Rule-Obj-Class is used to validate values entered into the Applies To field in the Create form when creating a new rule. To validate that input entered into the Applies To field is a valid, existing class, the property associated with that field in the New dialog specifies Rule-Obj-Class as the Validation class . The Rule-Obj-Class class has one key defined in its Keys array.

Two key example: A class Data-CustomerTerritory has two keys defined in its Keys array — state code and county name. To restrict input values for a property at runtime to county names in New York state, specify Data-CustomerTerritory as the Validation class and "NY" as the Subset Name .

Three key example: The standard class Rule-Obj-FieldValue used to validate properties has three keys defined in its Keys array. The first is pyClassName, the second is pyFieldName and is used to group the values for the third key ( pyFieldValue ), which are the allowed input values.

The Class Key Value validation method is a generalization of the Field Value method. For example, a Pega Platform system has fifty-one (51) standard field value rules that identify codes for the fifty United States and the District of Columbia. These field value rules have Data-Party as the first key part (the Applies To ) and pyState as the second key part (the Field Name ). The values for the third key part of these field value rules range from AK (for Alaska) to WY (for Wyoming).

Two standard properties, Data-Party.pyHomeState and Data-Party.pyWorkState, use these field values through the Class Key Values method. Those properties specify:

• Rule-Obj-FieldValue for the Validation Class
• pyState for the Subset Name

At runtime, if your system contains other field value rules in this key range (in an application RuleSet) such as PR for Puerto Rico, the system uses them as acceptable values for pyHomeState and pyWorkState also.

Remote List table validation

Choose Remote List when there are a large number of objects to be validated against (such as countries of the world) that you might not want to enter as individual values, or when the data changes frequently, but is available at runtime as the keys of a certain known class.

Whereas Class Key Value specifies a class to validate the input values against, Remote List specifies a particular instance of a class to validate against.

After you select Remote List, complete the fields that appear.

Prompt List table validation

Select Prompt List and complete the associated fields to provide a mapping between a list of text values used in the property value internally and corresponding text values presented on input or output. For example, the text values presented at runtime can be human-readable labels that end users see and choose from, while the corresponding stored values can be shorter, easy-to-machine-reference values.

When you use Prompt List as the Table type , specify PromptSelect for the Control . At runtime, a selection list displaying the Prompt value values is presented to the user. If the values have been localized using the Localization wizard, the appropriate translated values are presented.

Prompt List tables are used when you want the actual value stored in the clipboard to be different from the value presented to the user 'on the glass' at runtime. This choice allows users to see information from the Prompt value column on both input and display, while the system internally maintains the corresponding value from the Standard value column. For example, when the Standard value specifies a short value like EDate, the corresponding Prompt value can be a more human-readable value like Date to complete this task. The Standard value is the value stored in the clipboard, and the Prompt value is the value displayed to the user at runtime.

This feature is most useful to support localization. The Localization wizard localizes the values specified in the Prompt value field. When the wizard runs, it creates the appropriate field value rules for the Prompt Value entries, and then those field value rules are used to hold the translated text.