This statement is for the use of the HSMS administrator only.
From time to time (recommended: daily, but at least weekly) it should be checked if there are any files in the version backup archive that have been deleted from the processing level. The HSMS statement CHECK-CATALOGED-FILES is used for this purpose. CHECK-CATALOGED-FILES checks for every file in the version backup archive whether the file exists in the system. If the file is not found (has been deleted), the current date is entered as the deletion date for the file in the archive directory.
With //SHOW-ARCHIVE SELECT=*FILES(...,INFO=*VERSION) the user may see which files have been recognized as deleted by HSMS (not empty DELETION-DATE denotes the status). If necessary, the user can restore the file. As long as the file has not been marked for deletion with //MODIFY-ARCHIVE ... FILES=*MARK-FOR-DELETION(...), the file will be copied during subsequent reorganization runs. Conversely, CHECK-CATALOGED-FILES also removes the deletion date. CHECK-CATALOGED-FILES also updates the number of backup versions in the archive directory if this has previously been changed in the catalog entry of the file or the assigned management class.
The result of the check is output into a report. This lists all files that have been deleted or for which the number of backup versions to be retained (NUM-OF-BACKUP-VERS) has changed.
The statement checks files only on imported pubsets.
Format (only for HSMS administrators)
CHECK-CATALOGED-FILES | Alias: CCF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PUBSET =
Specifies the pubsets for which files the check is to be performed within the version backup archive.
PUBSET = <cat-id 1..4>
Only files residing on the pubset are checked within the specified version backup archive. The pubset must be imported on the system, otherwise statement will be rejected.
In case of SM-environment the pubset must be the same as given in CATALOG-ID parameter otherwise the statement will be rejected.
PUBSET = *ALL
Files from all imported pubsets saved within the specified version backup archive. Not-imported pubsets are not taken into consideration. Corresponding warning message will be given.
ARCHIVE-NAME =
Specifies the version backup archive that contains the files to be checked.
ARCHIVE-NAME = *SYSVERSION
In an SF environment, the HSMS statement applies to an archive which is defined as system version archive to the specified pubset. If it is not defined the statement will be rejected.
In an SM environment, the HSMS statement applies to an archive defined as system version archive in the SM-pubset-parameters.
If the pubset, which is specified in the PUBSET operand, does not exist on //SHOW-PUBSET-PARAMETERS statement, a warning message will be displayed.
If *ALL is specified as PUBSET, system version archives are found in the same way as described above per each imported pubset in SF-environment.
In the report for every version backup archive there is the message:
HSM0040 CHECK OF FILES FROM THE VERSION BACKUP ARCHIVE '(&00)' STARTED.
For SM-environment the statement will be rejected. If system version archive for some pubset is not defined corresponding error message will be given.
ARCHIVE-NAME = <filename 1..22 without-cat-gen-vers>
Name of the version backup archive that contains the files to be checked.
The specified archive must already exist.
If the archive directory is protected by a password, this password must be entered by means of the ADD-PASSWORD command prior to statement entry.
ENVIRONMENT =
Determines the HSMS environment in which the specified archive is located.
ENVIRONMENT = *SINGLE-FEATURE
The specified version backup archive is in the SF environment.
ENVIRONMENT = *SYSTEM-MANAGED(...)
The specified version backup archive is in the specified SM pubset environment.
CATALOG-ID = <cat-id>
Catalog ID of the SM pubset to which the HSMS statement applies.
REPORT =
Serves to define whether a report is to be output and to determine the scope of this report.
REPORT = *SUMMARY
A summary of the results, including any error messages, is to be output.
REPORT = *FULL
A report, including a list of all actions performed, is to be printed.
REPORT = *NONE
No report is to be output.
OUTPUT =
Specifies where the report is to be output.
OUTPUT = *STD
The output destination of the report is determined by the default value that is defined by the global HSMS parameter OUTPUT.
OUTPUT = *PRINTER
The report for all the actions performed is printed out.
OUTPUT = *MAIL
The report is sent as an email attachment to the address which is entered in the caller’s user entry. If it is not possible to send the report by email, it is printed out.
OUTPUT = *LIBRARY-ELEMENT(...)
The report is edited and output to the specified PLAM library element (type P). If this is not possible, the report is printed out.
LIBRARY = <filename 1..54 without-gen-vers>
Name of the PLAM library.
ELEMENT = <composed-name 1..64 with-under>
Name of the element. A type P element is created with a version which contains the user ID plus the date and time.
OUTPUT = <filename 1..54 without-gen-vers>
The report for all the actions performed is edited and written to the specified file. If the file already exists, the following applies:
if it is a non-empty SAM file, it is continued
if not, the report is printed.
- If a file that has already been deleted or marked as deleted has been restored or newly created with the same name and a CHECK-CATALOGED-FILES is executed again, the following happens:
- The deletion date for this file is removed from the archive directory.
- An existing deletion flag (MARK-FOR-DELETION) is removed.
- Any new value NUM-OF-BACKUP-VERS is noted for the file in the archive directory.
- If a file in the archive directory has already been marked as deleted and is still deleted, the deletion date is not updated.
- With //CHECK-CATALOGED-FILES PUBSET=*ALL, ARCHIVE=*SYSVERSION the files for each SYSVERSION archive of each pubset are checked. The following message is displayed in the report for each version backup archive:
HSM0040 CHECK OF FILES FROM THE VERSION BACKUP ARCHIVE '(&00)' STARTED.