在Tulip中命名元素的最佳做法

目的

回顾我们在Tulip中命名自定义元素的最佳做法，作为你自己的应用程序和命名惯例的起点。

所有自定义命名的元素，如变量、步骤、记录等，在Tulip中的命名方式应使其具有可读性、明确性和可理解性，以促进应用程序在其生命周期内的可用性。

建议对所有元素采用以下一般的命名惯例。

• 描述性名称
• 字的全称，没有缩略语
• 每个词的第一个字母用大写，后面的字母用小写
• 单个单词用空格隔开

| | | |

|例子|问题|更好的例子
| 完成 | 非描述性的 | 操作完成 |
| 操作员姓名 | 小写且无空格 | 操作员姓名 |

下面的章节概述了一些关于特定元素的更详细的准则。

变量

变量名称在应用程序中必须是唯一的，但是相同的名称可以在Tulip平台中重复使用。

• 变量类型不包括在名称中
• 数字变量名称旁的括号内写有单位缩写

| | | |

|例子|问题|更好的例子
| 总重量 | 缩写和单位。对于受管制的行业，见下面的注释。| 总重量 (g) |
| fltTemperatureF | 键入名称，无空格，单位错误对于受管制行业，见下一小节 | 温度 (°F) |

受监管的行业

建议在两个独立的变量/表记录字段中存储一个数值及其计量单位，例如 "总重量 "和 "总重量_UOM"。更多信息请参见GxP应用程序构建最佳实践。

| | | |

|例子|问题|更好的例子|
| 温度 (°F) | 只有一个变量用于数值和计量单位 | 温度 Temperature_UOM |

用于过滤表的变量

用于过滤表格中特定列的变量应以 "Filter "为前缀来命名。这可以提高这些变量在应用程序构建过程中的可用性。对于只用于过滤的变量，建议这样做。应用程序中的一般用途变量不需要前缀。

| | | |

|例子|问题|更好的例子|
| 状态过滤器 | 不带后缀的过滤器_状态 |
| IPCtimestamp过滤器|后缀与前缀的关系
小写且无空格 | Filter_IPC Timestamp |

关键指标的变量

对于带有关键指标的应用程序，例如CPPs/CQAs（关键过程参数/关键过程属性）或KPIs，在变量名称中添加一个前缀，以提高变量的可读性。

| | | |

|例子|问题|更好的例子
| CPP温度 | 前缀未与变量名称明确分开 | CPP_Temperature (°C) |
| AssayB_CQA | 作为后缀与前缀使用 | CQA_Assay B |
| 可用性 | 缺少关键指标的前缀 | KPI_Availability|

表

表的名称应采用与变量相同的命名规则，并以前缀分组。表应按一般目的分组，如多个/所有用例，或特定用例。建议使用''来分组，而不是使用''来分组。

'用于一般用途的分组，不要使用'*'。Tulip使用'*'来标记来自Tulip库应用程序的表格。

| | | |

|例子|问题|更好的例子|
|打印的lables_table |使用后缀 | #打印的标签 |
| *打印的lables_table |使用'*'前缀 | #打印的label |

触发器

不建议使用默认的 "未命名的触发器 "名称。相反，触发器的名称应该用几个字来描述其功能。

| | | |

|例子|问题|更好的名字|
| 未命名的触发器 | 默认名称 | 递增缺陷计数器 |
| 检查状态 | 上下文太少 | 检查订单交付状态 |