Property form
Completing the General tab — Value modes

Type

Description

Text

Select Text to allow the property to hold text strings that can contain tabs, carriage returns, and line feeds.

When you use an activity or an HTML form to set the value of the property, the value can contain any graphic characters in addition to tabs, carriage returns, and line feeds.

Use the Text Property Type if a user may enter the value in a text area of an HTML form.

Identifier

Select Identifier to allow the property to hold a text string that does not contain double quote, tab, carriage return or line break characters.

Don't confuse the Identifier type with the more restricted Java identifier values. To limit the values of a property to those that PRPC accepts as Java identifiers, set the Type to Identifier and also set the Validate field (on the Advanced tab) to JavaIdentifier. See How to enter a Java identifier. KHATV 5/8/09

Password

Select Password to allow the property to hold a password.

The values of properties with this Property Type are always encrypted when stored in the database. When on the clipboard, the values may appear as clear text (not encrypted), until the page containing the property is validated.

The value can contain only legal graphic characters. Tabs, carriage returns, and line feed characters are not allowed.

Don't confuse the Password type with the TextEncrypted type, which has encrypted values even when on the clipboard; clear text values are visible only if a Rule-Access-When rule evaluates to true. See Implementing and using the TextEncrypted type.

You can prevent any text field from echoing when typed into an HTML form using the PASSWORD input type:

<INPUT TYPE="PASSWORD" NAME=...>

This HTML does not cause any encryption. This native HTML feature is not related to the Password Type.

Integer

R-7995 Select Integer to allow the property to hold an integer.

When you specify the value in your later configuration, use any sequence of digits for the value. You can precede the digits with a plus sign (+12) or a minus sign (-12).

Double

R-7996 Select Double to allow the property to hold a 64-bit floating point value.

Decimal

Select Decimal to allow the property to hold a decimal quantity.

Your property can reference the standard property qualifier named pyDecimalPrecision to fix the number of digits the system keeps after the decimal position in values of this property.

DateTime

Select DateTime to allow the property to hold a UTC (Coordinated Universal Time) value. The value is essentially the same as Greenwich Mean Time (GMT), used for the synchronization of computers on the Internet.

Internally, a DateTime value is stored in the format YYYYMMDDTHHMMSS.QQQ GMT where T and GMT are literal characters, YYYY represents a year, MM is a month, DD is a day, HH is an hour value between 00 to 23, MM is a minute value between 00 and 59, SS is a second value between 00 and 59, and QQQ is a millisecond value between 000 and 999. See Understanding the Date, Time of Day, and DateTime property types for more about this type.

Users need not enter DateTime values in this format, as shortcuts and alternative entry formats are available.

Date

Select Date to allow the property to hold a calendar date. Internally, a date is stored as an eight-digit text value, in the format YYYYMMDD. For example 20071123 represents November 23, 2007. No time zone is implicitly associated with a Date.

Application users are not required to enter Date values in this format, as many shortcuts and alternative entry formats are available.

As a best practice, use DateTime rather than Date for properties that are part of work items, assignments, or other persistent objects in your application. Avoid using Date property types in persistent objects, such as work items or assignments, even if your application is used in only a single time zone, unless a time zone value is also stored in another property of the object. See Understanding the Date, Time of Day, and DateTime property types for more about this type.

TimeOfDay

Select TimeOfDay to allow the property to hold a time of day at the seconds level, not associated with a time zone. CLINB 1/22/03

Internally, a TimeOfDay value is stored as six digits in the format HHMMSS, with two digits for the hour, two digits for the minute, and two digits for the second. COLEA 11/8/02

For example, 000000 represents midnight and 120000 identifies noon. The value 235959 identifies the second before midnight.

Application users are not required to enter TimeOfDay values in this format, as shortcuts and alternative entry formats are available.

As a best practice, use DateTime rather than TimeOfDay for properties that are part of work items, assignments, or other persistent objects in your application. See Understanding the Date, TimeOfDay, and DateTime property types for more about this type.

TrueFalse

Select TrueFalse to allow the property to hold values representing true or false. When you specify the value in your later configuration, you can enter true, false, or any of these values:

• 1, -1 or Y for true
• 0 or N for false

A TrueFalse property with a null value ("") can be saved into the PegaRULES database, but this is not a desirable practice. To avoid possible confusion and errors, choose a value "true" or "false" when initializing a TrueFalse property using a data transform or through other means, as appropriate to the business situation. CLINB 11/15/07 clinic

TextEncrypted

Select this type to implement encryption for the value. PROJ-466 5.3 See Implementing and using the TextEncrypted type.

Don't confuse the TextEncrypted type with the Password type. For TextEncrypted values, clear-text values are visible only if a Rule-Access-When rule evaluates to true.

Field

Description

Linked Property

Select to indicate that this property is a linked property, with values that correspond to all or part of the internal key of a unique instance of a concrete class.

Linked Class

For a linked property, identify a concrete class, one instance of which is to be accessed through the value of this linked property.

Do not link to a rule (any instance of a concrete class derived from the Rule- base class.)

Linked Mapping

Identify one or more properties (in the Source Property column) that at runtime contain values that together define all parts of a key to a single, unique instance of the objects in the Linked Class class. To assist in defining this mapping, the form identifies the properties that form the key to the linked class in the Linked Class Key column.

If each value of the linked property forms the entire key to the instances of the linked class, enter the property name (the value you entered in the New dialog) in the Source Property column. If the values of the linked properties form only part of they key to instances of the linked class, complete the Source Property column by identifying the properties that supply the other key parts.

Field

Description

Optional. For Single Value properties, identify a control (auto-generated or non-auto-generated) to control the read-only presentation and read-write presentation of this property. Dozens of standard controls are available:

• If there is no value, the system uses the control named Default. R-10856
• Choose Default-NonNLS to use default presentations that do not reflect operator locale settings.
• Choose PromptSelect (for a drop-down list) or RadioButtons (for a rectangular array of radio buttons) in most cases when Table Type has Local List, Remote List, or Prompt List selected. PROJ-183
• Choose PromptFieldValue when Table Type has Field Value selected. OSMAE 8/23/05
• ShowTextEncryptedPropertyValue is the default if the property Type is TextEncrypted.
• Do not choose SmartLabel, StartSmartField, SmartInfoBehavior, SmartInfo, ListView, ListToList or Chart; these are pseudo-controls with special, restricted use.

• Checkbox — pxTrueFalse v6.2
• Date — pxDateTime v6.2
• DateTime — pxDateTime v6.2
• Decimal — pxNumber
• Double — pxNumber
• Integer — pxInteger v6.2
• Password — pxPassword
• Text — pxTextInput
• TimeOfDay — pxDateTime v6.2

This field is not meaningful for Value List or Value Group properties. Leave blank. CLINB 3/15/06

If the control requires parameters and you want to specify them in this Property form, click the button and enter values as prompted.

When completing a Field panel (for a cell in a harness, section, or flow action), you can override the parameter values entered here with values that apply to that cell only. PROJ-64 5.3 MELLJ

For a list of selected popular formats that use parameters, see Atlas — Standard controls with parameters.

This button does not work with auto-generated controls. You can customize an auto-generated control only in a section or harness that contains the control. To customize the control, specify the rule in the Control field on the Cell Properties panel and use the magnifying glass icon () next to the field to open the control's Parameters dialog.v6.1 sp2

Field

Description

Select None, Local List, Field Value, Class Key Value, Remote List, or Prompt List:

• None — No table validations apply.
• Local List — The set of acceptable values is provided directly in the General tab of the Property rule form. See Property Form — General Tab — Tables — Case 1: Local List. 
• Field Value — The set of acceptable values corresponds to a set of field value rules. See Property Form — General Tab — Tables — Case 2: Field Value. 
• Class Key Value — The set of acceptable values is defined using the keys of a known class (a class other than this property's class). See Property Form — General Tab — Tables — Case3: Class Key Value . 
• Remote List — The set of acceptable values consists of the elements of a Value List, Page List, Value Group or Page Group embedded within a single PRPC object. See Property Form — General Tab — Tables — Case 4: Remote List.
• Prompt List — Acceptable values are enumerated as with a Local List, but for each internal value, a different localized value appears on input or output. See Property Form — General Tab — Tables — Case 5: Prompt List.