Cosminexus ビジネスプロセス管理/エンタープライズサービスバス V8 サービスプラットフォーム 開発ガイド

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

18.4.1 FTPアダプタの要求電文フォーマット

<この項の構成>
(1) PUTオペレーション
(2) GETオペレーション
(3) GETINFOオペレーション

(1) PUTオペレーション

ビジネスプロセスからFTPアダプタに渡すPUTオペレーションの要求電文フォーマットを次に示します。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csaftp/put_request」です。

表18-11 要求電文フォーマット(PUTオペレーション)

タグ名 出現回数※1 説明
<request> 1回
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
<host-ipaddr> 0または1回 接続するFTPサーバのIPアドレスまたはホスト名です。
  • タグがあって値がある場合
    指定の文字列でconnectが発行されます。
  • タグがあって値がない場合
    システム例外を返します。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。FTPアダプタ実行環境プロパティファイルに指定がない場合,システム例外を返します。
<host-con-port> 0または1回 FTPサーバの制御コネクション用ポート番号です。
  • タグがあって値がある場合
    1から65535までのポート番号を指定します。これ以外の値を指定した場合,システム例外を返します。
  • タグがあって値がない場合
    デフォルトの21が指定されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
<file-name-charset> 0または1回 FTPサーバとの間の制御コネクションで,ファイル名などの情報を送受信するときに使用する文字セットの名称を示すタグです。指定値は次のどちらかです。
UTF-8:文字セットに「UTF-8」を使用します。
MS932:文字セットに「MS932」を使用します。
  • タグがあって値が使用できる文字セットの場合
    ファイル名などの情報を送受信するときの文字セットとして適用されます。
  • タグがあって値が使用できない文字セット名の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「UTF-8」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
<ftps> 0または1回 FTPSに関する設定を示すタグです。タグがない場合,FTPSに関するすべての設定はFTPアダプタ実行環境プロパティファイルの値が有効となります。
 
 
 
 
 
<ftps-enable> 0または1回 FTPサーバとの接続にFTPSを使用するかどうかを指定するタグです。指定値は次のどちらかです。
true:FTPサーバとの接続にFTPSを使用します。
false:FTPサーバとの接続に通常のFTPを使用します。※2
FTPSを使用する場合,制御コネクションおよびデータコネクションの通信は暗号化されます。ただし,接続先のFTPサーバがFTPSによる接続をサポートしている必要があります。「true」を指定した場合でも,データコネクションの通信の暗号化が設定されていないときは,データコネクションの通信も暗号化されません。
  • タグがあって値が「true」または「false」の場合
    指定した値が適用されます。
  • タグがあって値が「true」または「false」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「false」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
<ftps-protocol-name> 0または1回 FTPサーバとの接続にFTPSを使用する場合に,使用するセキュリティ通信用のプロトコルを示すタグです。指定値は次のどちらかです。
TLS:セキュリティ通信用のプロトコルにTLSを使用します。
SSL:セキュリティ通信用のプロトコルにSSLを使用します。
  • タグがあって値が「TLS」または「SSL」の場合
    指定した値が適用されます。
  • タグがあって値が「TLS」または「SSL」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「TLS」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
この設定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。
<ftps-implicit-mode> 0または1回 FTPサーバとの接続にFTPSを使用する場合に,FTPSのImplicitモードを使用するかどうかを指定するタグです。指定値は次のどちらかです。
true:Implicitモードを使用します。
false:Explicitモードを使用します。※2
  • タグがあって値が「true」または「false」の場合
    指定した値が適用されます。
  • タグがあって値が「true」または「false」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「false」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
この設定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。
<ftps-data-con-secure> 0または1回 FTPサーバとの接続にFTPSを使用する場合に,データコネクションの通信を暗号化するかどうかを指定するタグです。指定値は次のどちらかです。
true:データコネクションの通信を暗号化します。
false:データコネクションの通信を暗号化しません。
  • タグがあって値が「true」または「false」の場合
    指定した値が適用されます。
  • タグがあって値が「true」または「false」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「true」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
この設定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。
<ftps-server-authentication> 0または1回 FTPサーバとの接続にFTPSを使用する場合に,サーバ認証をするかどうかを指定するタグです。指定値は次のどちらかです。
true:サーバ認証をします。
false:サーバ認証をしません。
  • タグがあって値が「true」または「false」の場合
    指定した値が適用されます。
  • タグがあって値が「true」または「false」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「false」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
この設定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。なお,「true」を指定する場合,キーストアに関する設定が必要になります。キーストアの設定方法については,「18.2.5 FTPSを使用したセキュアな接続」を参照してください。
<ftp-user>※3 0または1回 接続するFTPサーバのログインユーザ名を示すタグです。USERコマンドの引数として使用します。このタグに指定するログインユーザには,ファイル操作を実行できる権限が与えられている必要があります。
FTPアダプタ実行環境プロパティファイルに重複して設定されている場合,要求電文の値が有効になります。
  • タグがあって正常な値がある場合
    「USER "値"」が発行されます。値に改行が含まれている場合,システム例外を返します。
  • タグがあって値がない場合,または値に不正な文字が含まれている場合
    システム例外を返します。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。FTPアダプタ実行環境プロパティファイルに指定がない場合,システム例外を返します。
<ftp-acct>※3 0または1回 接続するFTPサーバの課金情報を示すタグです。
FTPアダプタ実行環境プロパティファイルに重複して設定されている場合,要求電文の値が有効になります。

課金情報を必要とするユーザ
条件に応じて次の値が利用されます。
  • タグがあって正常な値がある場合
    タグの内容がACCTコマンドに利用されます。値に改行が含まれている場合,システム例外を返します。
  • タグがあって値に不正な文字が含まれている場合
    システム例外を返します。
  • タグがあって値がない場合
    「ACCT ""」が発行されます。
  • タグがない場合
    アカウント定義ファイルで指定されているACCTの値が利用されます。アカウント定義ファイルにACCTがない場合は「ACCT ""」が発行されます。

課金情報を必要としないユーザ
指定は無視されます。
<ftp-type> 0または1回 転送するデータタイプ(伝送モード)を示すタグです。TYPEコマンドの引数として使用します。FTPアダプタ実行環境プロパティファイルに重複して設定されている場合,要求電文の値が有効になります。
指定値は次のどちらかです。
A:ASCII形式で転送します。
I:バイナリ形式で転送します。
  • タグがあって値が「A」または「I」の場合
    TYPEコマンドの引数として使用されます。
  • タグがあって値が「A」および「I」のどちらでもない場合
    システム例外を返します。
  • タグがあって値がない場合
    TYPEコマンドは実行されません。※4
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。FTPアダプタ実行環境プロパティファイルに指定がない場合,TYPEコマンドは実行されません。※4
<ftp-mode> 0または1回 転送モード(圧縮モード)を示すタグです。MODEコマンドの引数として使用します。FTPアダプタ実行環境プロパティファイルに重複して設定されている場合,要求電文の値が有効になります。
指定値は次のどちらかです。
S:ファイルを圧縮しないで伝送します。
C:ファイルを圧縮して伝送します。
  • タグがあって値が「S」または「C」の場合
    MODEコマンドの引数として使用されます。
  • タグがあって値が「S」および「C」のどちらでもない場合
    システム例外を返します。
  • タグがあって値がない場合
    MODEコマンドは実行されません。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効となります。FTPアダプタ実行環境プロパティファイルにも指定がない場合は,デフォルトの「S」でMODEコマンドが実行されます。
<transfer-type> 1回 転送種別を示すタグです。次のどれかを設定します。
STOR:ファイルの上書き
APPE:ファイルへの情報追加
  • タグがあって値が「STOR」または「APPE」の場合
    転送種別として利用されます。
  • タグがない,またはタグがあって値が「STOR」および「APPE」のどちらでもない場合
    システム例外を返します。
<request-id> 0または1回 受付で作成したリクエストIDを示すタグです。
  • タグがあって値がある場合
    リクエストIDとして利用されます。
  • タグがない,またはタグがあって値がない場合
    作業フォルダを利用するときはシステム例外を返します。共通フォルダを利用するときは無視されます。
<local-folder> 1回 ローカル側フォルダを示すタグです。
  • タグの属性にcommon="true"が指定されている場合
    ローカルフォルダとして共通フォルダを利用し,このタグには「共通フォルダ定義名」を指定します。
    指定された共通フォルダ定義名から共通フォルダが取得できないときは,システム例外を返します。
  • タグの属性にcommon="false"が指定されている場合
    ローカルフォルダとして作業フォルダを利用します。
  • common属性がない,または値が"true"および"false"のどちらでもない場合
    システム例外を返します。
<local-file-name> 1回 ローカル側ファイル名を示すタグです。
作業フォルダまたは共通フォルダ直下のファイルを指定してください。ファイル名の先頭以外にスラッシュ(/)や円マーク(\)などの区切り文字は使用できません。ファイル名の先頭にスラッシュ(/)を使用した場合,スラッシュ(/)は無視されます。また,シンボリックリンク以外のファイルを指定してください。
  • タグがあって値が上記の制限に従っている場合
    ファイル名として使用されます。
  • タグがあって値が上記の制限に違反する場合
    システム例外を返します。
  • タグがない,またはタグがあって値がない場合
    システム例外を返します。
<remote-path>※5 1回 リモートパス名(FTPサーバに転送するときの転送先パス名)を示すタグです。
  • タグがあって値がある場合
    リモートパス名として利用されます。
  • タグがない,またはタグがあって値がない場合
    システム例外を返します。
<ftp-commands-before> 0または1回 ファイル転送前に実行するFTPコマンドとその引数を示すタグです。※6
複数のコマンドを実行する場合は,実行する順番にセミコロン(;)で区切って設定します(例:MKD transdir;CWD transdir)。
  • タグがあって値がある場合
    ファイル転送前に実行するコマンドとして利用されます。
  • タグがない,またはタグがあって値がない場合
    ファイル転送前に実行するコマンドはありません。
<ftp-commands-after> 0または1回 ファイル転送後に実行するFTPコマンドとその引数を示すタグです。※6
複数のコマンドを実行する場合は,実行する順番にセミコロン(;)で区切って設定します(例:RNFR oldfile.txt;RNTO newfile.txt)。
  • タグがあって値がある場合
    ファイル転送後に実行するコマンドとして利用されます。
  • タグがない,またはタグがあって値がない場合
    ファイル転送後に実行するコマンドはありません。

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

注※1
規定の出現回数を超える場合の動作は保証しません。

注※2
接続先FTPサーバがFTPSのImplicitモードで動作している場合に<ftps-enable>タグ,または<ftps-implicitmode>タグの値にfalseを指定すると,FTPサーバに接続したあとタイムアウトが発生するまで待ち状態となることがあります。
タイムアウトが発生するまでの時間は,次のうちどちらか小さい方の値となります。
  • FTPアダプタ実行環境プロパティファイルのftpadp.control-con.connect.timeoutプロパティで指定した値
  • 接続先FTPサーバ側で設定されたタイムアウト値
FTPアダプタ実行環境プロパティファイルのftpadp.control-con.connect.timeoutプロパティで指定した値でタイムアウトとなった場合,FTPアダプタ実行環境プロパティファイルのftpadp.control-con.retry.countプロパティで指定した回数のリトライを行ったあと,KDEK30407-Eのエラーが発生します。
接続先FTPサーバ側で設定されたタイムアウト値でタイムアウトとなった場合,KDEK30428-Eのエラーが発生します。

注※3
次に示す文字以外は使用できません。
半角英数字,半角空白,感嘆符(!),ダブルクォーテーション("),番号記号(#),ドル記号($),パーセント(%),アンパサンド(&),アポストロフィ('),始め小括弧((),終わり小括弧()),アスタリスク(*),正符号(+),コンマ(,),ハイフン(-),ピリオド(.),スラッシュ(/),コロン(:),セミコロン(;),左アングルブラケット(<),右アングルブラケット(>),等号(=),クエスチョンマーク(?),単価記号(@),始め角括弧([),終わり角括弧(]),円マーク(\),アクサンシルコンフレックス(^),アンダーライン(_),アクサングラーブ(`),始め波括弧({),終わり波括弧(}),パイプライン(|),波ダッシュ(~)

注※4
FTPプロトコルの仕様(RFC959)に従い,デフォルトではASCII形式で転送されます。

注※5
FTP受付の要求電文の<transfer-path>タグと同じ値をFTPアダプタの<remote-path>タグに設定すると,パスの先頭がスラッシュ(/)になります。
相対パスを指定する場合やWindowsの絶対パス形式でパスを指定したい場合など,パスの先頭にスラッシュ(/)があると問題がある場合は,ビジネスプロセスのデータ変換アクティビティで部分文字列取得ファンクション(substr)を使用してFTP受付の要求電文の<transfer-path>タグの値から2文字目以降の文字列を取り出して,FTPアダプタの<remote-path>タグに設定してください。

注※6
<ftp-commands-before>タグおよび<ftp-commands-after>タグに指定されたコマンドは,そのままFTPサーバに送られ,FTPアダプタはコマンドのオプションの妥当性やコマンドの実行による影響について関知しません。
そのため,<ftp-commands-before>タグおよび<ftp-commands-after>タグにOPTS UTF {ON|OFF}コマンドを指定した場合は,FTPサーバとの通信に適用される文字セットを次のどちらかで指定しておく必要があります。
  • 要求電文の<file-name-charset>タグ
  • FTPアダプタ実行環境プロパティファイルのftpadp.file-name.charsetプロパティ

(2) GETオペレーション

ビジネスプロセスがFTPアダプタに渡すGETオペレーションの要求電文のフォーマットを次に示します。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csaftp/get_request」です。

表18-12 要求電文フォーマット(GETオペレーション)

タグ名 出現回数※1 説明
<request> 1回
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
<host-ipaddr> 0または1回 接続するFTPサーバのIPアドレスまたはホスト名です。
  • タグがあって値がある場合
    指定の文字列でconnectが発行されます。
  • タグがあって値がない場合
    システム例外を返します。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。FTPアダプタ実行環境プロパティファイルに指定がない場合,システム例外を返します。
<host-con-port> 0または1回 FTPサーバの制御コネクション用ポート番号です。
  • タグがあって値がある場合
    1から65535までのポート番号を指定します。これ以外の値を指定した場合,システム例外を返します。
  • タグがあって値がない場合
    デフォルトの21が指定されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
<file-name-charset> 0または1回 FTPサーバとの間の制御コネクションで,ファイル名などの情報を送受信するときに使用する文字セットの名称を示すタグです。指定値は次のどちらかです。
UTF-8:文字セットに「UTF-8」を使用します。
MS932:文字セットに「MS932」を使用します。
  • タグがあって値が使用できる文字セットの場合
    ファイル名などの情報を送受信するときの文字セットとして適用されます。
  • タグがあって値が使用できない文字セット名の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「UTF-8」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
<ftps> 0または1回 FTPSに関する設定を示すタグです。タグがない場合,FTPSに関するすべての設定はFTPアダプタ実行環境プロパティファイルの値が有効となります。
 
 
 
 
 
<ftps-enable> 0または1回 FTPサーバとの接続にFTPSを使用するかどうかを指定するタグです。指定値は次のどちらかです。
true:FTPサーバとの接続にFTPSを使用します。
false:FTPサーバとの接続に通常のFTPを使用します。※2
FTPSを使用する場合,制御コネクションおよびデータコネクションの通信は暗号化されます。ただし,接続先のFTPサーバがFTPSによる接続をサポートしている必要があります。「true」を指定した場合でも,データコネクションの通信の暗号化が設定されていないときは,データコネクションの通信も暗号化されません。
  • タグがあって値が「true」または「false」の場合
    指定した値が適用されます。
  • タグがあって値が「true」または「false」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「false」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
<ftps-protocol-name> 0または1回 FTPサーバとの接続にFTPSを使用する場合に,使用するセキュリティ通信用のプロトコルを示すタグです。指定値は次のどちらかです。
TLS:セキュリティ通信用のプロトコルにTLSを使用します。
SSL:セキュリティ通信用のプロトコルにSSLを使用します。
  • タグがあって値が「TLS」または「SSL」の場合
    指定した値が適用されます。
  • タグがあって値が「TLS」または「SSL」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「TLS」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
この設定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。
<ftps-implicit-mode> 0または1回 FTPサーバとの接続にFTPSを使用する場合に,FTPSのImplicitモードを使用するかどうかを指定するタグです。指定値は次のどちらかです。
true:Implicitモードを使用します。
false:Explicitモードを使用します。※2
  • タグがあって値が「true」または「false」の場合
    指定した値が適用されます。
  • タグがあって値が「true」または「false」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「false」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
この設定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。
<ftps-data-con-secure> 0または1回 FTPサーバとの接続にFTPSを使用する場合に,データコネクションの通信を暗号化するかどうかを指定するタグです。指定値は次のどちらかです。
true:データコネクションの通信を暗号化します。
false:データコネクションの通信を暗号化しません。
  • タグがあって値が「true」または「false」の場合
    指定した値が適用されます。
  • タグがあって値が「true」または「false」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「true」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
この設定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。
<ftps-server-authentication> 0または1回 FTPサーバとの接続にFTPSを使用する場合に,サーバ認証をするかどうかを指定するタグです。指定値は次のどちらかです。
true:サーバ認証をします。
false:サーバ認証をしません。
  • タグがあって値が「true」または「false」の場合
    指定した値が適用されます。
  • タグがあって値が「true」または「false」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「false」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
この設定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。なお,「true」を指定する場合,キーストアに関する設定が必要になります。キーストアの設定方法については,「18.2.5 FTPSを使用したセキュアな接続」を参照してください。
<ftp-user>※3 0または1回 接続するFTPサーバのログインユーザ名を示すタグです。USERコマンドの引数として使用します。このタグに指定するログインユーザには,ファイル操作を実行できる権限が与えられている必要があります。
FTPアダプタ実行環境プロパティファイルに重複して設定されている場合,要求電文の値が有効になります。
  • タグがあって正常な値がある場合
    「USER "値"」が発行されます。値に改行が含まれている場合,システム例外を返します。
  • タグがあって値がない場合,または値に不正な文字が含まれている場合
    システム例外を返します。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。FTPアダプタ実行環境プロパティファイルに指定がない場合,システム例外を返します。
<ftp-acct>※3 0または1回 接続するFTPサーバの課金情報を示すタグです。FTPアダプタ実行環境プロパティファイルに重複して設定されている場合,要求電文の値が有効になります。

課金情報を必要とするユーザ
条件に応じて次の値が利用されます。
  • タグがあって正常な値がある場合
    タグの内容がACCTコマンドに利用されます。値に改行が含まれている場合,システム例外を返します。
  • タグがあって値に不正な文字が含まれている場合
    システム例外を返します。
  • タグがあって値がない場合
    「ACCT ""」が発行されます。
  • タグがない場合
    アカウント定義ファイルで指定されているACCTの値が利用されます。アカウント定義ファイルにACCTがない場合は「ACCT ""」が発行されます。

課金情報を必要としないユーザ
指定は無視されます。
<ftp-type> 0または1回 転送するデータタイプ(伝送モード)を示すタグです。TYPEコマンドの引数として使用します。FTPアダプタ実行環境プロパティファイルに重複して設定されている場合,要求電文の値が有効になります。
指定値は次のどちらかです。
A:ASCII形式で転送します。
I:バイナリ形式で転送します。
  • タグがあって値が「A」または「I」の場合
    TYPEコマンドの引数として使用されます。
  • タグがあって値が「A」および「I」のどちらでもない場合
    システム例外を返します。
  • タグがあって値がない場合
    TYPEコマンドは実行されません。※4
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。FTPアダプタ実行環境プロパティファイルに指定がない場合,TYPEコマンドは実行されません。※4
<ftp-mode> 0または1回 転送モード(圧縮モード)を示すタグです。MODEコマンドの引数として使用します。FTPアダプタ実行環境プロパティファイルに重複して設定されている場合,要求電文の値が有効になります。
指定値は次のどちらかです。
S:ファイルを圧縮しないで伝送します。
C:ファイルを圧縮して伝送します。
  • タグがあって値が「S」または「C」の場合
    MODEコマンドの引数として使用されます。
  • タグがあって値が「S」または「C」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    MODEコマンドは実行されません。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効となります。FTPアダプタ実行環境プロパティファイルにも指定がない場合は,デフォルトの「S」でMODEコマンドが実行されます。
<request-id> 0または1回 受付で作成したリクエストIDを示すタグです。
  • タグがあって値がある場合
    リクエストIDとして利用されます。
  • タグがない,またはタグがあって値がない場合
    作業フォルダを利用するときはシステム例外を返します。共通フォルダを利用するときは無視されます。
<local-folder> 1回 ローカル側フォルダを示すタグです。
  • タグの属性にcommon="true"が指定されている場合
    ローカルフォルダとして共通フォルダを利用し,このタグには「共通フォルダ定義名」を指定します。
    指定された共通フォルダ定義名から共通フォルダが取得できないときは,システム例外を返します。
  • タグの属性にcommon="false"が指定されている場合
    ローカルフォルダとして作業フォルダを利用します。
  • common属性がない,または値が"true"および"false"のどちらでもない場合
    システム例外を返します。
<local-file-name> 1回 ローカル側ファイル名を示すタグです。

作業フォルダを利用する場合
  • タグがあって値があるとき
    この設定は無視されて処理が続行します。
  • タグがない,またはタグがあって値がないとき
    処理が続行します。

共通フォルダを利用する場合
共通フォルダ直下のファイルを指定してください。ファイル名の先頭以外にスラッシュ(/)や円マーク(\)などの区切り文字は使用できません。ファイル名の先頭にスラッシュ(/)を使用した場合,スラッシュ(/)は無視されます。また,シンボリックリンク以外のファイルを指定してください。
  • タグがあって値が上記の制限に従っているとき
    ファイル名として使用されます。
  • タグがあって値が上記の制限に違反するとき
    システム例外を返します。
  • タグがない,またはタグがあって値がないとき
    システム例外を返します。
<remote-path>※5 1回 リモートパス名(FTPサーバに転送するときの転送先パス名)を示すタグです。
  • タグがあって値がある場合
    リモートパス名として利用されます。
  • タグがない,またはタグがあって値がない場合
    システム例外を返します。
<ftp-commands-before>※6 0または1回 ファイル転送前に実行するFTPコマンドとその引数を示すタグです。
複数のコマンドを実行する場合は,実行する順番にセミコロン(;)で区切って設定します。(例:MKD transdir;CWD transdir)
  • タグがあって値がある場合
    ファイル転送前に実行するコマンドとして利用されます。
  • タグがない,またはタグがあって値がない場合
    ファイル転送前に実行するコマンドはありません。
<ftp-commands-after>※6 0または1回 ファイル転送後に実行するFTPコマンドとその引数を示すタグです。
複数のコマンドを実行する場合は,実行する順番にセミコロン(;)で区切って設定します。(例:RNFR oldfile.txt;RNTO newfile.txt)
  • タグがあって値がある場合
    ファイル転送後に実行するコマンドとして利用されます。
  • タグがない,またはタグがあって値がない場合
    ファイル転送後に実行するコマンドはありません。

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

注※1
規定の出現回数を超える場合の動作は保証しません。

注※2
接続先FTPサーバがFTPSのImplicitモードで動作している場合に<ftps-enable>タグ,または<ftps-implicitmode>タグの値にfalseを指定すると,FTPサーバに接続したあとタイムアウトが発生するまで待ち状態となることがあります。
タイムアウトが発生するまでの時間は,次のうちどちらか小さい方の値となります。
  • FTPアダプタ実行環境プロパティファイルのftpadp.control-con.connect.timeoutプロパティで指定した値
  • 接続先FTPサーバ側で設定されたタイムアウト値
FTPアダプタ実行環境プロパティファイルのftpadp.control-con.connect.timeoutプロパティで指定した値でタイムアウトとなった場合,FTPアダプタ実行環境プロパティファイルのftpadp.control-con.retry.countプロパティで指定した回数のリトライを行ったあと,KDEK30407-Eのエラーが発生します。
接続先FTPサーバ側で設定されたタイムアウト値でタイムアウトとなった場合,KDEK30428-Eのエラーが発生します。

注※3
次に示す文字以外は使用できません。
半角英数字,半角空白,感嘆符(!),ダブルクォーテーション("),番号記号(#),ドル記号($),パーセント(%),アンパサンド(&),アポストロフィ('),始め小括弧((),終わり小括弧()),アスタリスク(*),正符号(+),コンマ(,),ハイフン(-),ピリオド(.),スラッシュ(/),コロン(:),セミコロン(;),左アングルブラケット(<),右アングルブラケット(>),等号(=),クエスチョンマーク(?),単価記号(@),始め角括弧([),終わり角括弧(]),円マーク(\),アクサンシルコンフレックス(^),アンダーライン(_),アクサングラーブ(`),始め波括弧({),終わり波括弧(}),パイプライン(|),波ダッシュ(~)

注※4
FTPプロトコルの仕様(RFC959)に従い,デフォルトではASCII形式で転送されます。

注※5
FTP受付の要求電文の<transfer-path>タグと同じ値をFTPアダプタの<remote-path>タグに設定すると,パスの先頭がスラッシュ(/)になります。
相対パスを指定する場合やWindowsの絶対パス形式でパスを指定したい場合など,パスの先頭にスラッシュ(/)があると問題がある場合は,ビジネスプロセスのデータ変換アクティビティで部分文字列取得ファンクション(substr)を使用してFTP受付の要求電文の<transfer-path>タグの値から2文字目以降の文字列を取り出して,FTPアダプタの<remote-path>タグに設定してください。

注※6
<ftp-commands-before>タグおよび<ftp-commands-after>タグに指定されたコマンドは,そのままFTPサーバに送られ,FTPアダプタはコマンドのオプションの妥当性やコマンドの実行による影響について関知しません。
そのため,<ftp-commands-before>タグおよび<ftp-commands-after>タグにOPTS UTF {ON|OFF}コマンドを指定した場合は,FTPサーバとの通信に適用される文字セットを次のどちらかで指定しておく必要があります。
  • 要求電文の<file-name-charset>タグ
  • FTPアダプタ実行環境プロパティファイルのftpadp.file-name.charsetプロパティ

(3) GETINFOオペレーション

ビジネスプロセスがFTPアダプタに渡すGETINFOオペレーションの要求電文のフォーマットを次に示します。名前空間名は「http://www.hitachi.co.jp/soft/xml/cosminexus/csaftp/getinfo_request」です。

表18-13 要求電文フォーマット(GETINFOオペレーション)

タグ名 出現回数※1 説明
<request> 1回
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
<host-ipaddr> 0または1回 接続するFTPサーバのIPアドレスまたはホスト名です。
  • タグがあって値がある場合
    指定の文字列でconnectが発行されます。
  • タグがあって値がない場合
    システム例外を返します。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。FTPアダプタ実行環境プロパティファイルに指定がない場合,システム例外を返します。
<host-con-port> 0または1回 FTPサーバの制御コネクション用ポート番号です。
  • タグがあって値がある場合
    1から65535までのポート番号を指定します。これ以外の値を指定した場合,システム例外を返します。
  • タグがあって値がない場合
    デフォルトの21が指定されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
<file-name-charset> 0または1回 FTPサーバとの間の制御コネクションで,次に示す情報を送受信するときに使用する文字セットの名称を示すタグです。
  • 制御コネクションで送受信する情報(ファイル名など)
  • LISTコマンドまたはNLSTコマンド実行時にデータコネクションを介してFTPサーバから受け取る情報(ファイルの一覧情報)
指定値は次のどちらかです。
UTF-8:文字セットに「UTF-8」を使用します。
MS932:文字セットに「MS932」を使用します。
  • タグがあって値が使用できる文字セットの場合
    ファイル名などの情報を送受信するときの文字セットとして適用されます。
  • タグがあって値が使用できない文字セット名の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「UTF-8」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
<ftps> 0または1回 FTPSに関する設定を示すタグです。タグがない場合,FTPSに関するすべての設定はFTPアダプタ実行環境プロパティファイルの値が有効となります。
 
 
 
 
 
<ftps-enable> 0または1回 FTPサーバとの接続にFTPSを使用するかどうかを指定するタグです。指定値は次のどちらかです。
true:FTPサーバとの接続にFTPSを使用します。
false:FTPサーバとの接続に通常のFTPを使用します。※2
FTPSを使用する場合,制御コネクションおよびデータコネクションの通信は暗号化されます。ただし,接続先のFTPサーバがFTPSによる接続をサポートしている必要があります。「true」を指定した場合でも,データコネクションの通信の暗号化が設定されていないときは,データコネクションの通信も暗号化されません。
  • タグがあって値が「true」または「false」の場合
    指定した値が適用されます。
  • タグがあって値が「true」または「false」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「false」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
<ftps-protocol-name> 0または1回 FTPサーバとの接続にFTPSを使用する場合に,使用するセキュリティ通信用のプロトコルを示すタグです。指定値は次のどちらかです。
TLS:セキュリティ通信用のプロトコルにTLSを使用します。
SSL:セキュリティ通信用のプロトコルにSSLを使用します。
  • タグがあって値が「TLS」または「SSL」の場合
    指定した値が適用されます。
  • タグがあって値が「TLS」または「SSL」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「TLS」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
この設定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。
<ftps-implicit-mode> 0または1回 FTPサーバとの接続にFTPSを使用する場合に,FTPSのImplicitモードを使用するかどうかを指定するタグです。指定値は次のどちらかです。
true:Implicitモードを使用します。
false:Explicitモードを使用します。※2
  • タグがあって値が「true」または「false」の場合
    指定した値が適用されます。
  • タグがあって値が「true」または「false」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「false」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
この設定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。
<ftps-data-con-secure> 0または1回 FTPサーバとの接続にFTPSを使用する場合に,データコネクションの通信を暗号化するかどうかを指定するタグです。指定値は次のどちらかです。
true:データコネクションの通信を暗号化します。
false:データコネクションの通信を暗号化しません。
  • タグがあって値が「true」または「false」の場合
    指定した値が適用されます。
  • タグがあって値が「true」または「false」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「true」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
この設定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。
<ftps-server-authentication> 0または1回 FTPサーバとの接続にFTPSを使用する場合に,サーバ認証をするかどうかを指定するタグです。指定値は次のどちらかです。
true:サーバ認証をします。
false:サーバ認証をしません。
  • タグがあって値が「true」または「false」の場合
    指定した値が適用されます。
  • タグがあって値が「true」または「false」以外の場合
    システム例外を返します。
  • タグがあって値がない場合
    デフォルトの「false」が使用されます。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。
この設定は,FTPサーバとの接続にFTPSを使用する場合だけ有効となります。なお,「true」を指定する場合,キーストアに関する設定が必要になります。キーストアの設定方法については,「18.2.5 FTPSを使用したセキュアな接続」を参照してください。
<ftp-user>※3 0または1回 接続するFTPサーバのログインユーザ名を示すタグです。USERコマンドの引数として使用します。ログインユーザ名は80文字以内で指定してください。このタグに指定するログインユーザには,ファイル操作を実行できる権限が与えられている必要があります。
FTPアダプタ実行環境プロパティファイルに重複して設定されている場合,要求電文の値が有効になります。
  • タグがあって正常な値がある場合
    「USER "値"」が発行されます。値に改行が含まれている場合,システム例外を返します。
  • タグがあって値がない場合,または値に不正な文字が含まれている場合
    システム例外を返します。
  • タグがない場合
    FTPアダプタ実行環境プロパティファイルの値が有効になります。FTPアダプタ実行環境プロパティファイルに指定がない場合,システム例外を返します。
<ftp-acct>※3 0または1回 接続するFTPサーバの課金情報を示すタグです。FTPアダプタ実行環境プロパティファイルに重複して設定されている場合,要求電文の値が有効になります。

課金情報を必要とするユーザ
条件に応じて次の値が利用されます。
  • タグがあって正常な値がある場合
    タグの内容がACCTコマンドに利用されます。値に改行が含まれている場合,システム例外を返します。
  • タグがあって値に不正な文字が含まれている場合
    システム例外を返します。
  • タグがあって値がない場合
    「ACCT ""」が発行されます。
  • タグがない場合
    アカウント定義ファイルで指定されているACCTの値が利用されます。アカウント定義ファイルにACCTがない場合は「ACCT ""」が発行されます。

課金情報を必要としないユーザ
指定は無視されます。
<getinfo-type> 1回 接続するFTPサーバから取得する情報の取得種別を示すタグです。
設定値は次のどちらかです。
LIST:LISTコマンドを実行し,ファイル情報の一覧を取得します。
NLST:NLSTコマンドを実行し,ファイル名の一覧を取得します。
  • タグがあって値が「LIST」または「NLST」の場合
    指定された値を取得種別として利用します。
  • タグがあって値が「LIST」または「NLST」以外の場合
    システム例外を返します。
  • タグがない,またはタグがあって値がない場合
    システム例外を返します。
<getinfo-option> 0または1回 接続するFTPサーバから取得する情報の取得オプションを示すタグです。<getinfo-type>で指定したコマンドを実行するときに指定するオプションになります。
  • タグがあって値がある場合
    指定された値をオプションとして指定して,<getinfo-type>で指定されたコマンドを実行します。
  • タグがない,またはタグがあって値がない場合
    オプションなしで,<getinfo-type>で指定されたコマンドを実行します。
<getinfo-path> 0または1回 接続するFTPサーバから取得する情報の取得パスを示すタグです。<getinfo-type>で指定したコマンドを実行するときに指定するパスになります。
  • タグがあって値がある場合
    指定された値をパスとして指定して,<getinfo-type>で指定されたコマンドを実行します。
  • タグがない,またはタグがあって値がない場合
    パスなしで,<getinfo-type>で指定されたコマンドを実行します。
<request-id> 1回 FTP受付で作成したリクエストIDを示すタグです。
  • 値がある場合
    指定されている値をリクエストIDとして利用します。
  • 値がない場合
    システム例外を返します。
<ftp-commands-before>※4 0または1回 リストコマンド実行前に実行するFTPコマンドとその引数を示すタグです。
複数のコマンドを実行する場合は,実行する順番にセミコロン(;)で区切って設定します(例:MKD transdir;CWD transdir)。
  • タグがあって値がある場合
    リストコマンド実行前に実行するコマンドとして利用されます。
  • タグがない,またはタグがあって値がない場合
    リストコマンド実行前に実行するコマンドはありません。
<ftp-commands-after>※4 0または1回 リストコマンド実行後に実行するFTPコマンドとその引数を示すタグです。
複数のコマンドを実行する場合は,実行する順番にセミコロン(;)で区切って設定します(例:RNFR oldfile.txt;RNTO newfile.txt)。
  • タグがあって値がある場合
    リストコマンド実行後に実行するコマンドとして利用されます。
  • タグがない,またはタグがあって値がない場合
    リストコマンド実行後に実行するコマンドはありません。

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

注※1
規定の出現回数を超える場合の動作は保証しません。

注※2
接続先FTPサーバがFTPSのImplicitモードで動作している場合に<ftps-enable>タグ,または<ftps-implicitmode>タグの値にfalseを指定すると,FTPサーバに接続したあとタイムアウトが発生するまで待ち状態となることがあります。
タイムアウトが発生するまでの時間は,次のうちどちらか小さい方の値となります。
  • FTPアダプタ実行環境プロパティファイルのftpadp.control-con.connect.timeoutプロパティで指定した値
  • 接続先FTPサーバ側で設定されたタイムアウト値
FTPアダプタ実行環境プロパティファイルのftpadp.control-con.connect.timeoutプロパティで指定した値でタイムアウトとなった場合,FTPアダプタ実行環境プロパティファイルのftpadp.control-con.retry.countプロパティで指定した回数のリトライを行ったあと,KDEK30407-Eのエラーが発生します。
接続先FTPサーバ側で設定されたタイムアウト値でタイムアウトとなった場合,KDEK30428-Eのエラーが発生します。

注※3
次に示す文字以外は使用できません。
半角英数字,半角空白,感嘆符(!),ダブルクォーテーション("),番号記号(#),ドル記号($),パーセント(%),アンパサンド(&),アポストロフィ('),始め小括弧((),終わり小括弧()),アスタリスク(*),正符号(+),コンマ(,),ハイフン(-),ピリオド(.),スラッシュ(/),コロン(:),セミコロン(;),左アングルブラケット(<),右アングルブラケット(>),等号(=),クエスチョンマーク(?),単価記号(@),始め角括弧([),終わり角括弧(]),円マーク(\),アクサンシルコンフレックス(^),アンダーライン(_),アクサングラーブ(`),始め波括弧({),終わり波括弧(}),パイプライン(|),波ダッシュ(~)

注※4
<ftp-commands-before>タグおよび<ftp-commands-after>タグに指定されたコマンドは,そのままFTPサーバに送られ,FTPアダプタはコマンドのオプションの妥当性やコマンドの実行による影響について関知しません。
そのため,<ftp-commands-before>タグおよび<ftp-commands-after>タグにOPTS UTF {ON|OFF}コマンドを指定した場合は,FTPサーバとの通信に適用される文字セットを次のどちらかで指定しておく必要があります。
  • 要求電文の<file-name-charset>タグ
  • FTPアダプタ実行環境プロパティファイルのftpadp.file-name.charsetプロパティ