File control quiesce receive exit, XFCVSDS

The XFCVSDS exit is invoked when VSAM RLS notifies CICS® that processing is required as a result of some data set-related events occurring in the sysplex. XFCVSDS is invoked before CICS processing takes place, and only if a data set name block (DSNB) exists for the data set. The actions that cause XFCVSDS to be invoked are:

Exit XFCVSDS

When invoked
Invoked after VSAM RLS has informed CICS that processing is required as a result of a data set-related action occurring in the sysplex.
Exit-specific parameters
UEPDSNAM
Address of a 44-byte field containing the name of the data set to which the action applies
UEPVSACT
Address of a 1-byte field indicating the RLS action of which CICS has been informed. Possible values are:
UEQUIES
Quiesce
UEUNQUIS
Unquiesce
UENBWST
Non-BWO backup start
UENBWCMP
Non-BWO backup complete
UEBWOST
BWO backup start
UEBWOCMP
BWO backup complete.
UEPQUCLS
Address of a 1-byte field indicating, for UEQUIES only, how files open in RLS mode are to be closed. Possible values are:
UEORDCLO
Wait until all in-flight UOWs that are accessing the data set have completed syncpoint before closing.
UEIMMCLO
Abend all in-flight UOWs that are accessing the data set before closing.
UEPCPTEC
Address of a 1-byte field indicating, for UENBWST and UEBWOST only, whether the backup is to use the concurrent copy technique. Possible values are:
UEORDCOP
Concurrent copy is not being used.
UECONCOP
Concurrent copy is being used.
Return codes
UERCNORM
Continue processing--complete the actions required to support the VSAM RLS operation.
UERCBYP
This applies only to actions UEQUIES, UENBWST and UEBWOST. CICS is not to carry out the processing required for the VSAM RLS action, and is to cancel the action throughout the sysplex.

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 can be used, with the following restrictions:

Related concepts
Overview -- what is a global user exit?
Overview of the XPI
Global user exit XPI examples, showing the use of storage
Related tasks
Writing global user exit programs
Making an XPI call
Related reference
List of global user exit points
The XPI functions
[[ Contents Previous Page | Next Page Index ]]