ページの先頭行へ戻る
Systemwalker Runbook Automation Studio利用ガイド
Systemwalker
付録C ファイルの記述形式について > C.2 FTPエージェントファイル
前次

C.2 FTPエージェントファイル

FTPエージェントは、すべてのエージェントと同様に、agentsConfig.xmlで構成されます。この環境設定ファイルの<ActionAgent>セクションには、FTPエージェントのデフォルトの設定が含まれています。通常、このファイルのFTPエージェントの設定を変更する必要はありません。

FTPエージェントは、ServiceAgentクラスを使用します。また、ftp.xmlというFTPエージェントの環境設定ファイルも使用します。この環境設定ファイルは、FTPホストのアドレスなど、FTPの設定を定義します。この環境設定ファイルを確認して、使用する環境に合わせてください。

ftp.xml環境設定ファイル

FTPエージェントの環境設定ファイルであるftp.xmlは、管理サーバインストール環境内のエージェントディレクトリ、<DMSRoot>/apps/<アプリケーションID>にあります。

FTPエージェントを構成するftp.xmlファイルのサンプルを以下に示します。

<Services>
   <Service>
      <ServiceType>FTP</ServiceType>
      <ServiceStatusUDA>AgentServiceStatus</ServiceStatusUDA>
      <ServiceResultUDA>AgentServiceResult</ServiceResultUDA>
      <ServiceSpecificInfo>
         <FTPHost><HOSTNAME or IP Address></FTPHost>
         <FTPPort></FTPPort>
         <FTPUser>anonymous</FTPUser>
         <FTPPassword></FTPPassword>
         <FTPType>ASCII</FTPType>
         <FTPAppend>FALSE</FTPAppend>
         <FTPDirectory>%%REMOTE_FTP_DIRECTORY%%
            </FTPDirectory>
         <FTPFileNames>%%REMOTE_FTP_FILES%%</FTPFileNames>
         <Documents>%%OUTGOING_FILES%%</Documents>
      </ServiceSpecificInfo>
   </Service>
</Services>

このファイル内の一部のタグは、ServiceAgentクラスを使用するすべてのエージェントが利用します。一部のタグはFTPエージェント固有のものです。

以下の表は、ftp.xmlで使用されているXMLタグを説明しています。

タグ

説明

<ServiceType>

FTPエージェントのサービスタイプは、常にFTPです。サービスタイプが指定されていない場合や、サービスタイプが無効な場合、プロセスインスタンスはエラー状態になります。
このタグは、ServiceAgentクラスを使用するすべてのエージェントが利用します。

<ServiceStatusUDA>

FTPエージェントのアクティビティの状態を保存するUDAの名前です。設定可能な値は、DoneまたはFailedです。このタグを削除してもFTPエージェントには何も影響がありませんが、ユーザーはFTPエージェントのアクティビティの状態を確認できなくなります。

<ServiceResultUDA>

FTPエージェントが例外を送出した場合に使用する、エラーメッセージを保存するUDAの名前です。このタグを削除してもFTPエージェントには何も影響がありませんが、FTPエージェントが失敗しても、ユーザーはエラーが発生したことを確認できなくなります。

<FTPHost>

転送されたファイルを受信するローカルコンピュータのサーバ名またはIPアドレスです。デフォルト値は127.0.0.1 (ローカルコンピュータ)です。FTPホストが指定されていない場合や、FTPホストが無効な場合、ファイルは、FTPサーバが使用できる場合は、そこに転送されます。
このタグはFTPエージェント固有のものです。

<FTPPort>

FTPサーバが使用するポートです。ポートが指定されていない場合は、デフォルトのFTPポートである21が使用されます。
このタグはFTPエージェント固有のものです。

<FTPUser>

ファイルを転送するFTPユーザーのユーザー名です。ユーザー名が無効な場合、ファイルの転送は失敗し、プロセスインスタンスはエラー状態になります。
このタグはFTPエージェント固有のものです。

<FTPPassword>

ファイルを転送するFTPユーザーのパスワードです。
このタグはFTPエージェント固有のものです。

<FTPType>

転送されるファイルのタイプです。設定可能な値は、ASCIIまたはBINARYです。デフォルト値はBINARYです。
テキストファイルを転送する場合は、ASCIIを使用します。バイナリファイルを転送する場合は、BINARYを使用します。ASCIIまたはBINARY以外の値を指定すると、FTPエージェントは例外を送出します。
このタグはFTPエージェント固有のものです。

<FTPAppend>

転送されるファイルをリモートファイルに追加するかどうかを指定します。設定可能な値は、TRUEまたはFALSEです。デフォルト値はFALSEです。
既存のリモートファイルにローカルファイルのコンテンツを追加する場合は、TRUEを使用します。既存のリモートファイルを上書きする場合は、FALSEを使用します。TRUEまたはFALSE以外の値を指定すると、FTPエージェントは例外を送出します。
このタグはFTPエージェント固有のものです。

<FTPDirectory>

ファイルの転送先のディレクトリを指定するUDAの名前です。FTPサーバからの相対パスが指定されます。
たとえば、/iflowがREMOTE_FTP_DIRECTORY UDAの値で、ユーザーがWindowsシステムで作業している場合、ファイルはC:\Inetpub\ftproot\iflowに転送されます。無効なディレクトリが指定された場合、プロセスインスタンスはエラー状態になります。
このタグはFTPエージェント固有のものです。

<FTPFileNames>

リモートファイルに使用するファイル名を指定するUDAの名前です。このパラメーターは、ファイルの名前を転送中に変更するために使用します。
たとえば、プロセスインスタンスにLocalFile.txtというファイルが添付されていて、REMOTE_FTP_FILESの値にRemoteFile.txtが設定されている場合、LocalFile.txtはFTPディレクトリに転送され、RemoteFile.txtというファイル名に変更されます。REMOTE_FTP_FILESには、複数のファイル名をセミコロン(;)で区切って指定できます。REMOTE_FTP_FILESにファイル名が含まれていない場合は、元のファイル名が使用されます。

<Documents>

FTPディレクトリに転送されるファイルを指定するUDAの名前です。OUTGOING_FILESには、複数のファイル名をセミコロン(;)で区切って指定できます。OUTGOING_FILESにファイル名が含まれていない場合は、プロセスインスタンスに添付されているすべてのファイルが転送されます。

注意

ファイル名にセミコロン(;)が含まれるファイルは、FTPディレクトリに転送できません。セミコロンはファイル名の区切り文字と見なされるので、転送するファイルの名前に含めることはできません。

前次
Copyright 2010-2017 FUJITSU LIMITED