Retrieve Backup History (QEZRTBKH) API
| 1 | Receiver variable | Output | Char(*) |
| 2 | Length of receiver variable | Input | Binary(4) |
| 3 | Format name | Input | Char(8) |
| 4 | Error code | I/O | Char(*) |
Default Public Authority: *USE
Threadsafe: No
The Retrieve Backup History (QEZRTBKH) API retrieves information about the backup status and history into a single variable in the calling program. The amount of information that is returned depends on the size of the variable. The information that this API returns is the same information that the Display Backup Status (DSPBCKSTS) command returns.
Authorities and Locks
- User Index Authority
- *USE
- User Index Lock
- *SHRRD
Required Parameter Group
- Receiver variable
- OUTPUT; CHAR(*)
The receiver variable that receives the information requested. You can specify the size of the area to be smaller than the format requested as long as you specify the length parameter correctly. As a result, the API returns only the data that the area can hold.
- Length of receiver variable
- INPUT; BINARY(4)
The length of the receiver variable provided. The length of receiver variable parameter may be specified up to the size of the receiver variable specified in the user program. If the length of receiver variable parameter specified is larger than the allocated size of the receiver variable specified in the user program, the results are not predictable. The minimum length is 8 bytes.
- Format name
- INPUT; CHAR(8)
The format of the command information to be returned. One of the following format names may be used:
RBKH0100 Basic backup status and history. For more information, see RBKH0100 Format. RBKH0200 Detailed backup status and information. For more information, see RBKH0200 Format.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter.
RBKH0100 Format
The following table describes the information that is returned in the receiver variable for the RBKH0100 format. For detailed descriptions of the fields, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4 | Bytes returned |
| 4 | 4 | BINARY(4) | Bytes available |
| 8 | 8 | CHAR(7) | Last date all user libraries backed up |
| 15 | F | CHAR(6) | Last backup time of all user libraries |
| 21 | 15 | CHAR(4) | Tape set for all user libraries |
| 25 | 19 | CHAR(7) | Last date all user libraries backed up (changes only) |
| 32 | 20 | CHAR(6) | Last backup time of all user libraries (changes only) |
| 38 | 26 | CHAR(4) | Tape set for all user libraries (changes only) |
| 42 | 2A | CHAR(7) | Last date libraries on list backed up |
| 49 | 31 | CHAR(6) | Last backup time of libraries on list |
| 55 | 37 | CHAR(4) | Tape set for libraries on list |
| 59 | 3B | CHAR(7) | Last date libraries on list backed up (changes only) |
| 66 | 42 | CHAR(6) | Last backup time of libraries on list (changes only) |
| 72 | 48 | CHAR(4) | Tape set for libraries on list (changes only) |
| 76 | 4C | CHAR(7) | Last date all folders backed up |
| 83 | 53 | CHAR(6) | Last backup time of all folders |
| 89 | 59 | CHAR(4) | Tape set for folders |
| 93 | 5D | CHAR(7) | Last date all folders backed up (changes only) |
| 100 | 64 | CHAR(6) | Last backup time of all folders (changes only) |
| 106 | 6A | CHAR(4) | Tape set for folders (changes only) |
| 110 | 6E | CHAR(7) | Last date folders on list backed up |
| 117 | 75 | CHAR(6) | Last backup time of folders on list |
| 123 | 7B | CHAR(4) | Tape set for folders on list |
| 127 | 7F | CHAR(7) | Last date security data backed up |
| 134 | 86 | CHAR(6) | Last backup time of security data |
| 140 | 8C | CHAR(4) | Tape set for security data |
| 144 | 90 | CHAR(7) | Last date configuration data backed up |
| 151 | 97 | CHAR(6) | Last backup time of configuration |
| 157 | 9D | CHAR(4) | Tape set for configuration data |
| 161 | A1 | CHAR(7) | Last date calendars backed up |
| 168 | A8 | CHAR(6) | Last backup time of calendars |
| 174 | AE | CHAR(4) | Tape set for calendars |
| 178 | B2 | CHAR(7) | Last date mail backed up |
| 185 | B9 | CHAR(6) | Last backup time of mail |
| 191 | BF | CHAR(4) | Tape set for mail |
| 195 | C3 | CHAR(7) | Last date all user directories backed up |
| 202 | CA | CHAR(6) | Last backup time of all user directories |
| 208 | D0 | CHAR(4) | Tape set for all user directories backed up |
| 212 | D4 | CHAR(7) | Last date all user directories backed up (changes only) |
| 219 | DB | CHAR(6) | Last backup time of all user directories (changes only) |
| 225 | E1 | CHAR(4) | Tape set for all user directories backed up (changes only) |
| 229 | E5 | CHAR(21) | Reserved |
RBKH0200 Format
The following table describes the information that is returned in the receiver variable for the RBKH0200 format. For detailed descriptions of the fields, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | Returns everything from format RBKH0100 | |
| 250 | FA | BINARY(4) | Number of backup date entries |
| 254 | FE | BINARY(4) | Length of a backup date entry |
| Note: Format of a backup date entry. The backup date entry fields repeat, in the order listed, by the number of backup date entries. The decimal and hexadecimal offsets to the following fields depend on the number of backup date entries and the length of a backup date entry. | |||
| CHAR(7) | Backup date | ||
| CHAR(6) | Backup time | ||
| CHAR(10) | Backup options | ||
| CHAR(4) | Tape set | ||
| CHAR(1) | Changes only | ||
| CHAR(1) | User libraries saved | ||
| CHAR(1) | Folders saved | ||
| CHAR(1) | User directories saved | ||
| CHAR(1) | Security data saved | ||
| CHAR(1) | Configuration saved | ||
| CHAR(1) | Calendars saved | ||
| CHAR(1) | Mail saved | ||
Field Descriptions
Some of the fields use a date format (CYYMMDD) as follows:
| C | Century, where 0 indicates years 19xx and 1 indicates years 20xx. |
| YY | Year |
| MM | Month |
| DD | Day |
Some of the fields use a time format (HHMMSS), where:
| HH | Hour |
| MM | Minute |
| SS | Second |
For more information on the following fields, see the Display Backup Status (DSPBCKSTS) command.
Backup date. The completion date of the backup. This date is in the format CYYMMDD.
Backup time. The completion time of the backup. This time is in the format HHMMSS.
Backup options. The backup option that were used. The possible values are:
| *DAILY | |
| *WEEKLY | |
| *MONTHLY |
Bytes available. The number of bytes of data available to be returned. All available data is returned if enough space is provided.
Bytes returned. The number of bytes of data returned.
Calendars saved. Whether OfficeVision® calendars were saved during the backup.
| 0 | No OfficeVision calendars were saved during the backup. |
| 1 | All OfficeVision calendars were saved during the backup. |
Changes only. Whether the backup saved only the changes to libraries, directories, and folders.
| 0 | All objects in the libraries, folders, and directories were saved during the backup. |
| 1 | Only changes made to the libraries, folders, and directories since the last backup were saved during the backup. |
Configuration saved. Whether the system configuration was saved.
| 0 | The system configuration was not saved during the backup. |
| 1 | The system configuration was saved during the backup. |
Folders saved. Which folders were saved during the backup. The possible values follow:
| 1 | Only folders that were selected from the folder backup list were saved. |
| 2 | All folders were saved. |
| 3 | No folders were saved. |
Last backup time of calendars. The completion time of the most recent backup of all the calendars for OfficeVision. This time uses the 24-hour clock and is in the format HHMMSS.
Last backup time of mail. The completion time of the most recent backup of all the mail for OfficeVision. This time uses the 24-hour clock and is in the format HHMMSS.
Last backup time of all folders. The completion time of the most recent backup of all the objects in all the root folders. This time uses the 24-hour clock and is in the format HHMMSS.
Last backup time of all folders (changes only). The completion time of the most recent backup of all the objects in all the root folders that changed since the previous backup. This time uses the 24-hour clock and is in the format HHMMSS.
Last backup time of all user directories. The completion time of the most recent backup of all the objects in all the user directories on the system. This time uses the 24-hour clock and is in the format HHMMSS.
Last backup time of all user directories (changes only). The completion time of the most recent backup of all the objects in all the user directories that changed since the previous backup. This time uses the 24-hour clock and is in the format HHMMSS.
Last backup time of all user libraries. The completion time of the most recent backup of all the objects in all the user libraries on the system. This time uses the 24-hour clock and is in the format HHMMSS.
Last backup time of all user libraries (changes only). The completion time of the most recent backup of all the objects in all the user libraries that changed since the previous backup. This time uses the 24-hour clock and is in the format HHMMSS.
Last backup time of configuration. The completion time of the most recent backup of the system configuration. This uses the 24-hour clock and is in the format HHMMSS.
Last backup time of folders on list. The completion time of the most recent backup of all the objects in all the folders on the folder backup list. This time uses the 24-hour clock and is in the format HHMMSS.
Last backup time of libraries on list. The completion time of the most recent backup of all the objects in all the libraries on the library backup list. This time uses the 24-hour clock and is in the format HHMMSS.
Last backup time of libraries on list (changes only). The completion time of the most recent backup of all the objects in all the libraries on the library backup list that changed since the previous backup. This time uses the 24-hour clock and is in the format HHMMSS.
Last backup time of security data. The completion time of the most recent backup of all the system security data. This uses the 24-hour clock and is in the format HHMMSS.
Last date all folders backed up. The completion date for the most recent backup of all the objects in all the root folders on the system. This date is in the format CYYMMDD.
Last date all folders backed up (changes only). The completion date for the most recent backup of all the objects in all the folders that changed since the previous backup. This date is in the format CYYMMDD.
Last date all user directories backed up (changes only). The completion date for the most recent backup of all the objects in all the user directories that changed since the previous backup. This date is in the format CYYMMDD.
Last date all user directories backed up. The completion date for the most recent backup of all the objects in all the user directories on the system. This date is in the format CYYMMDD.
Last date all user libraries backed up. The completion date for the most recent backup of all the objects in all the user libraries on the system. This date is in the format CYYMMDD.
Last date all user libraries backed up (changes only). The completion date for the most recent backup of all the objects in all the user libraries that changed since the previous backup. This date is in the format CYYMMDD.
Last date calendars backed up. The completion date for the most recent backup of all the OfficeVision calendars on the system. This date is in the format CYYMMDD.
Last date configuration data backed up. The last backup date for the most recent backup of the system configuration.
Last date folders on list backed up. The completion date for the most recent backup of all the objects in all the folders in the folder backup list. This date is in the format CYYMMDD.
Last date libraries on list backed up. The completion date for the most recent backup of all the objects in all the libraries in the library backup list. This date is in the format CYYMMDD.
Last date libraries on list backed up (changes only). The completion date for the most recent backup of all the objects in all the libraries in the library backup list that changed since the previous backup. This date is in the format CYYMMDD.
Last date mail backed up. The completion date for the most recent backup of all the OfficeVision mail on the system. This date is in the format CYYMMDD.
Last date security data backed up. The last backup date for the most recent backup of system security data.
Length of a backup date entry. The length of one backup date entry.
Mail saved. Whether mail was saved during the backup.
| 0 | OfficeVision mail was not saved during the backup. |
| 1 | OfficeVision mail was saved during the backup. |
Number of backup date entries. The number of backup date e ntries that are contained in format RBKH0200.
Reserved. This space is reserved for future use.
Security data saved. Whether the security data was saved.
| 0 | Security data was not saved during the backup. |
| 1 | Security data was saved during the backup. |
Tape set. The name of the last tape set that the system used to complete the backup of the information described in this backup date entry.
Tape set for all user directories backed up. The name of the last tape set that the system used for the most recent backup of all the objects in all the user directories on the system. The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
Tape set for all user directories backed up (changes only). The name of the last tape set that the system used for the most recent backup of all the objects in all the user directories that changed since the previous backup. The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
Tape set for all user libraries. The name of the last tape set that the system used for the most recent backup of all the objects in all the user libraries on the system. The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
Tape set for all user libraries (changes only). The name of the last tape set that the system used for the most recent backup of all the objects in all the user libraries that changed since the previous backup. The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
Tape set for calendars. The name of the last tape set that the system used for the most recent backup of all the calendars for OfficeVision.
The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
Tape set for configuration. The name of the last tape set that the system used for the most recent backup of the system configuration. The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
Tape set for folders. The name of the last tape set that the system used for the most recent backup of all the objects in all the root folders on the system. The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
Tape set for folders (changes only). The name of the last tape set that the system used for the most recent backup of all the new and changed documents from all the new and changed root folders since the previous backup. The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
Tape set for folders on list. The name of the last tape se t that the system used for the most recent backup of all the folders that were selected for backup from the folder backup list. The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
Tape set for libraries on list. The name of the last tape set that the system used for the most recent backup of all the libraries on the library backup list. The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
Tape set for libraries on list (changes only). The name of the last tape set that the system used for the most recent backup of all the objects in the libraries on the library backup list that changed since the previous backup. The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
Tape set for mail. The name of the last tape set that the system used for the most recent backup of all the mail for OfficeVision. The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
Tape set for security data. The name of the last tape set that the system used for the most recent backup of the system security data. The possible value follows:
| *ANY | The option that the system used for the backup did not specify a tape set name. |
User directories saved. The directories that were saved during the backup. The possible values follow:
| 2 | All user directories were saved. |
| 3 | No user directories were saved. |
User libraries saved. The libraries that were saved during the backup. The possible values follow:
| 1 | Only user libraries that were selected from the library backup list were saved. |
| 2 | All user libraries were saved. |
| 3 | No user libraries were saved. |
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF1E00 E | All CPF1Exx messages could be returned. xx is from 01 to FF. |
| CPF24B4 E | Severe error while addressing parameter list. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3C19 E | Error occurred with receiver variable specified. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C24 E | Length of the receiver variable is not valid. |
| CPF3C90 E | Literal value cannot be changed. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
API introduced: V3R7
[ Back to top | Backup and Recovery APIs | APIs by category ]