外部ファイルからのプロパティー値の取得

プロパティーの値を HTTP 経由で XML ファイルまたは JSON ファイルから取得するように指定できます。 そうすると、サーバーは、プロセスの実行時にそのファイルからの値リストを使用してプロンプトを出します。

始める前に

IBM® UrbanCode Deploy からアクセス可能なサーバーで、プロパティーの値を含む XML ファイルまたは JSON ファイルを管理します。 このファイルは、複数の異なる方法でフォーマット設定できます。3 つのパラメーターを使用して値へのパスを特定することも必要です。 これらのパス・パラメーターの例は、サンプル・ファイルに含まれています。
このファイルをフォーマット設定する最も簡単な方法は、次の例のように、プロパティーの値のシンプルなリストを提供することです。
<company>
  <employee>Alice</employee>
  <employee>Bob</employee>
  <employee>Chris</employee>
<company>
XML ファイルの場合、XPath を使用して値へのパスを指定します。 前述の XML ファイルでは、「基本パス」パラメーターは XPath 式 //company/employee で、パラメーターの「値のパス」「ラベル・パス」はブランクです。
次の例は、JSON の同等のファイルを示しています。
{
  company: {
    employee: [
      "Alice",
      "Bob",
      "Chris"
    ]
  }
}
前述の JSON ファイルでは、「基本パス」パラメーターは company.employee で、パラメーターの「値のパス」「ラベル・パス」はブランクです。
ファイル内に別々のラベルと値情報を組み込むことができます。 例えば、次の XML ファイルには、名前と ID 番号が含まれています。
<company>
  <employee>
    <name>Alice</name>
    <id>1</id>
  </employee>
  <employee>
    <name>Bob</name>
    <id>2</id>
  </employee>
  <employee>
    <name>Chris</name>
    <id>3</id>
  </employee>
</company>
この場合、「基本パス」パラメーターは XPath 式 //company/employee です。「値の パス」パラメーターは、基本パスからの相対で値へのパスを示す XPath 式です。この場合の式は、./id です。同様に、「ラベル・パス」パラメーターは、基本パスからの相対でラベルへのパスを示す XPath 式です。この場合の式は、./name です。
次の JSON ファイルは、前述の XML ファイルと同等です。
{
  company: {
    employees: [
      { name: "Alice", employee.id: 1 },
      { name: "Bob", employee.id: 2 },
      { name: "Chris", employee.id: 3}
    ]
  }
} 
この場合、「基本パス」パラメーターは company.employees です。「値のパス」パラメーターは employee¥.id で、「ラベル・パス」パラメーターは name です。
注: JSON ファイルのパスを指定する際、属性名内のピリオドは、前述の例における「値のパス」パラメーターのように、バックスラッシュでエスケープしてください。
XML ファイルで属性を使用する場合、@ 文字を使用して XPath の属性を指定します。 例えば、次の XML ファイルには、次のような属性の値が入ります。
<company>
  <employee id="1">Alice</employee>
  <employee id="2">Bob</employee>
  <employee id="3">Chris</employee>
<company>
この場合、「基本パス」パラメーターは XPath 式 //company/employee です。「値のパス」パラメーターが ./@id で、「ラベル・パス」パラメーターがピリオド (.) です。

このタスクについて

これらのリモート・プロパティー値をコンポーネントの環境プロパティーなどのプロパティーの定義に使用することができますが、システム・プロパティー、アプリケーション・プロパティー、あるいはコンポーネント・プロパティーなどの一般プロパティーには使用できません。

手順

  1. プロパティー定義を作成します。 例えば、コンポーネントをクリックし、「構成」タブに進み、 「環境プロパティーの定義」をクリックして、「プロパティーの追加」をクリックします。
  2. 「名前」「説明」「ラベル」「パターン」、および「必須」フィールドを通常通り、指定します
  3. 「タイプ」リストで、単一のプロパティー値には「HTTP 選択」を選択し、複数のプロパティー値を可能にするには、「HTTP 複数選択」を選択します。 新規フィールドがいくつか表示されます。
  4. 次のフィールドを指定します。 これらのフィールドは、外部ファイルからのパラメーターに固有のものです。
    URL
    外部 XML または JSON ファイルの URL を指定します。
    ユーザー名
    URL がユーザー名を必要とする場合は、ここに指定します。
    パスワード
    URL がパスワードを必要とする場合は、ここに指定します。
    データ形式
    ファイルのタイプ、すなわち、JSONXML かを指定します。
    基本パス
    XML ファイルの場合、データへの XPath 式を指定します。JSON ファイルの場合、JSON 属性を介したデータまでのパスを、ピリオド (.) でパスを区切りながら指定します。 このページの先頭にある例を参照してください。
    値のパス
    パラメーター値へのパスを、「基本パス」パラメーターからの相対で指定します。
    ラベル・パス
    パラメーター・ラベルへのパスを、「基本パス」パラメーターからの相対で指定します。
    デフォルト値
    パラメーターのデフォルト値を指定します。
  5. 「保存」をクリックします。

タスクの結果

これで、プロセスの実行時に、「プロセスの実行」ウィンドウに、外部ファイルから値を取得するパラメーターが含まれます。

フィードバック