CICS context management parameters
CICS® context management parameters are those parameters that CICS passes when a task-related user exit (TRUE) signals that CICS is to be called for CICS context management.
If the context management bit in the schedule word is set for the current transaction, CICS context management calls the exit program whenever the transaction issues a non-terminal-related EXEC CICS START command. The exit program is not called for terminal-related EXEC CICS START commands.
When called, the exit program
is passed the following parameter list, which is mapped by the DFHUECON
DSECT:
- UECON_EXEC_PLIST_PTR
- The address of a copy of the parameter list passed to the EXEC CICS START command. Your task-related user exit program can use this address to access, for example, the data passed on the FROM parameter of the START command, or the name of the transaction to be started. The EXEC CICS START parameter list is described by the DFHICUED copy book.
- UECON_CORRELATOR_PTR
- The address of a 512-byte area in which the exit program can place an ARM workload correlator.
- UECON_ICRX_LEN
- Reserved for future use.
- UECON_ICRX_PTR
- Reserved for future use.
The following adapter fields are intended to
be used in hierarchical order with the adapter identifier specifying
the most general information and adapter data 3 specifying the most
specific information. This order provides a uniform manner to identify
and isolate tasks.
- UECON_ADAPTER_ID_PTR
- The address of a 64-character area in which the exit program can pass the data to be placed into the origin data adapter identifier field. Use the same value for all instances of the adapter; for example, the product identifier for the owner of the adapter. If an adapter does not specify an identifier in this area then none of the other adapter data is set.
- UECON_ADAPTER_DATA1_PTR
- The address of a 64-character area in which the exit program can pass the data to be placed into the origin data adapter data 1 field. This field can be used to identify the server to which the adapter instance (which might be one of many) is connected.
- UECON_ADAPTER_DATA2_PTR
- The address of a 64-character area in which the exit program can pass the data to be placed into the origin data adapter data 2 field. This field can be used to identify the instance of the adapter task that is starting the task with the START command.
- UECON_ADAPTER_DATA3_PTR
- The address of a 64-character area in which the exit program can pass the data to be placed into the origin data adapter data 3 field. This field can contain details to identify the reason that the adapter instance started this particular task with the START command.
- UECON_FLAGS
- The address of a single byte with bit definitions that indicate
to the adapter whether the task that is issuing the START command
contains origin data adapter data.
- UECON_ADAPTER_DATA_ON
- (X'80') indicates that the task that is issuing the START command contains origin data adapter data, and therefore it is not the first (origin) adapter for this set of tasks.
The DFH$APDT adapter tracking sample TRUE demonstrates how you can use adapter data fields for transaction tracking. For more details, see Adapter tracking sample task-related user exit program (DFH$APDT).