RXUW gate, PUT_CLIENT_REQUEST function
The PUT_CLIENT_REQUEST function of the RXDM gate is used to associate a request from a client with an RRS Unit of Recovery (UR).
Input Parameters
- CLIENT_TOKEN
- A token representing the client of the UR.
- CLIENT_TYPE
- Indicates the type of client of the transaction.
- Values for the parameter are:
- TERMINAL
- CONNECTION
- The connection on which the client request was received. This parameter is used to identify the source of the request in any messages that are issued.
- CONTEXT_TOKEN
- The token representing the RRMS context for which the request is issued.
- PASS_TOKEN
- A token used to protect against unauthorised use of the context token and URID.
- TRANSACTION_ID
- The transaction id associated with the request. This parmeter is used to correlate succesive requests for the same transaction instance.
- URID
- The identifier of the RRS Unit of Recovery associated with the context.
- USERID
- The userid associated with the request. This parmeter is used to correlate succesive requests for the same transaction instance.
Output Parameters
- REASON
- The following values are returned when RESPONSE is EXCEPTION:
- BACKOUT
- RACE
- RRS_UNAVAILABLE
- SYNCPOINT
- The following values are returned when RESPONSE is INVALID:
- INVALID_FUNCTION
- The following values are returned when RESPONSE is PURGED:
- TASK_CANCELLED
- TIMED_OUT
- NEW_UR
- Indicates whether a new UR has been created for this request.
- Values for the parameter are:
- YES
- NO_AND_READY
- NO_AND_NOT_READY
- NO_AND_NOTASK
- YES
- Indicates that a new UR has been created
- NO_AND_READY
- Indicates that the request was associated with an existing UR and that task is ready to receive the request.
- NO_AND_NOT_READY
- Indicates that the request was associated with an existing UR but that task is not ready to receive the request. This typically occurs when the original request has timed out and another transactional EXCI request in the same RU has been sent by the EXCI job.
- NO_AND_NOTASK
- Indicates that the request was associated with an existing UR but that task has not yet expressed an interest in that UR. This can occur when the original request has been held by MAXTASK or TRANCLASS (TCLASS) limits and has timed out, and another transactional EXCI request in the same RU has been sent by the EXCI job.
- RESPONSE
- Indicates whether the domain call was successful. For more information, see RESPONSE parameter on domain interfaces.
- TRANSACTION_NUMBER
- The transaction number of the transaction associated with the request.
- UR_TOKEN
- is the token by which the UR associated with the request is known by the RX domain.