Recovery Manager domain’s call back formats

Table 87 describes the call back format owned by the Recovery Manager domain and shows the function performed on the calls.

Table 87. Call back format owned by the Recovery Manager domain
Format Calling module Function
RMRO
DFHRMUO
DFHRMUP
DFHRMUQ
DFHRMUW
DFHRMUO
DFHRMRO2
DFHRMRO3
DFHRMRO4
DFHRMROS
DFHRMROU
PERFORM_COMMIT



PERFORM_PREPARE
START_BACKOUT
DELIVER_BACKOUT_DATA
END_BACKOUT
PERFORM_SHUNT
PERFORM_UNSHUNT
RMDE
DFHRMR1S
DFHRMR1D
DFHRMR1E
DFHRMR1D
START_DELIVERY
DELIVER_RECOVERY
END_DELIVERY
DELIVER_FORGET
RMKP
DFHRMR1K
TAKE_KEYPOINT
RMLK
DFHRMLSP
DFHRMLSP
DFHRMLSD
DFHRMLSD
DFHRMLSO
DFHRMLSS
DFHRMLSU
PERFORM_PRELOGGING
PERFORM_PREPARE
REPLY_DO_COMMIT
SEND_DO_COMMIT
PERFORM_COMMIT
PERFORM_SHUNT
PERFORM_UNSHUNT

In the descriptions of the formats that follow, the "input" parameters are input not to Recovery Manager domain, but to the domain being called by the Recovery Manager. Similarly, the "output" parameters are output by the domain that was called by Recovery Manager domain, in response to the call.

RMRO gate, PERFORM_COMMIT function

This function requires the Recovery Manager client to perform phase 2 of syncpoint processing.

Input parameters

WORK_TOKEN
The Recovery Manager client’s work token for the syncpointing unit of work.
CONTINUE
A parameter specifying whether the current transaction will continue into a following unit of work. It can have any one of these values:
YES|NO
UOW_STATUS
The status of the current unit of work. It can have any one of these values:
FORWARD|BACKWARD
RESTART
An optional parameter specifying whether a backing out transaction will be restarted. It can have any one of these values:
YES|NO

Output parameters

FORGET_RECORD
A value specifying whether all obligations to this Recovery Manager client have been discharged. It can have any one of these values:
YES|NO
RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMRO gate, PERFORM_PREPARE function

This function requires the Recovery Manager client to perform phase 1 of syncpoint processing.

Input parameters

WORK_TOKEN
The Recovery Manager client’s work token for the syncpointing unit of work.
CONTINUE
A parameter specifying whether the current transaction will continue into a following unit of work. It can have any one of these values:
YES|NO

Output parameters

VOTE
A value specifying the Recovery Manager client’s vote on the outcome of the syncpointing unit of work. It can have any one of these values:
YES|NO|NO_CONTINUE|READ_ONLY
RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMRO gate, START_BACKOUT function

This function notifies the Recovery Manager client that backout processing is about to be performed for the unit of work.

Input parameters

WORK_TOKEN
The Recovery Manager client’s work token for the syncpointing unit of work.
CONTINUE
A parameter specifying whether the current transaction will continue into a following unit of work. It can have any one of these values:
YES|NO
REMOVE
A parameter specifying whether or not the backout is due to an invocation of the REMOVE function of the RMRE gate. It can have any one of these values:
YES|NO

Output parameters

RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMRO gate, DELIVER_BACKOUT_DATA function

This function requires the Recovery Manager client process backout data from the system log for the unit of work.

Input parameters

WORK_TOKEN
The Recovery Manager client’s work token for the syncpointing unit of work.
DATA
A buffer containing the data previously logged with BACKWARD_DATA(YES) via the APPEND function of the RMRE gate.
RESOURCE_ID
An optional parameter specifying the name of the resource with which the logged data is associated.
CONTINUE
A parameter specifying whether the current transaction will continue into a following unit of work. It can have any one of these values:
YES|NO
FORWARD_DATA
A parameter specifying whether or not the data was originally logged as FORWARD_DATA. It can have any one of these values:
YES|NO
REMOVE
A parameter specifying whether or not the backout is due to an invocation of the REMOVE function of the RMRE gate. It can have any one of these values:
YES|NO
CLUSTER_ID
A buffer to receive a symbolic name identifying the resource.
LOCAL_ACCESS_ID
A buffer to receive the specific name of the resource

Output parameters

KEEP
A value specifying whether the backout action failed, implying the record should be kept and not forgotten. It can have any one of these values:
YES|NO
RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMRO gate, END_BACKOUT function

This function notifies the Recovery Manager client that backout processing has completed for the unit of work.

Input parameters

WORK_TOKEN
The Recovery Manager client’s work token for the syncpointing unit of work.
CONTINUE
A parameter specifying whether the current transaction will continue into a following unit of work. It can have any one of these values:
YES|NO
REMOVE
A parameter specifying whether or not the backout is due to an invocation of the REMOVE function of the RMRE gate. It can have any one of these values:
YES|NO

Output parameters

RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMRO gate, PERFORM_SHUNT function

This function notifies the Recovery Manager client that the unit of work is about to shunt.

Input parameters

WORK_TOKEN
The Recovery Manager client’s work token for the syncpointing unit of work.
CONTINUE
A parameter specifying whether the current transaction will continue into a following unit of work. It can have any one of these values:
YES|NO

Output parameters

NEXT_WORK_TOKEN
A value for the Recovery Manager client’s work token in the following unit of work.
RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMRO gate, PERFORM_UNSHUNT function

This function notifies the Recovery Manager client that the unit of work is unshunting.

Input parameters

WORK_TOKEN
The Recovery Manager client’s work token for the syncpointing unit of work.

Output parameters

RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMDE gate, START_DELIVERY function

This function notifies the Recovery Manager client that system recovery processing is about to be performed.

Input parameters

None

Output parameters

RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMDE gate, DELIVER_RECOVERY function

This function requires the Recovery Manager client to process recovery data from the system log.

Input parameters

RESOURCE_ID
An optional parameter specifying the name of the resource with which the logged data is associated.
DATA
A buffer containing the data previously logged with BACKWARD_DATA(YES) via the APPEND function of the RMRE gate.
FORWARD_DATA
A parameter specifying whether or not the data was originally logged as FORWARD_DATA. It can have any one of these values:
YES|NO
BACKWARD_DATA
A parameter specifying whether or not the data was originally logged as BACKWARD_DATA. It can have any one of these values:
YES|NO
KEYPOINT
A parameter specifying whether or not the data was logged as part of a keypoint. It can have any one of these values:
YES|NO
BACKED_OUT
A parameter specifying whether or not the update the data is associated with backed out. It can have any one of these values:
YES|NO
UOW
A parameter specifying whether the data is related to a particular unit of work. It can have any one of these values:
YES|NO
UOW_STATUS
An optional parameter specifying the status of unit of work the data belongs to (if any). It can have any one of these values:
FORWARD|BACKWARD|IN_DOUBT|IN_FLIGHT
LOCAL_UOW_ID
An optional parameter specifying the local UOWID of the unit of work the data belongs to (if any).

Output parameters

RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMDE gate, END_DELIVERY function

This function notifies the Recovery Manager client that all recovery information from the system log has been processed.

Input parameters

None

Output parameters

RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMDE gate, DELIVER_FORGET function

This function notifies the Recovery Manager client that FORGET processing is required for some resource in a unit of work.

Input parameters

LOCAL_ACCESS_ID
A parameter specifying the name of the resource associated with the forget processing.
UOW
It can only have the value YES.
UOW_STATUS
The status of the unit of work. It can have any one of these values:
FORWARD|BACKWARD|IN_DOUBT|IN_FLIGHT
LOCAL_UOW_ID
The local UOWID of the unit of work.

Output parameters

RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMKP gate, TAKE_KEYPOINT function

This function requires the Recovery Manager client to perform keypoint processing.

Input parameters

SHUTDOWN
A parameter specifying whether the keypoint is the warm keypoint taken during shutdown or an activity keypoint. It can have any one of these values:
YES|NO

Output parameters

RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMLK gate, PERFORM_PRELOGGING function

This function notifies the Recovery Manager client that phase 1 of syncpoint processing is about to occur.

Input parameters

RMC_TOKEN
The Recovery Manager client’s token associated with the Recovery Manager Link object.
INITIATOR
A parameter specifying whether the remote system is the initiator of the syncpoint. It can have any one of these values:
YES|NO
COORDINATOR(YES]NO)
A parameter specifying whether the remote system is the coordinator of the distributed unit of work. It can have any one of these values:
YES|NO

Output parameters

RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMLK gate, PERFORM_PREPARE function

This function requires the Recovery Manager client perform phase 1 of syncpoint processing.

Input parameters

RMC_TOKEN
The Recovery Manager client’s token associated with the Recovery Manager Link object.
CONTINUE
A parameter specifying whether the current transaction will continue into a following unit of work. It can have any one of these values:
YES|NO
SYSTEM
A parameter specifying whether PERFORM_PREPARE call is part of a syncpoint or the result of EXEC CICS® ISSUE PREPARE. It can have any one of these values:
YES|NO
RECOVERY_STATUS
A parameter specifying whether recoverable work has taken place as part of the distributed unit of work on the remote system. It can have any one of these values:
NECESSARY|UNNECESSARY|SYNC_LEVEL_1

Output parameters

VOTE
A value specifying the Recovery Manager client’s vote on the outcome of the syncpointing unit of work. It can have any one of these values:
YES|NO|NO_CONTINUE|READ_ONLY|HEURISTIC_MIXED
RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMLK gate, REPLY_DO_COMMIT function

This function requires the Recovery Manager client communicate the result of this systems phase 1 syncpoint processing to the coordinating system, and obtain the outcome of the distributed unit of work.

Input parameters

RMC_TOKEN
The Recovery Manager client’s token associated with the Recovery Manager Link object.
CONTINUE
A parameter specifying whether the current transaction will continue into a following unit of work. It can have any one of these values:
YES|NO
SINGLE_UPDATER
A parameter specifying whether the single updater optimization is being performed. It can have any one of these values:
YES|NO

Output parameters

ACCESSIBLE
A value specifying whether communication with the remote system failed. It can have any one of these values:
YES|NO|SHUNTED
VOTE
A value specifying the outcome of the syncpointing unit of work. It can have any one of these values:
YES|NO|NO_CONTINUE|READ_ONLY|HEURISTIC_MIXED
RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMLK gate, SEND_DO_COMMIT function

This function requires the Recovery Manager client communicate the result of this systems phase 1 syncpoint processing to the last agent system, and obtain the outcome of the distributed unit of work.

Input parameters

RMC_TOKEN
The Recovery Manager client’s token associated with the Recovery Manager Link object.
CONTINUE
A parameter specifying whether the current transaction will continue into a following unit of work. It can have any one of these values:
YES|NO
SINGLE_UPDATER
A parameter specifying whether the single updater optimization is being performed. It can have any one of these values:
YES|NO

Output parameters

ACCESSIBLE
A value specifying whether communication with the remote system failed. It can have any one of these values:
YES|NO|SHUNTED
VOTE
A value specifying the outcome of the syncpointing unit of work. It can have any one of these values:
YES|NO|NO_CONTINUE|READ_ONLY|HEURISTIC_MIXED
RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMLK gate, PERFORM_COMMIT function

This function requires the Recovery Manager client perform phase 2 of syncpoint processing.

Input parameters

RMC_TOKEN
The Recovery Manager client’s token associated with the Recovery Manager Link object.
CONTINUE
A parameter specifying whether the current transaction will continue into a following unit of work. It can have any one of these values:
YES|NO
SINGLE_UPDATER
A parameter specifying whether the single updater optimization is being performed. It can have any one of these values:
YES|NO
UOW_STATUS
The status of the syncpointing unit of work. It can have any one of these values:
FORWARD|BACKWARD
RESTART
An optional parameter specifying whether a backing out transaction will be restarted. It can have any one of these values:
YES|NO
COORDINATOR
A parameter specifying whether the remote system is the coordinator of the distributed unit of work. It can have any one of these values:
YES|NO
INITIATOR
A parameter specifying whether the remote system is the initiator of the syncpoint. It can have any one of these values:
YES|NO
PRESUMPTION
A parameter specifying whether the remote system assumes the presume abort or presume nothing protocols. It can have any one of these values:
ABORT|NOTHING
RECOVERY_STATUS
A parameter specifying whether recoverable work has taken place as part of the distributed unit of work on the remote system. It can have any one of these values:
NECESSARY|UNNECESSARY|SYNC_LEVEL_1

Output parameters

ACCESSIBLE
A parameter specifying that the communications link to the remote system has failed. It can have any one of these values:
YES|NO|SHUNTED
FORGET
A parameter specifying whether all obligations to the remote system with respect to recovery have been discharged. It can have any one of these values:
YES|NO
PASS
A parameter specifying whether an equivalent Recovery Manager Link object should be created in the following unit of work. It can have any one of these values:
YES|NO
ABEND
A parameter specifying whether an abend occurred during the PERFORM_COMMIT call-back. It can have any one of these values:
YES|NO
NEXT_RECOVERY_STATUS
A parameter specifying the initial RECOVERY_STATUS of the Recovery Manager Link object created in the following unit of work as a result of PASS(YES). It can have any one of these values:
NECESSARY|UNNECESSARY|SYNC_LEVEL_1|DEFAULT
RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMLK gate, PERFORM_SHUNT function

This function notifies the Recovery Manager client that the unit of work is shunting.

Input parameters

RMC_TOKEN
The Recovery Manager client’s token associated with the Recovery Manager Link object.
CONTINUE
A parameter specifying whether the current transaction will continue into a following unit of work. It can have any one of these values:
YES|NO
RECOVERY_STATUS
A parameter specifying whether recoverable work has taken place as part of the distributed unit of work on the remote system. It can have any one of these values:
NECESSARY|UNNECESSARY|SYNC_LEVEL_1

Output parameters

FORGET
A parameter specifying whether all obligations to the remote system with respect to recovery have been discharged. It can have any one of these values:
YES|NO
RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED

RMLK gate, PERFORM_UNSHUNT function

This function notifies the Recovery Manager client that the unit of work is unshunting.

Input parameters

LINK_TOKEN
A token identifying the Recovery Manager Link object to be unshunted.
LOGNAME_BUFFER
A parameter specifying a buffer containing the logname of the remote system.
REMOTE_ACCESS_ID_BUFFER
A buffer containing the netname of the remote system, or the name of the External Resource Manager.
LINK_ID_BUFFER
A buffer containing the termid of the session to the remote system, or the External Resource Manager qualifier.
LINK_ID_SOURCE
An optional parameter specifying whether the local or remote system allocated the session. It can have any one of these values:
LOCAL|REMOTE

Output parameters

RESPONSE
is the Recovery Manager client’s response to the call. It can have any one of these values:
OK|EXCEPTION|DISASTER|INVALID|KERNERROR|PURGED
[[ Contents Previous Page | Next Page Index ]]