# tESBConsumer

呼び出されたWebサービスから定義済みメソッドを呼び出し、指定されたパラメーターに基づいて定義されているクラスを返します。

デフォルトで、このコンポーネントはTalend Studioと共には出荷されていません。機能マネージャーを使ってインストールする必要があります。 詳細は、[機能マネージャーを使って機能をインストール](https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/install-features-to-talend-studio)をご覧ください。

## tESBConsumerの標準プロパティ

これらのプロパティは、標準ジョブのフレームワークで実行されているtESBConsumerを設定するために使われます。

標準のtESBConsumerコンポーネントは、ESBファミリーに属しています。

このフレームワーク内のコンポーネントは、すべてのTalend製品で利用できます。

## 基本設定

| プロパティ | 説明 |
| --- | --- |
| サービス設定 | Webサービスのバインドと設定の説明。[Endpoint] (エンドポイント)フィールドは、サービス設定が完了すると自動的に入力されます。 |
| [Input Schema] (入力スキーマ)および[Edit schema] (スキーマを編集) | <ul> <li> <p>スキーマとは行の説明のことです。処理して次のコンポーネントに渡すフィールド(カラム)数を定義します。Sparkジョブを作成する場合、フィールドの命名時は予約語の<kbd>line</kbd>を避けます。</p> <p>スキーマを変更するには<span>[Edit schema] (スキーマを編集)</span>をクリックします。現在のスキーマが<span>リポジトリー</span>タイプの場合は、3つのオプションを利用できます。</p> <ul> <li> <p> <span>[View schema] (スキーマを表示)</span>: スキーマのみを表示する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Change to built-in property] (組み込みのプロパティに変更)</span>: ローカルで変更を行うためにスキーマを<span>組み込み</span>に変更する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Update repository connection] (リポジトリー接続をアップデート)</span>: リポジトリーに保存されているスキーマに変更を加え、変更後にそのコンテンツをすべてのジョブにプロパゲートするかどうかを決める場合は、このオプションを選択します。</p> <p>変更を現在のジョブにのみ反映する場合は、変更後、<span>[No] (いいえ)</span>を選択し、<span>[Repository Content] (リポジトリーコンテンツ)</span>ウィンドウで再びこのスキーマのメタデータを選択します。</p> </li> </ul> </li> <li> <p> <span>[Built-in] (組み込み)</span>: スキーマが作成され、このコンポーネント専用にローカルに保存されます。関連項目: 詳細は、<a href="https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/setting-built-in-schema-in-job" target="_blank">ジョブに組み込みスキーマを設定</a>をご覧ください。</p> </li> <li> <p> <span>[Repository] (リポジトリー)</span>: スキーマは既に存在し、リポジトリーに保存されています。したがって、再利用できます。関連項目:<a href="https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/setting-repository-schema-in-job" target="_blank">ジョブにリポジトリースキーマを設定</a>をご覧ください。</p> </li> </ul> |
| [Response Schema] (応答スキーマ)および[Edit schema] (スキーマを編集) | <ul> <li> <p>スキーマとは行の説明のことです。処理して次のコンポーネントに渡すフィールド(カラム)数を定義します。Sparkジョブを作成する場合、フィールドの命名時は予約語の<kbd>line</kbd>を避けます。</p> <p>スキーマを変更するには<span>[Edit schema] (スキーマを編集)</span>をクリックします。現在のスキーマが<span>リポジトリー</span>タイプの場合は、3つのオプションを利用できます。</p> <ul> <li> <p> <span>[View schema] (スキーマを表示)</span>: スキーマのみを表示する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Change to built-in property] (組み込みのプロパティに変更)</span>: ローカルで変更を行うためにスキーマを<span>組み込み</span>に変更する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Update repository connection] (リポジトリー接続をアップデート)</span>: リポジトリーに保存されているスキーマに変更を加え、変更後にそのコンテンツをすべてのジョブにプロパゲートするかどうかを決める場合は、このオプションを選択します。</p> <p>変更を現在のジョブにのみ反映する場合は、変更後、<span>[No] (いいえ)</span>を選択し、<span>[Repository Content] (リポジトリーコンテンツ)</span>ウィンドウで再びこのスキーマのメタデータを選択します。</p> </li> </ul> </li> <li> <p> <span>[Built-in] (組み込み)</span>: スキーマが作成され、このコンポーネント専用にローカルに保存されます。関連項目: 詳細は、<a href="https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/setting-built-in-schema-in-job" target="_blank">ジョブに組み込みスキーマを設定</a>をご覧ください。</p> </li> <li> <p> <span>[Repository] (リポジトリー)</span>: スキーマは既に存在し、リポジトリーに保存されています。したがって、再利用できます。関連項目:<a href="https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/setting-repository-schema-in-job" target="_blank">ジョブにリポジトリースキーマを設定</a>をご覧ください。</p> </li> </ul> |
| [Fault Schema] (フォールトスキーマ)および[Edit schema] (スキーマを編集) | <ul> <li> <p>スキーマとは行の説明のことです。処理して次のコンポーネントに渡すフィールド(カラム)数を定義します。Sparkジョブを作成する場合、フィールドの命名時は予約語の<kbd>line</kbd>を避けます。</p> <p>スキーマを変更するには<span>[Edit schema] (スキーマを編集)</span>をクリックします。現在のスキーマが<span>リポジトリー</span>タイプの場合は、3つのオプションを利用できます。</p> <ul> <li> <p> <span>[View schema] (スキーマを表示)</span>: スキーマのみを表示する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Change to built-in property] (組み込みのプロパティに変更)</span>: ローカルで変更を行うためにスキーマを<span>組み込み</span>に変更する場合は、このオプションを選択します。</p> </li> <li> <p> <span>[Update repository connection] (リポジトリー接続をアップデート)</span>: リポジトリーに保存されているスキーマに変更を加え、変更後にそのコンテンツをすべてのジョブにプロパゲートするかどうかを決める場合は、このオプションを選択します。</p> <p>変更を現在のジョブにのみ反映する場合は、変更後、<span>[No] (いいえ)</span>を選択し、<span>[Repository Content] (リポジトリーコンテンツ)</span>ウィンドウで再びこのスキーマのメタデータを選択します。</p> </li> </ul> </li> <li> <p> <span>[Built-in] (組み込み)</span>: スキーマが作成され、このコンポーネント専用にローカルに保存されます。関連項目: 詳細は、<a href="https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/setting-built-in-schema-in-job" target="_blank">ジョブに組み込みスキーマを設定</a>をご覧ください。</p> </li> <li> <p> <span>[Repository] (リポジトリー)</span>: スキーマは既に存在し、リポジトリーに保存されています。したがって、再利用できます。関連項目:<a href="https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/setting-repository-schema-in-job" target="_blank">ジョブにリポジトリースキーマを設定</a>をご覧ください。</p> </li> </ul> |
| Service Registryを使用 | このオプションは、Talend Enterprise ESBソリューションをサブスクライブしている場合のみ利用可能です。<br><br>このチェックボックスをオンにすると、Service Registryが有効になります。それによりダイナミックエンドポイントのルックアップが可能になり、レジストリーから取得された情報に基づいて、サービスのリダイレクトができるようになります。これはランタイムでのみ使用できます。<br><br>[Username] (ユーザー名)および[Password] (パスワード)フィールドに、認証情報を入力します。<br><br>SAMLトークンがService Registryに登録されている場合、[Role] (役割)フィールドでクライアントの役割を指定する必要があります。[Propagate Credentials] (認証情報のプロパゲート)チェックボックスをオンにし、既存の認証情報をプロパゲートすることで、認証済みユーザーの代わりに決断を下すこともできます。ユーザー名とパスワードを入力してSTSで認証し、ユーザー名とパスワードを使用してプロパゲートするか、またはエイリアス、ユーザー名、およびパスワードを入力し、証明書を使ってプロパゲートします。詳細は、[Use Authentication] (認証を使用)オプションをご覧ください。[Encryption/Signature body] (暗号化/署名本文)チェックボックスをオンにして、XML暗号化/XML署名を有効にします。詳細は、[XKMSサービス](https://help.qlik.com/talend/r/en-US/8.0/esb-infra-services-configuration-guide/xkms-service)をご覧ください。<br><br>[Correlation Value] (相関値)フィールドで、相関IDを指定するか、またはこのフィールドを空白のままにしておきます。詳細は、[Use Business Correlation] (ビジネス相関の使用)オプションをご覧ください。<br><br>Service Registryの設定方法と使い方は、[Setting up ESB Service Registry](https://help.qlik.com/talend/r/en-US/8.0/administration-center-user-guide/setting-up-esb-service-registry)と[Service Registry](https://help.qlik.com/talend/r/en-US/8.0/esb-infra-services-configuration-guide/service-registry)をご覧ください。 |
| Service Locatorを使用 | 要求およびサービスレベル合意(SLA)を満たすよう、サービスの可用性を維持します。<br><br>このオプションは、[Use Service Registry] (Service Registryを使用)チェックボックスがオンになっている場合は表示されません。 |
| [Use Service Activity Monitor] (サービスアクティビティモニタリングの使用) | このオプションにより、イベントがキャプチャーされ、それに関する情報が保存されて、サービスアクティビィティの詳細な分析とビジネストランザクションにおけるメッセージの追跡とトレースが行えます。これはサービス応答時間の分析、トラフィックパターンの特定、根本原因分析の実行などに使用できます。<br><br>Talend Enterprise ESBソリューションをサブスクライブしている場合、[Use Service Registry] (サービスレジストリーを使用)チェックボックスをオンにすることでもこのオプションは無効になります。 |
| [Use Authentication] (認証を使用) | 認証オプションを有効にするには、このチェックボックスをオンにします。Basic HTTP (基本HTTP)、[HTTP Digest] (HTTPダイジェスト)、[Username Token] (ユーザー名トークン)、[SAML Token (ESB runtime only)] (SAMLトークン(ESB Runtimeのみ))から選択します。必要に応じて、該当するフィールドにユーザー名およびパスワードを入力します。Basic HTTP (基本HTTP)、[HTTP Digest] (HTTPダイジェスト)、[Username Token] (ユーザー名トークン)による認証は、Talend Studioと Talend Runtimeの両方で機能します。[SAML Token] (SAMLトークン)による認証は実行時にのみ使用できます。<br><br>[SAML Token (ESB runtime only)] (SAMLトークン-ESB実行時のみ)を選択した場合、リクエストを送信するためにユーザーの認証情報を提供するか、または既存の認証情報をプロパゲートすることで、認証済みユーザーの代わりに決定を下すことができます。次の中から選択します:<br><br>-: 該当するフィールドにユーザー名とパスワードを入力して、サービスにアクセスします。<br><br>[Propagate using U/P] (U/Pを使ってプロパゲート): STSの認証に使用するユーザー名とパスワードを入力します。<br><br>[Propagate using Certificate] (証明書を使ってプロパゲート): STSの認証に使用するエイリアスとパスワードを入力します。<br><br>パスワードを入力するためには、パスワードフィールドの横にある[...]ボタンをクリックし、ポップアップダイアログボックスにパスワードを二重引用符で囲んで入力して[OK]をクリックし、設定を保存します。<br><br>このオプションは、[Use Service Registry] (Service Registryを使用)チェックボックスがオンになっている場合は表示されません。 |
| [Use Authorization] (認証サービスを使用) | このオプションは、Talend Enterprise ESBソリューションをサブスクライブしている場合のみ利用可能です。<br><br>このチェックボックスをオンにして、許可されたコールを有効にします。クライアントのロールを[Role] (ロール)フィールドに指定します。このオプションは、[Use Authentication] (認証を使用)リストで[SAML Token (ESB runtime only)] (SAMLトークン(ESB実行時のみ))を選択すると表示されます。<br><br>ユーザーのロールと権限の管理については、[Managing ESB Resources and authorization](https://help.qlik.com/talend/r/en-US/8.0/administration-center-user-guide/managing-esb-resources-and-authorizations)と[Talend Identity and Access Management](https://help.qlik.com/talend/r/en-US/8.0/esb-infra-services-configuration-guide/talend-identity-and-access-management)をご覧ください。 |
| [Encryption/Signature body] (暗号化/署名本文) | このチェックボックスをオンにして、XML暗号化/XML署名を有効にします。詳細は、[XKMSサービス](https://help.qlik.com/talend/r/en-US/8.0/esb-infra-services-configuration-guide/xkms-service)をご覧ください。<br><br>このオプションは、[Use Authentication] (認証を使用)リストで[SAML Token (ESB runtime only)] (SAMLトークン(ESB実行時のみ))を選択すると表示されます。 |
| [Use Business Correlation] (ビジネスコリレーションを使用) | このチェックボックスをオンにしてこのコンポーネントにコリレーションIDを作成します。<br><br>コリレーションIDは[Correlation Value] (コリレーション値)フィールドで指定できます。この場合、コリレーションIDはIDが呼び出すサービスに渡されます。その結果、連鎖型のサービスコールがこのコリレーションIDの下にまとめられます。このフィールドを空白にすると、実行時にこの値が自動的に生成されます。<br><br>このオプションを有効になっている場合、tESBConsumerは応答ヘッダーから相関IDを抽出し、それをフロー内での今後の使用のためにコンポーネント変数に保存します。<br><br>このオプションは、[Use Service Registry] (サービスレジストリーを使用)チェックボックスがオンになっている場合、自動的に有効になります。 |
| [Use GZip Compress] (GZip圧縮の使用) | このチェックボックスをオンにすると、送信する前に受信メッセージをGZip形式に圧縮できます。 |
| Die on error (エラー発生時に強制終了) | エラー発生時にジョブを強制終了するには、このチェックボックスをオンにします。 |

## 詳細設定

| プロパティ | 説明 |
| --- | --- |
| [Log messages] (ログメッセージ) | サービスプロバイダーとコンシューマーの間のメッセージ交換を記録するには、このチェックボックスをオンにします。 |
| [Service Locator Custom Properties] (カスタムプロパティ) | このテーブルは、[Use Service Locator] (サービスロケーターを使用)チェックボックスがオンになっている場合に表示されます。テーブルに必要な数だけ行を追加して、関連するプロパティをカスタマイズできます。[Property Name] (プロパティ名)フィールドと[Property Value] (プロパティ値)フィールドに、それぞれのプロパティの名前と値を二重引用符で囲んで入力します。 |
| [Service Activity Custom Properties] (サービスアクティビティのカスタムプロパティ) | このテーブルは、[Use Service Activity Monitor] (サービスアクティビティモニタリングの使用)チェックボックスがオンになっている場合に表示されます。テーブルに必要な数だけ行を追加して、関連するプロパティをカスタマイズできます。[Property Name] (プロパティ名)フィールドと[Property Value] (プロパティ値)フィールドに、それぞれのプロパティの名前と値を二重引用符で囲んで入力します。 |
| [Connection time out(second)] (接続タイムアウト(秒)) | Webサービス接続タイムアウトの値を秒単位で設定します。<br><br>このオプションは、Talend Studioでのみ機能します。実行時にコンポーネントがデプロイされた後にそれを使用するには:<br><br><ol> <li> <p>&lt;TalendRuntimePath&gt;/container/etc /フォルダーに名前<span>org.apache.cxf.http.conduits-&lt;endpoint_name&gt;.cfg</span>を持つ設定ファイルを作成します。</p> </li> <li> <p>Webサービスの<span>url</span>と<span>client.ConnectionTimeout</span>パラメーターを設定ファイルにミリ秒単位で指定します。<span>[Receive time out] (受信タイムアウト)</span>オプションを使用する必要がある場合は、<span>client.ReceiveTimeout</span>もミリ秒で指定してください。<span>url</span>には、完全なエンドポイントアドレス、またはワイルドカードを含む正規表現を指定できます。たとえば、次のようになります。</p> <pre><code><pre><code><code>url = http://localhost:8040/*client.ConnectionTimeout=10000000client.ReceiveTimeout=20000000</code></code></pre></code></pre> <p>この場合、<span>http://localhost:8040/*</span>は、<span>http://localhost:8040/</span>で始まるすべてのURLとマッチします。</p> </li> </ol> |
| [Receive time out(second)] (受信タイムアウト(秒)) | サーバー応答の値を秒単位で設定します。<br><br>このオプションは、Talend Studioでのみ機能します。コンポーネントが実行時にデプロイされた後にそれを使用する方法については、[Connection time out] (接続タイムアウト)オプションをご覧ください。 |
| [Disable Chunking] (チャンクの無効化) | payloadのチャンクエンコードを無効にする場合は、このチェックボックスをオンにします。通常、ストリーミングは直接実行されるため、チャンクはより有効に機能します。しかし、チャンクが有効な状態でペイロードが切り詰められる場合があります。サービスとの連携時に奇妙なエラーが発生する場合は、チャンクをオフにして、それが機能するかどうかご確認ください。 |
| [Trust server with SSL] (SSLを使用したTrustサーバー)/[TrustStore file] (TrustStoreファイル)と[TrustStore password] (TrustStoreパスワード) | このチェックボックスをオンにすると、SSLプロトコルを使用してサーバー証明書についてクライアントに対して検証を行い、対応するフィールドに入力できます。<br><br>[TrustStore file] (トラストストアファイル): クライアントが信頼する証明書のリストを含む証明書トラストストアファイルへのパス(ファイル名を含む)を入力します。<br><br>[TrustStore password] (トラストストアパスワード): トラストストアデータの整合性チェックに使用するパスワードを入力します。 |
| [Use http proxy/Proxy host] (httpプロキシ/プロキシホストを使用)、[Proxy port] (プロキシポート)、[Proxy user] (プロキシユーザー)、および[Proxy password] (プロキシパスワード) | プロキシサーバーを使用している場合は、このチェックボックスをオンにして、必要な情報を入力します。<br><br>パスワードを入力するためには、パスワードフィールドの横にある[...]ボタンをクリックし、ポップアップダイアログボックスにパスワードを二重引用符で囲んで入力して[OK]をクリックし、設定を保存します。 |
| [HTTP Headers] (HTTPヘッダー) | リクエストされたHTTP操作のパラメーターを定義するために、HTTPヘッダーの名前/値ペアを追加するのに必要な数だけ[+]をクリックします。 |
| [tStatCatcher Statistics] (tStatCatcher統計) | このチェックボックスを選択すると、ジョブレベルやコンポーネントレベルでジョブ処理メタデータが収集されます。 |

## グローバル変数

| 変数 | 説明 |
| --- | --- |
| グローバル変数 | NB\_LINE: 処理された行の数。これはAfter変数で、整数を返します。<br><br>CORRELATION\_ID: チェーンされたサービス呼び出しがグルーピングされるコリレーションID。これはFlow変数で、文字列を返します。<br><br>ERROR\_MESSAGE: エラーが発生した時にコンポーネントによって生成されるエラーメッセージ。これはAfter変数で、文字列を返します。この変数はコンポーネントにこのチェックボックスが存在し、[Die on error] (エラー発生時に強制終了)がオフになっている場合のみ機能します。<br><br>HTTP\_RESPONSE\_CODE: HTTPレスポンスステータスコード。これはAfter変数で、整数を返します。<br><br>HTTP\_HEADERS: レスポンスからのHTTPヘッダーのセット。これはFlow変数で、マップオブジェクトjava.util.Map&lt;String, java.util.List&lt;?&gt;&gt;を返します。ヘッダー名はマップキーで表されます。ヘッダー値はjava.util.List&lt;?&gt;で表されます。<br><br>Flow変数はのコンポーネントの実行中に機能し、After変数はコンポーネントの実行後に機能します。<br><br>フィールドまたは式に変数を入力する場合は、Ctrl + スペースを押して変数リストにアクセスし、使用する変数を選択します。<br><br>変数の詳細は、[コンテキストと変数を使用](https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/contexts-and-variables)をご覧ください。 |

## 使用方法

| 使用方法のガイダンス | 説明 |
| --- | --- |
| **使用ルール** | このコンポーネントは、中間コンポーネントとして使用できます。出力コンポーネントにリンクしている必要があります。 |
| [Dynamic settings] (ダイナミック設定) | [+]ボタンをクリックしてテーブルに行を追加し、[Code] (コード)フィールドにコンテキスト変数を入力して、[Use Authentication] (認証を使用)または[Use HTTP proxy] (HTTPプロキシの使用)オプションがランタイムにダイナミックにオンまたはオフになるようにします。テーブルに行を2つ追加すれば、両方のオプションを設定できます。<br><br>ダイナミックパラメーターを定義すると、[Basic settings] (基本設定)ビューまたは[Advanced settings] (詳細設定)ビューで対応するオプションがハイライトされ、利用できなくなります。<br><br>ダイナミックパラメーターの定義法を示すユースケースについては、[コンテキストベースのダイナミック接続によってデータベースからデータを読み取り](https://help.qlik.com/talend/r/ja-JP/8.0/components/defining-context-groups/reading-data-from-databases-through-context-based-dynamic-connections)と、[ダイナミックにロードされた接続パラメーターを使って異なるMySQLデータベースからデータを読み取り](https://help.qlik.com/talend/r/ja-JP/8.0/components/context/reading-data-from-different-mysql-databases-using-dynamically-loaded-connection-parameters)をご覧ください。ダイナミック設定とコンテキスト変数の詳細は、[ダイナミックスキーマ](https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/dynamic-schema)と[コンテキストグループを作成し、その中でコンテキスト変数を定義](https://help.qlik.com/talend/r/ja-JP/8.0/studio-user-guide/creating-context-group-and-define-context-variables-in-it)をご覧ください。 |
| [Limitation] (制限事項) | このコンポーネントを動作させるには、JDKが必要です。 |

**関連概念**

[国コードに基づいて空港名をリクエスト](https://help.qlik.com/talend/ja-JP/components/8.0/esb-soap/tesbconsumer-tesbproviderfault-tmap-requesting-airport-names-based-on-country-codes-standard-component-esb-this)

[Hello World応答を返す](https://help.qlik.com/talend/ja-JP/components/8.0/esb-soap/tesbconsumer-tesbproviderrequest-tfixedflowinput-returning-hello-world-response-standard-component-esb-the)

[応答を期待せずにメッセージを送信](https://help.qlik.com/talend/ja-JP/components/8.0/esb-soap/tesbconsumer-tesbproviderrequest-tlogrow-tfixedflowinput-sending-message-without-expecting-response-standard-component-esb-the)

[カスタムSOAPヘッダーでのtESBConsumerの使用](https://help.qlik.com/talend/ja-JP/components/8.0/esb-soap/tesbconsumer-txmlmap-tfixedflowinput-tlogrow-using-tesbconsumer-with-custom-soap-headers-standard-component-this)