IBM CTG Connector リファレンス - Mule 4

IBM CICS Transaction Gateway Connector バージョン 2.3

IBM CICS Transaction Gateway 用 Anypoint Connector (IBM CTG Connector) は、CICS Transaction Gateway を使用してバックエンド CICS アプリケーションとの統合を実現します。

設定


設定

パラメーター

名前 説明 デフォルト値 必須

Name (名前)

String (文字列)

この設定の名前。コネクタはこの名前の設定を参照します。

x

Connection (接続)

この設定に指定する接続型。

x

Expiration Policy (有効期限ポリシー)

動的設定インスタンスがアイドル状態を続けられる最小時間を設定します。この時間が経過すると、Runtime で期限切れに相当するとみなされます。これは、インスタンスが有効期限の対象となった瞬間にプラットフォームでそのインスタンスが期限切れになるということではありません。ランタイムによって適切と判断されたときに、インスタンスがパージされます。

接続種別

Connection (接続)
パラメーター
名前 説明 デフォルト値 必須

Host (ホスト)

String (文字列)

localhost

Port (ポート)

String (文字列)

2006

Server name (サーバー名)

String (文字列)

x

Username (ユーザー名)

String (文字列)

x

Password (パスワード)

String (文字列)

x

Keystore location (キーストアの場所)

String (文字列)

SSL 接続に必要な証明書が格納されたキーストア。

Keystore Password (キーストアパスワード)

String (文字列)

SSL 接続用のキーストアにアクセスするために必要なパスワード。

Connection Timeout (接続タイムアウト)

Number (数値)

CICS TG への接続時のソケット接続タイムアウト値を設定します。このタイムアウトは、管理される接続試行が成功してリモートゲートウェイデーモンとのソケット接続が開かれるまでの最大時間 (ミリ秒) を表します。ローカルゲートウェイインスタンスへの接続試行では、タイムアウトは無視されます。0 はタイムアウトなしを意味します。

0

Response Timeout (応答タイムアウト)

Number (数値)

CICS TG への接続時の応答タイムアウト値を設定します。このタイムアウトは、管理される接続試行が要求への応答を待機する最大時間 (ミリ秒) を表します。0 はタイムアウトなしを意味します。

30000

CTG Trace (CTG トレース)

Boolean (ブール)

CTG トレースのすべてのレベルをオンまたはオフにします。

false

Reconnection (再接続)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Pooling Profile (プーリングプロファイル)

接続プールの特性。

操作

Create Channel And Content Instance

<ibmctg:create-channel-and-content-instance>

Execute with Multiple channels​ 操作の入力リストで使用する ChannelAndContent のインスタンスを作成します。

パラメーター

名前 説明 デフォルト値 必須

Content (コンテンツ)

Binary (バイナリ)

CICS プログラムに渡す入力データ。

x

Request

CTG への要求の詳細 (プログラム名、TPN、エンコード、チャネル名とそのコンテナ (要求、応答、およびエラー) など) を含む ChannelRequest。

x

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

スロー

  • IBMCTG:AEI0

  • IBMCTG:CONNECTION_ERROR

  • IBMCTG:CONNECTIVITY

  • IBMCTG:ECI_ERR_INVALID_CALL_TYPE

  • IBMCTG:ECI_ERR_NO_CICS

  • IBMCTG:ECI_ERR_SECURITY_ERROR

  • IBMCTG:ECOM

  • IBMCTG:ERR_GATEWAY

  • IBMCTG:IBMCCExecution

  • IBMCTG:REQUEST_ERROR

  • IBMCTG:RESOURCE

  • IBMCTG:SERVER_ERROR

  • IBMCTG:TRANSACTION

  • IBMCTG:UNKNOWN

Execute

<ibmctg:execute>

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Content (コンテンツ)

Binary (バイナリ)

#[payload]

Channel Request (チャネル要求)

x

Transactional Action (トランザクションアクション)

Enumeration (列挙)。次のいずれかになります。

  • ALWAYS_JOIN​

  • JOIN_IF_POSSIBLE​

  • NOT_SUPPORTED

トランザクションに関する操作で実行できる結合アクションの種別。

JOIN_IF_POSSIBLE

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Binary (バイナリ)

次の設定の場合

スロー

  • IBMCTG:AEI0

  • IBMCTG:CONNECTION_ERROR

  • IBMCTG:CONNECTIVITY

  • IBMCTG:ECI_ERR_INVALID_CALL_TYPE

  • IBMCTG:ECI_ERR_NO_CICS

  • IBMCTG:ECI_ERR_SECURITY_ERROR

  • IBMCTG:ECOM

  • IBMCTG:ERR_GATEWAY

  • IBMCTG:IBMCCExecution

  • IBMCTG:REQUEST_ERROR

  • IBMCTG:RESOURCE

  • IBMCTG:RETRY_EXHAUSTED

  • IBMCTG:SERVER_ERROR

  • IBMCTG:TRANSACTION

  • IBMCTG:UNKNOWN

Execute Using COMMAREA

<ibmctg:execute-using-commarea>

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Content (コンテンツ)

Binary (バイナリ)

#[payload]

Commarea Request Type (COMMAREA 要求種別)

x

Transactional Action (トランザクションアクション)

Enumeration (列挙)。次のいずれかになります。

  • ALWAYS_JOIN​

  • JOIN_IF_POSSIBLE​

  • NOT_SUPPORTED

トランザクションに関する操作で実行できる結合アクションの種別。

JOIN_IF_POSSIBLE

Streaming Strategy (ストリーミング戦略)

反復可能なストリームを使用するように設定します。

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Binary (バイナリ)

次の設定の場合

スロー

  • IBMCTG:AEI0

  • IBMCTG:CONNECTION_ERROR

  • IBMCTG:CONNECTIVITY

  • IBMCTG:ECI_ERR_INVALID_CALL_TYPE

  • IBMCTG:ECI_ERR_NO_CICS

  • IBMCTG:ECI_ERR_SECURITY_ERROR

  • IBMCTG:ECOM

  • IBMCTG:ERR_GATEWAY

  • IBMCTG:IBMCCExecution

  • IBMCTG:REQUEST_ERROR

  • IBMCTG:RESOURCE

  • IBMCTG:RETRY_EXHAUSTED

  • IBMCTG:SERVER_ERROR

  • IBMCTG:TRANSACTION

  • IBMCTG:UNKNOWN

Execute With Multiple Channels

<ibmctg:execute-with-multiple-channels>

チャネルとコンテナ内にカプセル化されたデータを送信するリモート CICS プログラムをコールし、ユーザーが 1 回の要求で 32 KB を超えるデータを転送できるようにします。

コンテナは、あらゆる形式のアプリケーションデータを保持できる CICS が管理するストレージ領域への名前付き参照です。コンテナはアプリケーションで必要とされるあらゆる形式のデータを保持でき、使用可能なストレージの量によってのみ制限されます。アプリケーションは任意の数のコンテナを参照できます。

チャネルは、コンテナのコレクションへの一意の名前付き参照です。これは COMMAREA と似ていますが、その制約を受けません。プログラムはプログラム間で 1 つのチャネルを渡すことができます。チャネルはパラメーターリストと考えることができます。プログラム間で同じチャネルを渡すことができます。

チャネルとプログラムは、それらを作成したプログラムと、それらが渡されたプログラムのみが参照できます。このプログラムが終了すると、CICS はコンテナとそのストレージを自動的に削除します。これらを復元することはできません。復元可能なコンテナを使用する必要がある場合、CICS BTS コンテナを使用します。

パラメーター

名前 説明 デフォルト値 必須

Configuration (設定)

String (文字列)

使用する設定の名前。

x

Channel And Contents (チャネルおよびコンテンツ)

チャネルと、CTG への要求の詳細 (プログラム名、TPN、エンコード、チャネル名とそのコンテナ (要求、応答、およびエラー) など) の 1 つ以上のペアを含む ChannelAndContent の java.util.List。

#[payload]

Transactional Action (トランザクションアクション)

Enumeration (列挙)。次のいずれかになります。

  • ALWAYS_JOIN​

  • JOIN_IF_POSSIBLE​

  • NOT_SUPPORTED

トランザクションに関する操作で実行できる結合アクションの種別。

JOIN_IF_POSSIBLE

Target Variable (対象変数)

String (文字列)

操作の出力を保存する変数の名前。

Target Value (対象値)

String (文字列)

操作の出力に対して評価される式。この式の結果が対象変数に保存されます。

#[payload]

Reconnection Strategy (再接続戦略)

接続エラーが発生した場合の再試行戦略。

出力

Binary の配列

次の設定の場合

スロー

  • IBMCTG:AEI0

  • IBMCTG:CONNECTION_ERROR

  • IBMCTG:CONNECTIVITY

  • IBMCTG:ECI_ERR_INVALID_CALL_TYPE

  • IBMCTG:ECI_ERR_NO_CICS

  • IBMCTG:ECI_ERR_SECURITY_ERROR

  • IBMCTG:ECOM

  • IBMCTG:ERR_GATEWAY

  • IBMCTG:IBMCCExecution

  • IBMCTG:REQUEST_ERROR

  • IBMCTG:RESOURCE

  • IBMCTG:RETRY_EXHAUSTED

  • IBMCTG:SERVER_ERROR

  • IBMCTG:TRANSACTION

  • IBMCTG:UNKNOWN

Reconnection (再接続)

項目 説明 デフォルト値 必須

Fails Deployment (デプロイに失敗)

Boolean (ブール)

アプリケーションがデプロイされると、すべてのコネクタで接続テストが実行されます。true に設定されている場合、関連する再接続戦略をすべて実行した後にテストに合格しないと、デプロイメントが失敗します。

Reconnection Strategy (再接続戦略)

使用する再接続戦略。

Reconnect (再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

Count (数)

Number (数値)

再接続の試行回数。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Reconnect Forever (繰り返し再接続)

項目 説明 デフォルト値 必須

Frequency (頻度)

Number (数値)

再接続する頻度 (ミリ秒)。

blocking (ブロック)

Boolean (ブール)

false の場合、再接続戦略が個別の非ブロックスレッドで実行されます。

true

Pooling Profile (プーリングプロファイル)

項目 説明 デフォルト値 必須

Max Active (最大アクティブ)

Number (数値)

一度にセッションから借りることができる Mule コンポーネントの数を制御します。負の値に設定した場合、同時にアクティブにできるコンポーネントの数に制限はありません。maxActive を超えた場合、プールは枯渇したと呼ばれます。

Max Idle (最大アイドル)

Number (数値)

プール内で同時にアイドル状態のままにできる Mule コンポーネントの最大数。負の値に設定した場合、同時にアイドルにできる Mule コンポーネントの数に制限はありません。

Max Wait (最大待機)

Number (数値)

プールが枯渇し、exhaustedAction が ​WHEN_EXHAUSTED_WAIT​ に設定されている場合に、プールされたコンポーネントが使用可能になるまで待機する時間 (ミリ秒) を指定します。

Min Eviction Millis (最小除去時間)

Number (数値)

オブジェクトが除去対象となるまでにオブジェクトをプール内でアイドル状態のままにできる最小時間を決定します。正の値以外の場合、アイドル時間のみによってオブジェクトがプールから削除されることはありません。

Eviction Check Interval Millis (除去確認間隔)

Number (数値)

オブジェクトエビクターの実行間隔 (ミリ秒) を指定します。正の値以外の場合、オブジェクトエビクターは実行されません。

Exhausted Action (枯渇アクション)

Enumeration (列挙)。次のいずれかになります。

  • WHEN_EXHAUSTED_GROW​

  • WHEN_EXHAUSTED_WAIT​

  • WHEN_EXHAUSTED_FAIL

Mule コンポーネントプールが枯渇した場合のプールの動作を指定します。使用可能な値は次のいずれかです。​WHEN_EXHAUSTED_FAIL​: NoSuchElementException をスローします。​WHEN_EXHAUSTED_WAIT​: 新規またはアイドルオブジェクトが使用可能になるまで、Object.wait(long) を呼び出してブロックします。​WHEN_EXHAUSTED_GROW​: 新しい Mule インスタンスを作成して返します。基本的に maxActive の意味がなくなります。正の maxWait 値を指定した場合、最大で数ミリ秒ブロックされた後 NoSuchElementException が発生します。maxThreadWait が負数の場合、無期限にブロックされます。

Initialisation Policy (初期化ポリシー)

Enumeration (列挙)。次のいずれかになります。

  • INITIALISE_NONE​

  • INITIALISE_ONE​

  • INITIALISE_ALL

プール内のコンポーネントの初期化方法を決定します。有効な値: INITIALISE_NONE​ (起動時にコンポーネントをプールに読み込まない)、​INITIALISE_ONE​ (起動時に 1 つの初期コンポーネントをプールに読み込む)、または ​INITIALISE_ALL​ (起動時にすべてのコンポーネントをプールに読み込む)。

Disabled

Boolean (ブール)

プーリングを無効にする必要があるかどうか

Expiration Policy (有効期限ポリシー)

項目 説明 デフォルト値 必須

Max Idle Time (最大アイドル時間)

Number (数値)

有効期限の対象とみなされるまで、動的設定インスタンスがアイドル状態を維持できる最大時間のスカラー時間値

Time Unit (時間単位)

Enumeration (列挙)。次のいずれかになります。

  • NANOSECONDS (ナノ秒)

  • MICROSECONDS (マイクロ秒)

  • MILLISECONDS (ミリ秒)

  • SECONDS (秒)

  • MINUTES (分)

  • HOURS (時間)

  • DAYS (日)

maxIdleTime 属性の時間単位

Channel Request (チャネル要求)

項目 説明 デフォルト値 必須

Channel (チャネル)

String (文字列)

チャネルの名前。値は大文字と小文字が区別されます。

x

Request Container (要求コンテナ)

String (文字列)

要求データを CICS プログラムに送信するために使用するコンテナの名前。値は大文字と小文字が区別されます。

x

Response Container (応答コンテナ)

String (文字列)

CICS プログラムから取得したデータを返すために使用するコンテナの名前。値は大文字と小文字が区別されます。

x

Error Container (エラーコンテナ)

String (文字列)

CICS プログラムで問題が発生した場合にエラー情報を返すために使用するコンテナの名前。値は大文字と小文字が区別されます。

x

Program Name (プログラム名)

String (文字列)

コールする CICS プログラムの名前。これは大文字と小文字が区別されます。

x

Tpn Name (Tpn 名)

String (文字列)

CICS ミラートランザクションのトランザクション識別子。省略可能。

Encoding (エンコード)

String (文字列)

データエンコード。デフォルト値は IBM037 です。

IBM037

Repeatable In Memory Stream (反復可能なメモリ内ストリーム)

項目 説明 デフォルト値 必須

Initial Buffer Size (初期バッファサイズ)

Number (数値)

ストリームをコンシュームし、ストリームへのランダムアクセスを提供する目的で割り当てられるメモリの容量。ストリームに含まれているデータがこのバッファに適合できる量を超えている場合、bufferSizeIncrement 属性に従ってバッファが拡張され、上限は maxInMemorySize となります。

Buffer Size Increment (バッファサイズ増分)

Number (数値)

バッファサイズが初期サイズを超えた場合に、どれだけ拡張するか。値を 0 以下に設定すると、バッファが拡張されません。つまり、バッファがフルになると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。

Max Buffer Size (最大バッファサイズ)

Number (数値)

使用するメモリの最大量。これを超えると、​STREAM_MAXIMUM_SIZE_EXCEEDED​ エラーが発生します。0 以下の値は無制限を意味します。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

これらのすべての属性の単位

Repeatable File Store Stream (反復可能なファイルストアストリーム)

項目 説明 デフォルト値 必須

Max In Memory Size (最大メモリ内サイズ)

Number (数値)

データをメモリ内に保持するためにストリームで使用する最大メモリを定義します。これを超えると、ディスクへのコンテンツのバッファが開始されます。

Buffer Unit (バッファ単位)

Enumeration (列挙)。次のいずれかになります。

  • BYTE (バイト)

  • KB

  • MB

  • GB

maxInMemorySize で表される単位

Commarea Request (COMMAREA 要求)

項目 説明 デフォルト値 必須

Commarea Length (COMMAREA 長)

Number (数値)

COMMAREA の長さ。デフォルト値は -1 です。これは、ペイロードで渡されるバイト配列の長さ以下に設定する必要があります。推奨される最大サイズは 32,500 バイトです。このサイズでは、すべてのプロトコルでのデータの正常な流れが保証されます。これより大きい COMMAREA サイズでは、​ECI_ERR_INVALID_DATA_LENGTH​ リターンコードが生成される場合があります。

-1

Reply Length (応答長)

Number (数値)

ゲートウェイデーモンから Mule (JCA) アプリケーションに戻されるデータストリームの長さ。デフォルト値は -1 です。このプロパティを設定すると、CICS から返されるデータが最大 COMMAREA サイズ未満であり、データのサイズを事前に認識している場合、ネットワーク上に送信するデータを縮小できます。

-1

Program Name (プログラム名)

String (文字列)

コールする CICS プログラムの名前。これは大文字と小文字が区別されます。

x

Tpn Name (Tpn 名)

String (文字列)

CICS ミラートランザクションのトランザクション識別子。省略可能。

Encoding (エンコード)

String (文字列)

データエンコード。デフォルト値は IBM037 です。

IBM037

Channel And Content (チャネルおよびコンテンツ)

項目 説明 デフォルト値 必須

Channel Request (チャネル要求)

Content (コンテンツ)

Binary (バイナリ)