Remove contradictory underscore usage from 'Best Practices for Naming Elements in Tulip' article

Purpose

Review our best practices for naming custom elements in Tulip as a starting point for your own apps and naming conventions.

All custom named elements, e.g. Variables, Steps, Records, 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
• No underscores

The sections below outline some more detailed guidelines for specific elements.

Variables

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

Regulated industries

It is recommended to store a value and its unit of measure in two separate Variables/Table Record Fields, e.g. "Total Weight" and "Total Weight UOM". See GxP App Building Best Practices for more information.

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.

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.

[!IMPORTANT] SME Input Required
The Slack reporter flags that the "Better Example" column in this section uses underscores (e.g. CPP_Temperature) which directly contradicts the general naming rule of "No underscores" stated at the top of the article. The proposed changes below remove underscores and use spaces instead. However, an SME should confirm: (1) whether the prefix separator for key indicators (CPP, CQA, KPI) should be a space, or if a different convention is preferred, and (2) whether the GxP best practices article also needs to be updated for consistency.

Tables

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.

Triggers

Do not use the default "unnamed trigger" name. Instead, the name of a trigger should describe its functionality in a few words.