Required parameters

return_code 
TYPE: INTEGER 
LENGTH: FULL WORD
EXPLANATION: Return code from DWWCVRN. The return code is also returned in register 15. This is a required output parameter and must be defined as an integer. See Return and reason codes for a further explanation of the possible return codes.
,reason_code
TYPE: INTEGER 
LENGTH: FULL WORD
EXPLANATION: Reason code from DWWCVRN. The reason code is also returned in register 0. This is a required output parameter and must be defined as an integer. See Return and reason codes for a further explanation of the possible reason codes.
,prob_det
TYPE: INTEGER 
LENGTH: TWO FULL WORDS
EXPLANATION: Problem determination data when DWWCVRN encounters an error. This is a required output parameter and must be defined as a two-element array of integers. See Return and reason codes for a further explanation of the problem determination data.
,backup_product 
TYPE: CHARACTER (EBCDIC) 
LENGTH: THREE BYTES
EXPLANATION: Identifies the product that created the backup. This is required three character input field. The characters can be alphabetic, numeric, or national (@, #, $). No blanks can be specified.

For example, if a product named SAMPLE VSAM BACKUP is used to create the backup of the VSAM data set, you could specify the acronym SVB as input to the backup_product parameter. Use a consistent value for the backup_product parameter for all backups made by the same product.

CICS® VR uses the values specified for the backup_product and backup_type parameters to produce a five character "product identifier" that CICS VR can use as a reference for further CICS VR processing of the backup.

Note: The following values for the backup_product parameter are reserved and cannot be used:
  • HSM
  • DSS
,backup_type 
TYPE: CHARACTER (EBCDIC) 
LENGTH: TWO BYTES
EXPLANATION: Identifies the type of backup that was created by the backup product. This is a required two character input field. The characters can be alphabetic, numeric, or national (@, #, $). No blanks can be specified.

For example, if a product named SAMPLE VSAM BACKUP is used to create two types of backups for VSAM data sets, logical and physical, you can specify LC for the logical backup types and PY for the physical backup types. Use a consistent value for the backup_type parameter for all backups of the same type made by the same product.

CICS VR uses the values specified for the backup_product and backup_type parameters to produce a five character "product identifier" that CICS VR can use as a reference for further CICS VR processing of the backup.

,dataset_name 
TYPE: CHARACTER (EBCDIC) 
LENGTH: 44 BYTES
EXPLANATION: Fully qualified base cluster name of the VSAM data set for which the backup was created. This is a required 44 character input field and must be defined as EBCDIC character data. If the data set name is less than 44 characters, left-justify the name in the field and pad it on the right with EBCDIC blanks.
,backup_name
TYPE: CHARACTER (EBCDIC) 
LENGTH: 44 BYTES
EXPLANATION: Fully qualified name of the VSAM data set backup. This is a required 44 character input field and must be defined as EBCDIC character data. If the data set name is less than 44 characters, left-justify the name in the field and pad it on the right with EBCDIC blanks.
Note: All backup names registered in the CICS VR RCDS for a VSAM sphere must be unique. If CICS VR is notified of a backup with a duplicate name for the same VSAM data set, all information about the previously registered backup is replaced.
,backup_date_local 
TYPE: INTEGER 
LENGTH: FULL WORD
EXPLANATION: Local date, in Julian format, when the backup was created. This is a required input field and must be in the format YYYYDDDF, where:
YYYY
Four digit year the backup was created
DDD
Day of the year, in Julian format, the backup was created
F
The sign F (for positive number)
If the local backup date and time is not available during notification, zeros can be specified for both the backup_date_local and backup_time_local parameters, and CICS VR performs one of the following actions:
Zeroes for local backup date and time only
If zeroes are specified for the local backup date and time parameters, but non-zero values are specified for the GMT backup date and time parameters, CICS VR translates the date and time specified in the backup_date_GMT and backup_time_GMT parameters into local format. CICS VR then uses the translated local date and time as values for the backup_date_local and backup_time_local parameters.
Note: Be sure the system clock is not changed due to daylight saving between backup processing and execution of the CICS VR file copy notification service.
Zeroes for both local and GMT backup date and time
If zeroes are specified for both the local and GMT backup date and time parameters, CICS VR uses the system date and time in both local and GMT format at the time of notification as the values for the backup_date_local, backup_time_local, backup_date_GMT, and backup_time_GMT parameters.
However, if zeroes are specified for the local and GMT backup date and time parameters:
  • CICS VR is notified immediately after the backup is created.
  • It must not be possible for updates to be made to the data set between the time the backup completed and the time CICS VR is notified of the backup.
Note: Local date and time formats are affected by a change in daylight saving time on a system. Therefore, when you later refer to a backup, IBM® recommends that you use the GMT date and time format for backups created near a change in daylight saving time.
,backup_time_local 
TYPE: UNSIGNED PACKED-DECIMAL 
LENGTH: FULL WORD
EXPLANATION: Local time when the backup was created. This is a required input parameter and must be in the format HHMMSSTh, where:
HH
Hour the day the backup was created based on a 24-hour clock
MM
The number of minutes
SS
The number of seconds
T
The tenths of a second
h
The hundredths of a second

If the local backup date and time is not available during notification, zeroes can be specified for both the backup_date_local and backup_time_local parameters. CICS VR performs one of the actions described in the description for the backup_date_local parameter, depending on which parameters are specified with zeroes.

,backup_date_GMT 
TYPE: INTEGER 
LENGTH: FULL WORD
EXPLANATION: GMT date, in Julian format, when the backup was created. This is a required input field and must be in the format YYYYDDDF, where:
YYYY
Four digit year the backup was created
DDD
Day of the year, in Julian format, the backup was created
F
The sign F (for positive number)
If the GMT backup date and time is not available during notification, zeroes can be specified for both the backup_date_GMT and backup_time_GMT parameters, and CICS VR performs one of the following actions:
Zeroes for GMT backup date and time only
If zeroes are specified for the GMT backup date and time parameters, but non-zero values are specified for the local backup date and time parameters, CICS VR translates the date and time specified in the backup_date_local and backup_time_local parameters into GMT format. CICS VR then uses the translated GMT date and time as values for the backup_date_GMT and backup_time_GMT parameters.
Note: Be sure the system clock is not changed due to daylight saving between backup processing and execution of the CICS VR file copy notification service.
Zeroes for both local and GMT backup date and time
If zeroes are specified for both the local and GMT backup date and time parameters, CICS VR uses the system date and time in both local and GMT format at the time of notification as the values for the backup_date_local, backup_time_local, backup_date_GMT, and backup_time_GMT parameters.
However, if zeroes are specified for the local and GMT backup date and time parameters:
  • CICS VR is notified immediately after the backup is created.
  • It must not be possible for updates to be made to the data set between the time the backup completed and the time CICS VR is notified of the backup.
Note: Local date and time formats are affected by a change in daylight saving time on a system. Therefore, when you later refer to a backup, IBM recommends that you use the GMT date and time format for backups created near a change in daylight saving time.
,backup_time_GMT 
TYPE: UNSIGNED PACKED-DECIMAL 
LENGTH: FULL WORD
EXPLANATION: GMT time when the backup was created. This is a required input parameter and must be in the format HHMMSSTh, where:
HH
Hour the day the backup was created based on a 24-hour clock MM The number of minutes SS The number of seconds
T
The tenths of a second
h
The hundredths of a second

If the GMT backup date and time is not available during notification, zeroes can be specified for both the backup_date_GMT and backup_time_GMT parameters. CICS VR performs one of the actions described in the description for the backup_date_GMT parameter, depending on which parameters are specified with zeroes.