Cosminexus V9 BPM/ESB基盤 サービスプラットフォーム 開発ガイド 受付・アダプタ定義編

[目次][用語][索引][前へ][次へ]

2.7.2 ファイルイベント受付の電文フォーマットを作成する

ファイルイベント受付の要求電文および応答電文の電文フォーマットは,サービスプラットフォームが提供するスキーマを使用します。そのため,電文フォーマットの定義ファイルの作成は不要です。

ファイルイベント受付で使用する電文フォーマットの種類,および内容について説明します。

ファイルの格納場所は「<サービスプラットフォームのインストールディレクトリ>\CSC\custom-reception\fileevent\schema」です。

<この項の構成>
(1) ファイルイベント受付の要求電文フォーマット
(2) ファイルイベント受付の応答電文フォーマット

(1) ファイルイベント受付の要求電文フォーマット

ファイルイベント受付がビジネスプロセスを呼び出すときに,ビジネスプロセスへ渡す要求電文のフォーマットを次に示します。この電文フォーマットのファイル名は「urecp_fileevent_request.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/fileevent/request」です。

表2-25 ファイルイベント受付の要求電文フォーマット

タグ名 種別 出現回数 説明
<request> 1回
 
 
 
 
<common-folder-def-name> string 1回 取得対象ファイルが格納されている共通フォルダの定義名です。
<sub-folder> string 0または1回 共通フォルダのサブフォルダです。
ファイルイベント受付定義ファイルのurecp-fileevent.sub-folderプロパティが設定されている場合に値が設定されます。
urecp-fileevent.sub-folderプロパティが設定されていない場合は,要素は出現しません。
<file-name> string 1回 取得対象ファイル名です。
共通フォルダを監視する場合は,監視対象はリネーム後のファイル名です。
リネーム後のファイル名については,詳細はマニュアル「サービスプラットフォーム 解説」の「9.1.2 監視対象のファイルの状態管理機能」を参照してください。
<file-size> long 1回 取得対象ファイルのファイルサイズです。

(凡例)
−:該当する項目はありません。

(2) ファイルイベント受付の応答電文フォーマット

ファイルイベント受付の応答電文のフォーマットを次に示します。この電文フォーマットのファイル名は「urecp_fileevent_response.xsd」です。名前空間は,「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/reception/fileevent/response」です。

表2-26 ファイルイベント受付の応答電文フォーマット

タグ名 種別 出現回数 説明
<response> 1回
 
 
<message> string 0または1回 ビジネスプロセスの終了状態を示すメッセージです。タグの設定値をファイルイベントトレースの付加情報に出力します。
<success> boolean 0または1回 ビジネスプロセスの終了状態を示すフラグです。
次のどちらかを指定します。
  • true
    ビジネスプロセスの処理が正常に終了した。
  • false
    ビジネスプロセスの処理でエラーが発生した。
省略した場合,または上記以外の値を設定した場合はtrueが設定されます。
なお,タグの設定値によって,ファイルイベントトレースの出力内容が変わります。ファイルイベントトレースについては,マニュアル「サービスプラットフォーム システム構築・運用ガイド」の「7.7.12 ファイルイベント連携システムでの障害対策」を参照してください。

(凡例)
−:該当する項目はありません。