File control quiesce send exit XFCQUIS
The XFCQUIS global user exit is invoked on completion of a VSAM RLS quiesce or unquiesce of a data set that was requested either by a CEMT or EXEC CICS SET DSNAME QUIESCESTATE command.
The exit is invoked regardless of whether the QUIESCESTATE action has completed
successfully or unsuccessfully. This enables you to perform, or schedule,
any processing that cannot take place until quiesce or unquiesce processing
has finished.
- When invoked
- On completion, successful or failed, of a SET DSNAME QUIESCESTATE command.
- Exit-specific parameters
-
- UEPQDSNM
- Address of a 44-byte field containing the name of the data set that was being quiesced or unquiesced.
- UEPQSTAT
- Address of a 1-byte field indicating whether the data set was being quiesced
or unquiesced. Possible values are:
- UEQSD
- Data set was being quiesced by QUIESCESTATE(QUIESCED). In-flight UOWs accessing the data set completed syncpoint before files open in RLS mode were closed.
- UEIMQSD
- Data set was being quiesced by QUIESCESTATE(IMMQUIESCED). In-flight UOWs accessing the data set were abended before files open in RLS mode were closed.
- UEUNQSD
- Data set was being unquiesced by QUIESCESTATE(UNQUIESCED).
- UEPQRCDE
- Address of a 1-byte field indicating the result of the quiesce or unquiesce.
Possible values are:
- UEQOK
- Successful.
- UEQREJEC
- Rejected—see UEPQCONF for the reason code.
- UEQUNKNO
- Failed because data set not known to DFSMS as a VSAM data set.
- UEQIOERR
- Failed because of RLS error or SMSVSAM server not available.
- UEQCANCL
- Failed because quiesce was canceled by user (UEQSD and UEIMQSD only).
- UEQTIMED
- Failed because quiesce was canceled due to timeout (UEQSD and UEIMQSD only).
- UEQMIGRT
- Failed because the data set has been migrated.
- UEPQCONF
- Address of a 1-byte field indicating the reason why the quiesce or unquiesce
was rejected (for UEQREJEC only). Possible values are:
- UEQUIINP
- Quiesce is in progress (UEQSD and UEIMQSD status only).
- UEUNQINP
- Unquiesce is in progress.
- UENBWINP
- Non-BWO copy is in progress.
- UEBWOINP
- BWO copy is in progress.
- UEUNKINP
- Unknown event is in progress.
- Return codes
-
- UERCNORM
- Continue processing.
A return code of UERCPURG is not allowed.
- XPI calls
- All can be used.
- API and SPI calls
- You can use CICS® API and SPI commands at this exit. In general, all except EXEC CICS SHUTDOWN and EXEC CICS XCTL can be used, but you must not use the QUIESCESTATE keyword of EXEC CICS SET DSNAME.