C.3 HTTPエージェントファイル

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

HTTPagent.xml環境設定ファイル

HTTPエージェントの環境設定ファイルを作成し、管理サーバのエージェントディレクトリ、<DMSRoot>/apps/<アプリケーションID>に保存します。

以下は、HTTPエージェントの環境設定ファイルのサンプルです。

<HTTPAgent>
   <HTTPBaseURL method="POST"
      followRedirects="true">{{Field HTTP_URL}}</HTTPBaseURL>
   <HTTPHeaderParams name="Content-Type">text/xml;
      charset=UTF-8</HTTPHeaderParams>
   <HTTPHeaderParams name="User-Agent">I- HTTP Agent
   </HTTPHeaderParams>
   <HTTPHeaderParams name="accept-charset">UTF-8
   </HTTPHeaderParams>
   <QueryParams name= "ParamName"> Param value</QueryParams>
   <HTTPRequestUDA>HTTP_REQUEST</HTTPRequestUDA>
   <HTTPResponseUDA>HTTP_RESPONSE</HTTPResponseUDA>
   <HTTPAgentStatusUDA>HTTP_STATUS</HTTPAgentStatusUDA>
</HTTPAgent>

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

タグ	説明
<HTTPBaseURL>	URLエンドポイントです。<HTTPBaseURL>タグの値は、HTTPエージェントによって呼び出される、サーブレットなどの外部サービスを指定します。属性: method="POST"または"GET"を指定します。HTTPリクエストで使用するリクエストメソッドを定義します。method属性が指定されていない場合、プロセスインスタンスはエラー状態になります。"POST"または"GET"以外の属性値を設定した場合は、HTTPエージェントは失敗します。 followRedirects="true"を指定します。 followRedirectsのデフォルト値はfalseなので、この属性を指定する必要があります。
<HTTPHeaderParams>	エンコードスタイルやコンテンツタイプなどのHTTPヘッダのプロパティを設定します。HTTPヘッダは、たとえば、現在のHTTPセッションのリクエスト、レスポンスオブジェクトのプロパティなど、様々なWebオブジェクトプロパティを定義するために使用します。属性: name="Content-type"または"User-Agent"を指定します。 "Content-type"は、リクエストされたコンテンツの種類を定義します。以下の値が使用できます。value="text/xml"、およびcharset=UTF-8。 "User-Agent"は、リクエストを送ったクライアント(ユーザーエージェント)についての情報を含みます。 <HTTPHeaderParams>タグのname属性で指定される値には、現在制限が設けられていないことに注意してください。この属性に有効な値はすべて、HTTPヘッダに有効となります。
<QueryParams>	このタグは、HTTPエージェントが"GET"メソッドを使用した場合、必要となります。このタグの値は、クエリ文字列として外部サービスに渡されます。<HTTPRequestUDA>タグに指定されたUDAの値は、"GET"メソッドを使用した場合は使用されないことに注意してください。このタグの正しい使用法は以下のとおりです。 <QueryParams name= "ParamName"> Param value</QueryParams> これは、HTTPエージェントが実行中の以下のようなURL指定となります。 URL?ParamName= Param value <QueryParams>タグの名前属性には、有効な文字列であれば、すべて指定できます。
<HTTPRequestUDA>	タグ内で指定されたUDAの値は、HTTPリクエストのクエリ文字列の一部となります。
<HTTPAgentStatusUDA>	HTTPサービスのステータスが保存されるUDAです。
<HTTPResponseUDA>	HTTPレスポンスが保存されるUDAです。