付録H.12　アプリケーション呼び出し情報ファイル

(1)　アプリケーション呼び出し情報ファイルの概要

アプリケーション呼び出し情報ファイルには，RESTアプリケーションのURLなどを設定します。

ページの先頭へ

(2)　アプリケーション呼び出し情報ファイルの設定個所

アプリケーション呼び出し情報ファイルは，ビジネスプロセス定義を作成する開発環境で作成し，実行環境にコピーしてください。

アプリケーション呼び出し情報ファイルの配置例を次の図に示します。

図H‒11　アプリケーション呼び出し情報ファイルの配置例

なお，アプリケーション呼び出し情報ファイルは，ref識別子単位に作成します。各アプリケーション呼び出し情報ファイルには，呼び出し対象のref識別子に対応するファイル名を付けてください。

作成したアプリケーション呼び出し情報ファイルの格納先として，共通設定ファイルのBpmnCallInformationFileDirプロパティで指定したディレクトリ内に，サブディレクトリ（ope）を作成します。

次に示すアプリケーション呼び出し情報ファイルのファイル名を付けて，該当するサブディレクトリにファイルを格納してください。

<BpmnCallInformationFileDirの指定値>/ope/<ref識別子の値>.properties

重要

• 「図H-11　アプリケーション呼び出し情報ファイルの配置例」のOperationRef1のように，複数のビジネスプロセス定義（BP1，BP2）で同じref識別子を定義している場合，共通で使用するOperationRef1.propertiesファイルをopeフォルダの下に配置してください。

• 大文字と小文字だけが異なる同じ名称のref識別子は使用しないでください。

ページの先頭へ

(3)　アプリケーション呼び出し情報ファイルの記述規則

アプリケーション呼び出し情報ファイルの記述規則を次に示します。

• java.util.Propertiesクラスが扱えるフォーマットで記載してください。

• 文字コードは，UTF-8を使用してください。ただし，BOM付きUTF-8では記述できません。

• プロパティの各キーは，大文字と小文字が区別されます。

• プロパティの各キーは，1つだけ指定してください（同一のキーは複数指定できません）。同一のキーを複数指定した場合，どの設定値が有効になるかは不定です。

• プロパティの記載順は任意です。また，プロパティが読み込まれる順番は不定です。

• プロパティのキーに，アプリケーション呼び出し情報ファイルで使用できるプロパティで定義されていないキー名を指定した場合，アプリケーションの呼び出し時にエラーが発生します。

• プロパティでファイルパスを指定する場合，パスの区切り文字には"/"を使用してください。

• プロパティの値の先頭に"$$"を記載した場合，"$"に変換されます。

• プロパティの値の先頭に"@@""を記載した場合，"@"に変換されます。

• プロパティの値が空の場合，エラーが発生します。

アプリケーション呼び出し情報ファイルが次に示すケースに該当する場合，アプリケーション呼び出しサービスは，該当するref識別子のアプリケーション呼び出しを中止します。

• 指定必須のプロパティのキーが指定されていない

• プロパティに不正な値が指定されている

ページの先頭へ

(4)　アプリケーション呼び出し情報ファイルで使用できる組み込み変数

組み込み変数は，CSCIWで管理する案件や作業の属性値を指定するための変数です。アプリケーション呼び出し情報ファイルに記載した組み込み変数は，呼び出し元の案件や作業の属性値に変換されます。

使用できる組み込み変数

項番	組み込み変数	説明
1	@PIID	案件ID
2	@PIName	案件名
3	@PICreator	案件投入者
4	@PIDeadline	案件処理期限
5	@PDefName	ビジネスプロセス定義名
6	@WIID	作業ID
7	@WDefName	作業定義名
8	@NULL	null値

組み込み変数の使用規則

アプリケーション呼び出し情報ファイルで組み込み変数を使用する場合は，次の規則に従ってください。

• 組み込み変数名の前後に，ほかの組み込み変数名やその他の文字列を連続して記載することはできません。また，半角空白などで文字列を区切ることもできません。

  誤った記載例（通常の文字列として扱われる）

  　abc@PIName

  誤った記載例（エラーが発生）

  　@PIName@PIID

  ただし，rest.request.urlプロパティの値の中では，特定の文字で区切ることで，組み込み変数の前後にほかの組み込み変数や文字列を連続して記載できます。

• プロパティの値の先頭に"@"を記載し，上記の表「使用できる組み込み変数」の「組み込み変数」列以外の文字列を指定した場合は，アプリケーションの呼び出し時にエラーが発生します。

  誤った記載例

  　@ABC

  　@PINameABC

• プロパティの値の先頭に"@@"を記載した場合は，組み込み変数ではなく通常の文字列として扱われます。

• 組み込み変数の対象となる属性の値がnullの場合，null値として扱われます。ただし，rest.request.urlプロパティの値の中に含まれている場合は，空文字として扱われます。

• 案件処理期限は，"1970/01/01 00:00:00 GMT"を起点とした通算秒に置き換えられます。

ヒント

rest.request.urlプロパティについては，「付録H.12(9)　アプリケーション呼び出し情報ファイルに指定する内容」の「(c)　rest.request.url」を参照してください。

ページの先頭へ

(5)　HTTPヘッダを記述したファイルの指定方法

HTTPヘッダを記述したファイルとは，RESTアプリケーションを呼び出す際のリクエストのHTTPヘッダに指定する内容を記述するファイルのことです。HTTPヘッダを記述したファイルを作成した場合は，HTTPヘッダを記述したファイルのファイルパスを，アプリケーション呼び出し情報ファイルのrest.request.header.filepathプロパティに指定してください。

ヒント

rest.request.header.filepathプロパティについては，「付録H.12(9)　アプリケーション呼び出し情報ファイルに指定する内容」の「(d)　rest.request.header.filepath」を参照してください。

HTTPヘッダを記述したファイルの指定規則を次に示します。

• java.util.Propertiesクラスが扱えるフォーマットで記載してください。

• 文字コードはUTF-8を使用してください。ただし，BOM付きUTF-8では記述しないでください。

• ファイル中に記載する要素の数や種類は，HTTPヘッダの仕様に合わせてください。複数回指定できない要素を2行以上指定しているなど，HTTPヘッダの仕様と異なる記述をした場合の動作は保証しません。

HTTPヘッダの記述例を次に示します。

Accept=application/xml

ページの先頭へ

(6)　アプリケーション呼び出し情報ファイルの読み込みタイミング

アプリケーション呼び出し情報ファイルは，対応するref識別子のアプリケーション呼び出しが最初に実行されるタイミングで，読み込まれます。一度読み込まれたファイルの内容は，アプリケーション呼び出しサービス内で保持されます。

また，アプリケーション呼び出し情報の一部として読み込まれた次のファイルについても同様に，一度読み込まれたファイルの内容は，アプリケーション呼び出しサービス内で保持されます。

• RESTアプリケーション用のHTTPヘッダファイル

• RESTアプリケーション用のスキーマ変換に使用されるスタイルシート（リクエストボディ用）

ファイルの再読み込みについては，「6.2.8(1)　ファイルに格納した設定情報を変更する」の，アプリケーション呼び出し情報ファイル，RESTアプリケーション呼び出し用ヘッダファイル，またはRESTアプリケーション呼び出しスキーマ変換用スタイルシートの内容を変更した場合についての説明を参照してください。

ページの先頭へ

(7)　アプリケーション呼び出し情報ファイルとリクエストボディの関係

アプリケーション呼び出し情報ファイルに記述した内容に従って，対応する値がリクエストボディに渡されます。リクエストボディは，RESTアプリケーションに渡されます。

アプリケーション呼び出し情報ファイルの記述例を次に示します。この例では，1行目でrest.request.body.key.userdescriptionの値として案件名を指定しています。

rest.request.body.key.userdescription=@PIName
rest.request.body.key.offset=0

アプリケーション呼び出し情報ファイルを上記の例のとおり記述した場合の，RESTアプリケーションにリクエストボディが渡されるまでの流れを，次の図に示します。

図H‒12　RESTアプリケーションにリクエストボディが渡されるまでの流れ

＜説明＞

アプリケーション呼び出し情報ファイルの内容に従って，対応する値がリクエストボディに渡されます。リクエストボディは，RESTアプリケーションに渡されます。

ページの先頭へ

(8)　アプリケーション呼び出し情報ファイルに指定するパラメタの一覧

指定するパラメタの一覧（アプリケーション呼び出し情報ファイル）

アプリケーション呼び出し情報ファイルに指定するパラメタの一覧を示します。

表H‒5　指定するパラメタの一覧（アプリケーション呼び出し情報ファイル）

項番	パラメタ名	指定内容
1	type（REST）	アプリケーション呼び出しの種類（REST）
2	rest.request.method	RESTアプリケーションのメソッド
3	rest.request.url	RESTアプリケーションのURL
4	rest.request.header.filepath	HTTPヘッダを記述したファイルのファイルパス
5	rest.request.stylesheet.filepath	リクエストボディ用スキーマ変換スタイルシートのファイルパス
6	rest.request.read.timeout	RESTアプリケーションの呼び出し時の読み込みタイムアウト値
7	rest.request.connect.timeout	RESTアプリケーション呼び出し時の接続タイムアウト値
8	rest.request.body.key.<key要素値>※	リクエストボディに格納する値
9	rest.request.idempotency	RESTアプリケーションがべき等性を保証しているかどうか

注※

key要素値とは，REST アプリケーションの呼び出し時に使用されるボディデータ（リクエストボディまたはレスポンスボディ）の，data要素中のkey要素の値です。

次に示すボディデータの記述例の"aaa"に該当する値です。

  <data>
      <key>aaa</key>
      <value>bbb</value>
    </data>

ページの先頭へ

(9)　アプリケーション呼び出し情報ファイルに指定する内容

アプリケーション呼び出し情報ファイルの格納先ファイルパス

RESTアプリケーションの呼び出しについて設定する，アプリケーション呼び出し情報ファイルの格納先ファイルパスを，次に示します。

<BpmnCallInformationFileDirプロパティの指定値>/ope/<ref識別子の値>.properties

アプリケーション呼び出し情報ファイルの記述例

RESTアプリケーションの呼び出しについて設定する場合の，アプリケーション呼び出し情報ファイルの記述例を次に示します。

type=REST
rest.request.method=POST
rest.request.url=http://hostname/app/function
rest.request.header.filepath= /home/csciw/header.properties
rest.request.body.key.offset=0
rest.request.body.key.userdescription=@PIName

ページの先頭へ