3.3.11 ファイル操作アダプタを定義する
ファイル操作アダプタの定義方法について説明します。なお,ファイル変換オペレーションを使用する場合の定義例については,「付録E ファイル操作アダプタの定義例」を参照してください。
- 〈この項の構成〉
(1) 電文フォーマットの作成
ファイル操作アダプタの電文フォーマットの定義ファイルはサービスプラットフォームが提供するスキーマを使用します。そのため,電文フォーマットの定義ファイルの作成は不要です。
ファイル操作アダプタで使用する電文フォーマットの内容について説明します。
ファイルの格納場所は「<サービスプラットフォームのインストールディレクトリ>\CSC\schema\adpfop」です。
(a) ファイル操作アダプタの要求電文フォーマット
- ●共通仕様
-
ファイル操作アダプタの要求電文フォーマットの指定についての共通仕様を,次に説明します。
ファイル操作アダプタの要求電文フォーマットで指定する,ファイルやディレクトリのパス(ファイル名だけの指定も含む)には,次の制限があります。
-
Windowsの場合,次の制限があります。
・大文字と小文字は区別されません。
・UNC形式のディレクトリおよびファイル名は指定できません。
・NTFSのストリーム名は指定できません。
-
絶対パスは指定できません。
-
末尾が「.」または「..」のパスは指定できません。
-
作業フォルダを指定する場合に,相対パスは指定できません。
-
作業フォルダを指定する場合に,ファイル名の先頭にだけスラッシュ(/)を使用できます。また,ファイル名の先頭に設定されたスラッシュ(/)は,無視されます。
-
共通フォルダを指定する場合に,共通フォルダの子孫ではないパスは指定できません。
作業フォルダを指定してファイルを出力する場合,java.io.FileのcreateTempFile()を使用して作業フォルダ内で一意のファイルが作成されるため,指定は無視されます。
パスを指定する場合の注意事項について,次に説明します。
-
デバイス名を含むパスは指定しないでください。
-
シンボリックリンクを含むパスは指定しないでください。
-
ファイル操作アダプタの要求電文フォーマットを,オペレーションごとに説明します。
- ●ファイル変換オペレーション
-
ビジネスプロセスからファイル操作アダプタに渡す要求電文フォーマットを次に示します。ファイル名は「adpfop_transform_request.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/transform_request」です。
表3‒67 要求電文フォーマット(ファイル変換オペレーション) タグ名
出現回数※
説明
<request>
1回
−
<request-id>
0または1回
受付で作成したリクエストIDです。作業フォルダのパス生成に使用します。入力フォルダ,および出力フォルダに作業フォルダを指定しない場合は,省略できます。
<input-folder-name>
1回
変換するファイルが格納されているディレクトリを指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を,値に共通フォルダ定義名を指定します。
<input-file-name>
1回
変換するファイルを指定します。
<output-folder-name>
1回
変換後のファイルを出力するディレクトリを指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を,値に共通フォルダ定義名を指定します。
<output-file-name>
0または1回
変換後のファイルを指定します。
-
- ●ファイル複製オペレーション
-
ビジネスプロセスからファイル操作アダプタに渡す要求電文フォーマットを次に示します。ファイル名は「adpfop_copy_request.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/copy_request」です。
表3‒68 要求電文フォーマット(ファイル複製オペレーション) タグ名
出現回数※
説明
<request>
1回
−
<request-id>
0または1回
受付で作成したリクエストIDです。作業フォルダのパス生成に使用します。入力フォルダ,および出力フォルダに作業フォルダを指定しない場合は,省略できます。
<input-folder-name>
1回
複製するファイルが格納されているディレクトリを指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を,値に共通フォルダ定義名を指定します。
<input-file-name>
1回
複製するファイルを指定します。
<output-folder-name>
1回
複製後のファイルを出力するディレクトリを指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を,値に共通フォルダ定義名を指定します。
<output-file-name>
0または1回
複製後のファイルを指定します。
-
- ●ファイル移動オペレーション
-
ビジネスプロセスからファイル操作アダプタに渡す要求電文フォーマットを次に示します。ファイル名は「adpfop_move_request.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/move_request」です。
表3‒69 要求電文フォーマット(ファイル移動オペレーション) タグ名
出現回数※
説明
<request>
1回
−
<request-id>
0または1回
受付で作成したリクエストIDです。作業フォルダのパス生成に使用します。入力フォルダ,および出力フォルダに作業フォルダを指定しない場合は,省略できます。
<input-folder-name>
1回
移動するファイルが格納されているディレクトリを指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を指定し,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を指定し,値に共通フォルダ定義名を指定します。
<input-file-name>
1回
移動するファイルを指定します。
<output-folder-name>
1回
移動先のディレクトリを指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を指定し,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を指定し,値に共通フォルダ定義名を指定します。
<output-file-name>
0または1回
移動先のファイルを指定します。
移動先のディレクトリが共通フォルダで当該要素が省略された場合,移動元ファイル名を仮定します。
-
- ●ファイル・フォルダ削除オペレーション
-
ビジネスプロセスからファイル操作アダプタに渡す要求電文フォーマットを次に示します。ファイル名は「adpfop_delete_request.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/delete_request」です。
表3‒70 要求電文フォーマット(ファイル・フォルダ削除オペレーション) タグ名
出現回数※1
説明
<request>
1回
−
<request-id>
0または1回
受付で作成したリクエストIDです。作業フォルダのパス生成に使用します。入力フォルダ,および出力フォルダに作業フォルダを指定しない場合は,省略できます。
<folder-name>
1回
削除するファイルが格納されているディレクトリ,または削除するフォルダを指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を,値に共通フォルダ定義名を指定します。
<file-name>
0または1回
削除するファイルを指定します。※2
<sub-folder-name>
0または1回
削除するサブフォルダを指定します。※2
-
- ●ファイル圧縮オペレーション
-
ビジネスプロセスからファイル操作アダプタに渡す要求電文フォーマットを次に示します。ファイル名は「adpfop_compress_request.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/compress_request」です。
表3‒71 要求電文フォーマット(ファイル圧縮オペレーション) タグ名
出現回数※1
説明
<request>
1回
−
<request-id>
0または1回
受付で作成したリクエストIDです。作業フォルダのパス生成に使用します。入力フォルダ,および出力フォルダに作業フォルダを指定しない場合は,省略できます。
<input-folder-name>
1回
圧縮するファイルが格納されているディレクトリを指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を,値に共通フォルダ定義名を指定します。
<input-files>
1回
−
<input-file>
1から999回
−
<input-file-name>
1回
圧縮するファイルを指定します。※2
<entry-name>
1回
同じinput-fileタグ内のinput-file-nameタグで指定したファイルの圧縮後のエントリ名を指定します。空文字列を指定した場合,同じinput-fileタグ内のinput-file-nameタグの値が指定されます。この場合,エントリ名は変更されません。
Windowsの場合,次の制限があります。
-
大文字と小文字は区別されます。※3
-
UNC形式のエントリ名は指定できません。
-
NTFSのストリーム名は指定できません。
-
デバイス名を含むエントリ名は指定しないでください。
<output-folder-name>
1回
圧縮後のファイルを出力するディレクトリを指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を,値に共通フォルダ定義名を指定します。
<output-file-name>
0または1回
圧縮後のファイルを指定します。
-
- ●ファイル伸張オペレーション
-
ビジネスプロセスからファイル操作アダプタに渡す要求電文フォーマットを次に示します。ファイル名は「adpfop_extract_request.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/extract_request」です。
表3‒72 要求電文フォーマット(ファイル伸張オペレーション) タグ名
出現回数※
説明
<request>
1回
−
<request-id>
0または1回
受付で作成したリクエストIDです。作業フォルダのパス生成に使用します。入力フォルダ,および出力フォルダに作業フォルダを指定しない場合は,省略できます。
<input-folder-name>
1回
伸張するファイルが格納されているディレクトリを指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を,値に共通フォルダ定義名を指定します。
<input-file-name>
1回
伸張するファイルを指定します。
<output-folder-name>
1回
伸張後のファイルを出力するディレクトリを指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を,値に共通フォルダ定義名を指定します。
<output-sub-folder-name>
0または1回
伸張後のファイルを出力するサブフォルダを指定します。指定を省略した場合,共通フォルダの直下にファイルを出力します。
<output-file-prefix-name>
0または1回
伸張後のファイル名の接頭辞を指定します。
-
変換後のファイルの出力先が共通フォルダの場合(output-folder-nameタグの属性にcommon="true"を指定した場合)
このタグの指定を使用してファイル名が自動で付与されます。
-
変換後のファイルの出力先が作業フォルダの場合(output-folder-nameタグの属性にcommon="false"を指定した場合)
java.io.FileのcreateTempFile()を使用して作業フォルダ内で一意のファイルが作成されるため,指定は無視されます。
Windowsの場合,次の制限があります。
-
大文字と小文字は区別されません。
-
UNC形式のファイル名は指定できません。
-
NTFSのストリーム名は指定できません。
-
デバイス名を含むファイル名は指定しないでください。
-
- ●ファイル一覧取得オペレーション
-
ビジネスプロセスからファイル操作アダプタに渡す要求電文フォーマットを次に示します。ファイル名は「adpfop_get_list_request.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/get_list_request」です。
表3‒73 要求電文フォーマット(ファイル一覧取得オペレーション) タグ名
出現回数※1
説明
<request>
1回
−
<input-folder-name>
1回
ファイル一覧を取得する共通フォルダ名を指定します。
<input-file-name>
0または1回
ファイル一覧を取得するファイルもしくはサブフォルダのパスを指定します。
-
パスは共通フォルダからの相対パスで指定します。
-
当該要素が省略された場合,共通フォルダ自体を対象とします。
<options>
0または1回
オプションを指定する場合に使用します。
当該要素が省略された場合はオプション項目をすべて省略時の動作とします。
<list-option>
0または1回
出力するファイル一覧の出力形式を指定します。※2
<date-time-pattern>
0または1回
最終更新日時の出力形式を指定します。
-
当該要素が省略もしくは空白の場合は,「yyyy-MM-dd'T'HH:mm:ss」が仮定されます。
-
指定できるパターン文字列はjava.time.format.DateTimeFormatter#ofPattern(java.lang.String)の引数に指定できるパターン文字列です。
-
ローカルタイムで使用できるパターンを指定できます。タイムゾーンで使用するパターンは指定できません。
-
次の文字はパターン文字の予約語として使用されるため,文字列として使用する場合はシングルクォーテーションで囲む必要があります。また,シングルクォーテーション(')自身を指定する場合は「''」のように指定します。
(予約語)[a-zA-Z]
(指定例)「T」と「'」を使用したい場合
yyyy-MM-dd'T'HH:mm:ss''
出力例:「2015-03-04T11:22:33'」
-
- ●ファイル一覧書き込みオペレーション
-
ビジネスプロセスからファイル操作アダプタに渡す要求電文フォーマットを次に示します。ファイル名は「adpfop_write_list_request.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/write_list_request」です。
表3‒74 要求電文フォーマット(ファイル一覧書き込みオペレーション) タグ名
出現回数※1
説明
<request>
1回
−
<request-id>
0または1回
受付で作成したリクエストIDです。作業フォルダのパス生成に使用します。出力フォルダに作業フォルダを指定しない場合は,省略できます。
<input-folder-name>
1回
ファイル一覧を取得する共通フォルダ名を指定します。
<input-file-name>
0または1回
ファイル一覧を取得するファイルもしくはサブフォルダのパスを指定します。パスは共通フォルダからの相対パスで指定します。
当該要素が省略された場合,共通フォルダ自体を対象とします。
<output-folder-name>
1回
取得したファイル一覧を出力するディレクトリを指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を指定し,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を指定し,値に共通フォルダ定義名を指定します。
<output-file-name>
0または1回
取得したファイル一覧を出力するファイルを指定します。
<options>
0または1回
オプションを指定する場合に使用します。
当該要素が省略された場合はオプション項目をすべて省略時の動作とします。
<list-option>
0または1回
出力するファイル一覧の出力形式を指定します。※2
<date-time-pattern>
0または1回
最終更新日時の出力形式を指定します。
-
当該要素が省略もしくは空白の場合は,「yyyyMMddHHmmss」が仮定されます。
-
指定できるパターン文字列はjava.time.format.DateTimeFormatter#ofPattern(java.lang.String)の引数に指定できるパターン文字列です。
-
ローカルタイムで使用できるパターンを指定できます。タイムゾーンで使用するパターンは指定できません。
-
次の文字はパターン文字の予約語として使用されるため,文字列として使用する場合はシングルクォーテーションで囲む必要があります。また,シングルクォーテーション(')自身を指定する場合は「''」のように指定します。
(予約語)[a-zA-Z]
(指定例)「T」と「'」を使用したい場合
yyyy-MM-dd'T'HH:mm:ss''
出力例:「2015-03-04T11:22:33'」
-
- ●ファイル読み込みオペレーション
-
ビジネスプロセスからファイル操作アダプタに渡す要求電文フォーマットを次に示します。ファイル名は「adpfop_read_request.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/read_request」です。
表3‒75 要求電文フォーマット(ファイル読み込みオペレーション) タグ名
出現回数※
説明
<request>
1回
−
<request-id>
0または1回
受付で作成したリクエストIDです。作業フォルダのパス生成に使用します。出力フォルダに作業フォルダを指定しない場合は,省略できます。
<input-folder-name>
1回
読み込むファイルが格納されているフォルダ名を指定します。common属性に,trueまたはfalseを必ず指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を指定し,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を指定し,値に共通フォルダ定義名を指定します。
<input-file-name>
1回
取得するファイルまたはサブフォルダのパスを指定します。パスは共通フォルダからの相対パスで指定します。
-
共通フォルダから入力する場合
共通フォルダからの相対パスを指定します。
-
作業フォルダから入力する場合
入力ファイル名を指定します。
<input-file-validation>
0または1回
入力ファイルの検証を実施するかどうかをONまたはOFFで指定します。
-
ON:検証を実施します。
-
OFF:検証を実施しません。
指定を省略した場合はOFFが設定されます。
-
- ●ファイル書き込みオペレーション
-
ビジネスプロセスからファイル操作アダプタに渡す要求電文フォーマットを次に示します。ファイル名は「adpfop_write_request.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/write_request」です。
ファイル書き込みオペレーションの要求電文は,ヘッダとボディで指定します。ヘッダとボディの要求電文フォーマットを次の表に示します。
表3‒76 要求電文フォーマット(ファイル書き込みオペレーション) 要求電文
タグ名
出現回数※
説明
ヘッダ
<request>
1回
−
<request-id>
0または1回
受付で作成したリクエストIDです。作業フォルダのパス生成に使用します。出力フォルダに作業フォルダを指定しない場合は,省略できます。
<output-folder-name>
1回
ファイルを書き込むフォルダを指定します。common属性に,trueまたはfalseを必ず指定します。
-
作業フォルダを指定する場合
タグの属性にcommon="false"を指定し,値に空文字を指定します。
-
共通フォルダを指定する場合
タグの属性にcommon="true"を指定し,値に共通フォルダ定義名を指定します。
<output-file-name>
0または1回
書き込むファイルのパスを共通フォルダからの相対パスで指定します。
output-folder-name要素で,common属性にtrueを指定した場合は,必ず指定します。output-folder-name要素で,common属性にfalseを指定した場合は,指定しても無視されます。
<output-mode>
0または1回
ファイルの出力モードをnewまたはappendで指定します。
-
new:ファイルを新規作成します。既存のファイルがある場合は,上書きされます。
-
append:既存のファイルの末尾に出力ファイルの記述を追加して,書き込みます。
この要素を省略した場合はnewが設定されます。
次の場合は,この要素の設定は無視され,newが設定されます。
-
出力ファイルの形式がXML(ボディの電文フォーマットがXML形式)の場合
-
作業フォルダに出力する場合
<input-file-validation>
0または1回
出力ファイルの検証を実施するかどうかをONまたはOFFで指定します。
-
ON:検証を実施します。
-
OFF:検証を実施しません。
指定を省略した場合はOFFが設定されます。
ボディ
ボディの内容が,出力データとしてファイルに書き込まれます。サービスプラットフォームではスキーマファイルを提供していません。スキーマファイルはユーザが作成してください。ボディがAny型の場合は,スキーマファイルは不要です。
-
- ●ファイル操作アダプタが要求電文の取得に失敗した場合
-
エラーメッセージ(KDEC80002-E)を出力して処理を終了します。
(b) ファイル操作アダプタの応答電文フォーマット
ファイル操作アダプタの応答電文フォーマットを,オペレーションごとに説明します。
- ●ファイル変換オペレーション
-
ファイル操作アダプタが呼び出し元のビジネスプロセスへ返す応答電文のフォーマットを次に示します。ファイル名は「adpfop_transform_response.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/transform_response」です。
表3‒77 応答電文フォーマット(ファイル変換オペレーション) タグ名
出現回数※
説明
<response>
1回
−
<output-folder-name>
1回
変換後のファイルを出力するディレクトリが設定されます。
-
作業フォルダが設定されている場合
タグの属性にcommon="false"が,値に空文字が設定されます。
-
共通フォルダが設定されている場合
タグの属性にcommon="true"が,値に共通フォルダ定義名が設定されます。
<output-file-name>
1回
変換後のファイルのファイル名(ファイルパス)が設定されます。共通フォルダを操作した場合,要求電文のoutput-file-nameの値がそのまま設定されます。
<output-file-size>
1回
変換後のファイルのサイズ(バイト)が設定されます。
-
- ●ファイル複製オペレーション
-
ファイル操作アダプタが呼び出し元のビジネスプロセスへ返す応答電文のフォーマットを次に示します。ファイル名は「adpfop_copy_response.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/copy_response」です。
表3‒78 応答電文フォーマット(ファイル複製オペレーション) タグ名
出現回数※
説明
<response>
1回
−
<output-folder-name>
1回
複製後のファイルを出力するディレクトリが設定されます。
-
作業フォルダが設定されている場合
タグの属性にcommon="false"が,値に空文字が設定されます。
-
共通フォルダが設定されている場合
タグの属性にcommon="true"が,値に共通フォルダ定義名が設定されます。
<output-file-name>
1回
複製後のファイルのファイル名(ファイルパス)が設定されます。共通フォルダを操作した場合,要求電文のoutput-file-nameの値がそのまま設定されます。
-
- ●ファイル移動オペレーション
-
ファイル操作アダプタが呼び出し元のビジネスプロセスへ返す応答電文のフォーマットを次に示します。ファイル名は「adpfop_move_response.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/move_response」です。
表3‒79 応答電文フォーマット(ファイル移動オペレーション) タグ名
出現回数※
説明
<response>
1回
−
<output-folder-name>
1回
移動後のファイルが格納されているディレクトリ名を設定されます。
-
作業フォルダを操作した場合
タグの属性にcommon="false"が設定され,値に空文字が設定されます。
-
共通フォルダを操作した場合
タグの属性にcommon="true"が設定され,値に共通フォルダ定義名が設定されます。
<output-file-name>
1回
移動後のファイルが格納されている共通フォルダもしくは作業フォルダからの相対パスを設定します。
-
- ●ファイル・フォルダ削除オペレーション
-
ファイル操作アダプタが呼び出し元のビジネスプロセスへ返す応答電文のフォーマットを次に示します。ファイル名は「adpfop_delete_response.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/delete_response」です。
表3‒80 応答電文フォーマット(ファイル・フォルダ削除オペレーション) タグ名
出現回数※1
説明
<response>
1回
−
<folder-name>
1回
削除されたファイルが格納されているディレクトリ名が設定されます。
-
作業フォルダが設定されている場合
タグの属性にcommon="false"が,値に空文字が設定されます。
-
共通フォルダが設定されている場合
タグの属性にcommon="true"が,値に共通フォルダ定義名が設定されます。
<file-name>
0または1回
削除されたファイルのファイル名(ファイルパス)が設定されます。
要求電文のfile-nameの値がそのまま設定されます。※2
<sub-folder-name>
0または1回
削除されたファイルのサブフォルダ名が設定されます。要求電文のsub-folder-nameの値がそのまま設定されます。※2
-
- ●ファイル圧縮オペレーション
-
ファイル操作アダプタが呼び出し元のビジネスプロセスへ返す応答電文のフォーマットを次に示します。ファイル名は「adpfop_compress_response.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/compress_response」です。
表3‒81 応答電文フォーマット(ファイル圧縮オペレーション) タグ名
出現回数※
説明
<response>
1回
−
<output-folder-name>
1回
圧縮されたファイルが格納されているディレクトリ名が設定されます。
-
作業フォルダが設定されている場合
タグの属性にcommon="false"が,値に空文字が設定されます。
-
共通フォルダが設定されている場合
タグの属性にcommon="true"が,値に共通フォルダ定義名が設定されます。
<output-file-name>
1回
圧縮されたファイルのファイル名(ファイルパス)が設定されます。共通フォルダを操作した場合,要求電文のoutput-file-nameの値がそのまま設定されます。
-
- ●ファイル伸張オペレーション
-
ファイル操作アダプタが呼び出し元のビジネスプロセスへ返す応答電文のフォーマットを次に示します。ファイル名は「adpfop_extract_response.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/extract_response」です。
表3‒82 応答電文フォーマット(ファイル伸張オペレーション) タグ名
出現回数※
説明
<response>
1回
−
<output-folder-name>
1回
伸張されたファイルが格納されているディレクトリ名が設定されます。
-
作業フォルダが設定されている場合
タグの属性にcommon="false"が,値に空文字が設定されます。
-
共通フォルダが設定されている場合
タグの属性にcommon="true"が,値に共通フォルダ定義名が設定されます。
<output-files>
1回
−
<output-file>
1から999回
−
<output-file-name>
1回
伸張されたファイルのファイル名が設定されます。
<entry-name>
1回
output-file-nameタグに設定されたファイルの伸張前のエントリ名が設定されます。
-
- ●ファイル一覧取得オペレーション
-
ファイル操作アダプタが呼び出し元のビジネスプロセスへ返す応答電文のフォーマットを次に示します。ファイル名は「adpfop_get_list_response.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/get_list_response」です。
表3‒83 応答電文フォーマット(ファイル一覧取得オペレーション) タグ名
出現回数※
説明
<response>
1回
−
<file-list>
1回
ファイルが1つも存在しない場合も生成します。
<file>
0から999回
一覧取得したファイル単位ごとに指定します。
要求電文のlist-optionで”l”が指定された場合,属性typeには,fかdが必ず設定されます。
-
f:対象がファイルの場合。
-
d:対象がディレクトリの場合。
ファイルが1つも存在しない場合には生成されません。
<name>
1回
ファイル名またはディレクトリ名を設定します。
<size>
0または1回
ファイルサイズをバイト単位で設定します。
要求電文のlist-option要素で”l”が指定された場合だけ出力します。
対象がディレクトリの場合には0を設定します。
<last-modified-time>
0または1回
ファイルの最終更新日時を出力します。
要求電文のlist-option要素で”l”が指定された場合だけ出力します。
出力形式は要求電文のdate-time-pattern要素の指定パターンで出力します。要求電文のdate-time-pattern要素が省略された場合は「yyyy-MM-dd'T'HH:mm:ss」の形式で出力します。
-
- ●ファイル一覧書き込みオペレーション
-
ファイル操作アダプタが呼び出し元のビジネスプロセスへ返す応答電文のフォーマットを次に示します。ファイル名は「adpfop_write_list_response.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/write_list_response」です。
表3‒84 応答電文フォーマット(ファイル一覧書き込みオペレーション) タグ名
出現回数※
説明
<response>
1回
−
<output-folder-name>
1回
ファイル一覧情報が書き込まれたファイルが格納されているディレクトリ名を設定します。
-
作業フォルダを操作した場合
タグの属性にcommon="false"が設定され,値に空文字が設定されます。
-
共通フォルダを操作した場合
タグの属性にcommon="true"が設定され,値に共通フォルダ定義名が設定されます。
<output-file-name>
1回
ファイル一覧情報を書き込んだファイルが格納されている共通フォルダもしくは作業フォルダからの相対パスを設定します。
<output-file-size>
1回
ファイル一覧情報を書き込んだファイルのサイズを設定します。
-
- ●ファイル読み込みオペレーション
-
ファイル読み込みオペレーションの応答電文は,読み込んだファイルの内容となるため,サービスプラットフォームではスキーマファイルを提供していません。
- ●ファイル書き込みオペレーション
-
ファイル操作アダプタが呼び出し元のビジネスプロセスへ返す応答電文のフォーマットを次に示します。ファイル名は「adpfop_write_response.xsd」です。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csc/adapter/fileoperation/write_response」です。
表3‒85 応答電文フォーマット(ファイル書き込みオペレーション) タグ名
出現回数※
説明
<response>
1回
−
<output-folder-name>
1回
タグの属性commonに,trueまたはfalseが設定されます。
-
作業フォルダに出力した場合
タグの属性にcommon="false"が設定され,値に空文字が設定されます。
-
共通フォルダに出力した場合
タグの属性にcommon="true"が設定され,値に共通フォルダ定義名が設定されます。
<output-file-name>
1回
書き込んだファイルのファイル名,またはファイルパスが設定されます。
<output-file-size>
1回
書き込んだファイルのサイズ(単位:バイト)が設定されます。
-
- ●ファイル操作アダプタが応答電文の生成に失敗した場合
-
エラーメッセージ(KDEC80003-E)を出力して処理を終了します。
(2) サービスアダプタ定義画面での操作
ファイル操作アダプタを定義する場合の手順を次に示します。
-
サービスアダプタ定義画面を表示します。
サービスアダプタ定義画面の表示方法については,「3.3.1(4) サービスアダプタ定義画面の表示」を参照してください。
-
サービスアダプタ定義画面(基本)およびサービスアダプタ定義画面(詳細)で定義情報を設定します。
各オペレーションで設定する項目については,次の個所を参照してください。
-
ファイル変換オペレーションの場合
-
ファイル複製オペレーションの場合
-
ファイル移動オペレーションの場合
-
ファイル・フォルダ削除オペレーションの場合
-
ファイル圧縮オペレーションの場合
-
ファイル伸張オペレーションの場合
-
ファイル一覧取得オペレーションの場合
-
ファイル一覧書き込みオペレーションの場合
-
ファイル読み込みオペレーションの場合
-
ファイル書き込みオペレーションの場合
また,サービスアダプタ定義画面(基本)については,マニュアル「サービスプラットフォーム リファレンス」の「1.2.2 サービスアダプタ定義画面」を参照してください。
-
- 参考
-
作成したファイル操作アダプタは,必要に応じて保存,編集,および検証できます。
ファイル操作アダプタを編集する方法については,「3.5 サービスアダプタの編集」を参照してください。ファイル操作アダプタを検証する方法については,「3.6 サービスアダプタの検証」を参照してください。
(3) ファイル操作アダプタの定義ファイルの作成および編集
作成および編集する定義ファイルの種類を次に示します。
-
ファイル操作アダプタ実行環境プロパティファイル
ファイル操作アダプタごとの構成情報を定義するためのファイルです。
-
ファイル操作アダプタ定義ファイル
ファイル操作アダプタの動作内容を定義するためのファイルです。
ファイル操作アダプタで使用する定義ファイルの作成手順および編集手順を次に示します。
(a) ファイル操作アダプタ実行環境プロパティファイルの作成手順
ファイル操作アダプタ実行環境プロパティファイルの作成手順を示します。
-
テンプレートファイル(<サービスプラットフォームのインストールディレクトリ>\CSC\config\adpfop\templates\adpfop.properties)をコピーして,次のディレクトリに格納します。
<サービスプラットフォームのインストールディレクトリ>\CSC\config\adpfop
-
コピーしたテンプレートファイルのファイル名を「<サービスID>.properties」に変更します。
サービスIDとは,ファイル操作アダプタを新規に追加するときに指定する任意の文字列です。
-
定義内容を編集して保存します。
ファイル操作アダプタ実行環境プロパティファイルで編集できる項目については,マニュアル「サービスプラットフォーム リファレンス」の「6.8.8 ファイル操作アダプタ実行環境プロパティファイル」を参照してください。
ファイル操作アダプタ実行環境プロパティファイルは,ファイル操作アダプタを開始する際に実行環境に反映されます。ファイル操作アダプタ実行環境プロパティファイルの内容を変更する場合は,ファイル操作アダプタを停止してから作業をします。ファイル操作アダプタを再開始すると,変更内容が実行環境に反映されます。
(b) ファイル操作アダプタ定義ファイルの編集手順
ファイル操作アダプタ定義ファイルの編集手順を示します。
-
サービスアダプタ定義画面(詳細)の[独自定義ファイル]で「cscFileOperation.properties」を選択し,[編集]ボタンをクリックします。
ファイル操作アダプタ定義ファイルを編集するためのエディタが起動します。
-
エディタ上でファイル操作アダプタ定義ファイルを編集します。
ファイル操作アダプタ定義ファイルの詳細は,マニュアル「サービスプラットフォーム リファレンス」の「3.5.2 ファイル操作アダプタ定義ファイル」を参照してください。
-
Eclipseのメニューから[ファイル]−[保管]を選択し,定義内容を保存します。
ファイル操作アダプタを開始すると,ファイル操作アダプタ定義ファイルに設定した内容が有効になります。
(4) ファイル変換オペレーション使用時の注意事項
ファイル変換オペレーションで分割処理方式を選択して,入力ファイルに改行セパレータ形式のファイルを扱う場合,次のファイルの複合内容要素のセパレータには,LineFeedを設定しないでください。
-
入力側のヘッダレコード部のバイナリフォーマット定義ファイル
-
入力側のデータレコード部のバイナリフォーマット定義ファイル
-
入力側のトレーラレコード部のバイナリフォーマット定義ファイル
LineFeedを設定した場合,メッセージ(KDEC80043-E)が出力され,ファイル変換の処理が中止されます。
正しく設定したセパレータの設定画面例を次に示します。
(5) 要求電文list-option要素の指定値について
ファイル一覧取得オペレーションとファイル一覧書き込みオペレーションの要求電文list-option要素について示します。
-
ファイル一覧の出力形式を,ハイフン以降のオプション文字で指定できます。
指定例:「-l」,「-rl」,「-l -r」
-
要素の値には次の形式の文字列だけ指定できます。
{空白}※1*[-][a-zA-Z0-9]+({セパレータ}※2+[-][a-zA-Z0-9]+)*{空白}*
- 注※1
-
{空白}:XML解析上トリムされる前後空白文字
- 注※2
-
{セパレータ}:半角スペース,改行,タブ文字
-
有効なオプション文字は「l」(小文字エル),「r」,「t」だけです。そのほかの文字は無視します。大文字小文字は区別されます。
-
GUN形式(ハイフン2個)のオプション指定はサポートしません。
オプション文字の指定有無の動作を次に示します。
オプション文字 |
指定有無 |
動作 |
---|---|---|
l(エル) |
指定なし |
ファイル名だけを出力します。 |
l(エル) |
指定あり |
ファイル名,ファイル種別,サイズ,最終更新日時を出力します。 |
r |
指定なし |
出力する一覧のソート順を昇順にします。 |
r |
指定あり |
出力する一覧のソート順を降順にします。 |
t |
指定なし |
出力する一覧のソートキーをファイル名にします。※ |
t |
指定あり |
出力する一覧のソートキーを最終更新日時にします。※ |