The job variable is composed of fixed-length fields. While the request is being checked, each field is initialized with blanks.
The job variable for monitoring HSMS requests is not governed by the conventions for monitoring job variables. In particular, the field containing the request status does not begin at position 1 (see also the “Job Variables” manual [23]).
Field | Pos. | Length | Value | Meaning |
CCS INIT STATUS | 1 | 1 | Blank | Request without active CCOPY function or (yet) incomplete |
T | Terminated successfully | |||
A | Terminated abnormally | |||
AUTOMATIC DUPLICATION | 2 | 1 | Blank | Request without automatic duplication to a shadow archive or not (yet) started |
S | Started | |||
TSN SERVERTASK | 3 | 4 | txt | TSN of the server task |
REQUEST DATE and TIME | 7 | 14 | dig | Date and time of the request |
SFID | 21 | 14 | dig | Save file ID |
SVID | 35 | 14 | dig | Save version ID |
(LOCAL) STATUS | 49 | 11 | txt | See STATUS in table below |
(LOCAL) SUB-STATUS | 60 | 17 | txt | See SUBSTATUS in table below |
FULL-FROM-FULL-STATE | 77 | 1 | Blank | Save of backup not yet started |
(REMOTE) STATUS | 78 | 11 | txt | See table below |
(REMOTE) SUB-STATUS | 89 | 17 | txt | See table below |
SERVER-NAME | 106 | 8 | txt | BCAM name of the host that is currently processing the request |
CCOPY SESSION-ID | 114 | 8 | txt | Identifier for the CCOPY save run |
The following table displays the possible values for STATUS and SUBSTATUS:
STATUS | SUBSTATUS |
INCOMPLETE | – – – |
ACCEPTED | – – – |
STARTED | COLLECTED |
COMPLETED | – – – |
INTERRUPTED | MASTER-TIMEOUT |
CANCELLED | – – – |
When HSMS halts the processing of a job, the status of the job is either COMPLETED, INTERRUPTED or CANCELLED (for more detailed information on possible request statuses, refer to section "Information about requests"). The status that is sent to the job variable can then be queried using a procedure.
If a request with the status ACCEPTED or STARTED is deleted by another task, the request monitoring job variable is updated. It is set to the status COMPLETED and the substatus WITH-ERRORS.
If requests which have a different status are deleted, the job variable is not updated.
CCS INIT STATUS
This field provides information on the initialization status of a CCOPY session. This makes it possible to optimize CCOPY processing: The application is closed before the BACKUP-FILES statement is entered, and is immediately reopened once initialization of the CCOPY session has been terminated successfully (even before the request is accepted!).AUTOMATIC DUPLICATION
In the case of a backup or long-term archiving with automatic duplication, indicates that the save file of the original archive is complete and that automatic duplication is starting. This means that HSMS/ARCHIVE no longer accesses the duplicated files. Consequently, the applications that access these files can be restarted.TSN SERVERTASK
TSN of the server task that is processing the request.REQUEST DATE and TIME
This information can be helpful for HSMS statements in which a request can be selected via the date and time, e.g. SHOW-REQUESTS, DELETE-REQUESTS, etc. .SFID
ID of the save file that is assigned by the request. This is only present for the following HSMS statements: ARCHIVE-FILES, ARCHIVE-NODE-FILES, BACKUP-FILES, BACKUP-FILE-VERSIONS and BACKUP-NODE-FILES.SVID
ID of the save version that is assigned by the request. This is only present for the following HSMS statements: ARCHIVE-FILES, ARCHIVE-NODE-FILES, BACKUP-FILES, BACKUP-FILE-VERSIONS and BACKUP-NODE-FILES.(LOCAL) STATUS
Current status of the request. This field can be used, for example, for S procedures which monitor a request.
See also the HSMS statement SHOW-REQUESTS: STATUS (“HSMS Vol. 2” [1])(LOCAL) SUB-STATUS
Provides additional information about the status of the request.
See also the HSMS statement SHOW-REQUESTS: SUBSTATUS (“HSMS Vol. 2” [1])FULL-FROM-FULL-STATE
This status relates to saving with FROM=*LATEST-BACKUP-OR-S0. The field contains a 2 if backing up of S0 has been completed and saving of earlier backups has been started.(REMOTE) STATUS
Current status of the request on the remote server.
For local requests, this field is of no significance.(REMOTE) SUB-STATUS
Supplies additional information on the status of the request on the remote server.
For local requests, this field is of no significance.SERVER-NAME
BCAM name of the remote server that is processing the request.
For local requests, this field is of no significance.CCOPY-SESSION-ID
This field is the identifier for a CCOPY save run with BACKUP-FILES CURRENT-COPY=YES or BACKUP-FILE-VERSIONS BACKUP-FILES CURRENT-COPY=YES.
The following table provides important information about where and when the content of the job variable is available.
Field | Location of the information | Time available |
CCS INIT STATUS | User-side | During acceptance of request |
AUTOMATIC DUPLICATION | Server-side | After first backup |
TSN SERVERTASK | Server-side | After start of request |
REQUEST DATE and TIME | User-side | After acceptance of request |
SFID | Server-side | After backup |
SVID | Server-side | After backup |
(LOCAL) STATUS | User-side | Constantly changing |
(LOCAL) SUB-STATUS | User-side | Constantly changing |
FULL-FROM-FULL-STATE | Server-side | After incremental backup |
(REMOTE) STATUS | Server-side | Constantly changing |
(REMOTE) SUB-STATUS | Server-side | Constantly changing |
SERVER-NAME | Server-side | After start of request |
CCOPY-SESSION-ID | User-side | From acceptance of the request |