Correlation points available in the exits

Correlation points are available to identify the flow data available in the exits between the exits and between flows. For all flows, the FlowType enumeration is available. The enumeration defines the type of flow and has methods to determine other key qualities about this flow.

You can use FlowTopology to distinguish between Gateway daemon flows and flows in the Gateway classes, in both local and remote mode. The underlying ECIRequest object is not accessible from the exits.

Flow correlators

Individual flows through the Gateway daemon or Gateway classes have a CtgCorrelator. This correlator is a Java integer which is available at all RequestEvents: RequestEntry to ResponseExit, and can take any value from Integer.MinValue to Integer.MaxValue (values from -2,147,483,648 to 2,147,483,647). Each Gateway daemon or JavaGateway object uses independent correlators.

The Gateway daemon or JavaGateway object of a Client application can be identified if the APPLID and APPLID Qualifier are defined and are available as CtgApplid and CtgApplidQualifier. These are Java Strings containing 1 to 8 characters.

In three-tier (or remote mode) topologies, the CtgCorrelator, CtgApplid, and CtgApplidQualifier of the Client application flow are available in the exits in the Gateway daemon as ClientCtgCorrelator, ClientCtgApplid, and ClientCtgApplidQualifier.

For transactions that use IPIC, the origin data is available to associate the flow from a Java application through to a CICS server.

For EXCI SYNCONRETURN flows from the Gateway daemon, the CtgApplid, and CtgApplidQualifier are passed to CICS as a LU6.2 style UOWID. The format of this UOWID is a byte array, and available as CicsCorrelator.

The CICS Network UOWID is a byte array used by CICS to uniquely identify a unit of work. The encoding is binary for the integers and EBCDIC for the characters. The format is shown in the following table.
Table 1. Format of CICS Network UOWID
Offset Length Description
0 1 Length of UOWID
1 1 Length of network ID
2 n = 3 to 17 Network ID - [APPLIIDQUALIFIER.] APPLID
3+q+u 6 NETUOWSX

Access to any user correlation data in the COMMAREA is through the PayLoad object, which is read-only, and available only during the eventFired() method.

Transaction correlators

For XA transactions the XID is available, and for transactions that use EXCI, where the XID is unknown to CICS, the RRMS URID is also available as the URID object.

For extended mode ECI transactions, the LUW token is available after it has been set; for example, on all exits except the RequestEntry of the first request of the transaction.


Concept Concept

Feedback


Timestamp icon Last updated: Tuesday, 19 November 2013


https://ut-ilnx-r4.hursley.ibm.com/tgzos_latest/help/topic/com.ibm.cics.tg.zos.doc//progdezos/correlatorexits.html