Tulipにおける要素名の命名のベストプラクティス

目的

Tulipのカスタム要素の命名に関するベストプラクティスを確認し、独自のアプリと命名規則の出発点とします。

Tulipの変数、ステップ、レコードなど、すべてのカスタム命名要素は、アプリのライフサイクルにおけるユーザビリティを促進するために、人間が読みやすく、あいまいでなく、理解しやすい方法で命名する必要があります。

すべての要素について、以下の一般的な命名規則を採用することが推奨されます。

• 説明的な名前
• 略語を使わず、単語を完全に表記する。
• 各単語の最初の文字は大文字で、それ以降の文字は小文字で書く
• 個々の単語はスペースで区切る

以下のセクションでは、特定の要素についてのより詳細なガイドラインの概要を説明します。

変数

変数名はアプリ内でユニークでなければなりませんが、同じ名前をチューリップ・プラットフォーム内で再利用することができます。

• 変数名に変数の種類を含めない
• 数値変数の名前の隣に括弧で書かれた単位の省略形

| --- | --- | --- |
| 例題｜課題｜より良い例題
| 総重量｜略語と単位.規制業種は下記コメント参照| 総重量(g)
| fltTemperatureF｜名称を入力し、スペースを入れず、単位を間違える規制対象業界では、次のサブセクションを参照してください｜温度（°F）｜。

規制対象業種

値とその単位を2つの別々の変数/テーブルレコードフィールドに格納することが推奨されます。詳細については、GxPアプリ構築のベストプラクティスを参照してください。

| --- | --- | --- |
| 例｜問題点｜より良い例
| 温度（°F）｜値と単位に使用される唯一の変数｜温度Temperature_UOM｜。

テーブルをフィルタリングするために使用される変数

特定の列に関してテーブルをフィルタリングするために使用される変数には、接頭辞 'Filter' を付けて命名する必要があります。これは、アプリ構築時にこれらの変数の使い勝手を向上させます。これは、フィルタリングにのみ使用される変数に推奨されます。アプリの汎用変数には接頭辞は必要ありません。

| --- | --- | --- |
| 例｜問題点｜より良い例
| ステータス・フィルター｜サフィックスなし｜Filter_Status｜｜。
| IPCtimestampフィルター｜サフィックスとプレフィックスの比較
小文字とスペースなし｜Filter_IPC timestamp｜（フィルターIPCタイムスタンプ

キーインジケータ用の変数

CPP/CQA（Critical Process Parameters / Critical Process Attributes）やKPIなどの重要な指標を持つアプリの場合、変数の読みやすさを向上させるために、変数の名前に接頭辞を追加する。

| --- | --- | --- |
|例:課題:より良い例:課題:より良い例:課題:課題:課題
| CPP温度｜接頭辞が変数名から明確に分離されていない｜CPP_Temperature (°C)|」。
| AssayB_CQA｜接頭辞ではなく接尾辞として使用｜CQA_Assay B
| 可用性｜主要指標のプレフィックスがない｜KPI_Availability

テーブル

テーブル名は、変数に使用されるのと同じ命名規則を適用し、接頭辞でグループ化する必要がある。テーブルは、複数/すべてのユースケースなどの一般的な目的、または特定のユースケースに対してグループ化する必要があります。汎用のグループ化には、''を使用することを推奨します。

を使用し、'*'は使用しないことを推奨します。は、TulipライブラリAppsから発信されたテーブルをマークするためにTulipによって使用されます。

| --- | --- | --- |
| 例題｜問題点｜より良い例題
| 印刷されたラベルテーブル｜サフィックスの使用｜#印刷されたラベル｜#印刷されたラベル
| *Printed_labels | '*'接頭辞の使用｜#印刷されたラベル｜#Printed Labels

トリガー

デフォルトの「無名トリガー」名を使用することはお勧めしません。その代わりに、トリガーの名前は、いくつかの単語でその機能を説明する必要があります。