You are here:
Contract Naming Conventions
When you create contracts, use the naming convention specified for the contract files.
Required Editions
| Available in: Enterprise, Performance, and Unlimited Editions that have Consumer Goods Cloud enabled |
The table lists the naming conventions applicable to the different core contracts in VS Code based Modeler.
| Contract Type | Naming Convention (ID) | Example |
|---|---|---|
| Business object | BO_<BusinessObjectName> | BO_Call |
| Validation messages | BO_<BusinessObjectName>_ValidationMessages | BO_Call_ValidationMessages |
| Business logic (including validations) | BO_<Business object name>_BL_<Function name> LO_<List object name>_BL_<Function name> BO_<Business object name>_BL_Validate<Function name> | LO_UsrNotificationOverview_BL_SetOnlyUnreadFilter |
| Data source | <Business object name>_DS <List object name>_DS | BOUsrNotification_DS |
| Process | <Module name>_<Process name>_PR | Call_AgendaOverview_PR |
| User interface | <Module name>_<UI screen name>_UI |
|
| List item | LI_<List object name> | LI_AgendaOverview |
| List object | LO_<List object name> | LO_AgendaOverview |
| Lookup object | LU_<Lookup object name> | LU_CallOrderInfo |
| Domain | - | Domains |
| Actors | - | Actors |
| Image | <ImageName> | Approve24 |
| Locale | Locale_<language code> | Locale_en |
Naming Conventions for Contract Elements
The table lists the naming convention and notation for contract elements. This information applies to all contract types, although the attribute value examples are specific to the context of a process contract.
| Type | Style | Example |
|---|---|---|
| Tag names | Capitalized camel case |
Process, DataSource |
| Attribute names | Camel case |
name, defaultAction |
| Attribute value: Class name | Capitalized camel case |
BoCall, List |
| Attribute value: Method name | Camel case |
getNavigationTitle, getSurveyList |
| Attribute value: Method parameter | Camel case |
pKey, status |
| Attribute value: Event name | Capitalized camel case |
ItemSelected, SetFacings |
| Attribute value: Action types | Capitalized |
LOGIC, PROCESS, VIEW |
Namespaces are separated by using double colons (::). Method calls are separated by using dots (.).
Example ProcessContext::Call.getNavigationTitle means that there’s a Call object in the current
context of a process, and that the method getNavigationTitle can be called on this
object.
Did this article solve your issue?
Let us know so we can improve!
