出力 XML の静的テンプレートの定義およびデプロイ

標準出力テンプレートの要素に加えてこれ以外の要素を含むテンプレートを使用する場合、静的出力テンプレートを作成します。 この機能を使用すると、標準出力テンプレートのすべての要素と追加した新しい要素を含むテンプレートを作成できます。

このタスクについて

例えば、追加した任意のデータベース列に UI フィールドを追加する必要がある場合があります。 この機能を使用した場合、標準テンプレートに存在する任意の要素を削除できないことに注意してください。

静的テンプレートを定義およびデプロイする手順は、次のとおりです。

手順

  1. 変更する API の標準出力テンプレートを、 <runtime_sandbox>/repository/xapi/template/merged/api/FileName.xml ファイルから <runtime_sandbox>/extensions/global/template/FileName[.DocType].xmlとしてコピーします。
    • 新しいテンプレートのファイル名を標準テンプレートの名前と同じままにします。

      出力テンプレートの名前は、これに関連付けられた API またはイベントの名前に対応します。 例えば、getOrderDetails() API は、出力テンプレート・ファイル getOrderDetails.xml を取ります。

    • テンプレートが伝票種別を参照する場合、ファイル名に伝票種別コードを含めます。

      例えば、オーダー (0001) 伝票種別の getOrderDetails() API の出力テンプレートを作成するには、テンプレート XML の名前は getOrderDetails.0001.xml になります。

  2. 必要に応じて、 /extensions/global/template/api/ ディレクトリー内のコピーしたテンプレートを変更します。カスタム出力 XML テンプレートを作成するためのベスト・プラクティスに留意してください。
    注: 任意の要素を追加できますが、標準出力テンプレートにある要素を削除することはできません。
  3. 標準として API を呼び出すと、カスタム・テンプレートを含むディレクトリーからカスタム出力テンプレートが自動的に取得されます。