After an action statement or a MODIFY-ARCHIVE or CHECK-CATALOGED-FILES statement has been processed, HSMS generates reports which supply information about the result of the request.
Report output can be controlled via suboperands of the OPERATION-CONTROL operand of the action statements. A default value can be defined for the OUTPUT suboperand with the global HSMS parameter OUTPUT. This can be *PRINTER, *MAIL, *STD-FILE or *STD-LIB.
The REPORT suboperand determines the output scope as follows:
The operand value *SUMMARY causes a summary to be output which supplies information about the statement, the request generated and the save file created.
*FULL causes additional information to be output about the individual files, PLAM library elements and job variables processed.
*SAVED-FILES/*RESTORED-FILES restricts output to those files which have actually been processed in backup or restore runs.
*NONE causes report output to be suppressed.
Note
When migration takes place from S1 or S2 (reorganization), multiple copy and delete requests are executed internally. Here logging is performed as specified in the REPORT operand. Only delete requests also create a full log (*FULL) when REPORT=*SUMMARY is specified to ensure that in all cases the report contains the volumes which have become free.
The information output for the save file and the individual files is similar to the ARCHIVE lists. The only exemption are the different page header and additional HSMS-specific messages.
The OUTPUT suboperand defines the output destination:
OUTPUT=*STD directs outputs according to the value of the global HSMS parameter OUTPUT.
OUTPUT=*PRINTER directs outputs to the printer. Output is in this case always to the printer and not to the *SYSLST system file.
OUTPUT=<filename> directs outputs to a file. If the specified file is an already cataloged, non-empty SAM file, it is extended instead of overwritten (OPEN EXTEND). If this file is not a SAM file, the system displays an error message and output is re-directed to *PRINTER.
OUTPUT=*LIBRARY-ELEMENT(LIBRARY=<library>,ELEMENT=<element>) results in a PLAM library element being output. A type P element is created with a version which contains the user ID plus the date and time. If output to the library element is not possible, an error message is issued and the output is redirected to *PRINTER.
OUTPUT=*MAIL results in the report being sent as an email attachment. The email is sent to the address which is entered in the caller’s user entry (see the MAIL-FILE command). If the report cannot be sent by email, an error message is output and the output is redirected to *PRINTER.
- OUTPUT=*NONE means that report is created only for requests monitored on the BS2000 backup monitor on the SE server. Output is directed in PDF file only.
*STD-LIB and *STD-FILE values for destination can be set implicitly only (via global HSMS parameter OUTPUT). Output is directed to a standard SAM file or a library-element of a standard library if OUTPUT is set to *STD in an action statement and the value of HSMS global parameter OUPUT is *STD-LIB and *STD-FILE. See section "OUTPUT handling".
Reports which are to be printed at the server-side have a different layout. The layout depends on the type of workstation on which the files are to be processed (BS2000 or UFS report).
Reports for action statements entered at an active node are formatted using predefined structures and written in response files. The contents of these response files are then sent by the communication task via the network to the inodes. The client converts the report so that it has the correct layout.
In the case of HSMS requests which are also monitored on the BS2000 backup monitor on the SE server, the reports are also stored as a PDF file under the user ID SYSHSMS. Only the system can access this file.
The structure of an HSMS report is explained below, with reference to a backup example.
1st page of the report
The header is the same for all pages of the report. Its title line contains
the name of the action statement that initiated the request
the HSMS version used
the date and time
the page number of the report.
The second line contains information on the request:
the environment in which the statement was processed (SF or SM)
the name and date of the request
the user ID under which the statement was executed
the request status (here COMPLETED WITHOUT ERROR).
Then the HSMS statement entered is logged. The complete HSMS statement used to create the request is output under STATEMENT LISTING.
This is followed by other operands and their values (ENVIRONMENT, ARCHIVE-NAME, SAVE-FILE ATTRIBUTES ...).
A*** BACKUP - FILES HSMS V12.0 FULL REPORT ***2016-09-17 12:05:38 PAGE 1
REQUEST-ENVIRONMENT=SF
REQUEST-NAME=BCF#4362 REQUEST-DATE=2016-09-17 12:04:52 USER-ID=SYSHSM
REQUEST-STATE=COMPLETED WITHOUT ERROR
STATEMENT LISTING:
BACKUP-FILES FILE-NAMES=(¤MANUAL.FILE.0*,¤USEROLD.FILE.1*,¤USERNEW.FILE.2*),SELECT-FILES=*ALL-FILES,
ARCHIVE-NAME=MANUAL.BAC,SAVE-FILE=*NEW(RETENTION-PERIOD=0),
TO-STORAGE=*S2-STORAGE-LEVEL(VOLUMES=(WORK12,WORK13,WORK14)),
OPERATION-CONTROL=*PARAMETERS(PARALLEL-RUNS=3,REPORT=*FULL,OUTPUT=HSMS.MAN.R.BCF.1)
ENVIRONMENT : SF
ARCHIVE-NAME : ¤SYSHSMS.MANUAL.BAC
SAVE-FILE ATTRIBUTES : NEW
TO-STORAGE : S2-STORAGE-LEVEL
DEVICE-TYPE : TAPE-C4
RETENTION-PERIOD : 0
SELECT-FILES PARAMETER
ALL-FILES
MAX-BACKUP-CLASS : STD
2nd page of the report
The second page lists the ARCHIVE messages relating to the acceptance of the request (ARC0002) and the generation of subtasks (ARC0003). In the case of some HSMS statements (e.g. //MODIFY-ARCHIVE), these messages appear earlier, at the bottom of the first page.
These are followed by the name of the save file which was processed and output indicating which parallel run processed which volume:
Column | Meaning |
SAVE FILE IDENTIFIER | Number of the save file (SFID) which was written or read |
SUBSAVE NUMBER | Number of the parallel run |
VSNS | Serial numbers of the volumes containing the save file. In the case of save files on S1, only the pubset ID is output, introduced by “0:” |
This is followed in turn by a table listing the files and job variables which were processed with the following meanings:
Column | Meaning |
FILE/JOB VARIABLE NAME | Names of the files and job variables processed |
VERS | Version number of the saved file |
LASTPG/SIZE | File size in PAM pages (last-page pointer); for job variables the size in bytes |
SAVE TYPE | Save type (FULL, PART, MIGF, FGGI, CNS, OPER, FNOD) |
INPUT VSN | Serial number of the first input volume |
DEV TYP | Device type of the input volume (D=disk, T=tape, C=catalog) |
SUBSAVE | Number of the parallel run in which the volume was written/read |
OUTPUT VSN(S) | Serial numbers of the output volumes |
The IDs to which the listed files belong are shown in a header line, e.g.:
*** CATALOG - RD3A USER - MANUAL ***
A*** BACKUP - FILES HSMS V12.0 FULL REPORT *** 2016-09-17 12:05:38 PAGE 2
REQUEST-ENVIRONMENT=SF
REQUEST-NAME=BCF#4362 REQUEST-DATE=2016-09-17 12:04:52 USER-ID=SYSHSMS
REQUEST-STATE=COMPLETED WITHOUT ERROR
% ARC0002 STATEMENT ACCEPTED. ARCHIVE SEQUENCE NUMBER 'A.160917.120456', VERSION '12.0'
% ARC0033 ARCHIVE SUBTASK TSN '4487' GENERATED
% ARC0033 ARCHIVE SUBTASK TSN '4488' GENERATED
% ARC0033 ARCHIVE SUBTASK TSN '4489' GENERATED
SAVE FILE IDENTIFIER - S.160917.120456 SAVE-VERSION-DATE=16-09-17 SAVE-VERSION-TIME=12:04:57
SUBSAVE
NUMBER VSNS
0 WORK14
1 WORK13
2 WORK12
SAVE FILE IDENTIFIER - S.160917.120456 SAVE-VERSION-DATE=16-09-17 SAVE-VERSION-TIME=12:04:57
*** CATALOG - RD3A USER - MANUAL ***
FILE/JOB VARIABLE NAME LASTPG/ SAVE INPUT DEV SUB OUTPUT
VERS SIZE TYPE VSN TYP SAVE VSN(S)
FILE.01 1 5 FULL RD3A.0 D 2 WORK12
FILE.02 1 4 FULL RD3A.0 D 2 WORK12
FILE.03 1 4 FULL RD3A.0 D 2 WORK12
FILE.04 1 14 FULL RD3A.0 D 2 WORK12
FILE.05 1 9 FULL RD3A.0 D 2 WORK12
FILE.06 1 1 FULL RD3A.0 D 2 WORK12
FILE.07 1 21 FULL RD3A.0 D 2 WORK12
3rd and any further pages of the report
If the list of the files and jobs variables processed extends beyond the second page, further pages are added as needed, e.g.:
A*** BACKUP - FILES HSMS V12.0 FULL REPORT *** 2016-09-17 12:05:38 PAGE 3
REQUEST-ENVIRONMENT=SF
REQUEST-NAME=BCF#4362 REQUEST-DATE=2016-09-17 12:04:52 USER-ID=SYSHSMS
REQUEST-STATE=COMPLETED WITHOUT ERROR
SAVE FILE IDENTIFIER - S.160917.120456 SAVE-VERSION-DATE=16-09-17 SAVE-VERSION-TIME=12:04:57
*** CATALOG - RD3A USER - USERNEW ***
FILE/JOB VARIABLE NAME LASTPG/ SAVE INPUT DEV SUB OUTPUT
VERS SIZE TYPE VSN TYP SAVE VSN(S)
FILE.21 1 5 FULL RD3A.0 D 1 WORK13
FILE.22 1 4 FULL RD3A.0 D 1 WORK13
FILE.23 1 4 FULL RD3A.0 D 1 WORK13
FILE.24 1 14 FULL RD3A.0 D 1 WORK13
FILE.25 1 9 FULL RD3A.0 D 1 WORK13
FILE.26 1 1 FULL RD3A.0 D 1 WORK13
FILE.27 1 21 FULL RD3A.0 D 1 WORK13
SAVE FILE IDENTIFIER - S.160917.120456 SAVE-VERSION-DATE=16-09-17 SAVE-VERSION-TIME=12:04:57
*** CATALOG - RD3A USER - USEROLD ***
FILE/JOB VARIABLE NAME LASTPG/ SAVE INPUT DEV SUB OUTPUT
VERS SIZE TYPE VSN TYP SAVE VSN(S)
FILE.11 1 5 FULL RD3A.0 D 0 WORK14
FILE.12 1 4 FULL RD3A.0 D 0 WORK14
FILE.13 1 4 FULL RD3A.0 D 0 WORK14
FILE.14 1 14 FULL RD3A.0 D 0 WORK14
FILE.15 1 9 FULL RD3A.0 D 0 WORK14
FILE.16 1 1 FULL RD3A.0 D 0 WORK14
FILE.17 1 21 FULL RD3A.0 D 0 WORK14
NUMBER OF FILES= 21 GLOBAL SIZE= 174 START=2016-09-17 12:04:53 END= 2016-09-17 12:05:38
The penultimate line of the final page of the report contains the following information:
NUMBER OF FILES= | Number of files and job variables processed |
GLOBAL SIZE= | Total size of all files and job variables |
START= | Date and time at which the request was made |
END= | Date and time at which the request was terminated |
The last page of the HSMS report concludes with the following line:
*** E N D O F HSMS V12.0 FULL REPORT *** 2016-09-17 12:05:38 ***