2017 June Release

Reference naming conventionsPermanent link for this heading

The next table gives an overview of suggested naming conventions for component object references. These naming conventions are only recommendations, and you are free to define your own naming conventions.

Note: A valid reference must begin with a character and must not contain any special characters except the underscore character.

Element

Recommended reference

Software component

The reference of a software component should be composed of upper case characters only.

Example: APPDUCXSAMPLE

Object class

The reference of an object class should be in singular form. Use mixed case notation, starting with a capital first letter.

Example: OrderRecord

Enumeration type,
compound type

The reference of an enumeration type or a compound type should describe the purpose of a property of this type. If possible, do not include the word “Type”. Use mixed case notation, starting with a capital first letter.

Example: OrderState

Enumeration item

The reference of an enumeration item should be composed of upper case characters only. Individual words should be separated by an underscore character. Each enumeration item should share a prefix common to all enumeration items of the enumeration type containing them.

Example: OS_SHIPPED

Property

The reference of a property should describe the purpose of the property. You may include an abbreviation of the object class the property belongs to. Use lower case characters only for a property reference.

Example: orderdate

Use case

The reference of a use case should be comprised of a verb describing the action performed followed by the object on which this action is carried out. Use mixed case notation, starting with a capital first letter.

Example: PrintInvoice

ACL

The reference of an ACL should be in mixed case notation, starting with a capital first letter, and ending with the postfix “ACL”.

Example: OrderRecordACL

Form

The reference of a form should be in mixed case notation, starting with the prefix “Form”. If you define different forms for administrators and end-users, you should use the postfixes “User” and “Admin”.

Example: FormOrderRecord, FormOrderRecordUser, FormOrderRecordAdmin

Form page

The reference of a form page should be in mixed case notation, starting with the prefix “Page”.

Example: PageOrderRecord

Other component objects

The reference of all other component objects should be in mixed case notation, starting with a capital first letter. An abbreviation of the object class may be used as a prefix.

Example: ButtonBarOrderRecord

Table 1: Reference naming conventions