環境設定ファイル

この記事には、以下のトピックが含まれています。
casm173
この記事には、以下のトピックが含まれています。
text_api.cfg ファイルは、更新可能な各種テーブルのフィールドに直接関係するキーワードを定義します。 このファイルは、特定の定義済みの値(キーワードなど)を検索するための参照情報として、また Text API を設定するためのメカニズムとして使用します。ただし、初期設定の環境設定ファイルは、変更しなくてもほとんどのインストール環境で機能します。
text_api.cfg ファイルは、以下のディレクトリにあります。
  • UNIX - $NX_ROOT/site
  • Windows -
    インストール ディレクトリ
    \site。 例: C:\Program Files\CA\Service Desk\site
環境設定ファイルはいくつかのセクションに分かれていて、各セクション内には特定の属性が定義されています。 属性は以下の形式で定義されています。
keyword=value
キーワードの大文字小文字は区別されませんが、値の大文字小文字は区別されます([OPTIONS]セクションを除く)。
text_api.cfg ファイルは、任意のテキスト エディタを使用して表示および変更できます。
CA NSM アラート管理システム コンポーネントと統合している場合は、CA SDM に渡されるすべての追加フィールドについて text_api.cfg を更新する必要があります。
オプション
text_api.cfg ファイルの [OPTIONS] セクションでは処理オプションを定義します。これはサイトによって異なる可能性があります。 たとえば、入力データ形式を判断したり、改行を許可するフィールドを指定したり、電子メール インターフェースを使用して案件、リクエスト、または変更要求を更新できるようにするかどうかを指定したりするオプションがあります。 このセクションのすべてのオプションは設定可能です。 VALID_TABLE_LISTからテーブル名を削除して、Text APIがこれらのテーブルにアクセスできないように設定することはできますが、このリストにテーブル名を追加することはできません。
デフォルト
Text API を使用するインターフェースごとに text_api.cfg ファイルで提供されている [XX_DEFAULTS] セクションを使用します(電子メール インターフェース用の [EMAIL_DEFAULTS] やコマンド ライン インターフェース用の [CMD_DEFAULTS] など)。 [XX_DEFAULTS] セクションには、ユーザが直接指定しなかった場合に必要なフィールドやプロパティのデフォルト値が定義されています。 XX は、CMD や EMAIL などのインターフェース タイプを指します。
初期設定値を設定するには、以下のいずれかの形式を使用します。
  • table_name
    .
    keyword
    =
    value
    keyword
    は、[KEYWORDS]セクションに定義するか、データベース内にプロパティとして定義する必要があります。 keywordに関連付けられているあらゆるメソッドが自動的に
    value
    に適用されます。 以下に例を示します。
    ISSUE.PRIORITY=1
    PRIORITY キーワードは text_api.cfg で定義され、指定した値をデータベース内の対応する値と一致するように変換するためのルックアップを実行します。 ここでは、値 1 が、ベースにあるデータベース内の優先度シンボル 1 に対する値 5 に変換されます。 この機能を使用すると、ユーザは Web インターフェースと同様の方法で値を指定できます。
  • table_name
    .PROPERTY={{
    property_label
    }}
    value
    property_label
    は、データベース内にプロパティとして定義されている必要があります。
どちらの形式でも、
table_name
は、[OPTIONS]セクションのVALID_TABLE_LISTに定義されているいずれかの値(Issue、Request、Contactなど)である必要があります。
入力無視
text_api.cfg ファイルには、Text API を使用するインターフェースごとに [..._IGNORE_INCOMING] セクションが 1 つずつ存在します(たとえば、CA NSM インターフェース用の [TNG_IGNORE_INCOMING]、その他の CA 製品が使用する外部インターフェース用の [EXT_IGNORE_INCOMING] など)。 これらのセクションは、入力で無視されるフィールドとプロパティを定義します(形式は、「
=
value
」を指定することを除いて「初期設定」で説明したのと同じです)。 この機能により、ユーザが特定の値を設定できないようにすることができます。これにより、カスタマに電子メール インターフェースの使用を許可する場合などに、セキュリティ保護を高めることができます。
IGNORE セクションと、対応する [..._DEFAULTS] セクションを組み合わせて使用することで、ユーザが特定の値を設定できないようにして、それらの初期設定値を提供できます。 たとえば、電子メール インターフェース ユーザが案件の優先度を設定できないようにするには、以下の値を指定します。
[EMAIL_DEFAULTS] ISSUE.PRIORITY=2 [EMAIL_IGNORE_INCOMING] ISSUE.PRIORITY
この場合、ユーザが電子メール メッセージの本文に指定するあらゆる優先度が無視され、電子メール インターフェースによって作成されるすべての案件に自動的に優先度2が割り当てられます。
入力例
以下の例は、電子メール メッセージの本文で、またはコマンド ライン インターフェースの入力として使用するファイル内で使用できる入力を示しています。
例: 最初の行にキーワードが含まれていない場合
この例では、最初の行の最初の列に %keyword がないため、リテラル %DESCRIPTION
=
がメッセージの先頭に追加されます。 この追加によって、説明フィールドが「This entire text goes to the description field」に設定されます(text_api.cfg の[OPTIONS]セクションの LINEFEEDS_ALLOWED エントリにあるフィールドのリストに ISSUE.DESCRIPTION が含まれているため、改行はそのまま残ります)。
This entire text goes into the description field %PRIORITY=None
例: 最初の行にキーワードが含まれている場合
この例では、PRIORITY キーワードは text_api.cfg に定義されていて、指定した値をデータベース内の対応する値と一致するように変換するためのルックアップを実行します。 ここでは、値 None が、ベースにあるデータベース内の優先度シンボル 1 に対する値 0 に変換されます。 この機能を使用すると、ユーザは Web インターフェースと同様の方法で値を指定できます。
%description=This is my description %priority=None %CATEGORY=Upgrade.PC %PROPERTY={{Current CPU}}266 mhz %PROPERTY={{Current Harddrive}}1 gig %PROPERTY={{Requested Upgrade}}4 gig harddrive
指定した値は、前の例と同様に、チケットの説明フィールドと優先度フィールドを設定するのに使用されます(キーワードの大文字小文字は区別されません)。
Upgrade.PCの値が検索され、チケットのカテゴリ フィールドが適切に設定されます。
以下のラベルに一致する3つのプロパティ値が設定されます。
  • Current CPU
  • Current Harddrive
  • Requested Upgrade