リクエストファイルの形式

リクエストファイルの全体構成

リクエストファイルは、fusion_place サーバで行いたい処理の内容を指定する XML ファイルです(XML ファイルはテキスト形式です)。リクエストファイルの内容は以下のような形式です。

<?xml version="1.0" encoding="Windows-31J"?> (1)
  <requests> (2)
    <request type="IMPORT_VALUES" desc="実績インポートA">(3)
      <!-- ... -->
    </request> (3)
    <request type="IMPORT_VALUES" desc="実績インポートB"> (3)
      <!-- ... -->
  </request> (3)
</requests> (2)
1 XML 宣言
2 「リクエストの並び」開始、終了
3 「リクエスト」開始、終了

XML 宣言

「XML 宣言」(上記 1)はファイルの先頭に 1 行だけ置き、このファイルが XML 仕様 1.0 に準拠していることを示します。encoding="…​" の部分では、このファイルに適用されているエンコーディングを指定します。指定可能な値は、OS 環境等によって異なりますが、主に使用されるのは UTF-8Windows-31J (シフト JIS の Windows 拡張)です。

「リクエストの並び」の開始タグ・終了タグ

XML 宣言を除くと、ファイルの内容は、一連の「リクエストの並び」(requests)です。その並び全体の開始位置と終了位置にそれぞれ <requests> タグと </requests> タグを置いて下さい(上記 2)。

「リクエスト」の開始タグ・終了タグ

「リクエストの並び」(requests)の中には、任意の数の「リクエスト」(request)を置くことができます。リクエストの開始位置と終了位置にそれぞれ <request> タグと </request> タグを置いて下さい(上記 3)。上記の例のように、<request> タグにはタイプ(type)と説明(desc)という二つの属性を指定することができます。<request> タグおよびリクエスト内容の記述方法は後述します。

リクエストの記述方法

リクエストの開始と終了を示す 2 つのタグ <request …​></request> の間にリクエストを記述します。

<request type="IMPORT_VALUES" desc="実績インポートA"> (1)
  <parameters> (2)
    <parameter name="APPLICATION"  value="SAMPLE1"/> (3)
    <parameter name="FORM" value="IMPORT_ACT1"/> (3)
    <parameter name="PARTICIPANT" value="#NONE"/> (3)
    <parameter name="POV" key="#FY" value="FY2009"/> (3)
  </parameters> (2)
  <contents> (4)
    FY2009, M1, S01, M01, PL1100, -5131123 (5)
    FY2009, M2, S01, M01, PL1100, -11224332 (5)
    <!-- ... -->
  </contents> (4)
</request> (1)
1 「リクエスト」開始、終了
2 「パラメタの並び」開始、終了
3 パラメタ
4 「リクエスト内容」開始、終了
5 リクエスト内容

「リクエスト」の開始タグ・終了タグ

リクエストの開始タグには、以下の 2 つの属性を指定することができます。

属性 必須 説明

type

Yes

リクエストのタイプを指定します。具体的な値については、各リクエストタイプの説明をご覧ください。

大文字・小文字は区別されません。

desc

No

リクエストの内容を表す任意の文字列です。

「パラメタの並び」の開始タグ・終了タグ

リクエストの開始タグの直後に、パラメタの並び(parameters)を置きます。パラメタの並びの開始タグは <parameters>、終了タグは </parameters> です。この間に、複数のパラメタ(parameter)を置くことができます。パラメタについては次の説明をご覧下さい。

「パラメタ」タグ

パラメタとは、リクエストの内容を補足して、処理対象や処理条件を指定するものです。パラメタの例としては、対象アプリケーションを指定する APPLICATION や、データインポートに用いるフォームを指定する FORM があります。パラメタの種類はリクエストのタイプごとに決まっています。パラメタには必須と任意の区別があります。ひとつのリクエストに指定するパラメタが複数ある場合、どのような順序に記述してもかまいません。パラメタタグに指定できる属性は以下の通りです。

属性 必須 説明

name

Yes

パラメタの名前(APPLICATION, FORM 等)を指定します。

大文字・小文字は区別されません。

key

(説明右記)

パラメタが「キー付き」である場合、キーを指定します。現バージョンではキー付きパラメタは POV(レポートの視点メンバ)のみです。POV ではキーとしてディメンションラベルを指定し、値(value)にはそのディメンションのメンバのラベルを指定します。

大文字・小文字は区別されません。

value

Yes

パラメタの値を指定します。

大文字・小文字は区別されません。

リクエスタでは、パラメタ値に対する 環境変数値の埋め込み が可能です。この機能を利用すると、会計年度・相対期間など、リクエストファイル中の可変部分を処理の都度書き換えることが不要になります。この機能は、[Web API] には適用されません。

リクエスト内容

リクエスト内容(contents)の開始タグ <contents> と終了タグ </contents> で挟んで、リクエスト内容データを置きます。リクエスト内容は、fusion_place サーバに処理を依頼するデータそのものです。内容として何をどのように記述するかは、リクエストタイプによって異なります。

リクエストタイプが「フォームを用いたデータインポート(IMPORT_VALUES)」の場合、リクエスト内容には、インポート対象データを、当該フォームで読み込み可能な形式( 簡易版の場合フル機能版の場合 )で記述します。

(リクエスト内容に含まれる特殊用途文字のエスケープ処理)

リクエスト内容は XML ファイルの一部となっているため、XML で特殊な用途に用いられる文字 <, >, & を使用することはできません。これらの文字がリクエスト内容に含まれる場合、以下の文字列で置換して下さい(禁止文字をこのように特殊な文字列に置換する処理を「エスケープ」と呼びます)。

  • <&lt;

  • >&gt;

  • &&amp;

いずれも、&(アンパサンド)で始まり、;(セミコロン)で終わる点にご注意ください。

これらの文字をエスケープする手間を省きたい場合は、 エクスターナルモード の利用をご検討下さい(エクスターナルモードはリクエスタの機能であり、[Web API] では使用できません)。