Scheduler services domain’s specific gate

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

Table 92. Scheduler services domain’s specific gate
Gate Trace Function XPI
SHPR
SH 0151
SH 0152
ADD_PENDING_REQUEST
DELETE_PENDING_REQUEST
SET_BOUND_REQUEST
NO
NO
NO
SHRT
SH 0141
SH 0142
SET_EXIT_PROGRAM
INQUIRE_EXIT_PROGRAM
NO
NO
SHRQ
SH 0111
SH 0112
PERFORM_RESTART_DREDGE
PERFORM_REGULAR_DREDGE
PERFORM_SHUTDOWN
NO
NO
NO
SHRR
SH 0161
SH 0162
ROUTE_REQUEST
RECEIVE_REQUEST
RETRY_REQUEST
NO
NO
NO

SHPR gate, ADD_PENDING_REQUEST function

The ADD_PENDING_REQUEST function of the SHPR gate is used to add a pending schedule request to the scheduler services queue associated with this UOW. The pending schedule requests are hardened to the scheduler services local request queue (LRQ) as part of syncpoint processing.

Input parameters

TRANID
is an 4-character transaction id.
USERID
is an 8-character userid.
TIME
is a string of length 8, used when a request is delayed for a period time.
TOKEN
is a string of length 4, used to identify the pending queue.
BALANCE
indicates whether this schedule request is eligible for workload balancing. It can have either of these values:
YES|NO
PTYPE
is the 8-character process type.
PNAME
is the 36-character process name.
ACTIVITY_ID
is a block containing the activity id.
ACTIVITY_REQUEST_BLOCK
is a block containing the BAM domain activity request block.

Output parameters

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

SHPR gate, DELETE_PENDING_REQUEST function

The DELETE_PENDING_REQUEST of the SHPR gate is used to delete a pending request queue.

Input parameters

TOKEN
is a string of length 4, which identifies the queue to be deleted.

Output parameters

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

SHPR gate, SET_BOUND_REQUEST function

The SET_BOUND_REQUEST function of the SHPR gate is used to update the schedule request to indicate that a process and/or activity has completed.

Input parameters

ACTIVITY_COMPLETE
indicates whether the activity associated with this UOW has completed. It can have either of these values:
YES|NO
PROCESS_COMPLETE
indicates whether the process associated with this UOW has completed. It can have either of these values:
YES|NO

Output parameters

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

SHRT gate, SET_EXIT_PROGRAM function

The SET_EXIT_PROGRAM function of the SHRT gate is used to alter the distributed routing exit program, initially named on the DSRTPGM system initialisation parameter. The sysid of the local system is passed during CICS® initialisation.

Input parameters

PROGRAM_NAME
is the 8-character exit program name.
LOCAL_SYSID
is the 4-character local sysid.

Output parameters

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

SHRT gate, INQUIRE_EXIT_PROGRAM function

The INQUIRE_EXIT_PROGRAM function of the SHRT gate is used to return the name of the distributed routing exit program, initially named on the DSRTPGM system initialisation parameter.

Input parameters

PROGRAM_NAME
is the 8-character exit program name.

Output parameters

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

SHRQ gate, PERFORM_RESTART_DREDGE function

The PERFORM_RESTART_DREDGE of the SHRQ gate is used to initiate the dredging of expired schedule requests on the local request queue (LRQ) after a CICS system restart.

Output parameters

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

SHRQ gate, PERFORM_REGULAR_DREDGE function

The PERFORM_REGULAR_DREDGE function of the SHRQ gate initiates the periodic dredging of expired schedule requests on the local request queue (LRQ).

Output parameters

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

SHRQ gate, PERFORM_SHUTDOWN function

The PERFORM_SHUTDOWN function of the SHRQ gate is used to stop dredging of schedule requests on the local request queue (LRQ), preventing any further CICS BTS work from being initiated.

Output parameters

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

SHRR gate, ROUTE_REQUEST function

The ROUTE_REQUEST function of the SHRR gate is used to identify a target region to which a schedule request should be routed.

Input parameters

REQUEST_BUFFER
is a buffer used to hold the schedule request which is to be routed.

Output parameters

SYSID
is the 4-character sysid of the region to which the schedule request should be routed.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_REQUEST_FOUND
REQUEST_BUFFER_TOO_SMALL
NO_SYSTEM

SHRR gate, RECEIVE_REQUEST function

The RECIEVE_REQUEST function of the SHRR gate is used to receive a schedule request once it has been routed to the target region.

Input parameters

REQUEST_BUFFER
is a buffer used to hold the received schedule request.

Output parameters

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

SHRR gate, RETRY_REQUEST function

The RETRY_REQUEST function of the SHRR gate is used obtain another target region if the initial attempt at routing the schedule request fails.

Input parameters

REQUEST_BUFFER
is a buffer used to hold the schedule request which is to be routed.
ROUTE_ERROR
indicates the reason why the routing of the schedule request failed. It can have a value of:
SYSID_NOT_FOUND|SYSID_OUT_OF_SERVICE|NO_SESSIONS|
ALLOCATE_REJECTED|QUEUE_PURGED|FUNC_NOT_SUPPORTED|
LEGERR|PGMIDERR|INVREQ|NOTAUTH|TERMERR

Output parameters

SYSID
is the 4-character sysid of the region to which the schedule request should be routed.
LOCAL
indicates whether we should retry the schedule request on the local region. It can take the values:
YES|NO
ABEND_CODE
is the 4-character abend code.
RESPONSE
is the domain’s response to the call. It can have any of these values:
OK|EXCEPTION|INVALID|DISASTER|KERNERROR|PURGED
[REASON]
is returned when RESPONSE is EXCEPTION. Possible values are:
RESPONSE Possible REASON values
EXCEPTION
NO_REQUEST_FOUND
REQUEST_BUFFER_TOO_SMALL
NO_SYSTEM
[[ Contents Previous Page | Next Page Index ]]