チューリップにおける要素名のベストプラクティス
  • 31 Oct 2023
  • 1 読む分
  • 寄稿者

チューリップにおける要素名のベストプラクティス


記事の要約

目的

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

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

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

  • 記述名
  • 略語を使用せず、単語を完全に記述する。
  • 各単語の最初の文字は大文字、それ以降の文字は小文字
  • 個々の単語はスペースで区切る

| 例問題より良い例|完了|非記述的|操作終了|operatorName|小文字でスペースなし|オペレーター名

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


変数

変数名はAppで一意でなければなりませんが、同じ名前をTulipプラットフォーム内で再利用することができます。

  • 変数タイプは名前に含めない
  • 数値変数の名前の横に括弧で書かれた単位略語

| 例問題より良い例|総重量|略語と単位.規制産業については、以下のコメントを参照。| 総重量(g) | | fltTemperatureF | 名称の入力、スペースなし、単位間違い規制産業については、次のサブセクションを参照。

規制業種

例えば、"Total Weight"(総重量)と "Total Weight_UOM"(総重量)のように、値とその単位を2つの別々の変数/テーブルレコードフィールドに格納することを推奨します。詳細はGxPアプリ構築のベストプラクティスを参照。

| 例|温度(°F)|値と単位に使用される変数は1つだけ|温度 Temperature_UOM

テーブルのフィルタリングに使われる変数

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

| 例|ステータス・フィルター|サフィックスなし|Filter_Status|IPCtimestamp フィルター|サフィックスとプレフィックス 小文字とスペースなし|Filter_IPC Timestamp

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

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

ExampleIssueBetter Example
CPP TemperaturePrefix not clearly separated from variable nameCPP_Temperature (°C)
AssayB_CQAUse as suffix vs. prefixCQA_Assay B
AvailabilityMissing prefix for key indicatorKPI_Availability

テーブル

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

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

ExampleIssueBetter Example
Printed lables_tableUse of suffix#Printed Labels
*Printed_labelsUse of ‘*’ prefix#Printed Labels

トリガー

デフォルトの "unnamed trigger "名を使用することは推奨されません。その代わりに、トリガーの名前は、その機能を数語で説明する必要があります。

| 例問題 |より良い名前|無名トリガー|デフォルト名|欠陥カウンタのインクリメント|ステータスのチェック|コンテキストが少なすぎる|注文配送ステータスのチェック||など


この記事は役に立ちましたか?