Loading...
Select Version
&pagelevel(3)&pagelevel
The volume catalog has the following file structure:ACCESS-METHOD=ISAM,RECORD-FORMAT=V,KEY-POSITION=5,KEY-LENGTH=10
The file must be set up with ACCESS=*WRITE.
The records of the volume catalog start with 1002 bytes for including the secondary indexes. The next is the catalog entry fields (1014 bytes). The total record length is then 2016 bytes.
The catalog entry fields are described in the table below. The structure of the catalog entry fields is defined by the MARENA macro. The individual catalog entry fields can be symbolically addressed in Assembler programs via the dummy section of the MARENA macro.
For COBOL programmers, the copy element MARENAC is provided. Allocation of the catalog entry fields to the field names of the dummy section of the MARENA macro or the output of SHOW-VOLUME-ATTRIBUTES is described in the appendix starting in section “Statement operands and volume catalog entry fields”.
| Catalog entry field / Length in bytes | Designation / Value range / Meaning | |
| --- | 4 | Record length field. |
| VOLUME | 6 | VSN |
| FILE-SEQUENCE | 4 | File sequence number 0001,.....,9999. Corresponds to field 6 (file sequence number) in the HDR1 label. |
| Note VOLUME and FILE-SEQUENCE together form the ISAM key. | ||
| FILE-NAME | 41 | File name (without catalog ID and user ID) for a tape file. |
| --- | 1 | Internal MAREN catalog entry field. |
| CREATION-CAT-ID | 4 | Catalog ID from the file name at the time of file creation. |
| CREATION-USER-ID | 8 | User ID from the file name at the time of file creation. |
| Note The preceding four catalog entry fields are combined to form the following catalog entry field DIRECTORY-NAME for all tapes contained in a directory. | ||
| DIRECTORY-NAME | 54 | Name of a directory (with catalog ID and user ID) which contains the tape. |
| USER-IDENTIFICATION | 8 | User ID of the owner. Automatically entered by MAREN when a tape is reserved and then no longer modified. |
| ACCOUNT | 8 | Account number of the tape owner. The information for USER-IDENTIFICATION and ACCOUNT is taken automatically from the LOGON command of the user at reservation time. |
| REMARK | 24 | Remark field. This catalog entry field is output in response to a SHOW statement. The owner should therefore complete this field using an explanatory text. It is possible to assign different text to each catalog entry of a VSN (different FSEQ). |
| USER-FIELD | 54 | User field. Here the owner can enter any relevant data such as name, department, telephone number, or work scheduling data. It is possible to assign different text to each catalog entry of an archive number (different FSEQ). |
| EXPORT-ADDRESS | 50 | Mailing address. The EXPORT-VOLUME statement can be used here to enter a mailing address, a short message, a mailbox number, etc. |
| Note The above catalog entry fields REMARK, USER-FIELD, and EXPORT-ADDRESS are not provided with values by MAREN and are not evaluated. It is the responsibility of the user to provide these catalog entry fields with values. | ||
| USER-ACCESS | 1 | Shareability of the tape. OWNER-ONLY: not shareable (default) FOREIGN-READ-ONLY: read access only ALL-USERS: unrestricted access. |
| ARCHIVE-USAGE | 1 | ID for the HSMS/ARCHIVE free tape pool. Permitted values: *NO, *GLOBAL, *TSOS, <filename>. |
| PASSWORD | 4 | Password (default: 4X'00'). A password entered in this catalog entry field is related to the tape and not to the files on the tape. If a password exists, it must always be specified. |
| CHECK-COUNT | 2 | Check number (00 through 99). This MAREN-internal catalog entry field is incremented each time the catalog entry is modified (modulo 100); it is used for reorganization purposes, etc. |
| ACCESS-COUNT | 4 | Access counter (0000,....,9999). This counter is incremented each time the tape is accessed, also when exported. |
| FREE-LOCATION | 8 | Release location. A tape is moved to this location during the release run. |
| HOME-LOCATION | 8 | Permanent location. A tape is moved to this location during the clear-up run. |
| TEMPORARY-LOCATION | 8 | Current location. This catalog entry field designates the location where the tape can be found at the moment. If the tape is being processed, it contains the system name, unless the tape is at an external location or in an archive system. |
| Note The catalog entry fields FREE-LOCATION, HOME-LOCATION, and TEMPORARY-LOCATION can contain either a system name or 'CENTRAL' for central archive, or another location name, e.g. 'TRESOR' or 'BRAND'. | ||
| DEVICE-TYPE | 2 | Device type of the tape. |
| CREATION-JOB-NAME or REQUEST-NAME | 8 | For HSMS: REQUEST-NAME. Otherwise: CREATION-JOB-NAME. |
| CREATION-TIME | 8 | Creation time (hh:mm:ss). |
Note | ||
LAST-CLOSE-TIME | 8 | CLOSE time (hh:mm:ss). |
| Note The above catalog entry field LAST-CLOSE-TIME is updated at CLOSE time in the case of output. | ||
| OPEN-MODE | 2 | OPEN type of the last access. |
| VOLUME-SEQUENCE | 4 | Tape sequence number (0001,....,0255). This catalog entry field corresponds to field 5 (file sequence number) in the HDR1 label. |
| FIRST-VOLUME | 6 | First archive number of the MF/MV set. This catalog entry field corresponds to field 4 (file volume label) in the HDR1 label. |
| RESERVATION-COUNT | 4 | Reservation counter (0000,....,9999). This counter is incremented with each new reservation of the tape. |
| INITIALIZATION | 1 | Initialization flag (YES/NO/ERASE). The value ERASE is only set by MODIFY-VOLUME-ATTRIBUTES. 'YES' is set during tape processing:
|
| VOLUME-STATUS | 1 | Tape status: FREE - free tape in the local data center. PRIVATE - private tape. The tape has been exported from a foreign data center and added to the MAREN catalog of the local data center by means of IMPORT-FOREIGN-VOLUME. RESERVED - reserved tape in the local data center. |
| CLOSE-INDICATOR | 1 | CLOSE indicator. This catalog entry field provides information on whether creation of a tape file has been terminated correctly. At the start of creation, i.e. OPEN time, the indicator is set to 'OPEN'. If file creation is terminated by means of a CLOSE macro in the user program, MAREN sets the CLOSE indicator to 'CLOSED'. In many other cases, such as the cases with the TERM, LOGOFF, EXIT-JOB, CANCEL-JOB and SHUTDOWN macros as well as in the case of a system dump, an implicit CLOSE ALL does take place, but this does not affect the indicator. |
| LAST-ACCESS-SNO | 3 | Session number of the last access (001,...,255). |
| LAST-ACCESS-TIME | 8 | Time of the last access (hh:mm:ss). |
| LAST-ACCESS-TSN | 4 | Task sequence number (TSN) of the last access (only as long as the tape is allocated). |
| LAST-ACCESS-HOSTNAME | 8 | System name during the last access. |
| LAST-ACCESS-JOB-NAME | 8 | Job name of the last access. |
| LAST-ACCESS-USER-ID | 8 | User ID of the last access. |
| LAST-ACCESS-ACCOUNT | 8 | Account number of the last access. |
| LAST-ACCESS- FUNCTION-FLAG | 2 | This MAREN-internal catalog entry field indicates the action last taken on the catalog entry or the tape. Possible values are, for example: ' 11' - Add catalog entry. ' 17' - Reserve. ' 23' - Modify. |
| LAST-ACCESS- FUNCTION-NAME | 8 | Function name. This catalog entry field contains the name of the MAREN component or MAREN routine which last modified the catalog entry. For possible values, see section “Function names in MAREN”. |
| Note The above catalog entry fields LAST-ACCESS-... are used internally for the transfer of program information when program interfaces are employed. | ||
| --- | 10 | Start of number range: archive number and file sequence number. |
| RETFLAG | 1 | This MAREN-internal catalog entry field indicates whether the last action attempted was executed successfully. |
| ERRORKEY | 7 | This MAREN-internal catalog entry field contains the error key for the last action performed. |
| --- | 6 | End of number range (archive number). |
| ADMINISTRATOR-FIELD | 8 | Administrator field. Here any information can, for example, be stored via MAREN exits. When working with HSMS, the degree of tape utilization (number of PAM pages written to the tape) can be recorded here. This catalog entry field cannot be changed by the MAREN user. |
| AUDIT | 1 | Indicator byte bit 20: Audit flag. When this bit is set, AUDIT=YES applies. In this event, MAREN monitors and, if necessary, rejects all access attempts on the relevant tape. This AUDIT flag is only evaluated if the MAREN administrator has set the system-specific parameter AUDIT to OPTIONAL. |
| FREE-POOL-NAME | 54 | Name of the free tape pool in which this tape is located or in which it should be located when it is shared. |
| PAM-PAGE-NUMBER | 10 | Number of blocks (not PAM pages) written to the tape concerned. This is transferred from DMS to MAREN at the end of every write operation (number is cumulated). |
| DEVICE-NAME | 4 | 4-byte device name of the last tape device used. 2-byte device names are left-justified. |
| LAST-ACCESS-DATE | 10 | Date of the last access (yyyy-mm-dd). |
| FREE-DATE | 10 | Expiration date (yyyy-mm-dd). This date specifies when the tape can be released, i.e. when the tape reservation for a specific user ID can be lifted. Release is effected by the administrator in the so-called release session using the MARENADM statement FREE-VOLUMES. In the case of tapes from a remote data center, this catalog entry field is not evaluated and contains blanks. |
| EXPIRATION-DATE | 10 | File expiration date (yyyy-mm-dd). This catalog entry field corresponds to the RETENTION-PERIOD entry in the ADD-FILE-LINK command or in field 10 (expiration date) in the HDR1 label, as long as it is not explicitly modified at a later date. |
| EXPORT-DATE | 10 | Export date (yyyy-mm-dd). For tapes which are not exported, this catalog entry field contains blanks. |
| CREATION-DATE | 10 | Creation date (yyyy-mm-dd). |
| LAST-CLOSE-DATE | 10 | CLOSE date (yyyy-mm-dd). In the case of OUTPUT, the catalog entry field is updated at CLOSE time (see LAST-CLOSE-TIME). |
| RESERVATION-DATE | 10 | Reservation date (yyyy-mm-dd). Date when a tape was reserved in the local data center or when a tape was added to the local data center’s MAREN catalog from a remote data center. |
| SAVE-FILE-ID | 15 | SAVE-FILE (HSMS) or SAVE-VERSION (ARCHIVE). |
| SUBSAVE | 3 | Number of subtask for parallel save run in HSMS/ARCHIVE. |
| SUBSEQUENCE | 2 | Number of subsequent tape within a save run in HSMS. |
| DIR-ON-VOL | 1 | Displays whether a directory is stored at the end of the tape. |
| DOMAIN-NAME | 8 | If domains are being used, the name of the domain to which the relevant tape belongs. Otherwise blanks for '*STD-DOM'. |
| ADMINISTR-FIELD-2 | 16 | Freely definable administrator field. |
| REMARK2 | 10 | User field which can be freely set. |
| REMARK3 | 12 | User field which can be freely set. |
| ACCESS-COUNT | 8 | Access counter (00000000, ..., 99999999). This counter is incremented each time the tape is accessed, also when exported. |
| VOLUME-GROUP | 32 | Name of the volume group. |
| REGISTRATION-DATE | 10 | Date on which the tape was added to the MAREN catalog. ( yyyy-mm-dd). |