Transaction manager domain’s specific gates

Table 116 summarizes the transaction manager domain’s specific gates. It shows the level-1 trace point IDs of the modules providing the functions for the gates, the functions provided by the gates, and whether or not the functions are available through the exit programming interface (XPI).

Table 116. Transaction manager domain’s specific gates
Gate Trace Function XPI
XMAT
XM 1101
XM 1102
ATTACH
NO
XMBD
XM 0501
XM 0502
START_BROWSE_TRANDEF
GET_NEXT_TRANDEF
END_BROWSE_TRANDEF
NO
NO
NO
XMCL
XM 0A01
XM 0A02
ADD_REPLACE_TCLASS
ADD_TCLASS
INQUIRE_TCLASS
INQUIRE_ALL_TCLASSES
SET_TCLASS
DELETE_TCLASS
START_BROWSE_TCLASS
GET_NEXT_TCLASS
END_BROWSE_TCLASS
REGISTER_TCLASS_USAGE
DEREGISTER_TCLASS_USAGE
LOCATE_AND_LOCK_TCLASS
UNLOCK_TCLASS
NO
NO
YES
NO
NO
NO
NO
NO
NO
NO
NO
NO
NO
XMDD
XM 0601
XM 0602
DELETE_TRANDEF
NO
XMER
XM 1204
XM 1205
SET_DEFERRED_MESSAGE
INQUIRE_DEFERRED_MESSAGE
SET_DEFERRED_ABEND
INQUIRE_DEFERRED_ABEND
REPORT_MESSAGE
ABEND_TRANSACTION
NO
NO
NO
NO
NO
NO
XMFD
XM 0701
XM 0702
FIND_PROFILE
NO
XMIQ
XM 1001
XM 1002
INQUIRE_TRANSACTION
SET_TRANSACTION
START_BROWSE_TRANSACTION
GET_NEXT_TRANSACTION
END_BROWSE_TRANSACTION
START_BROWSE_TXN_TOKEN
GET_NEXT_TXN_TOKEN
END_BROWSE_TXN_TOKEN
INQUIRE_TRANSACTION_TOKEN
SET_TRANSACTION_TOKEN
PURGE_TRANSACTION
YES
YES
NO
NO
NO
NO
NO
NO
XMLD
XM 0401
XM 0402
LOCATE_AND_LOCK_TRANDEF
UNLOCK_TRANDEF
NO
NO
XMSR
XM 0801
XM 0802
INQUIRE_MXT
SET_MXT
INQUIRE_DTRTRAN
SET_DTRTRAN
YES
NO
YES
NO
XMXD
XM 0201
XM 0202
ADD_REPLACE_TRANDEF
SET_TRANDEF
INQUIRE_TRANDEF
INQUIRE_REMOTE_TRANDEF
NO
NO
YES
NO
XMXE
XM 1401
XM 1402
GET_TXN_ENVIRONMENT
FREE_TXN_ENVIRONMENT
NO
NO

XMAT gate, ATTACH function

The ATTACH function of the XMAT gate is used to attach a new transaction.

Input parameters

TRANSACTION_ID
The transaction identifier to attach.
TPNAME
Alternative means of specifying the transaction identifier to attach.
[ATTACH_PARMS]
Parameters to be passed to the attached transaction.
[PRIORITY]
Combined user and terminal priority to be added to that of the transaction definition to determine the total priority of the attached transaction.
[TOTAL_PRIORITY]
The overriding priority to be associated with the attached transaction.
FACILITY_TYPE
The type of principal facility to be associated with the attached transaction. It can have any of these values:
NONE|TERMINAL|TD|START
START_CODE
Indicates the reason for the attach It can have any of these values:
C|T|TT|QD|S|SD|SZ|DF
[TF_TOKEN]
Token identifying a terminal to be associated with the transaction.
[IC_TOKEN]
Token identifying a START request to be associated with the transaction.
[TD_TOKEN]
Token identifying a TDQ to be associated with the transaction.
[US_TOKEN]
Token identifying a user to be associated with the transaction.
[SYSTEM_ATTACH]
Indicates whether the transaction should be attached as a system transaction. It can have either of these values:
YES|NO
[SUSPEND]
Indicates whether the attacher is willing to suspend during the attach. It can have either of these values:
YES|NO
RETURN_NOT_FOUND
Indicates whether the attacher wishes to receive the NOT_FOUND exception. Default is to attach CSAC in place of the requested transaction. It can have either of these values:
YES|NO
[RESTART_COUNT]
If the attach is for a restarted transaction then this count indicates the number of this restart attempt.

Output parameters

[TRANSACTION_TOKEN]
Is the token identifying the newly attached transaction.
[TRANNUM]
Is the transaction number assigned to the newly attached transaction.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION
NOT_FOUND
DISABLED
INSUFFICIENT_STORAGE
NOT_ENABLED_FOR_SHUTDOWN
INVALID
INVALID_FUNCTION

XMBD gate, START_BROWSE_TRANDEF function

The START_BROWSE_TRANDEF function of the XMBD gate is used to initiate a browse of installed transaction definitions.

Input parameters

[START_AT]
Identifies a transaction identifier that the browse is to start at.

Output parameters

BROWSE_TOKEN
Token identifying this transaction definition browse.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
INVALID INVALID_FUNCTION

XMBD gate, GET_NEXT_TRANDEF function

The GET_NEXT_TRANDEF function of the XMBD gate is used to return information about the next transaction definition in the browse.

Input parameters

BROWSE_TOKEN
Token identifying this browse of the transaction definitions.

Output parameters

[TRANSACTION_ID]
Transaction identifier
[INITIAL_PROGRAM]
Initial program of transaction.
[PROFILE_NAME]
Profile of transaction.
[TWASIZE]
Size of Transaction Work Area.
[TRAN_PRIORITY]
Transaction priority
[STATUS]
The status of the transaction. It can have either of these values:
ENABLED|DISABLED
[PARTITIONSET]
The partitionset defined for the transaction. It can have any of these values:
NONE|NAMED|KEEP|OWN
[PARTITIONSET_NAME]
The name of the user defined partitionset used by the transaction.
[TASKDATAKEY]
The storage key that task-lifetime storage is allocated in. It can have either of these values:
CICS|USER
[TASKDATALOC]
The location of task-lifetime storage. It can have either of these values:
BELOW|ANY
[STORAGE_CLEAR]
Whether task-lifetime storage is to be cleared before it is freemained. It can have either of these values:
YES|NO
[SYSTEM_RUNAWAY]
Whether the transaction uses the default system runaway limit. It can have either of these values:
YES|NO
[RUNAWAY_LIMIT]
The runaway limit associated with the transaction.
[DYNAMIC]
Whether the transaction is defined to be dynamic. It can have either of these values:
YES|NO
[LOCAL_QUEUING]
Whether the transaction is eligible to queue locally when it is started on the remote system. It can have either of these values:
YES|NO
[REMOTE]
Whether the transaction is remote. It can have either of these values:
YES|NO
[REMOTE_SYSTEM]
The system that a remote transaction is to be routed to.
[REMOTE_NAME]
The name of a remote transaction on the remote system.
[TRAN_ROUTING_PROFILE]
Profile to be used to route a remote transaction to a remote system.
[TCLASS]
Whether the transaction belongs to a tclass. It can have either of these values:
YES|NO
[TCLASS_NAME]
The name of the tclass that the transaction belongs to.
[INDOUBT]
The action to take if work performed by the transaction becomes indoubt. It can have any of these values:
BACKOUT|COMMIT|WAIT
[RESTART]
Whether the transaction is restartable. It can have either of these values:
YES|NO
[SPURGE]
Whether the transaction is system-purgeable. It can have either of these values:
YES|NO
[DTIMEOUT]
The deadlock timeout value for the transaction.
[TPURGE]
Whether the transaction can be purged after a terminal error. It can have either of these values:
YES|NO
[DUMP]
Whether transaction dumps are to be taken. It can have either of these values:
YES|NO
[TRACE]
The level of tracing associated with the transaction. It can have any of these values:
STANDARD|SPECIAL|SUPPRESSED
[SHUTDOWN]
Whether the transaction can be run during shutdown. It can have either of these values:
ENABLED|DISABLED
[RESSEC]
Whether resource security checking is active. It can have either of these values:
YES|NO
[CMDSEC]
Whether command security checking is active. It can have either of these values:
YES|NO
[STORAGE_FREEZE]
Whether storage freeze is on for the transaction. It can have either of these values:
YES|NO
[ISOLATE]
Whether the transaction runs in its own subspace. It can have either of these values:
YES|NO
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
EXCEPTION BROWSE_END_TRANDEF
INVALID
INVALID_BROWSE_TOKEN
INVALID_FUNCTION

XMBD gate, END_BROWSE_TRANDEF function

The END_BROWSE_TRANDEF function of the XMBD gate is used to terminate a browse of installed transaction definitions.

Input parameters

BROWSE_TOKEN
Token identifying this transaction definition browse.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
INVALID
INVALID_BROWSE_TOKEN
INVALID_FUNCTION

XMCL gate, ADD_REPLACE_TCLASS function

The ADD_REPLACE_TCLASS function of the XMCL gate is used to install a tclass definition.

Input parameters

TCLASS_NAME
The name of the tclass.
MAX_ACTIVE
The max-active limit of the tclass.
[PURGE_THRESHOLD]
The purge-threshold limit of the tclass.

Output parameters

[TCLASS_TOKEN]
Token identifying the tclass.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
EXCEPTION
INVALID_TCLASS_NAME
INVALID_MAX_ACTIVE
INVALID_PURGE_THRESHOLD
INVALID INVALID_FUNCTION

XMCL gate, ADD_TCLASS function

The ADD_TCLASS function of the XMCL gate is used to add an internal tclass definition.

Input parameters

[TCLASS_NAME]
The name of the tclass.
MAX_ACTIVE
The max-active limit of the tclass.
[PURGE_THRESHOLD]
The purge-threshold limit of the tclass.

Output parameters

TCLASS_TOKEN
Token identifying the tclass.
RESPONSE
is the domain’s response to the call. Possible values are:
OK|EXCEPTION|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. It can have any of these values:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
EXCEPTION
DUPLICATE_TCLASS_NAME
INVALID_TCLASS_NAME
INVALID_MAX_ACTIVE
INVALID_PURGE_THRESHOLD
INVALID INVALID_FUNCTION

XMCL gate, INQUIRE_TCLASS function

The INQUIRE_TCLASS function of the XMCL gate is used to inquire upon a tclass.

Input parameters

INQ_TCLASS_NAME
The name of the tclass being inquired upon.
TCLASS_TOKEN
Token identifying tclass being inquired upon.

Output parameters

[TCLASS_NAME]
The name of the tclass.
[MAX_ACTIVE]
The max-active limit of the tclass.
[PURGE_THRESHOLD]
The purge-threshold limit of the tclass.
[CURRENT_ACTIVE]
The number of active transactions in the tclass.
[CURRENT_QUEUED]
The number of queuing transactions in the tclass.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
EXCEPTION UNKNOWN_TCLASS
INVALID
INVALID_TCLASS_TOKEN
INVALID_FUNCTION

XMCL gate, INQUIRE_ALL_TCLASSES function

The INQUIRE_ALL_TCLASSES function of the XMCL gate is used to inquire about the current state of all the tclasses in the system.

Input parameters

None.

Output parameters

[TOTAL_ACTIVE]
The number of transactions active in a tclass.
[TOTAL_QUEUED]
The number of transactions queueing for a tclass.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
EXCEPTION UNKNOWN_TCLASS
LOGIC_ERROR INVALID_FUNCTION

XMCL gate, SET_TCLASS function

The SET_TCLASS function of the XMCL gate is used to modify a tclass definition.

Input parameters

TCLASS_NAME
The name of the tclass to be changed.
TCLASS_TOKEN
Token identifying tclass to be changed.
[MAX_ACTIVE]
The max-active limit of the tclass.
[PURGE_THRESHOLD]
The purge-threshold limit of the tclass.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
EXCEPTION
UNKNOWN_TCLASS
INVALID_MAX_ACTIVE
INVALID_PURGE_THRESHOLD
INVALID
INVALID_TCLASS_TOKEN
INVALID_FUNCTION

XMCL gate, DELETE_TCLASS function

The DELETE_TCLASS function of the XMCL gate is used to discard an installed tclass definition.

Input parameters

TCLASS_NAME
The name of the tclass to be deleted.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
EXCEPTION
UNKNOWN_TCLASS
TCLASS_BUSY
INVALID INVALID_FUNCTION

XMCL gate, START_BROWSE_TCLASS function

The START_BROWSE_TCLASS function of the XMCL gate is used to initiate a browse of installed tclass definitions.

Input parameters

[START_AT]
Identifies a tclass that the browse is to start at.

Output parameters

BROWSE_TOKEN
Token identifying this tclass browse.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
INVALID INVALID_FUNCTION

XMCL gate, GET_NEXT_TCLASS function

The GET_NEXT_TCLASS function of the XMCL gate is used to return information about the next tclass definition in the browse.

Input parameters

BROWSE_TOKEN
Token identifying this browse of the tclass definitions.

Output parameters

[TCLASS_NAME]
The name of the tclass.
[MAX_ACTIVE]
The max-active limit of the tclass.
[PURGE_THRESHOLD]
The purge-threshold limit of the tclass.
[CURRENT_ACTIVE]
The number of active transactions in the tclass.
[CURRENT_QUEUED]
The number of queuing transactions in the tclass.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
EXCEPTION BROWSE_END_TCLASS
INVALID
INVALID_BROWSE_TOKEN
INVALID_FUNCTION

XMCL gate, END_BROWSE_TCLASS function

The END_BROWSE_TCLASS function of the XMCL gate is used to terminate a browse of installed tclass definitions.

Input parameters

BROWSE_TOKEN
Token identifying this tclass browse.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
INVALID
INVALID_BROWSE_TOKEN
INVALID_FUNCTION

XMCL gate, REGISTER_TCLASS_USAGE function

The REGISTER_TCLASS_USAGE function of the XMCL gate is used to register usage of a tclass by a transaction definition.

Input parameters

TCLASS_NAME
The name of the tclass that is being used.
UNKNOWN_ACTION
Specifies the action to perform if the tclass hasn't been installed by the user: It can have either of these values:
CREATE|ERROR

Output parameters

TCLASS_TOKEN
Token identifying tclass.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
EXCEPTION UNKNOWN_TCLASS
INVALID INVALID_FUNCTION

XMCL gate, DEREGISTER_TCLASS_USAGE function

The DEREGISTER_TCLASS_USAGE function of the XMCL gate is used to deregister usage of a tclass by a transaction definition.

Input parameters

TCLASS_TOKEN
Token identifying tclass that is no longer being used.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
INVALID
INVALID_TCLASS_TOKEN, NOT_IN_USE, INVALID_FUNCTION
DISASTER
LOGIC_ERROR, ABEND, LOOP

XMCL gate, LOCATE_AND_LOCK_TCLASS function

The LOCATE_AND_LOCK_TCLASS function of the XMCL gate is used to locate a named tclass and lock it against delete.

Input parameters

TCLASS_NAME
Name of tclass to be located.

Output parameters

TCLASS_TOKEN
Token identifying tclass.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
EXCEPTION UNKNOWN_TCLASS
INVALID INVALID_FUNCTION

XMCL gate, UNLOCK_TCLASS function

The UNLOCK_TCLASS function of the XMCL gate is used to unlock a previously locked tclass.

Input parameters

TCLASS_TOKEN
Token identifying tclass to be unlocked.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR, ABEND, LOOP
INVALID
INVALID_TCLASS_TOKEN, NOT_LOCKED, INVALID_FUNCTION

XMDD gate, DELETE_TRANDEF function

The DELETE_TRANDEF function of the XMDD gate is used to discard an installed transaction definition.

Input parameters

TRANSACTION_ID
The name of the transaction to be deleted.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND LOOP
EXCEPTION
UNKNOWN_TRANSACTION_ID
ICE_PENDING
AID_PENDING
SIT_PARAMETER
INVALID INVALID_FUNCTION

XMER gate, SET_DEFERRED_MESSAGE function

The SET_DEFERRED_MESSAGE function of the XMER gate is used to store a message to be issued if the attach of a transaction fails.

Input parameters

MESSAGE
The message that is to be issued.
[TRANSACTION_TOKEN]
Optional token to identify the transaction that the message is to be sent to. Defaults to the current transaction.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION
MESSAGE_ALREADY_SET
DEFERRED_ABEND_ALREADY_SET
INVALID_TRANSACTION_TOKEN
INVALID INVALID_FUNCTION

XMER gate, INQUIRE_DEFERRED_MESSAGE function

The INQUIRE_DEFERRED_MESSAGE function of the XMER gate is used to retrieve the message that is to be issued which will indicate the cause of a transaction attach failure.

Output parameters

MESSAGE
The message that is to be issued.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION MESSAGE_NOT_FOUND
INVALID INVALID_FUNCTION

XMER gate, SET_DEFERRED_ABEND function

The SET_DEFERRED_ABEND function of the XMER gate is used to schedule an abend to be issued if the attach of a transaction fails.

Input parameters

DEFERRED_ABEND_CODE
The abend code that is to be used.
[TRANSACTION_DUMP]
Indicates whether a transaction dump is to be taken for the abend. It can have either of these values:
YES|NO
[TRANSACTION_TOKEN]
Optional token to identify the transaction that is to be abended. Defaults to the current transaction.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION
MESSAGE_ALREADY_SET
DEFERRED_ABEND_ALREADY_SET
INVALID_TRANSACTION_TOKEN
INVALID
INVALID_ABEND_CODE
INVALID_FUNCTION

XMER gate, INQUIRE_DEFERRED_ABEND function

The INQUIRE_DEFERRED_ABEND function of the XMER gate is used to retrieve the abend that is to be issued for the transaction whose attach has failed.

Output parameters

DEFERRED_ABEND_CODE
The abend code.
[TRANSACTION_DUMP]
Indicates whether a transaction dump is to be taken for the abend. It can have either of these values:
YES|NO
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION
DEFERRED_ABEND_NOT_FOUND
INVALID INVALID_FUNCTION

XMER gate, REPORT_MESSAGE function

The REPORT_MESSAGE function of the XMER gate is used send a deferred message if the attach of a transaction has failed.

Input parameters

MESSAGE
The message that is to be sent.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION TRANSACTION_ABEND
INVALID INVALID_FUNCTION

XMER gate, ABEND_TRANSACTION function

The ABEND_TRANSACTION function of the XMER gate is used abend a transaction whose attach has failed.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
INVALID INVALID_FUNCTION

XMFD gate, FIND_PROFILE function

The FIND_PROFILE function of the XMFD gate is used to check whether the given profile is in use by a transaction definition.

Input parameters

PROFILE_NAME
The profile that is to be found.

Output parameters

[TRANSACTION_ID]
The name of a transaction definition that is using the profile.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
EXCEPTION PROFILE_NOT_FOUND
INVALID INVALID_FUNCTION

XMIQ gate, INQUIRE_TRANSACTION function

The INQUIRE_TRANSACTION function of the XMIQ gate is used to inquire upon a particular transaction.

Input parameters

[TRANSACTION_NUMBER]
The number of the transaction being inquired upon.
[TRANSACTION_TOKEN]
Or the token representing the transaction being inquired upon.

If neither TRANSACTION_NUMBER or TRANSACTION_TOKEN are specified the current transaction is assumed.

[ATTACH_PARMS]
Specified if the parameter area passed on the transaction. attach are to be returned.

Output parameters

[ABEND_CODE]
The abend code if the transaction is terminating abnormally.
[ABEND_IN_PROGRESS]
Indicates whether the transaction is in the process of terminating abnormally. It can have either of these values:
YES|NO
[CICS®_UOW_ID]
The CICS Unit Of Work Identifier associated with the transaction.
[CMDSEC]
Whether command security checking is active. It can have either of these values:
YES|NO
[DTIMEOUT]
The deadlock timeout value for the transaction.
[DUMP]
Whether transaction dumps are to be taken for the transaction. It can have either of these values:
YES|NO
[DYNAMIC]
Whether the transaction is dynamic. It can have either of these values:
YES|NO
[FACILITY_NAME]
The name of the principal facility associated with the transaction.
[FACILITY_TYPE]
The type of the principal facility associated with the transaction. It can have either of these values:
NONE|TERMINAL|TD|START
[INDOUBT]
The action to take if work performed by the transaction becomes indoubt. It can have any of these values:
BACKOUT|COMMIT|WAIT
[INITIAL_PROGRAM]
The initial program to linked to when the transaction started.
[ISOLATE]
Whether the transaction runs in its own subspace. It can have either of these values:
YES|NO
[LOCAL_QUEUING]
Whether the transaction is eligible to queue locally if it is started on the remote system. It can have either of these values:
YES|NO
[NETNAME]
The network name of a terminal principal facility.
[ORIGINAL_TRANSACTION_ID]
The transid that was used to attach the transaction.
[OUT_TRANSACTION_TOKEN]
The token that represents this transaction.
[PHASE]
The phase of the transaction. It can have one of these values:
PRE_INIT|INIT|BIND|TERM
[PROFILE_NAME]
The profile of the transaction.
[REMOTE]
Whether the transaction is remote. It can have either of these values:
YES|NO
[REMOTE_NAME]
The name of a remote transaction on the remote system.
[REMOTE_SYSTEM]
The system that a remote transaction is to be routed to.
[RESOURCE_NAME]
The name of a resource that a suspended transaction is waiting for.
[RESOURCE_TYPE]
The type of resource that a suspended transaction is waiting for.
[RESSEC]
Whether resource security checking is active for the transaction. It can have either of these values:
YES|NO
[RESTART]
Whether the transaction is restartable. It can have either of these values:
YES|NO
[RESTART_COUNT]
Contains the number of times this transaction instance has been restarted.
[RUNAWAY_LIMIT]
The runaway limit associated with the transaction.
[SPURGE]
Whether the transaction is system-purgeable. It can have either of these values:
YES|NO
START_CODE
Indicates the reason for the attach of the transaction. It can have any of these values:
C|T|TT|QD|S|SD|SZ|DF
[STATUS]
The status of the transaction. It can have either of these values:
ENABLED|DISABLED
[STORAGE_CLEAR]
Whether task-lifetime storage will be cleared before it is freemained. It can have either of these values:
YES|NO
[SUSPEND_TIME]
Contains the length of time that the transaction has currently been suspended for.
[SYSTEM_TRANSACTION]
Whether the transaction has been attached by CICS. It can have either of these values:
YES|NO
[TASK_PRIORITY]
The combined priority of the transaction.
[TASKDATAKEY]
The storage key that task-lifetime storage is allocated in. It can have either of these values:
CICS|USER
[TASKDATALOC]
The location of task-lifetime storage. It can have either of these values:
BELOW|ANY
[TCLASS]
Whether the transaction belongs to a tclass. It can have either of these values:
YES|NO
[TCLASS_NAME]
The name of the tclass that the transaction belongs to.
[TPURGE]
Whether the transaction can be purged after a terminal error. It can have either of these values:
YES|NO
[TRACE]
The level of tracing associated with the transaction. It can have any of these values:
STANDARD|SPECIAL|SUPPRESSED
[TRAN_PRIORITY]
The priority of the transaction definition used to attach the transaction.
[TRAN_ROUTING_PROFILE]
Profile used to route the transaction to a remote system.
[TRANNUM]
The transaction number of the transaction.
[TRANSACTION_ID]
The transaction identifier associated with the transaction.
[TWASIZE]
Size of Transaction Work Area associated with the transaction.
[USERID]
The userid of the user associated with the transaction.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION
NO_TRANSACTION_ENVIRONMENT
BUFFER_TOO_SMALL
UNKNOWN_TRANSACTION_NUMBER
INVALID_TRANSACTION_TOKEN
INVALID INVALID_FUNCTION

XMIQ gate, SET_TRANSACTION function

The SET_TRANSACTION function of the XMIQ gate is used to change some attributes associated with a particular transaction.

Input parameters

[TRANSACTION_NUMBER]
The number of the transaction being inquired upon.
[TRANSACTION_TOKEN]
Or the token representing the transaction being inquired upon.

If neither TRANSACTION_NUMBER or TRANSACTION_TOKEN are specified the current transaction is assumed.

[ABEND_CODE]
The abend code if the transaction is terminating abnormally.
[ABEND_IN_PROGRESS]
Whether the transaction is in the process of terminating abnormally. It can have either of these values:
YES|NO
[FACILITY_TYPE]
The type of the principal facility associated with the transaction. It can have either of these values:
NONE|TERMINAL|TD|START
START_CODE
The reason for the attach of the transaction. It can have any of these values:
C|T|TT|QD|S|SD|SZ|DF
[STORAGE_VIOLATIONS]
Set to indicate that the transaction has suffered a storage violation.
[TASK_PRIORITY]
The combined priority of the transaction.
[TCLASS_NAME]
The name of the tclass that the transaction belongs to.

Reserved name DFHTCL00 is used to change a transaction so that it no longer belongs to a tclass.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
EXCEPTION
NO_TRANSACTION_ENVIRONMENT
UNKNOWN_TCLASS
UNKNOWN_TRANSACTION_NUMBER
INVALID_TRANSACTION_TOKEN
INVALID INVALID_FUNCTION

XMIQ gate, START_BROWSE_TRANSACTION function

The START_BROWSE_TRANSACTION function of the XMIQ gate is used to initiate a browse of all transactions in the system.

Output parameters

BROWSE_TOKEN
Token identifying this transaction browse.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is INVALID or DISASTER. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
INVALID INVALID_FUNCTION

XMIQ gate, GET_NEXT_TRANSACTION function

The GET_NEXT_TRANSACTION function of the XMIQ gate is used to inquire upon the next transaction in a transaction browse.

Input parameters

BROWSE_TOKEN
The token identifying this transaction browse.
[ATTACH_PARMS]
Specified if the parameter area passed on the transaction. attach is to be returned.

Output parameters

[ABEND_CODE]
The abend code if the transaction is terminating abnormally.
[ABEND_IN_PROGRESS]
Indicates whether the transaction is in the process of terminating abnormally. It can have either of these values:
YES|NO
[CICS_UOW_ID]
The CICS Unit Of Work Identifier associated with the transaction.
[CMDSEC]
Whether command security checking is active. It can have either of these values:
YES|NO
[DTIMEOUT]
The deadlock timeout value for the transaction.
[DUMP]
Whether transaction dumps are to be taken for the transaction. It can have either of these values:
YES|NO
[DYNAMIC]
Whether the transaction is dynamic. It can have either of these values:
YES|NO
[FACILITY_NAME]
The name of the principal facility associated with the transaction.
[FACILITY_TYPE]
The type of the principal facility associated with the transaction. It can have either of these values:
NONE|TERMINAL|TD|START
[INDOUBT]
The action to take if work performed by the transaction becomes indoubt. It can have any of these values:
BACKOUT|COMMIT|WAIT
[INITIAL_PROGRAM]
The initial program to linked to when the transaction started.
[ISOLATE]
Whether the transaction runs in its own subspace. It can have either of these values:
YES|NO
[LOCAL_QUEUING]
Whether the transaction is eligible to queue locally if it is started on the remote system. It can have either of these values:
YES|NO
[NETNAME]
The network name of a terminal principal facility.
[ORIGINAL_TRANSACTION_ID]
The transid that was used to attach the transaction.
[OUT_TRANSACTION_TOKEN]
The token that represents this transaction.
[PHASE]
The phase of the transaction. It can have one of these values:
PRE_INIT|INIT|BIND|TERM
[PROFILE_NAME]
The profile of the transaction.
[REMOTE]
Whether the transaction is remote. It can have either of these values:
YES|NO
[REMOTE_NAME]
The name of a remote transaction on the remote system.
[REMOTE_SYSTEM]
The system that a remote transaction is to be routed to.
[RESOURCE_NAME]
The name of a resource that a suspended transaction is waiting for.
[RESOURCE_TYPE]
The type of resource that a suspended transaction is waiting for.
[RESSEC]
Whether resource security checking is active for the transaction. It can have either of these values:
YES|NO
[RESTART]
Whether the transaction is restartable. It can have either of these values:
YES|NO
[RESTART_COUNT]
Contains the number of times this transaction instance has been restarted.
[RUNAWAY_LIMIT]
The runaway limit associated with the transaction.
[SPURGE]
Whether the transaction is system-purgeable. It can have either of these values:
YES|NO
START_CODE
Indicates the reason for the attach of the transaction. It can have any of these values:
C|T|TT|QD|S|SD|SZ|DF
[STATUS]
The status of the transaction. It can have either of these values:
ENABLED|DISABLED
[STORAGE_CLEAR]
Whether task-lifetime storage will be cleared before it is freemained. It can have either of these values:
YES|NO
[SUSPEND_TIME]
Contains the length of time that the transaction has currently been suspended for.
[SYSTEM_TRANSACTION]
Whether the transaction has been attached by CICS. It can have either of these values:
YES|NO
[TASK_PRIORITY]
The combined priority of the transaction.
[TASKDATAKEY]
The storage key that task-lifetime storage is allocated in. It can have either of these values:
CICS|USER
[TASKDATALOC]
The location of task-lifetime storage. It can have either of these values:
BELOW|ANY
[TCLASS]
Whether the transaction belongs to a tclass. It can have either of these values:
YES|NO
[TCLASS_NAME]
The name of the tclass that the transaction belongs to.
[TPURGE]
Whether the transaction can be purged after a terminal error. It can have either of these values:
YES|NO
[TRACE]
The level of tracing associated with the transaction. It can have any of these values:
STANDARD|SPECIAL|SUPPRESSED
[TRAN_PRIORITY]
The priority of the transaction definition used to attach the transaction.
[TRAN_ROUTING_PROFILE]
Profile used to route the transaction to a remote system.
[TRANNUM]
The transaction number of the transaction.
[TRANSACTION_ID]
The transaction identifier associated with the transaction.
[TWASIZE]
Size of Transaction Work Area associated with the transaction.
[USERID]
The userid of the user associated with the transaction.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION BROWSE_END
DISASTER
ABEND
LOOP
INVALID
INVALID_BROWSE_TOKEN
INVALID_FUNCTION

XMIQ gate, END_BROWSE_TRANSACTION function

The END_BROWSE_TRANSACTION function of the XMIQ gate is used to terminate a browse of all transactions in the system.

Input parameters

BROWSE_TOKEN
Token identifying the transaction browse to be terminated.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK||DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND
LOOP
INVALID
INVALID_BROWSE_TOKEN
INVALID_FUNCTION

XMIQ gate, START_BROWSE_TXN_TOKEN function

The START_BROWSE_TXN_TOKEN function of the XMIQ gate is used to initiate a browse of a particular components transaction token in all transactions in the system.

Input parameters

TOKEN_OWNER
Identifies the particular transaction token that is to be browsed in the transactions. It can have any of these values:
AP|SM|TD|MN|PG|IC|XS|US|RM|TF

Output parameters

BROWSE_TOKEN
Token identifying this transaction token browse.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND, LOOP
INVALID INVALID_FUNCTION

XMIQ gate, GET_NEXT_TXN_TOKEN function

The GET_NEXT_TXN_TOKEN function of the XMIQ gate is used to return the transaction token associated with the next transaction in the system.

Input parameters

BROWSE_TOKEN
Identifies this browse of the transaction tokens.

Output parameters

OWNERS_TOKEN
The transaction token associated with the current transaction.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION BROWSE_END
DISASTER
ABEND
LOOP
INVALID
INVALID_BROWSE_TOKEN
INVALID_FUNCTION

XMIQ gate, END_BROWSE_TXN_TOKEN function

The END_BROWSE_TXN_TOKEN function of the XMIQ gate is used to terminate a browse of transaction tokens.

Input parameters

BROWSE_TOKEN
Token identifying the transaction token browse to be terminated.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK||DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
ABEND, LOOP
INVALID
INVALID_BROWSE_TOKEN, INVALID_FUNCTION

XMIQ gate, INQUIRE_TRANSACTION_TOKEN function

The INQUIRE_TRANSACTION_TOKEN function of the XMIQ gate is used to return a particular transaction token associated with a particular transaction.

Input parameters

[TRANSACTION_TOKEN]
Token identifying the transaction being inquired upon.

If omitted defaults to the current transaction.

TOKEN_OWNER
Identifies the particular transaction token that is to be returned. It can have any of these values:
AP|SM|TD|MN|PG|IC|XS|US|RM|TF

Output parameters

OWNERS_TOKEN
The transaction token associated with the transaction.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NO_TRANSACTION_ENVIRONMENT
DISASTER
ABEND
LOOP
INVALID
INVALID_BROWSE_TOKEN
INVALID_FUNCTION

XMIQ gate, SET_TRANSACTION_TOKEN function

The SET_TRANSACTION_TOKEN function of the XMIQ gate is used to modify a particular transaction token associated with a particular transaction.

Input parameters

[TRANSACTION_TOKEN]
Token identifying the transaction in which the token is to be modified.

If omitted defaults to the current transaction.

TOKEN_OWNER
Identifies the particular transaction token that is to be changed. It can have any of these values:
AP|SM|TD|MN|PG|IC|XS|US|RM|TF
OWNERS_TOKEN
The new value for the transaction token.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NO_TRANSACTION_ENVIRONMENT
DISASTER
ABEND
LOOP
INVALID
INVALID_BROWSE_TOKEN
INVALID_FUNCTION

XMIQ gate, PURGE_TRANSACTION function

The PURGE_TRANSACTION function of the XMIQ gate is used to purge a particular transaction in the system.

Input parameters

TRANSACTION_NUMBER
The number of the transaction to be purged.
TRANSACTION_TOKEN
Or the token representing the transaction to be purged.
PURGE_TYPE
The type of purge that is to be attempted. It can have either of these values:
NORMAL|FORCE

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_TRANSACTION_NUMBER
INVALID_TRANSACTION_TOKEN
PURGE_DEFERRED
TRANSACTION_INITIALIZING
TRANSACTION_TERMINATING
PURGE_SYSTEM_TRANSACTION
PURGE_ABENDING_TRANSACTION
SPURGE_PROTECTED
PURGE_INHIBITED
INVALID_STATE
FORCEPURGE_NOT_ATTEMPTED
DISASTER
ABEND
LOOP
INVALID INVALID_FUNCTION

XMLD gate, LOCATE_AND_LOCK_TRANDEF function

The LOCATE_AND_LOCK_TRANDEF function of the XMLD gate is used to locate a particular transaction definition instance.

Input parameters

TRANSACTION_ID
Transaction identifier to locate.
TPNAME
Or alternatively a tpname alias of the transaction definition to locate.
[USE_DTRTRAN]
If the named transaction-id or tpname cannot be found then indicates whether the DTRTRAN, if installed, should be used instead. It can have either of these values:
YES|NO

Output parameters

TRANDEF_TOKEN
The token representing the returned transaction definition.
[PRIMARY_TRANSACTION_ID]
The primary transaction identifier of the returned transaction. definition.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION NOT_FOUND
DISASTER
LOGIC_ERROR
ABEND
LOOP
INVALID
INVALID_TPNAME
INVALID_FUNCTION

XMLD gate, UNLOCK_TRANDEF function

The UNLOCK_TRANDEF function of the XMLD gate is used to unlock a previously located transaction definition instance.

Input parameters

TRANDEF_TOKEN
Transaction definition instance to unlock.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
INVALID
NOT_LOCKED
INVALID_TOKEN
INVALID_FUNCTION

XMSR gate, INQUIRE_MXT function

The INQUIRE_MXT function of the XMSR gate is used to inquire upon the state of MXT in the system.

Output parameters

[MXT_QUEUED]
The number of user transactions queued for MXT.
[TCLASS_QUEUED]
The number of transactions queued for tclass membership.
[CURRENT_ACTIVE]
The number of active user transactions.
[CURRENT_ACTIVE]
The number of user transactions queued on MXT.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
INVALID INVALID_FUNCTION

XMSR gate, SET_MXT function

The SET_MXT function of the XMSR gate is used to change MXT in the system.

Input parameters

MXT_LIMIT
The requested setting for MXT.

Output parameters

MXT_LIMIT_SET
The MXT limit that could be set.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
INVALID_MXT_LIMIT
LIMIT_TOO_HIGH
DISASTER
LOGIC_ERROR
ABEND
LOOP
INVALID INVALID_FUNCTION

XMSR gate, INQUIRE_DTRTRAN function

The INQUIRE_DTRTRAN function of the XMSR gate returns the name of the dynamic transaction routing transaction.

Output parameters

DTRTRAN
The name of the dynamic transaction routing transaction definition.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
INVALID INVALID_FUNCTION

XMSR gate, SET_DTRTRAN function

The SET_DTRTRAN function of the XMSR gate changes the dynamic transaction routing transaction definition.

Input parameters

DTRTRAN
The name of the dynamic transaction routing transaction definition.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER or INVALID. Possible values are:
RESPONSE Possible REASON values
DISASTER
LOGIC_ERROR
ABEND
LOOP
INVALID INVALID_FUNCTION

XMXD gate, ADD_REPLACE_TRANDEF function

The ADD_REPLACE_TRANDEF function of the XMXD gate is used to install a transaction definition.

Input parameters

TRANSACTION_ID
Name of transaction definition to install.
PROFILE_NAME
Profile of transaction.
TRAN_PRIORITY
Transaction priority
[INITIAL_PROGRAM]
Initial program of transaction.
[TWASIZE]
Size of Transaction Work Area.
[STATUS]
The status of the transaction. It can have either of these values:
ENABLED|DISABLED
[PARTITIONSET]
The partitionset defined for the transaction. It can have any of these values:
NONE|NAMED|KEEP|OWN
[PARTITIONSET_NAME]
The name of the user defined partitionset used by the transaction.
[TASKDATAKEY]
The storage key that task-lifetime storage is allocated in. It can have either of these values:
CICS|USER
[TASKDATALOC]
The location of task-lifetime storage. It can have either of these values:
BELOW|ANY
[STORAGE_CLEAR]
Whether task-lifetime storage is to be cleared before it is freemained. It can have either of these values:
YES|NO
[SYSTEM_RUNAWAY]
Whether the transaction uses the default system runaway limit. It can have either of these values:
YES|NO
[RUNAWAY_LIMIT]
The runaway limit associated with the transaction.
[DYNAMIC]
Whether the transaction is defined to be dynamic. It can have either of these values:
YES|NO
[LOCAL_QUEUING]
Whether the transaction is eligible to queue locally when it is started on the remote system. It can have either of these values:
YES|NO
[REMOTE_SYSTEM]
The system that a remote transaction is to be routed to.
[REMOTE_NAME]
The name of a remote transaction on the remote system.
[TRAN_ROUTING_PROFILE]
Profile to be used to route a remote transaction to a remote system.
[TCLASS]
Whether the transaction belongs to a tclass. It can have either of these values:
YES|NO
[TCLASS_NAME]
The name of the tclass that the transaction belongs to.
[INDOUBT]
The action to take if work performed by the transaction becomes indoubt. It can have any of these values:
BACKOUT|COMMIT|WAIT
[RESTART]
Whether the transaction is restartable. It can have either of these values:
YES|NO
[SPURGE]
Whether the transaction is system-purgeable. It can have either of these values:
YES|NO
[DTIMEOUT]
The deadlock timeout value for the transaction.
[TPURGE]
Whether the transaction can be purged after a terminal error. It can have either of these values:
YES|NO
[DUMP]
Whether transaction dumps are to be taken. It can have either of these values:
YES|NO
[TRACE]
The level of tracing associated with the transaction. It can have any of these values:
STANDARD|SPECIAL|SUPPRESSED
[SHUTDOWN]
Whether the transaction can be run during shutdown. It can have either of these values:
ENABLED|DISABLED
[RESSEC]
Whether resource security checking is active. It can have either of these values:
YES|NO
[CMDSEC]
Whether command security checking is active. It can have either of these values:
YES|NO
[STORAGE_FREEZE]
Whether storage freeze is on for the transaction. It can have either of these values:
YES|NO
[ISOLATE]
Whether the transaction runs in its own subspace. It can have either of these values:
YES|NO
[CATALOGUED_EXTERNALS]
Block of data specified as an alternative to the above parameters when a transaction definition is being installed from the catalog.
[ALIAS]
Alternative name for transaction definition.
[TASKREQ]
Alternative name for transaction definition so that it can be invoked by PF/PA key, light pen, etc.
[XTRANID]
Alternative name for transaction definition originally specified in hexadecimal notation.
[TPNAME]
Alternative name of transaction definition in form of a sixty four character transaction program name.
[SYSTEN_DEFINITION]
Whether the definition is being added on behalf of CICS or not. It can have either of these values:
YES|NO

Output parameters

[TRANDEF_TOKEN]
Token returned to represent the installed transaction. definition.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
TWASIZE_INVALID
RUNAWAY_LIMIT_INVALID
TRANSACTION_ID_INVALID
ALIAS_INVALID
XTRANID_INVALID
TASKREQ_INVALID
TPNAME_INVALID
RECOVERY_NOT_COMPLETE
DISASTER
LOGIC_ERROR
ABEND
LOOP
INVALID
INITIAL_PROGRAM_EXPECTED
REMOTE_SYSTEM_EXPECTED
REMOTE_NAME_EXPECTED
RUNAWAY_LIMIT_EXPECTED
TRAN_ROUTING_PROF_EXPECTED
TCLASS_NAME_EXPECTED
PARTITIONSET_NAME_EXPECTED
INVALID_FUNCTION

XMXD gate, SET_TRANDEF function

The SET_TRANDEF function of the XMXD gate is used to modify transaction definition creating a new transaction. definition instance.

Input parameters

TRANSACTION_ID
Name of transaction definition to change.
[TRAN_PRIORITY]
Transaction priority.
[STATUS]
The status of the transaction. It can have either of these values:
ENABLED|DISABLED
[SYSTEM_RUNAWAY]
Whether the transaction uses the default system runaway limit. It can have either of these values:
YES|NO
[RUNAWAY_LIMIT]
The runaway limit associated with the transaction.
[TCLASS]
Whether the transaction belongs to a tclass. It can have either of these values:
YES|NO
[TCLASS_NAME]
The name of the tclass that the transaction belongs to.
[SPURGE]
Whether the transaction is system-purgeable. It can have either of these values:
YES|NO
[DUMP]
Whether transaction dumps are to be taken. It can have either of these values:
YES|NO
[TRACE]
The level of tracing associated with the transaction. It can have any of these values:
STANDARD|SPECIAL|SUPPRESSED
[SHUTDOWN]
Whether the transaction can be run during shutdown. It can have either of these values:
ENABLED|DISABLED
[STORAGE_FREEZE]
Whether storage freeze is on for the transaction. It can have either of these values:
YES|NO
[SHUTDOWN_DISABLEOVERRIDE]
Whether to override a SHUTDOWN setting of DISABLED for the transaction definition. It can have either of these values:
YES|NO

Output parameters

[TRANDEF_TOKEN]
Token returned to represent the new transaction. definition instance.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
UNKNOWN_TRANSACTION_ID
RUNAWAY_LIMIT_INVALID
UNKNOWN_TCLASS
DISASTER
LOGIC_ERROR
ABEND
LOOP
INVALID
RUNAWAY_LIMIT_EXPECTED
TCLASS_NAME_EXPECTED
INVALID_FUNCTION

XMXD gate, INQUIRE_TRANDEF function

The INQUIRE_TRANDEF function of the XMXD gate is used to inquire upon a named transaction definition.

Input parameters

INQ_TRANSACTION_ID
Transaction-id to inquire upon.
TRANDEF_TOKEN
Or alternatively token representing transaction definition to inquire upon.
[USE_DTRTRAN]
If the INQ_TRANSACTION_ID cannot be found then indicates whether the DTRTRAN, if installed, should be used for the inquire instead. It can have either of these values:
YES|NO

Output parameters

[TRANSACTION_ID]
Transaction identifier.
[INITIAL_PROGRAM]
Initial program of transaction.
[PROFILE_NAME]
Profile of transaction.
[TWASIZE]
Size of Transaction Work Area.
[TRAN_PRIORITY]
Transaction priority.
[STATUS]
The status of the transaction. It can have either of these values:
ENABLED|DISABLED
[PARTITIONSET]
The partitionset defined for the transaction. It can have any of these values:
NONE|NAMED|KEEP|OWN
[PARTITIONSET_NAME]
The name of the user defined partitionset used by the transaction.
[TASKDATAKEY]
The storage key that task-lifetime storage is allocated in. It can have either of these values:
CICS|USER
[TASKDATALOC]
The location of task-lifetime storage. It can have either of these values:
BELOW|ANY
[STORAGE_CLEAR]
Whether task-lifetime storage is to be cleared before it is freemained. It can have either of these values:
YES|NO
[SYSTEM_RUNAWAY]
Whether the transaction uses the default system runaway limit. It can have either of these values:
YES|NO
[RUNAWAY_LIMIT]
The runaway limit associated with the transaction.
[DYNAMIC]
Whether the transaction is defined to be dynamic. It can have either of these values:
YES|NO
[LOCAL_QUEUING]
Whether the transaction is eligible to queue locally when it is started on the remote system. It can have either of these values:
YES|NO
[REMOTE]
Whether the transaction is remote. It can have either of these values:
YES|NO
[REMOTE_SYSTEM]
The system that a remote transaction is to be routed to.
[REMOTE_NAME]
The name of a remote transaction on the remote system.
[TRAN_ROUTING_PROFILE]
Profile to be used to route a remote transaction to a remote system.
[TCLASS]
Whether the transaction belongs to a tclass. It can have either of these values:
YES|NO
[TCLASS_NAME]
The name of the tclass that the transaction belongs to.
[INDOUBT]
The action to take if work performed by the transaction becomes indoubt. It can have any of these values:
BACKOUT|COMMIT|WAIT
[RESTART]
Whether the transaction is restartable. It can have either of these values:
YES|NO
[SPURGE]
Whether the transaction is system-purgeable. It can have either of these values:
YES|NO
[DTIMEOUT]
The deadlock timeout value for the transaction.
[TPURGE]
Whether the transaction can be purged after a terminal error. It can have either of these values:
YES|NO
[DUMP]
Whether transaction dumps are to be taken. It can have either of these values:
YES|NO
[TRACE]
The level of tracing associated with the transaction. It can have any of these values:
STANDARD|SPECIAL|SUPPRESSED
[SHUTDOWN]
Whether the transaction can be run during shutdown. It can have either of these values:
ENABLED|DISABLED
[RESSEC]
Whether resource security checking is active. It can have either of these values:
YES|NO
[CMDSEC]
Whether command security checking is active. It can have either of these values:
YES|NO
[STORAGE_FREEZE]
Whether storage freeze is on for the transaction. It can have either of these values:
YES|NO
[ISOLATE]
Whether the transaction runs in its own subspace. It can have either of these values:
YES|NO
[SYSTEM_ATTACH]
Whether a system task will be attached using this transaction definition It can have either of these values:
YES|NO
[DTRTRAN]
Indicates whether the returned transaction definition is the dynamic transaction routing transaction definition or not. It can have either of these values:
YES|NO
TCB_HISTORY
returns historical data indicating the frequency of usage of ic each subspace-inheriting open TCB mode by tasks with the caller's these transaction id.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION UNKNOWN_TRANSACTION_ID
INVALID
INVALID_TOKEN
INVALID_FUNCTION
DISASTER
LOGIC_ERROR
ABEND
LOOP

XMXD gate, INQUIRE_REMOTE_TRANDEF function

The INQUIRE_REMOTE_TRANDEF function of the XMXD gate is used to inquire upon a remote transaction definition.

Input parameters

REMOTESYSTEM_KEY
Remote system of remote transaction definition to be found.
REMOTENAME_KEY
Remote name of remote transaction definition to be found.

Output parameters

[TRANSACTION_ID]
Transaction identifier.
[INITIAL_PROGRAM]
Initial program of transaction.
[PROFILE_NAME]
Profile of transaction.
[TWASIZE]
Size of Transaction Work Area.
[TRAN_PRIORITY]
Transaction priority.
[STATUS]
The status of the transaction. It can have either of these values:
ENABLED|DISABLED
[PARTITIONSET]
The partitionset defined for the transaction. It can have any of these values:
NONE|NAMED|KEEP|OWN
[PARTITIONSET_NAME]
The name of the user defined partitionset used by the transaction.
[TASKDATAKEY]
The storage key that task-lifetime storage is allocated in. It can have either of these values:
CICS|USER
[TASKDATALOC]
The location of task-lifetime storage. It can have either of these values:
BELOW|ANY
[STORAGE_CLEAR]
Whether task-lifetime storage is to be cleared before it is freemained. It can have either of these values:
YES|NO
[SYSTEM_RUNAWAY]
Whether the transaction uses the default system runaway limit. It can have either of these values:
YES|NO
[RUNAWAY_LIMIT]
The runaway limit associated with the transaction.
[DYNAMIC]
Whether the transaction is defined to be dynamic. It can have either of these values:
YES|NO
[LOCAL_QUEUING]
Whether the transaction is eligible to queue locally when it is started on the remote system. It can have either of these values:
YES|NO
[REMOTE]
Whether the transaction is remote. It can have either of these values:
YES|NO
[REMOTE_SYSTEM]
The system that a remote transaction is to be routed to.
[REMOTE_NAME]
The name of a remote transaction on the remote system.
[TRAN_ROUTING_PROFILE]
Profile to be used to route a remote transaction to a remote system.
[TCLASS]
Whether the transaction belongs to a tclass. It can have either of these values:
YES|NO
[TCLASS_NAME]
The name of the tclass that the transaction belongs to.
[INDOUBT]
The action to take if work performed by the transaction becomes indoubt. It can have any of these values:
BACKOUT|COMMIT|WAIT
[RESTART]
Whether the transaction is restartable. It can have either of these values:
YES|NO
[SPURGE]
Whether the transaction is system-purgeable. It can have either of these values:
YES|NO
[DTIMEOUT]
The deadlock timeout value for the transaction.
[TPURGE]
Whether the transaction can be purged after a terminal error. It can have either of these values:
YES|NO
[DUMP]
Whether transaction dumps are to be taken. It can have either of these values:
YES|NO
[TRACE]
The level of tracing associated with the transaction. It can have any of these values:
STANDARD|SPECIAL|SUPPRESSED
[SHUTDOWN]
Whether the transaction can be run during shutdown. It can have either of these values:
ENABLED|DISABLED
[RESSEC]
Whether resource security checking is active. It can have either of these values:
YES|NO
[CMDSEC]
Whether command security checking is active. It can have either of these values:
YES|NO
[STORAGE_FREEZE]
Whether storage freeze is on for the transaction. It can have either of these values:
YES|NO
[ISOLATE]
Whether the transaction runs in its own subspace. It can have either of these values:
YES|NO
[SYSTEM_ATTACH]
Whether a system task will be attached using this transaction definition It can have either of these values:
YES|NO
[DTRTRAN]
Indicates whether the returned transaction definition is the dynamic transaction routing transaction definition or not. It can have either of these values:
YES|NO
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION REMOTE_NOT_FOUND
INVALID INVALID_FUNCTION
DISASTER
LOGIC_ERROR
ABEND
LOOP

XMXE gate, GET_TXN_ENVIRONMENT function

The GET_TXN_ENVIRONMENT function of the XMXE gate is used to acquire a transaction environment for a task that was DS instead XM attached.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
DUPLICATE_ENVIRONMENT
ATTACHED_TRANSACTION
DISASTER
ABEND
LOOP
INVALID INVALID_FUNCTION

XMXE gate, FREE_TXN_ENVIRONMENT function

The FREE_TXN_ENVIRONMENT function of the XMXE gate is used to release a transaction environment for a task that was DS instead XM attached.

Output parameters

RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is DISASTER, EXCEPTION, or INVALID. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_ENVIRONMENT
ATTACHED_TRANSACTION
DISASTER
ABEND
LOOP
INVALID INVALID_FUNCTION
[[ Contents Previous Page | Next Page Index ]]