11.1 HTTPコンポーネント
- HTTPコンポーネントの使用方法には次の2つのモードがあります。
トリガーモード
ステップモード
- トリガーモードを使用すると、Magic xpi サーバはクライアントからのHTTPリクエストを受け取ることができます。
- ステップモードを使用すると、Magic xpi サーバは、別のWebサーバに対してHTTPリクエストを送信することができます。
【トリガーモード】
- HTTPコンポーネントをトリガーとして使用すると、HTTPクライアント(ブラウザ等)からIIS経由でリクエストを受け付け、フローをトリガー起動することができます。
- HTTPリクエストのパラメータは、Magic xpiの変数にマッピングし、フローの中で使用することができます。
- フローで処理した結果をHTMLとしてHTTPクライアント(ブラウザ等)に返します。
【サービスの設定】
- HTTPコンポーネントをトリガーモードで使用する場合、サービス設定でHTTPエントリを作成し、エンドポイントを設定します。
Webサーバ | PC名、IPアドレスを設定。デフォルトでは内部環境変数の”MachineName”が設定されます。 |
別名(エイリアス)Alias | IISのエイリアスを設定。デフォルトでは内部環境変数の”Alias”が設定されます。 |
【エンドポイントの設定】
- エンドポイントURL:HTTPクライアントからHTTPトリガーを呼ぶためのURL
[ 例 ] http://PS_HP_01/Magicxpi4.13/MgWebRequester.dll?appname=IFSMagicxpiSample1&prgname=HTTP&arguments=-AHTTPTrigger%23Mitsumori
【エンドポイントURL構文規則】(※赤文字:可変部分)
http://<host>/<IISAlias>/MgWebRequester.dll?appname=IFS<ProjectName>&prgname=HTTP&arguments=-A<ServiceName>%23<EndpointName>
<host> | コンピュータ名 |
<IISAlias> | IISエイリアス名(デフォルト値はMagicxpi4.13) |
<ProjectName> | 実行するプロジェクト名 |
<ServiceName> | サービスリポジトリのHTTPサービス名 |
<EndpointName> | エンドポイント名 |
【サンプルHTML】
- エンドポイント詳細で「サンプルHTMLの生成」にチェックを入れると、エンドポイントURLを呼び出すサンプルHTMLが作成されます。
[ 作成先 ]
<マイドキュメント>¥Magic¥Projects¥<ソリューション名>¥
<プロジェクト名>¥Service¥<サービス名>¥<エンドポイント名>.html
[ 例 ]
C:¥Users¥PS¥Documents¥Magic¥Projects¥MagicxpiSample1¥
MagicxpiSample1¥Service¥HTTPTrigger¥Mitsumori.html
【トリガー設定】
- ツールボックスからHTTPコンポーネントをトリガーエリアに貼り付けます。
サービス名 | サービスで作成したサービス名 |
エンドポイント名 | 作成したエンドポイントを選択 |
引数名 | エンドポイント定義時に指定した引数名 |
マッピング変数 | 引数を受け取る変数 |
戻値 | 呼出元に返される情報を格納するBlob型の変数 |
【ステップモード】
- ステップモードでは、HTTPの各メソッドを使用して情報の送受信を行います。
- ステップモードを使用する場合、予めリソースを設定し呼び出し先のHTTPサーバのURLを指定する必要があります。
【メソッドの種類】
- HTTPのGET、POST、RESTメソッドが使用可能。
- メソッド内で指定したBlob変数に、リクエストの結果情報(htmlやxmlなど)を保存します。
【リソースの設定】
- HTTPコンポーネントをステップモードで使用する場合、リソース設定でHTTPエントリを作成し、HTTPサーバのURLを指定する必要があります。
【GETメソッド】
ヘッダーセット | HTTPヘッダーに追加するテキストまたは式 |
出力BLOB | GETオペレーションが返す出力情報を格納するBLOB型変数 |
出力ヘッダ | レスポンスヘッダを格納する文字列型変数 |
【POSTメソッド】
【RESTメソッド】
HTTP動詞 | GET,POST,PUT,HEAD,DELETEのいずれか |
URL動的追加 | URLに追加する文字列を設定 |
ヘッダーセット | HTTPヘッダーに追加するテキストまたは式 |
出力BLOB | RESTオペレーションが返す出力情報を格納するBLOB型変数 |
出力ヘッダ | レスポンスヘッダを格納する文字列型変数 |