Creating a directory file

Any user can define a directory file with any desired name in which ARCHIVE enters information concerning the save versions and with the aid of which the user can restore his/her files and job variables.

A directory file can be created with the EXPORT, SAVE and POOL statements. Its name is defined by way of the operand DIRECTORY=filename. In addition, ',NEW' must be specified for the DIRECTORY operand. If ',NEW' is specified for a directory that is not empty, ARCHIVE aborts the run with a corresponding message.

Example

/START-ARCHIVE ————————————————————————————————————————————————————————  (1)

%  BLS0990 PROCESSING OF REP FILE ':SBZ3:$TSOS.SYSREP.ARCHIVE.120' STARTED
%  ARCLOAD Program 'ARCHIVE', version '12.0A' of '2018-06-04' loaded  
           from file ':1OSH:$TSOS.SYSLNK.ARCHIVE.120'
%  ARCCOPY Copyright (C) FUJITSU TECHNOLOGY SOLUTIONS 2018. 
            All rights reserved  
%  ARC0001 ARCHIVE READY

*POOL DIRECTORY=DIR.TEST,NEW,ADD=OS0310,DEVICE=TAPE-C4 ————————————————  (2)

%  ARC0002 STATEMENT ACCEPTED. ARCHIVE SEQUENCE NUMBER 'A.200810.133604',
           VERSION='12.0A' 
%  MARM121 MAREN CATALOG ENTRY 'OS0310'/'0001' MODIFIED
%  ARC0010 VOLUME OF TYPE 'TAPE-C4' WITH VSN 'OS0310' ADDED TO THE POOL  (3) 
%  ARC0003 ARCHIVE STATEMENT COMPLETED 
. . .

(1)	The user calls ARCHIVE.
(2)	The POOL statement is used to set up the DIR.TEST directory file. The MT cartridge is added to the volume pool of the directory file.
(3)	ARCHIVE reports that the MT cartridge has been added to the volume pool.

It is also possible to create a directory file with /CREATE-FILE or /ADD-FILE-LINK (in which case ARCHIVE uses the link name DIRLINK for the directory).

If you create a directory file with /CREATE-FILE or /ADD-FILE-LINK, you can specify certain file attributes for the directory file; otherwise, only the default values are assigned.
You cannot change the values for

• the access method (ACCESS-METHOD=*ISAM),

• the record format (RECORD-FORMAT=*VARIABLE),

• the key length and position (KEY-LENGTH and KEY-POSITION).

Write access must be permitted for the directory file (ACCESS=WRITE) and the directory file must be empty. In addition, DIRECTORY=NEW must be specified in the next ARCHIVE run.

The directory file is created with or without a PAM key, depending on the default value defined for the system. Even in systems with PAM keys, the directory can be created as a non-key (NK) file, i.e. without PAM keys (see the „Introductory Guide to DMS“ manual [2]).

A new directory file is created with the characteristic BLOCK-CONTROL-INFO=*WITHIN-DATA-BLOCK (DATA-2K or DATA-4K, depending on whether the disk is an NK2 or an NK4 disk). This requires one of the following three conditions to be met:

• system parameter BLKCTRL=NONKEY if the disk has PAM keys

• system parameter BLKCTRL=KEY if the disk does not have PAM keys

• or the following command must be explicitly specified:

  /ADD-FILE-LINK LINK-NAME=DIRLINK,FILE-NAME=<directory-name>, 
                 BLOCK-CONTROL-INFO=*WITHIN-DATA-BLOCK

Moreover, the user must specify the operand DIRECTORY=directory-name,NEW in the subsequent ARCHIVE run.

In the explicit specification, all three operands are mandatory. The user may supplement the /ADD-FILE-LINK command by the POOL-LINK and WRITE-IMMEDIATE operands to support NK-ISAM handling.

If the user wants to link an existing directory file with the attribute BLOCK-CONTROL-INFO=*WITHIN-DATA-BLOCK to a user-own ISAM pool, (s)he must enter the /ADD-FILE-LINK command together with the additional operand POOL-LINK. If no /ADD-FILE-LINK command is entered or the POOL-LINK operand is omitted, the directory file is linked to the task-local standard pool.

Every directory file contains an identifier indicating the mode in which it was created. It can only be used in this mode. However, a directory file created with CATID=NO can be converted with the aid of DIRCONV (see the „HSMS“ manual [9]). After conversion, this directory can be used only for runs with CATID=YES.

Directory files cannot be used as file generation group files.

It is not possible to perform more than one save run at a time using the same directory file.