ローカル環境のツリー構造

ローカル環境ツリーは、メッセージ・フローがメッセージを処理する際に、情報を保管できる論理メッセージ・ツリーの一部です。

ローカル環境ツリーのルートは、LocalEnvironment と呼ばれています。 このツリーは入力メッセージ内に必ず存在し、メッセージが入力ノードによって受信される際に作成されます。 ローカル環境フィールドを作成する入力ノードもあれば、ツリーを空のままにするノードもあります。

ローカル環境ツリーは、以下のような構造をしています。
  • LocalEnvironment.Destination.output_or_request_node_name という形式 (例えば、LocalEnvironment.Destination.Email) のものはすべて、情報が出力ノードまたは要求ノード内に送られたときに何が起こるかを決定します。
  • LocalEnvironment.WrittenDestination.output_or_request_node_name という形式 (例えば、LocalEnvironment.WrittenDestination.FTE) のものはすべて、処理済みの出力ノードまたは要求ノードに関する情報を提供します。
  • LocalEnvironment.input_node_name.input という形式 (例えば、LocalEnvironment.Adapter.Input) のものはすべて、入力ノードによって保管された情報を含んでいます。

ローカル環境ツリーを使用して、メッセージ・フローの後の方で生じる、メッセージ処理ノードが参照および更新できる変数を保管します。 また、ローカル環境ツリーを使用して、メッセージを送信する宛先 (メッセージ・フローの内部でも外部でもよい) を定義することができます。 また、 IBM® Integration Bus は、状況によっては LocalEnvironment に情報を保管し、宛先に設定した値にアクセスするためにその情報を参照します。 (統合ノードが特定の状況の場合にのみ使用する環境ツリー構造と比較してください。)

下図は、ローカル環境のツリー構造の例を示しています。 Destination の子は、プロトコルによって異なります。

図は、提供された入力ノードおよびパーサーによって作成されたローカル環境ツリー構造を示しています。

ツリー構造では、LocalEnvironment には次のような子があります。

LocalEnvironment.Variables
このサブツリーはオプションです。 ローカル環境変数を作成する場合、それらを Variables と呼ばれるサブツリーに保管します。 これは、ノード間で情報を受け渡すために使用できる作業域を提供します。 このサブツリーは、提供されたノードによって検査されたり変更されたりすることは決してありません。

ローカル環境の変数は、後続の任意のメッセージ処理ノードによって変更することが可能であり、変数はそれを作成したノードが有効範囲の外に出るまで持続します。

このサブツリー内の変数は、メッセージ・フローの単一インスタンス内でのみ持続します。 メッセージ・フローを通過するメッセージの複数インスタンスがあり、それらの間で情報を受け渡す必要がある場合には、外部データベースを使用する必要があります。

LocalEnvironment.Destination
図は、以下のテキストで説明されている宛先サブツリーを示しています。
このサブツリーは、メッセージの送信先のトランスポート・タイプ (トランスポート ID) を示すいくつかの子、または ラベルにルーティング ノードによって使用されるターゲット 表示名 ノードで構成されます。
  • トランスポート情報

    トランスポート情報は、FTE、HTTP、ファイル、E メール、SOAP、 MQ、JMS、TCPIP、CORBA、CICS ®、および MQTTなど、一部の入出力ノードで使用されます。

    ローカル環境 .Destination.FTE

    メッセージ・フローに FTE 出力 ノードが含まれている場合は、このサブツリーのエレメントでそのプロパティーを指定変更できます。 ファイル・ノードでのローカル環境変数の使用を参照してください。

    LocalEnvironment.Destination.HTTP

    メッセージ・フローが HTTP 入力 ノードで開始される場合、単一の名前エレメント HTTP が宛先に追加されます。 エレメント HTTP.RequestIdentifier が作成され、 HTTP 応答 ノードで使用できるように初期化されます。 HTTP 要求 ノードで使用するその他のフィールド (要求の送信先のサービスの URL など) を HTTP 構造内に作成することもできます。 詳しくは、 HTTPRequest ノードのトピックの ローカル環境のオーバーライド 、および ローカル環境ツリーでの宛先へのデータの取り込みの例を参照してください。

    LocalEnvironment.Destination.File

    メッセージ・フローに ファイル出力 ノードが含まれている場合は、その ディレクトリー および 名前 プロパティーを、このサブツリーのエレメントで指定変更できます。 ファイル・ノードでのローカル環境変数の使用を参照してください。

    LocalEnvironment.Destination.Email

    メッセージ・フローに E メール出力 ノードが含まれている場合、このサブツリーで定義されている情報は、ノードによって送信される各 E メールに関連付けられている SMTP サーバー接続情報および添付ファイルを指定またはオーバーライドします。 送信する E メールに含めるために複数の添付ファイルを (添付ファイル名、内容、およびタイプの仕様を含め)、指定することができます。 EmailOutput ノードを参照してください。

    LocalEnvironment.Destination.SOAP

    アウトバウンド WS-Addressing ヘッダー情報をローカル環境に配置して、 _ 翻訳不要 _SOAPReply、 SOAP 要求、または SOAPAsync要求 ノードによって生成されるデフォルトをオーバーライドすることができます。 ローカル環境での WS-Addressing 情報を参照してください。

    メッセージ・フローに SOAP 要求 ノードまたは SOAPAsync要求 ノードが含まれている場合は、このサブツリーでそれらのノードの HTTP トランスポート および JMS トランスポート プロパティーをオーバーライドできます。 SOAPRequest ノード、 SOAPAsyncRequest ノード、または SOAPRequest ノードのローカル環境の指定変更を参照してください。

    メッセージ・フローに SOAPAsync要求 ノードが含まれている場合、このサブツリーを使用して、状態および相関情報を別のメッセージ・フロー内の SOAPAsync応答 ノードに渡すことができます。 SOAPAsyncRequest ノードおよび SOAPAsyncResponse ノードを使用した WS-Addressingを参照してください。

    メッセージ・フローに _ 翻訳不要 _SOAPReply、 SOAP 要求、または SOAPAsync要求 ノードが含まれている場合は、このサブツリーでのアウトバウンド MTOM メッセージの使用をオーバーライドできます。 SOAP MTOM と SOAPReply、SOAPRequest、および SOAPAsyncRequest ノードを参照してください。

    LocalEnvironment.Destination。MQ

    メッセージ・フローに MQOutput ノードが含まれている場合、各エレメントは名前エレメント MQ ( MQDestinationListという非推奨の代替エレメントが存在します。 新規のメッセージ・フローではすべて、MQ を使用してください。) 複数のエレメントが存在する場合には、それぞれノードによって順次処理されます。 ローカル環境ツリーでの宛先へのデータの取り込みの例を参照してください。

    プロパティー 宛先モード を 宛先リストに設定することにより、宛先のリストを調べ、それらの宛先にメッセージを送信するように MQOutput ノードを構成できます。 そうする場合には、このサブツリーとその内容を、それらの宛先を定義するように作成し、それに Destination という名前を付ける必要があります。 これを行わないと、 MQOutput ノードはメッセージを配信できません。

    必要に応じて、プロパティー 宛先モード を キュー名 または 応答先キューに設定することにより、単一の固定宛先にメッセージを送信するように MQOutput ノードを構成できます。 これらの固定オプションのいずれかを選択した場合、宛先リストは統合ノード操作に対して何の影響も与えず、このサブツリーを作成する必要もありません。

    MQ エレメントは、単一オプションの Defaults エレメントを含むように構成することができます。 Defaults エレメントは、それが作成される場合には、最初の子でなければならず、メッセージ宛先およびその親に対する PUT オプションのデフォルト値を与える、名前値エレメントのセットを含んでいる必要があります。

    MQ 内に DestinationData と呼ばれるエレメントを多数作成することもできます。 これらのそれぞれは、メッセージ宛先およびその PUT オプションを定義する、名前値エレメントのセットによってセットアップすることができます。

    宛先を定義するエレメントのセットについては、 MQ DestinationData サブツリーのエレメントのデータ・タイプで説明しています。

    DestinationData のそれぞれのインスタンスの内容は、それぞれのプロトコルごとの Defaults の内容と同じものであり、Defaults 内のデフォルト値を指定変更するために使用できます。 すべての宛先に共通の値を含むために Defaults をセットアップし、それぞれの DestinationData サブツリーに固有な値だけを設定できます。 DestinationData または Defaults のどちらにも値を設定しない場合、対応するノード・プロパティーに設定していた値が使用されます。 同様に、フィールド名または値のスペルまたは大/小文字を間違えて指定すると、その名前または値は無視され、対応するノード・プロパティーに設定していた値が使用されます。

    DestinationData に挿入する情報は、対応するノード・プロパティーの特性によって異なります。この情報については、 ローカル環境ツリーへのアクセスで説明しています。

    LocalEnvironment.Destination.JMSDestinationList

    _ 翻訳不要 _JMSOutput ノードは、変換ノードによってローカル環境で作成された宛先リストを使用して、複数の JMS キューに送信したり、複数の JMS トピックにパブリッシュしたりするように構成できます。

    _ 翻訳不要 _JMSOutput ノードは、Destination.JMSDestinationList フォルダーの下にある DestinationData というデータ・エレメントをローカル環境で検索します。 そのノードは JMS メッセージを、そのフォルダー内にある各 DestinationData エントリーに送信します。 ローカル環境ツリーでの宛先へのデータの取り込みの例を参照してください。

    ローカル環境 .Destination.TCPIP

    メッセージ・フローに TCPIPClientOutput ノードまたは TCP/IP サーバー出力 ノードが含まれている場合は、このサブツリーのエレメントで TCPIP 接続をオーバーライドできます。 TCPIPClientOutput ノード および TCPIPServerOutput ノードを参照してください。

    ローカル環境 .Destination.CORBA

    メッセージ・フローに CORBA 要求 ノードが含まれている場合、以下の場所で値を指定することにより、その 操作名 プロパティーを指定変更できます。
    $LocalEnvironment/Destination/CORBA/Request/OperationName
    操作名について詳しくは、 CORBARequest ノードを参照してください。

    LocalEnvironment.Destination.CICS の

    メッセージ・フローに CICS要求 ノードが含まれている場合は、このサブツリーのエレメントで以下のプロパティーを指定変更できます。
    • プログラム名
    • 通信域の長さ
    • ミラー・トランザクション ID
    • EIBTRNID のみを設定
    • メッセージ・ドメイン
    • メッセージ・セット
    • メッセージ・タイプ
    • メッセージ形式
    • メッセージ・コード化文字セット ID
    • メッセージ・エンコード
    詳しくは、 CICSRequest ノードのローカル環境の指定変更を参照してください。

    「CICS」 チャネルおよびコンテナーの LocalEnvironment 値を設定することもできます。 詳しくは、 COMMAREA またはチャネル・データ構造を参照してください。

    LocalEnvironment.Destination.MQTT.Output

    メッセージ・フローに MQTTPublish ノードが含まれている場合は、このサブツリーのエレメントで以下のプロパティーを指定変更できます。
    • Retained
    • トピック名
    • サービスの品質
    詳しくは、 MQTT ノードでのローカル環境変数の使用を参照してください。

    LocalEnvironment.Destination.Loopback

    メッセージ・フローに ループバック要求 ノードが含まれている場合は、このサブツリーのエレメントでそれらのノードのプロパティーを指定変更できます。 詳しくは、 LoopBackRequest ノードでのローカル環境変数の使用を参照してください。

    LocalEnvironment.Destination.Salesforce

    メッセージ・フローに SalesforceRequest ノードが含まれている場合は、このサブツリーのエレメントでそれらのノードのプロパティーを指定変更できます。 詳しくは、 Salesforce ノードでのローカル環境変数の使用を参照してください。

    LocalEnvironment.Destination.REST

    メッセージ・フローに RESTRequest ノードまたは RESTA 同期要求 ノードが含まれている場合は、このサブツリーのエレメントでそれらのノードのプロパティーを指定変更できます。 詳しくは、 REST ノードでのローカル環境変数の使用を参照してください。

    LocalEnvironment.Destination。Kafka

    メッセージ・フローに カフカプロデューサー ノードが含まれている場合は、このサブツリーのエレメントでノードのプロパティーを指定変更できます。 詳しくは、 Kafka ノードでのローカル環境変数の使用を参照してください。

  • ルーティング情報

    Destination の子は RouterList です。 これには DestinationData と呼ばれる単一の子エレメントがあります。それには、labelName という単一記入項目があります。 ラベルにルーティング ノードと 表示名 ノードを含む動的ルーティング・シナリオを使用する場合は、参照ラベルを含む RouterList を使用して Destination サブツリーをセットアップする必要があります。

LocalEnvironment.WrittenDestination
図は、以下のテキストで説明されている、書き込まれた宛先サブツリーを示しています。
このサブツリーには、メッセージが書き込まれたアドレスが含まれています。 その名前は固定しており、要求、出力、または Reply ノードの Out ターミナルを介してメッセージが伝搬される際に、メッセージ・フローによって作成されます。 サブツリーには、トランスポート固有の情報が含まれます (例えば、出力メッセージが WebSphere® MQ キューに書き込まれた場合は、キュー・マネージャーとキュー名が含まれます)。
以下のいずれかの方式を使用して、ノードによって送信された後のメッセージに関する詳細情報を取得できます。
  • 変換ノードを Out ターミナルに接続してください。
  • ユーザー出口の活用で説明されているように、出力メッセージ・コールバック・イベントを処理するようにユーザー出口を構成します。

WrittenDestination 情報をサポートする各ノードのトピックには、ノードに含まれるデータに関する詳細情報が含まれています。

LocalEnvironment.File
このサブツリーには、 ファイル入力 ノードによって保管される情報が含まれます。

この情報にはファイルについて記述されていて、現行レコードについてのデータも含まれます。

このサブツリーに保管される情報について詳しくは、 ファイル・ノードでのローカル環境変数の使用を参照してください。

LocalEnvironment.SOAP
このサブツリーには、 SOAP 入力、 SOAPAsync応答、または SOAP 要求 ノードによって保管される情報が含まれます。

このサブツリーに保管される情報について詳しくは、 ローカル環境での WS-Addressing 情報を参照してください。

メッセージ・フローに SOAPAsync応答 ノードが含まれている場合、このサブツリーを使用して、別のメッセージ・フローの SOAPAsync要求 ノードによって渡される状態および相関情報を受け取ることができます。

このサブツリーに保管される情報について詳しくは、 SOAPAsyncRequest ノードおよび SOAPAsyncResponse ノードを使用した WS-Addressingを参照してください。

LocalEnvironment.ServiceRegistry
このサブツリーには、 エンドポイント・ルックアップ および 登録ルックアップ ノードによる照会の情報が含まれます。

このサブツリーに保管される情報について詳しくは、 検索条件の動的定義、 EndpointLookup ノード出力、および RegistryLookup ノード出力を参照してください。

LocalEnvironment.Wildcard
このサブツリーには、 ファイル入力 ノードによって保管されるワイルドカード文字に関する情報が含まれます。

ファイル入力 ノードでは、ワイルドカード文字を含むファイル名パターンを指定できます。

このサブツリーに保管される情報について詳しくは、 ファイル・ノードでのローカル環境変数の使用を参照してください。

LocalEnvironment.Adapter
このサブツリーには、 WebSphere Adapters ノードによって保管される情報が含まれます。
WebSphere Adapters 入力ノードの場合:
  • MethodName は、このメッセージ・デリバリーを起動した、エンタープライズ情報システム (EIS) イベントに対応するビジネス・メソッドの名前です。

    EIS イベントまたはビジネス・メソッドのバインディングは、「アダプター接続」ウィザードによって作成されます。

  • Type は、使用されているアダプターの以下のタイプについて説明します。
    • SAP
    • Siebel
    • PeopleSoft
    • JD Edwards

WebSphere Adapters 要求ノードの場合:

MethodName は、要求ノードが使用しなければならないビジネス・メソッドの名前です。

LocalEnvironment.TCPIP

メッセージ・フローに TCP/IP クライアント受信 ノードまたは TCPIP サーバー受信 ノードが含まれている場合は、このサブツリーのエレメントで TCPIP 接続をオーバーライドできます。 TCPIPClientReceive ノード および TCPIPServerReceive ノードを参照してください。

このサブツリーには、 TCPIPClientInput、 TCP/IP クライアント受信、 TCPIP サーバー入力、および TCPIP サーバー受信 ノードによって保管される情報が含まれます。

この情報は、ノードが使用している接続を説明します。

このサブツリーに保管される情報について詳しくは、 TCPIPClientInput ノード、 TCPIPClientReceive ノード、 TCPIPServerInput ノード、および TCPIPServerReceive ノードを参照してください。

LocalEnvironment.FTE と LocalEnvironment.FTE.Transfer
これらのサブツリーには、 FTE 入力 ノードによって保管される情報が含まれます。 LocalEnvironment.FTE サブツリーに入っているのは、現行レコードに関する情報です。 LocalEnvironment.FTE.Transfer サブツリーには、ファイルに関して WebSphere MQ File Transfer Edition から受け取った情報が含まれます。

これらのサブツリーに保管される情報について詳しくは、 ファイル・ノードでのローカル環境変数の使用を参照してください。

LocalEnvironment.CD および LocalEnvironment.CD.Transfer
これらのサブツリーには、 CD 入力 ノードによって保管される情報が含まれます。 LocalEnvironment.CD サブツリーに入っているのは、現行レコードに関する情報です。 LocalEnvironment.CD.Transfer サブツリーには、ファイルに関して IBM Sterling Connect:Direct® から受け取った情報が含まれます。

これらのサブツリーに保管される情報について詳しくは、 ファイル・ノードでのローカル環境変数の使用を参照してください。

LocalEnvironment.Database
このサブツリーには、 データベース入力 ノードから伝搬される情報が含まれます。

LocalEnvironment.Database.Input.Event.Usr サブツリーには、イベントに関連するユーザー定義のデータが含まれます。 このデータは、DatabaseInput ノードに関連する ESQL モジュールの ReadEvents プロシージャーで初期化されます。

LocalEnvironment.Database.Input.Event.Key は、イベントの固有キーを保持します。 このキーは、DatabaseInput ノードに関連する ESQL モジュールの ReadEvents プロシージャーで設定されます。

LocalEnvironment.Database.Input.Event.FailureCount には、イベントを処理しようとして失敗した回数の値が保持されます。 この回数には、ESQL モジュール内、またはメッセージ・フロー内で発生する未処理の例外がすべて含まれます。

LocalEnvironment.DecisionServices
このサブツリーには、 意思決定サービス ノードから呼び出される意思決定サービスに関する情報が含まれます。

ローカル環境では、決定サービスに関する情報 (決定サービスによって処理されるメッセージによって突き合わせされる規則の数など) が示されます。

このサブツリーに保管される情報について詳しくは、 DecisionService ノードを参照してください。

LocalEnvironment.JMS
このサブツリーには、 JMS 受信 ノードによって保管される情報が含まれます。

メッセージ・フローに JMS 受信 ノードが含まれている場合は、このサブツリーのエレメントで JMS 接続プロパティーを指定変更できます。

このサブツリーに保管されるこの情報について詳しくは、 JMSReceive ノードのローカル環境の指定変更を参照してください。

LocalEnvironment.Mapping
このサブツリーには、 マッピング ノードによって保管される情報が含まれます。

メッセージ・フローに マッピング ノードが含まれている場合、 マッピン・ルーチン フィールドに新しいマッピング・ルーチンを指定することによって、メッセージ・インスタンスの変換に使用されるマッピング・ルーチンをオーバーライドできます。 変更する必要がある マッピング ノードのアップストリームである LocalEnvironment.Mapping サブツリーで新規マッピング・ルーチンを指定する必要があります。

LocalEnvironment.REST

このサブツリーには、REST API が要求を受け取ってその要求を REST API 内の操作を実装するサブフローに経路指定するときに、REST API が格納する情報が含まれます。 詳しくは、 メッセージ・フロー・ノードを使用したサブフローでの REST API 操作処理の実装を参照してください。

このサブツリーには、 RESTA 同期要求 ノードによって開始された要求に対する応答を受信したときに RESTA 同期応答 ノードによって保管される情報も含まれます。 詳しくは、 REST ノードでのローカル環境変数の使用を参照してください。

LocalEnvironment.Kafka

このサブツリーには、メッセージがパブリッシュされたトピックに関する情報など、 カフカコンシューマー ノードによって保管される情報が含まれます。 このサブツリーに含まれる情報について詳しくは、 Kafka ノードでのローカル環境変数の使用を参照してください。

メッセージ・フロー処理が完了すると、ローカル環境ツリーは廃棄されます。