UDF 名および UDL 名のベスト プラクティス - BlueCat Integrity - 9.5.0

管理ガイド

Locale
日本語
Product name
BlueCat Integrity
Version
9.5.0

Address Manager では、ユーザ定義フィールドおよびユーザ定義リンク (UDF および UDL) の名前を作成するときに制限を設けていません。ほとんどすべてのユニコード文字を含む名前を使用できます。ただし、UDL を外部ツールやアプライアンスに統合するときに問題を引き起こす名前や、更新プログラムが、ユーザが作成した名前と競合する名前を利用する場合、問題を引き起こす名前もあります。

現在および将来の問題を回避するために、以下の非公式規則を推奨します。

一般ガイドライン:
  • 標準 ASCII 文字と数字のみを使用する。記号、句読点、アクセント記号、その他の英語以外の文字を使用しないでください。一部の環境では、アンダースコア ("_") も使用できます。

    上記のガイドラインに従うと、名前を事実上すべてのデバイスで、どのようなスクリプトやプログラム言語でも使用できます。現在使用しているサードパーティ ツールがユニコードに対応していても、将来使用するツールもユニコードに対応するとは限りません。

  • 文字数を 24 文字以下に抑える。一部のプログラミング言語では、識別子の最初の 32 文字しか認識しません。名前を 24 文字までに制限すると、サードパーティのスクリプト内でもプレフィックスとサフィックスを使用できます。

    他方、名前は短くしすぎないでください。極めて短い名前 ("address" や "private" など) を使用すると、他のツールやアプリケーションと名前が競合する確率が上がります。

  • Java、JavaScript、または Python に予約されている名前やキーワードと同じ名前を使用しないでください。

    同様に、BlueCat によって定義されたプロパティやメソッドで使用される名前は使用しないでください。

  • 定義されたそれぞれの UDF または UDL の名前は、必ず全体において一意であるようにする。これは、名前が継承される現在の範囲内でのみ一意であるという意味ではありません。

    全体で一意の名前を付けることで、UDF および UDL それぞれの将来的な柔軟性が高まり、機能の拡張が容易になります。

  • 大文字/小文字が区別されない場合でも、必ず名前が一意であるようにする。例えば、"MyAddress" および "MYADDRESS" を両方使用することは避けてください。

    Address Manager では、UDF 名と UDL 名の大文字/小文字を区別して処理します。サードパーティ アプリケーションやスクリプト作成ツールの多くでは、大文字/小文字が区別されません。

  • UDF 名と UDL 名の先頭に、BlueCat によって使用されないプレフィックスを付ける。ユーザの会社名の短縮形を使用することを推奨します。例えば、会社名が "Example Company" の場合、"excIntrusionCount" や "excStoreStatus" などのUDF 名を使用するとよいでしょう。

    このような名前を付けることで、将来のアップデートで機能と名前が競合することを回避しやすくなります。BlueCat 機能を自社のチームが作成した機能と区別する際にも役立ちます。

UDF 名の追加ガイドライン:
  • UDF 名の先頭には小文字を使用してください。「キャメルケース」(例: myIndexName) を使用して、UDF 名に含まれる単語の一部を大文字にします。
UDL 名の追加ガイドライン:
  • 通常、UDL 名はすべて大文字を使用して、単語をアンダースコアで区切ります (例: MY_INDEX_NAME)。この命名規則を使用すると、UDL 名と UDF 名を区別しやすくなります。ただし、UDF 名と同じ命名規則に従う方が好ましい場合は、そうしても構いません。