Attach a CICS Connection policy to one or more CICSRequest nodes in a message flow to control connection details at run time.
You use the CICSRequest node in a message flow to call CICS® Transaction Server for z/OS® programs over TCP/IP-based IP InterCommunications (IPIC) protocol. You can use a CICS Connection policy that the CICSRequest node can refer to at run time for connection information.
To attach a CICS Connection policy to a CICSRequest node, set the CICS server property of the CICSRequest node to the name of the policy in the format {policyProjectName}:policyName. You must deploy this policy before the associated message flow is started.
The properties of this policy are described in the following table.
Property | Property name in .policyxml file | Value |
---|---|---|
CICS server | cicsServer | This property specifies the value that is used by the CICSRequest node to connect to CICS Transaction Server for z/OS. Specify one of the following connection methods:
Value type: String |
CICS Transaction Gateway URL | gatewayURL | This property specifies the URL that is used to connect to CICS Transaction Gateway. If this
property is specified, the CICS server property must contain the CICS server
definition that you specify in the CICS TG.INI initialization file. Use this
property to specify a protocol, host name, and port number, which is the minimum information you
need to connect to CICS TG. The URL must be in the format
protocol://hostname:port where:
tcp://mycicstransactiongateway.com:12345 If you are using SSL, the integration node key ring must trust the CICS TG middle tier. You can obtain the host name and port number from the CICS TG.INI initialization file. The default value for this property is local:, which indicates a direct two-tier connection to CICS. Value type: String |
CICS APPLID | clientApplid | This property specifies the application ID by which IBM App Connect
Enterprise
is known to the CICS region. This ID is not the application ID of the CICS region. You can enter a
maximum of 8 characters. Value type: String |
CICS APPLID qualifier | clientQualifier | This property specifies the application ID qualifier by which IBM App Connect
Enterprise is known to the CICS region. You can enter a maximum of 8
characters. Value type: String |
Connection timeout (seconds) | connectionTimeoutSecs | This property specifies the timeout value that is used by the CICSRequest node to set the expiry time in seconds for IBM App Connect
Enterprise to establish a connection to the CICS region. The default value
for this property is 30, indicating that the CICSRequest node
waits for 30 seconds. You can enter an integer in the range 0 - 2147483, where 0 indicates that no
timeout is applied. Value type: Integer |
Request timeout (seconds) | requestTimeoutSecs | This property specifies the timeout value that is used by the CICSRequest node to set the expiry time in seconds for the CICS
program to respond. The default value for this property is 120, indicating that the CICSRequest node waits for 120 seconds. This period does not
include the connection time period. You can enter an integer in the range 0 - 2147483, where 0
indicates that no timeout is applied. Value type: Integer |
Security identity (DSN) | securityIdentity | This property specifies the name of the security identity object that contains the user ID
and password to be used to authenticate the connection to CICS. Value type: String |
Integration server used for XA recovery | egForXARecovery | In a globally coordinated transaction, this property specifies the name of the integration
server that establishes a connection to CICS for XA recovery. If XA is being used, only the
specified integration server can use the policy. If you set this property, you must also set the CICS APPLID and CICS APPLID qualifier properties. This property is not supported on z/OS. Value type: String |