Free MuleSoft CONNECT Keynote & Expo Pass Available!

Register now+
Nav

IBM CTG Connector Reference

The IBM CICS Transaction Gateway (IBM CTG) connector provides integration with back-end CICS applications using the CICS Transaction Gateway.

Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Connection

The connection types that can be provided to this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime actually purges the instances when it sees fit.

Connection Types

Connection

Parameters

Name Type Description Default Value Required

Host

String

localhost

Port

String

2006

Servers name

String

x

Username

String

x

Password

String

x

Keystore location

String

The location of the keystore containing the certificates required for an SSL connection.

Keystore Password

String

The password required to access the keystore for an SSL connection.

Connection Timeout

Number

Sets the socket connection timeout value for a connection to CICS TG. This timeout represents the maximum amount of time (in milliseconds) a managed connection attempts to open a socket connection successfully to a remote gateway daemon. The timeout is ignored for attempted connections to a local gateway instance. A value of 0 represents no timeout.

0

CTG Trace

Boolean

Turns all levels of CTG tracing on or off.

false

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Associated Operations

  • Execute

  • Execute Using COMMAREA

Operations

Execute

<ibmctg:execute>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

Binary

#[payload]

Channel Request

Channel Request

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take for transactions.

JOIN_IF_POSSIBLE

Streaming Strategy

  • Repeatable in memory stream

  • Repeatable file store stream

  • Non-repeatable stream

Configure to use repeatable streams and their behavior.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output, and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • Reconnect

  • Reconnect forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

  • config

Throws

  • 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>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Content

Binary

#[payload]

Commarea Request Type

COMMAREA Request

x

Transactional Action

Enumeration, one of:

  • ALWAYS_JOIN

  • JOIN_IF_POSSIBLE

  • NOT_SUPPORTED

The type of joining action that operations can take regarding transactions.

JOIN_IF_POSSIBLE

Streaming Strategy

  • Repeatable in memory stream

  • Repeatable file store stream

  • Non-repeatable stream

Configure to use repeatable streams and their behavior.

Target Variable

String

The name of a variable in which to store the output of the operation.

Target Value

String

An expression to evaluate against the operation’s output, and the outcome of that expression is stored in the target variable.

#[payload]

Reconnection Strategy

  • Reconnect

  • Reconnect forever

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

  • config

Throws

  • 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

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

  • Reconnect

  • Reconnect forever

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often (in milliseconds) to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often (in milliseconds) to reconnect.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

Channel Request

Field Type Description Default Value Required

Tpn Name

String

Encoding

String

IBM037

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed.

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then the connector starts to buffer the content of the disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

Commarea Request

Field Type Description Default Value Required

Commarea Length

Number

-1

Reply Length

Number

-1

Tpn Name

String

Encoding

String

IBM037