All custom named elements, e.g. variables, steps, record, etc., in Tulip should be named in a way that makes them human readable, unambiguous, and understandable to facilitate usability of apps during their life cycle.
It is recommended to adopt the following general naming conventions for all elements:
- Descriptive name
- Words written out in full, no abbreviations
- First letter of each word in upper case, subsequent letters in lower case
- Individual words separated by a space
Lowercase and no space
The sections below outline some more detailed guidelines for specific elements.
Variable names must be unique with an App, however the same names can be reused within the Tulip platform.
- Variable type not included in name
- Unit abbreviations written in parenthesis next to name of numeric variables
Abbreviation and units.
For regulated industries, see comment below.
Total Weight (g)
Type in name, no space and wrong unit
For regulated industries, see next subsection
It is recommended to store a value and its unit of measure in two separate variables/table fields, e.g. “Total Weight” and “Total Weight_UOM”. See GxP App Building Best Practices for more information.
Only one variable used for value and unit of measure
Variables used to filter tables
Variables used to filter a table with respect to a specific column should be named with the prefix ‘Filter’. This improves the usability of those variables during app building. This is recommended for variables solely used for filtering. General purpose variables in Apps do not need a prefix.
Suffix vs. prefix
Lowercase and no space
Variables for key indicators
For Apps with key indicators, e.g. CPPs/CQAs (Critical Process Parameters / Critical Process Attributes) or KPIs, add a prefix to the variables’ names to improve the readability of the variables.
Prefix not clearly separated from variable name
Use as suffix vs. prefix
Missing prefix for key indicator
Tables names should adapt the same naming convention used for variables and be grouped with a prefix. Tables should be grouped against general purpose, e.g. multiple/all use cases, or specific use cases. It is recommended to use ‘#’ for general purpose grouping and not to use ‘*’. The ‘*’ is used by Tulip to mark tables originating from Tulip library Apps.
Use of suffix
Use of ‘*’ prefix
It is not recommended to use the default “unnamed trigger” name. Instead, the name of a trigger should describe its functionality in a few words.
Increment defect counter
Too little context
Check order delivery status