Naming conventions for properties
Creating descriptive and logical names for your properties can help you convey essential information just by looking at the name. As a result, you speed up development of your application, promote reuse across your application, and avoid duplicating properties that already exist in your system.For example, you can create CustomerName and PhoneNumber properties that clearly describe the type of data that the properties reference.
For the names of a property, choose nouns or noun phrases that clearly describe the property. Use names that are descriptive and meaningful, so that the contents of the property are easier to understand. For example, LoanNumber is a good choice for a numeric account number, while LoanID is a better choice for an alphanumeric account number. Enter the name in a camel case convention with the first letter in uppercase and then capitalize the first letter of each additional connected word.
For clarity, follow the following guidelines:
- End names for lists, that are Page List properties, with list.
- End names for groups, that are Page Group properties, with group.
- Because property names are case-sensitive, use only letters and digits.
- Do not start property names with an underscore ( _ ) or dollar sign ($).
Standard property names
Standard property names that Pega Platform includes start with the px, py, and pz characters. Do not start names of your properties with these prefixes. The following table describes the purpose of each of the prefixes:
|px||Computed properties that users see on a form, but cannot directly enter or change values, for example a pxCreateDateTime property.|
|py||Properties that users can explicitly enter or change, for example a pyDescription property.|
|pz||Properties that are reserved for internal use, for example a pzInsKey property. Users cannot see, enter, or change properties with the pz prefix.|