XMAT gate, ATTACH function
The ATTACH function of the XMAT gate is used to attach a new transaction.
Input Parameters
- RETURN_NOT_FOUND
- Indicates whether the attacher wants to receive the NOT_FOUND exception. Default is to attach CSAC in place of the requested transaction.
- Values for the parameter are:
- NO
- YES
- TPNAME
- Alternative means of specifying the transaction identifier to attach.
- TRANSACTION_ID
- The transaction identifier to attach.
- ATTACH_PARMS
- Optional Parameter
- Parameters to be passed to the attached transaction.
- EXTERNAL_UOW_ID
- Optional Parameter
- An externally created unit-of-work identifier to be associated with the attached transaction.
- FACILITY_TYPE
- Optional Parameter
- The type of principal facility to be associated with the attached transaction.
- Values for the parameter are:
- NONE
- TERMINAL
- PRIMARY_CLIENT_REQ_BLOCK
- Optional Parameter
- A data block containing information associated with the primary client.
- PRIMARY_CLIENT_TYPE
- Optional Parameter
- The type of client for which the transaction is being attached.
- Values for the parameter are:
- APPC_SESSION
- BRIDGE
- IIRR
- IP_ECI
- LU61_SESSION
- MRO_SESSION
- NONE
- RRS_UR
- RZ_INSTORE_TRPORT
- SCHEDULER
- SOCKET
- START
- START_TERMINAL
- TERMINAL
- TRANDATA
- WEB
- XM_RUN_TRANSACTION
- PRIORITY
- Optional Parameter
- Combined user and terminal priority to be added to that of the transaction definition to determine the total priority of the attached transaction.
- RESTART_COUNT
- Optional Parameter
- If the attach is for a restarted transaction then this count indicates the number of this restart attempt.
- START_ATTACH
- Optional Parameter
- Indicates if the attach is in response to a START command.
- Values for the parameter are:
- YES
- START_CODE
- Optional Parameter
- Indicates the reason for the attach.
- Values for the parameter are:
- C
- DF
- QD
- S
- SD
- SZ
- T
- TT
- SUSPEND
- Optional Parameter
- Indicates whether the attacher is willing to suspend during the attach.
- Values for the parameter are:
- NO
- YES
- SYSTEM_ATTACH
- Optional Parameter
- Indicates whether the transaction should be attached as a system transaction.
- Values for the parameter are:
- YES
- TD_TOKEN
- Optional Parameter
- Token identifying a TDQ to be associated with the transaction.
- TF_TOKEN
- Optional Parameter
- Token identifying a terminal to be associated with the transaction.
- TOTAL_PRIORITY
- Optional Parameter
- The overriding priority to be associated with the attached transaction.
- TRANSACTION_GROUP
- Optional Parameter
- Indicates whether the newly attached transaction should be in the same monitoring group as the current transaction.
- Values for the parameter are:
- NEW
- SAME
- US_TOKEN
- Optional Parameter
- Token identifying a user to be associated with the transaction.
- USE_DTRTRAN
- Optional Parameter
- If the named transaction-id or tpname cannot be found then indicates whether the DTRTRAN, if installed, should be used instead.
- Values for the parameter are:
- NO
- YES
Output Parameters
- CURRENT_ACTIVE
- Optional Parameter
-
Is the number of transactions that are currently active within the region.
- CURRENT_QUEUED
- Optional Parameter
-
Is the number of transactions that are currently queued waiting on MXT.
- REASON
- The values for the parameter are:
- ABEND
- DISABLED
- INSUFFICIENT_STORAGE
- INVALID_FUNCTION
- INVALID_RETURN_NOT_FOUND
- INVALID_START_CODE
- INVALID_SYSTEM_ATTACH
- LOOP
- NOT_ENABLED_FOR_SHUTDOWN
- NOT_FOUND
- STATE_SYSTEM_ATTACH
- STATE_TASKDATAKEY
- STATE_TASKDATALOC
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- TRANDEF_TOKEN
- Optional Parameter
- The token representing the returned transaction definition.
- TRANNUM
- Optional Parameter
- Is the transaction number assigned to the newly attached transaction.
- TRANSACTION_TOKEN
- Optional Parameter
- Is the token identifying the newly attached transaction.