TYPE: BINARY
LENGTH: HALF WORD
EXPLANATION: This parameter contains a set
of optional flags used to indicate how the file copy notification service
must be processed. For each flag, 1 is ON and 0 is OFF. This is an optional
input parameter. Below is a list of the possible bits along with their associated
meanings: The default value is OFF (asynchronous processing).
The default value is OFF.
TYPE: BINARY
LENGTH: HALF WORD
EXPLANATION: This parameter contains a set
of flags used to indicate various states of the backup. For each flag, 1
is ON and 0 is OFF. This is an optional input parameter. Below is a list
of the possible bits along with their associated meanings: If this flag is set on, the backup product must have the ability to successfully create a backup with data integrity while it remains open for update. Also, the timestamp of a tieup log record must be specified in either the BWO_timestamp parameter or the recovery_timestamp_local and recovery_timestamp_GMT parameters.
When this bit is set on, CICS VR does not run in "fuzzy" processing mode, meaning that CICS VR treats any log records found for updates that are already reflected in the backup as an error condition.
The FUZZY ONLINE BACKUP WITH TIEUP LOG RECORD, SHARP ONLINE BACKUP WITHOUT TIEUP LOG RECORD, and FUZZY ONLINE BACKUP WITHOUT TIEUP LOG RECORD bits cannot be set on if this bit is set on.
If this flag is set on, the backup product must have the ability to successfully create a backup with data integrity while it remains open for update. Also, the timestamp of a tieup log record must be specified in either the BWO_timestamp parameter or the recovery_timestamp_local and recovery_timestamp_GMT parameters.
When this bit is set on, CICS VR runs in "fuzzy" processing mode, meaning that CICS VR reports, but ignores any log records found for updates that are already reflected in the backup.
The SHARP ONLINE BACKUP WITH TIEUP LOG RECORD, SHARP ONLINE BACKUP WITHOUT TIEUP LOG RECORD, and FUZZY ONLINE BACKUP WITHOUT TIEUP LOG RECORD bits cannot be set on if this bit is set on.
A timestamp must also be specified in either the BWO_timestamp parameter or the recovery_timestamp_local and recovery_timestamp_GMT parameters. The specified timestamp must accurately reflect when the information in the parameters listed above was retrieved. For example, if the list of all opens (ddnames_list) against the data set was accurate at the timestamp 04.322 12:15:17, then this must be the timestamp specified in either the BWO_timestamp parameter or the recovery_timestamp_local and recovery_timestamp_GMT parameters (in the appropriate time format).
Therefore, if this backup is selected for restore and forward recovery, CICS VR can start recovery at the timestamp specified in either the BWO_timestamp parameter or the recovery_timestamp_local and recovery_timestamp_GMT parameters and does not have to start by reading a tieup log record on the log stream.
If this flag is set on, the backup product must have the ability to successfully create a backup with data integrity while it remains open for update. Also, when this bit is set on, CICS VR does not run in "fuzzy" processing mode, meaning that CICS VR treats any log records found for updates that are already reflected in the backup as an error condition.
The SHARP ONLINE BACKUP WITH TIEUP LOG RECORD, FUZZY ONLINE BACKUP WITH TIEUP LOG RECORD, and FUZZY ONLINE BACKUP WITHOUT TIEUP LOG RECORD bits cannot be set on if this bit is set on.
However, if you have access to the information normally read from a tieup log record, you can set this flag on, and specify information in the parameters listed in the description of bit 2, SHARP ONLINE BACKUP WITHOUT TIEUP LOG RECORD. Also as described for bit 2, a timestamp must be specified in either the BWO_timestamp parameter or the recovery_timestamp_local and recovery_timestamp_GMT parameters.
If this flag is set on, the backup product must have the ability to successfully create a backup with data integrity while it remains open for update. Also, when this bit is set on, CICS VR runs in "fuzzy" processing mode, meaning that CICS VR treats any log records found for updates that are already reflected in the backup as an error condition.
The SHARP ONLINE BACKUP WITH TIEUP LOG RECORD, FUZZY ONLINE BACKUP WITH TIEUP LOG RECORD, and SHARP ONLINE BACKUP WITHOUT TIEUP LOG RECORD bits cannot be set on if this bit is set on.
Set this bit on if you wish to remove the backup from CICS VR's inventory. The backup must have been previously registered to CICS VR using the file copy notification service. Once CICS VR is notified that the backup must be deregistered, the backup can no longer be displayed and selected through the CICS VR panel interface.
TYPE: PACKED-DECIMAL
LENGTH: TWO FULL WORDS
EXPLANATION: This parameter may be specified
if the backup created for the VSAM data set was made while the data set remained
open for update. The backup product must have the ability to successfully
create a backup with data integrity while it remains open for update. If
specified, CICS VR
uses the value of the BWO_timestamp parameter as
the forward recovery start time when the backup is selected for restore and
recovery. If the SHARP ONLINE BACKUP WITH TIEUP LOG RECORD or FUZZY ONLINE BACKUP WITH TIEUP LOG RECORD status flag is set on, the value specified for the BWO_timestamp parameter must correspond with the timestamp of a tieup log record written to the forward recovery log stream for the VSAM data set.
Values cannot be specified for the recovery_timestamp_local and recovery_timestamp_GMT parameters if a value is specified for the BWO_timestamp parameter.
0C | The century - 00 represents 19YY, 01 represents 20YY |
YY | The last two digits of the year |
DDD | The day of the year (Julian format) |
F | Constant (F for positive number) |
HH | Hour of the day based on a 24-hour clock |
MM | The number of minutes |
SS | The number of seconds |
T | The tenth of seconds |
F | Constant (F for positive number) |
Example: One approach to associate a forward recovery start time with a backup made while the data set remains open for update is to enable the VSAM data set for dynamic backup processing. This approach requires that you either set the BACKUPTYPE parameter in the CICS file definition for the VSAM data set to DYNAMIC or specify the BWO(TYPECICS) parameter in the ICF catalog entry for the VSAM data set. You must also set the CICS activity keypoint frequency (AKPFREQ) to a nonzero number.
After performing the above settings, CICS writes a tieup log record to the forward recovery log stream about every 30 minutes. The timestamp of the tieup log record is also recorded in the BWO TIMESTAMP field in the ICF catalog entry for the VSAM data set. When a backup is created for the VSAM data set while it is open to CICS, the timestamp in the BWO TIMESTAMP ICF catalog entry for the VSAM data set is the value that must be specified as the BWO_timestamp parameter value.
TYPE: CHARACTER or INTEGER
LENGTH: EIGHT BYTES
EXPLANATION: The recovery_timestamp_local and recovery_timestamp_GMT parameters might be specified if the backup created for the VSAM
data set was made while the data set remained open for update. The backup
product must have the ability to successfully create a backup with data integrity
while it remains open for update. If specified, CICS VR uses the value of the recovery_timestamp_local and recovery_timestamp_GMT parameters as the forward recovery start time when the backup is selected for restore and recovery.
If the SHARP ONLINE BACKUP WITH TIEUP LOG RECORD or FUZZY ONLINE BACKUP WITH TIEUP LOG RECORD status flag is set on, the value specified for the recovery_timestamp_local or recovery_timestamp_GMT parameter must correspond with the timestamp of a tieup log record written to the forward recovery log stream for the VSAM data set.
Values cannot be specified for the recovery_timestamp_local and recovery_timestamp_GMT parameters if a value is specified for the BWO_timestamp parameter.
The values of the recovery_timestamp_local and recovery_timestamp_GMT parameters must be specified in STCK format. If either parameter is specified, a value must also be specified in the other parameter. However, zeroes can be specified for one of the parameters. In this situation, CICS VR translates the value of the parameter where a nonzero value has been specified, into the format, local or GMT, used by the parameter where a zero value has been specified, and uses it as the value for that parameter.
For example, you might want to enter a small description of the backup, such as "remote site backup", in this optional parameter that is viewable when selecting a backup to restore at a later time.
In another example, you might want to enter some value that is unique to the backup product that is stored with information about the backup; for example, a specific volume name. Then, during restore, this information could be use as input to the restore commands.
TYPE: INTEGER
LENGTH: FULL WORD
EXPLANATION: Specifies the length, number of
bytes, of the area in storage that contains the optional information. This
value must be an integer greater than zero, and cannot be larger than 256
bytes. IBM recommends
that the specified optional information length is a multiple of 64 bytes.TYPE: CHARACTER
LENGTH: MAXIMUM 256 BYTES
EXPLANATION: Contains optional information
and must have a length equal to the value that was specified in the optional_information_length subparameter.
This is an optional character input field. The characters can be alphabetic,
numeric, or national (@, #, $). CICS VR divides and stores the entered optional information in 64 byte groups. For example, if 128 bytes of optional information is specified, CICS VR stores and displays this as two groups of 64 bytes. You can also view each 64 byte group through the CICS VR panel interface, and reference each 64 byte group individually using an appropriate variable in a restore JCL skeleton. You can therefore treat this optional parameter as 4 separate parameters that contain 64 bytes of optional information each, if appropriate.
For example, if you wish to record two separate pieces of information, perhaps a data class and a management class, during notification, specify the first piece of information, data class, in the first 64 bytes, and the second piece of information, management class, in the second 64 bytes.
TYPE: INTEGER
LENGTH: FULL WORD
EXPLANATION: This subparameter lists the number
of volumes on which the backup resides. For example, if the backup resides on three volumes, the number_of_volumes parameter must contain the integer 3.
TYPE: CHARACTER
LENGTH: NUMBER OF VOLUMES MULTIPLIED BY 6
EXPLANATION: The list
of volumes on which the backup resides. The volume area must be EBCDIC character
type, and its length must be the number of volumes specified in the number_of_volumes subparameter
multiplied by six. Each volume must occupy six characters and be padded on
the right with EBCDIC blanks if necessary. 'VOL1 VOL2 VOL3 '
TYPE: CHARACTER
LENGTH: EIGHT BYTES
EXPLANATION: The name or group name of the
device type of the previously listed volumes. This is an optional eight character
input field and must be defined as EBCDIC character data. If the device type
name is less than eight characters, left-justify the name in the field and
pad it on the right with EBCDIC blanks.TYPE: INTEGER
LENGTH: HALF WORD
EXPLANATION: The sequence number of the backup
if the backup resides on tape and is not cataloged. This is an optional half
word input field and must be defined as an integer. The minimum value that
can be specified is 0 and the maximum value that can be specified is 9999.The ddnames_list parameter contains the following subparameters:
TYPE: INTEGER
LENGTH: FULL WORD
EXPLANATION: This subparameter lists the number
of different ddnames that CICS has currently used to open the VSAM base cluster
and any AIXs of the base cluster. For example, if CICS currently has opened the VSAM base cluster with a ddname of PAY1BASE, and CICS has also opened an alternate index of the base cluster, using a path, with a ddname of PAY1AIX, the number_of_ddnames subparameter must contain the integer 2.
TYPE: CHARACTER
LENGTH: NUMBER OF DDNAMES MULTIPLIED BY 16
EXPLANATION: This
subparameter lists the ddnames and corresponding CICS APPLIDs that are currently used by CICS to
open the VSAM base cluster and any alternate indexes of the base cluster.
The field must be EBCDIC character type, and its length must be the number
of ddnames specified in the number_of_ddnames subparameter
multiplied by 16. Each ddname and CICS APPLID pair must occupy 16 characters
and use the following format: 'ddname (8 characters) CICS APPLID (8 characters)'
The
ddname must occupy the first 8 characters, padded on the right with EBCDIC
blanks if necessary. Then, the CICS APPLID associated with the specified
ddname must occupy the next 8 characters, again padded on the right with EBCDIC
blanks if necessary. 'PAY1BASECICSPRODPAY1AIX CICSPRD2 '
TYPE: CHARACTER
LENGTH: 26 BYTES
EXPLANATION: This optional parameter contains
the name of the forward recovery log stream to which CICS logging is writing after-images for
updates made to the VSAM data set. This 26 character input field must be defined as EBCDIC character data and padded on the right with EBCDIC blanks if necessary.
TYPE: CHARACTER
LENGTH: ONE BYTE
EXPLANATION: This optional parameter contains
an indication of the type of VSAM data set for which the backup has been created. K KSDS VSAM sphere
E ESDS VSAM sphere
R RRDS VSAM sphere
V VRRDS VSAM sphere
TYPE: INTEGER
LENGTH: FULL WORD
EXPLANATION: This optional parameter contains
the control interval size in bytes, of the VSAM data set for which the backup
has been created. This full word input field must be defined as an integer.
TYPE: INTEGER
LENGTH: FULL WORD
EXPLANATION: This optional parameter contains
the maximum record length in bytes, of the VSAM data set for which the backup
has been created. This full word input field must be defined as an integer.
TYPE: INTEGER
LENGTH: FULL WORD
EXPLANATION: This optional parameter contains
the key position of the VSAM data set if the backup was created for a KSDS
VSAM data set. If the backup was created for a non-KSDS VSAM data set, then
set this field to 0. This full word input field must be defined as an integer.
TYPE: INTEGER
LENGTH: FULL WORD
EXPLANATION: This optional parameter contains
the key length in bytes, of the VSAM data set if the backup was created for
a KSDS VSAM data set. If the backup was created for a non-KSDS VSAM data set,
then set this field to 0. This full word input field must be defined as an integer.