Property form
Completing the Advanced tab

Field

Description

Optional. This field is visible only for Value mode properties of type Password, Text, or Identifier. You can restrict the value to a specific maximum number of characters in internal storage.

Enter the number here. If a user or activity attempts to assign a longer value to the property, the clipboard does contain the longer value, but also has an associated message.

If you leave this blank, PRPC does not limit the length of values of the property. However, operational considerations and system performance considerations may apply. For example, database software supporting the PegaRULES database may limit the size of the column to no more than 255 characters, or 1023 characters, or another value; this applies if the property is to be exposed. Even when the property is not exposed as a database column, sizes larger than 1,000 bytes may adversely add to the memory demands on the server and JVMs, depending on how many instances contain the large property and how often they are accessed on requestor clipboards.

When updating or overriding a property that has a Max Length defined, you can enter a smaller Max Length value, but not a larger value.

Optional. Enter the typical length in characters expected for the property being defined, as entered into a form. This does not affect the number of characters that can be stored internally in the property value.

If you associate the standard control FixedSizeForInput with this property, the system uses this value to define the size of HTML input textboxes. Use the similar FixedSize control to apply this limit to both input and display presentations of the property.

This field is visible only for Value mode properties.

Optional. Use to this field in special situations, to compare and sort values of this property in ways other than the natural sort sequence for the Type. If you leave this blank, the system uses a built-in sort order based on the Type.

Identify here a function rule in the Pega-RULES:Sort library or a custom function in a custom Sort library. For a custom function, enter the RuleSet name, a colon and the sort function name.

This field is visible only for Single Value mode properties.

Optional. This field is meaningful only when the Type is TextEncrypted and the mode is Single Value.

Identify the second key part of an access when rule (Rule-Access-When rule type) that controls whether or not the clear-text or encrypted value appears in reports and forms. Design the access when rule to be true for those operators, situations, and times when the clear text of the property value is to appear, and false otherwise. See Implementing and using the TextEncrypted type.

Optional. To convert data entered by a user into another format, identify an edit input rule to perform the conversion. This field is visible only for Value mode properties.

If this property is to hold text that is composed using the RichTextControl control and so may contain HTML markup such as <b> or <h2>, select pyFilterRichText. This standard edit input rule deletes potentially insecure markup from the input value, while retaining the legitimate display markup.

Optional. Validation of a Value mode property always includes testing its value against the formats allowed by the Type and its maximum length. To provide stronger validation for this property, identify an edit validate rule.

When users complete and submit a form containing a value for this property, the system first applies the edit input rule. This rule may transform the input text. Next, it applies the edit validate rule, which may cause a message to be added to the property indicating that the property value has failed validation.

To restrict this value to a (PRPC) Java identifier, enter JavaIdentifier.

Many standard edit validate rules are emulated by an equivalent JavaScript function that can be run on the client workstation before users submit a user form or flow action form. See client-side validation.

This field is visible only for Value mode properties.

Optional. If this Single Value property is to belong to a top-level object (not to an embedded page) in any concrete class, indicate whether this property is to appear in the Database Class Mappings gadget and Modify Schema wizard as a candidate for an exposed column:

• Leave blank if you do not anticipate any benefit in making this property an exposed column.
• Choose Required or Recommended to record your intent that a database administrator extend a database table schema to expose this property. These choices cause this property to appear as a candidate for column exposure in the Database Class Mappings gadget and Modify Database Schema wizard.

The other choice Optional is equivalent to blank.

Your choice in this field only conveys advice to a database administrator; it does not cause the schema to change. You can update a property to revise this selection at any time. Using the Database Class Mappings gadget, you can compare the values in this field with the current schema, identifying properties marked as Required which are not exposed. To start this gadget, select > Data Model > Classes and Properties > Database Class Mappings.

See How to expose a property as a database column and Data Model category — Classes and Properties landing page.

If the property is not a Single Value property, or is not at the top level of an instance of any concrete class, this field is not meaningful.

If this is a transient property (the Transient Property checkbox is selected), select Optional or leave this field blank. A transient property cannot be exposed ("optimized").

A list of the classes containing this property that have values as an exposed column in the PegaRULES database. This read-only list appears only for Single Value properties which have been exposed through the Property Optimization tool. See About the Property Optimization tool.

Select to prevent this property from being the target of a Declare Expression rule.

This restriction applies to Declare Expression rules created after you save the Property form; it is not applied retroactively.

This restriction is meaningful only for Single Value, Page, or Java Property properties.

Select to turn on the pySpecial restriction for this rule. If selected, users cannot directly enter a value for this property on an HTML form. This restriction improves system security and reduces the chance of errors that can occur when one property is in some cases computed and in other cases directly input.

Such properties are sometimes called special properties.

Choose a naming convention for special properties, to help everyone on your team remember them. (Standard special properties have a property name starting with the letters px.)

Select to make this property a reference property, a property that can link to a source property. Reference properties can reduce the need for duplicating data values on multiple pages or objects, and can simplify lengthy property references. Use the Property-Ref method in an activity to establish the contents of a reference property.

If this property is of mode Page or Page List and the Page Class is a concrete class, you can in some cases use auto-population rather than use the Property-Ref method.

Select to cause the value of this property to be omitted (equivalently, set to null) when any clipboard page containing this property is committed to the PegaRULES database. Similarly, the property has no value when an instance containing this property is opened to the clipboard from the PegaRULES database.

Marking a property as transient, when appropriate, improves performance by reducing the size of the Storage Stream property value (the pzPVStream property and column). While on the clipboard, the property can have values of any length.

Of course, select this only for properties — Single Value or aggregate — that have values that you don't need to be saved in the database.

If you mark a property as transient, but saved instances of objects already exist in the PegaRULES database, the values of this property are removed only when and if those objects are later opened and then recommited.

The value of a transient property is not deleted when a requestor session containing a clipboard value for a transient property is passivated. The current value of the property is included in the saved passivation record, and restored when the requestor session is later activated.

You can't expose a transient property as a database column. Because all values of the column would be empty, this is not useful. Similarly, you can't mark a property as transient if PRPC determines that it is part of an external database table.

Field

Description

Select to indicate that values of this Page or Page List property are to be auto-populated at runtime based on the details entered on this tab.

This field is visible only for properties of type Page or Page List. When selected, the Advanced tab changes to include additional fields. Complete these fields to define a source of values.

Available when Auto-populate Property is checked. Select to indicate that values for this property are to be populated by a declare pages rule.

When this checkbox is selected, a field appears in which you specify the declare pages rule. Select the Page Name (key) of a declare pages rule that starts with the prefix Declare_Ref_. At runtime, the value of the Page property is set by copying this page (or referencing a temporary page. whenever the Page property is accessed.

If this property has mode Page, the class of the declare page must match the Page Class of this property. If this property has mode Page List, the class of the declare page must be Code-Pega-List, with embedded pages that match the Page Class of this property.

Select this option to record how PRPC obtains the key to an object (or keys to a list of objects) in the PegaRULES database. Typically, you cause auto-population of a Page or Page List mode property by

1. Setting a value for the property (or properties) that make up the key to the class identified in the Page Class field.
2. Referencing any non-key property (such as .pyLabel) on the object.

For example, to populate a page of class Data-Admin-Operator-ID, set a value to the property Data-Admin-Operator-ID.pyUserIdentifier. On the Basic tab of the Class form, pyUserIdentifier is listed as the key to these objects.

In less typical situations, the key value is as the value of a separate property in the current object, or is computed from multiple separate properties each providing one key part.

For a Page mode property, you can also specify how to load the property with an object from the PegaRULES database by selecting one of these options:

• Load Using Instance Handle — At runtime, the value of a property on the parent page, when not blank, holds the pzInsKey (handle) of the object to open.
• Load using Class Keys — At runtime, the values of one or more properties on the parent page, when not blank, together identify the visible key of the object to open.

These fields are displayed when the Advanced Auto-population Options checkbox is checked and Load Using Instance Handle is selected.

Select the property that, when not blank, holds the pzInsKey value of an object of the appropriate class. This field appears when you select Load Using Instance Handle.

At runtime, when this Page mode property is accessed, the system retrieves an object from the PegaRULES database based on this pzInsKey value.

Read-only. Identifies a property that forms the key, or part of the key, of instances of the Page Class class.

Select a property on the parent page that, when not blank, holds a value for this key part.

At runtime, when this Page mode property is accessed, the system retrieves an object from the PegaRULES database based on this key.

Read-only. Identifies a property that forms the key, or part of the key, of instances of the Page Class class.

Select property on this Page List property's parent page (Applies To class) that, when not blank, holds a value for this key part.

Enter at least one non-blank value. When the Page List mode property is accessed, the system performs a list operation on objects in the PegaRULES database, creating a page for each match.

Field

Description

Optional. For a permanent qualifier, enter the value in a pop-up dialog box:

• For the standard qualifier pyDecimalPrecision, enter a literal constant integer such as 2 to indicate how many decimal places are to be presented when this property value appears at runtime. (Use pyDecimalPrecision only with properties with a Decimal type.)
• For the standard qualifier pyMinimumLength, enter a literal constant minimum length, such as 10.
• For the standard qualifiers pyUnits and pyCurrency, identify an application property (found at runtime on the same page as this property) that holds the units or currency code applicable to this property.

To allow the value of a qualifier to be set dynamically and temporarily at runtime, leave this field blank.