Skip to content

How-to guide

Naming conventions

Naming conventions

2 min

Use understandable business terms and stable technical identifiers. A property's technical name and display label serve different purposes.

Types and relationships

Use singular names such as Client and Commande. Prefer a business concept over a technical table name. Add a qualifier when it distinguishes concepts, not merely source applications.

Use meaningful verbs and check direction: Client places Commande. Document cardinality and the reverse meaning. A generic “related to” does not explain the purpose.

Technical property names

In the property form, names start with a letter and contain only A–Z, a–z, digits and _. Spaces, accents and hyphens are not accepted in this field.

Technical nameDisplay labelMeaning
dateEcheanceDue dateExpected date in the specified time zone
dureeMinutesDuration in minutesNumeric value expressed in minutes
client_idSource customer identifierReference in the specified source system
montantAmountValue interpreted together with currency

Avoid date2 or value: document meaning and units. Display labels and descriptions may use accents and terminology familiar to users.

Verify stability

Create a property, save and reopen the type. Check its technical key in the JSON definition and its label in the form. Test an instance using a representative value.

Changing a label differs from renaming a key used by an API, mapping or agent. Identify and test these dependencies before renaming: see Evolve a used type.

A correctly formatted identifier does not ensure business uniqueness or matching across sources. Define those rules separately in your model.

Did this page help you achieve your goal?