Naming Conventions
Columns
General
- The schema name must be in singular case at all times, to prevent incorrect entity set name generation. E.g.:
- ❌ Incorrect:
osb_homes
=> Plural form: osb_homeses
- ✅ Correct:
osb_home
=> Plural form: osb_home
Lookup
- The schema name of a lookup should reflect the type of the connecting entity. E.g.:
- ❌ Incorrect:
osb_partnerid
- ✅ Correct:
osb_partner_customer_id
- ✅ Correct:
osb_contact_id
- The schema name of a lookup field should always end with
_id
suffix.
E.g.: osb_contact_id
Choice
- The schema name of a choice field should always end with
_set
suffix.
E.g.: osb_employeetype_set
Relationships
- When creating an N:N relationship between two tables, it is a good practice to provide a custom name, especially for the connection table.
- The name of the relationship should contain the type of the connecting entity. E.g.:
osb_invoice_invoiceline_related
.
Processes
- The name of a process should briefly explain its actions taken. E.g.:
- ❌ Incorrect: On Create
- ✅ Correct: Update Identifier On Case Create
- The name of a process should always end with a project code. E.g.:
- ❌ Incorrect: Set Status To Complete
- ✅ Correct: Set Status To Complete - ITSM 365