The EXPORT statement enables files, catalog entries or job variables to be saved to tape, MT cartridge or disk for subsequent transfer to another BS2000 system or to another user ID by means of an IMPORT run. In addition, save data created in an earlier EXPORT run can be copied. The save files created via EXPORT can be read in again by means of an IMPORT run.
Before you enter the EXPORT statement, you must define the files and/or job variables to be processed by means of FILES and/or JOBVAR statements.
The EXPORT statement saves all files, regardless of the BACKUP entry.
E[XPORT] |
DIR[ECTORY] = NONE / filename[,NEW] ,DIRSAVE = NO / YES ,ATTR[IBUTES] = KEEP / RESET [,CONT[INUE] = svid / [svid,](vsn,...),...] ,RETPD = 0 / days ,ER[ASE] = NO / YES / ALL / ALLP ,NOW = YES / NO[,TIME = sec] |
1 This operand is only offered for reasons of compatibility
DIRECTORY =
This operand defines whether a directory file is used for an EXPORT run.
DIRECTORY = NONE
No directory file is used.
DIRECTORY = filename
The file with the specified name is used as a directory file.
The file must already exist and contain entries from ARCHIVE.
DIRECTORY = filename,NEW
The file with the specified name is newly created.
NEW must also be specified if the file exists but is empty, i.e. contains no entries from ARCHIVE.
DIRSAVE =
This operand determines whether the directory file is saved to the volume.
DIRSAVE = NO
The directory file is not saved.
DIRSAVE = YES
The directory file used in this run is saved as the last file of the run.
The DIRSAVE operand is only evaluated if files are found that should be saved.
UNUSED = 0 / days
This operand specifies a period of days.
If it is specified, only those files in the FILES statement which were not accessed during this period are saved. Those files which do not yet have an access date entry are not saved either.
In the case of a RESTART run, the period is calculated from the date of the RESTART run.days can be a value from 0 - 36159 (99 years).
This operand is ignored for job variables.
CATONLY =
This operand specifies whether only the catalog entries of the files should be saved.
CATONLY = NO
The files and their catalog entries are saved.
CATONLY = YES
Of the files specified in the FILES statement, the catalog entries are saved only for files that are located on private volumes. CATONLY=YES presupposes DIRECTORY=NONE, i.e. the latter is assumed even if a directory file is specified.
When job variables are saved, this operand is ignored.
Catalog entries that are saved with CATONLY=YES are restored with the value of the file size at the time of the save run.
DUPLICATE =
This operand defines whether files or job variables that have been specified in several FILES or JOBVAR statements should also be saved several times.
DUPLICATE = YES
Files or job variables which exist more than once are also saved more than once; a warning is issued.
DUPLICATE = NO
All duplicate files or job variables are saved only once, i.e. only the first file or job variable specified in the FILES or JOBVAR statement is processed.
DUPLICATE=NO is permitted only if a directory file is specified.
ATTRIBUTES =
This operand defines the password and access attributes for the saved file or job variable.
ATTRIBUTES = KEEP
The save file or job variable receives the same password and access protection attributes as the original file.
ATTRIBUTES = RESET
The password and access protection attributes are reset during the save run.
In a subsequent IMPORT run, the attributes are either reset (if no file exists in the catalog) or taken from the existing file.
LOCATION =
This operand determines how the catalog ID and user ID information for exported files should be processed.
LOCATION = KEEP
The catalog ID and user ID information of every exported file will be retained in the save file.
LOCATION = RESET
The catalog ID and user ID information is reset in the save file.
The following restrictions exist for RESET:
The EXPORT run must be executed without a directory file.
The save file created in the EXPORT run is implicitly defined as PARAM CATID=NO (see the PARAM statement, "PARAM Set runtime values"). For this reason, PARAM CATID=NO must also be specified in a subsequent IMPORT or LIST statement.
A file saved in this way cannot be renamed during IMPORT.
The operand CATONLY=YES may not be specified.
The save file can only be duplicated with LOCATION=RESET.
CONTINUE =
This operand determines that an existing save version is to be extended.
The last volume of this save version is requested. The new files or job variables are written after the last file or job variable.
If the user has specified a directory file for the save run to be continued, ARCHIVE does not save those files which
have already been saved in a later save version of the specified directory file, or
have already been saved in the save version to be continued.
ARCHIVE includes any files which were not saved for either of these reasons in the report. This ensures that no file is saved more than once under the same svid. Any additional continuation volumes required for the output must be specified in the TAPES/VOLUME operand.
The first volume, i.e. the one to be continued, must not be specified in the TAPES/VOLUME operand. Either it must be specified in the CONTINUE operand or, if a directory file is being used, it is found automatically.
The operands DIRECTORY, TARGET-ARCHIVE-VERSION, ATTRIBUTES, LOCATION, CATONLY, SAVE-ACL, BACKUP, CHANGED, COMPRESS, CATID, SVPASS and BLOCK-SIZE must be assigned the same values as the corresponding operands of the run to be continued.
If the operands DIRSAVE, DEVICE, ERASE, LIST or SHARE do not have the same values as they had for the first run, the warning ARC0055 is issued.
The RETPD operand is ignored in a CONTINUE run. The expiration date of the continued save version is retained.
A save version with RETPD > 0 can only be continued if the user ID has entered TPIGNORE=YES (JOIN).
In runs with DIRECTORY=NONE the user must ensure that files with the same name are not saved in the same save version, as this would make it impossible to predict which file will actually be restored in a subsequent IMPORT run.
If tapes or MT cartridges created with an ARCHIVE version < V2.8A need to be continued for some reason, they must previously be converted to the new format via tape-to-tape saving (see the FROM operand in the FILES statement, "FILES Select files in save runs").
For save versions on disk, the specification svid,(vsn,...) is mandatory.
The continuation disks are specified in the VOLUME operand. They must all be of the same device type. If no continuation disk is required, the VOLUME specification can be omitted. ARCHIVE aborts the run once the specified disks are full. Sufficient disks must therefore be specified in advance.
CONTINUE = svid
A directory file must have been specified. For each volume request, the last VSN is taken from the directory file.
CONTINUE = svid,(vsn,...)
If a directory file is specified for this combination of operands, ARCHIVE checks whether the specified volumes belong to this save version (svid).
If this is not the case, ARCHIVE does not perform the save run.
If it is the case, the last volume is requested and continued.
If no directory file is specified, ARCHIVE requests only the last volume and checks whether it belongs to the specified svid. If it does, the save version is continued.
Regardless of whether a directory file is used, it is sufficient to specify the VSN of the last volume.
CONTINUE = (vsn,...),...
If only the VSNs are specified and a directory file is being used, ARCHIVE checks whether the volumes all belong to the specified save version (svid). If this is not the case, ARCHIVE does not perform the save run.
Specifying VSNs or VSN groups does not influence the distribution of the volumes to the subtasks, the continuation volumes being automatically assigned to the subtasks in this case. They are assigned in accordance with the division of the original save run.
If no directory file is specified, no check is performed.
It is sufficient to specify the VSN of the last volume each time, regardless of whether or not a directory file is specified.
TAPES / VOLUME =
This operand determines the VSNs of the output volume.
POOL and OPERATOR are permitted only for tapes and MT cartridges.
POOL only has meaning when together with a directory file; otherwise TAPES=OPERATOR assumed.
TAPES / VOLUME = POOL
The VSNs are taken from the volume pool of the specified directory file in ascending order. If the volume pool does not contain sufficient available volumes, the operator or MAREN requests further volumes.
After deletion of the save version, the volumes are again AVAILABLE in the pool.
This operand is not permitted when saving to disk.
TAPES / VOLUME = OPERATOR
If MAREN is being used, the volume is readied by MAREN. Otherwise a VSN is requested via message DMS0591 at the console. The specified VSN is entered in the pool with the qualifier “OPERATOR”. When the save version is deleted, the volumes are removed from the pool. This operand is not permitted when saving to disk.
TAPES / VOLUME = vsn / =(vsn,...)
The volumes are requested in the specified order.
For tapes and MT cartridges
The specified VSNs are entered in the pool with the qualifier “OPERATOR”. When the save versions are deleted, the volumes are removed from the pool. Any additionally required volumes are assigned by MAREN or by the operating.
For disks
If too few disks are specified for the save run, ARCHIVE aborts the run.
vsn cannot begin with PO or OP (conflict with the operand values OPERATOR or POOL).
DEVICE = TAPE-C4 / device type
This operand defines the device type for all the VSNs specified in the TAPES/VOLUME or CONTINUE operand. This also applies to VSNs which are only specified indirectly, e.g. in CONTINUE=svid.
MAREN-LOCATION = <alphanum-name 1..8>
This operand specifies the MAREN storage location from where free volumes should be taken if no volume is specified in the statement and no volume is available in the ARCHIVE directory pool. The following applies:
If the MAREN software product is not installed or started, the operand has no effect.
If the software product MAREN is installed, the specified MAREN-LOCATION may be overwritten implicitly by MAREN EXITS or a reservation file. In this case the user is not informed about the change. If however the run should be aborted, the MAREN-Parameter OVERRULE-LOCATION = *REJECT needs to be set (from MAREN V12.5A). If MAREN exits and/or a reservation file are used, it is recommended not to specify a MAREN-LOCATION in the SAVE or EXPORT statements.
DRIVES = 1 / integer
This defines the number of parallel runs (maximum 16). A number of output devices are used in parallel. The value of integer must be less than or equal to the number of devices available.
RETPD = 0 / days
This operand defines a retention period in days for the save version.
During this period
the save version in the directory file is protected against being deleted (PURGE),
tapes and MT cartridges are protected against being overwritten and
the save files on disk are protected against being overwritten or deleted.
The maximum retention period is 32767 days, or about 90 years.
SHARE =
This operand defines whether the volumes or save files that have been created are given the attribute “shareable”.
SHARE = YES
The volumes or save files created are shareable.
The exported files and job variables can be read in again under a different user ID with the aid of the RENAME operand. Other users can access the volumes.
SHARE = NO
The volumes or save files created are not shareable.
The exported files and job variables can only be read in again under the user ID under which they were saved. The user cannot even read in his/her files and job variables from a save file of the system support. Other users cannot access the volumes.
SVPASS = password
This operand defines a password for the entire save version. In order to read in a file or job variable or to delete the save version (svid) via PURGE, this password must be specified either in the PASSWORD operand or in the /ADD-PASSWORD command.
PRIMARY = 500 / PAM pages
This operand specifies the number of blocks (2048 bytes) for the primary allocation of the save file when saving to hard disk (integer between 32 and 50331645).
When saving to tape or MT cartridge, this operand is ignored.
SECONDARY = 100 / PAM pages
This specifies the number of blocks (2048 bytes) for the secondary allocation of the save file when saving to hard disk (0 or an integer between 32 and 32767). If the value 0 is assigned and ARCHIVE tries to extend the save file, a DMS error occurs.
When saving to tape or MT cartridge, this operand is ignored.
BLOCK-SIZE =
This operand specifies the maximum number of PAM pages of the saved file that are stored in an ARCHIVE save block. BLOCK-SIZE=16, for example, means that up to 16 PAM pages of the saved file are written to one save block.
The operand name TAPE-BLOCK-SIZE is still supported for reasons of compatibility.
If this parameter is not specified, ARCHIVE uses the setting in the ARCHIVE parameter BLOCK-SIZE-T-C for tape cartridge devices and the setting in the ARCHIVE parameter BLOCK-SIZE-TAPE for long tapes.
BLOCK-SIZE = STD
The compatible block size of 32 kB, which corresponds to BLOCK-SIZE=15, is used.
The default value is 15 for magnetic tape or MT cartridge devices and 31 for hard disk devices. On a hard disk device, values lower than 15 will reduce the performance of ARCHIVE.
BLOCK-SIZE = MAX
The maximum block size possible in this BS2000 version and for this device is used, in other words 256 kB for BS2000/OSD V6.0 or higher and TCs of type TAPE-C3 or higher, and otherwise 32 kB. When saving to public disk ARCHIVE determines the BLOCK-SIZE on the basis of the disk’s maximum transfer length.
BLOCK-SIZE = PAM pages
The value range for this operand is 1...35.
If
TARGET-ARCHIVE-VERSION=BEFORE-V26Bis specified, the minimum value is 1; in all other cases, it is 2.The maximum value is 15 for saving to tape or MT cartridge, 31 for saving to private disk, and 35 for saving to public disk.
For values greater than 31, the user must check their device configuration (with /SHOW-MASTER-CATALOG-ENTRY ...,INFORMATION=*USER) in order to ensure whether such values are permissible.
When saving NK4 disks, only odd values are processed, i.e. if an even value is specified it is decremented to the next lower odd value and a warning is issued.
The default value is 15 for magnetic tape or MT cartridge devices and 31 for hard disk devices. On a hard disk device, values lower than 15 will reduce the performance of ARCHIVE.
COMPRESS =
This operand determines whether the data should be written into the save file in a compressed form.
COMPRESS = NO
The data is not written to the save file in compressed form.
COMPRESS = YES
The data is written to the save file after being subjected to software compression.
In the case of device types which automatically implement hardware compression (e.g. TAPE-C4), COMPRESS=NO is assumed. Save files created with COMPRESS=YES cannot be read by the SIR software product.
CONSISTENCY-CHECK / CONS-CHK =
This operand determines whether check bytes are calculated for a consistency check of the save files.
CONSISTENCY-CHECK = NO
Check bytes are not calculated.
On a subsequent IMPORT or LIST operation, a CONSISTENCY-CHECK=YES entry is ignored.
CONSISTENCY-CHECK = YES
Check bytes are calculated and stored with the save data.
On a subsequent IMPORT or LIST operation, the correct transmission of save data is checked.
ERASE =
This operand determines whether the files and job variables are deleted after a save run.
ERASE = NO
The files and job variables are not deleted after the save run.
ERASE = YES
The exported files and job variables are deleted after the save run if they are not protected by means of a password or a retention period and if modifying access is permissible for them.
ERASE = ALL
As for YES, but those files and job variables which are protected by means of a retention period and for which only read access is permitted are also deleted.
ERASE = ALLP
This operand can only be entered with the TSOS privilege.
As for ALL, but those files and job variables which are protected by a password are also deleted, without the password having to be specified.
If both the ERASE operand and CATONLY=YES are specified, only the catalog entry is deleted, not the file itself.
The ERASE operand is ignored when copying save data.
File generation groups (FGGs) and file generations are deleted only if the entire FGG is being saved in this run.
NOW =
This operand specifies when the save run is to be executed.
NOW = YES
The EXPORT statement is to be executed immediately.
NOW = NO
The EXPORT statement is checked for correct syntax and then written to the queue file ARCHIVE.LATER. This process is given the ARCHIVE identifier L.yymmdd.hhmmss. The identifier is only allocated if no LATER job exists in the same task at the time. If this is not the case, then the process is stored under the existing identifier.
The LATER job can be started by means of the PROCESS statement or deleted by means of the DELETE statement.
NOW = NO,TIME=sec
The number of CPU seconds that are available to this process when it is started. This entry corresponds to the operand CPU-LIMIT in /START-(EXECUTABLE-)PROGRAM.
PASSWORD = password / (password,...)
If you specify the operand NOW=NO, you must specify passwords here for
files or job variables to be exported which are protected by a read password,
the save version, if it has been protected by a password with SVPASS.
the directory file, if it is protected by a write password and is not located under TSOS.
magnetic tapes and MT cartridges that are protected by a password (up to 4 characters) under MAREN.
In all other cases, you should enter the passwords in the /ADD-PASSWORD command before ARCHIVE is called. Only in this case are the passwords also valid for the subsequent ARCHIVE runs of the same user task.
The system support can process files and job variables without specifying the passwords.
However, he must specify the password for the directory file if it is assigned to another user ID.
LIST =
This operand specifies the output medium for the report of the EXPORT run.
LIST = SYSLST
The report is output to SYSLST.
LIST = SYSOUT
In an interactive task, the report is output to the terminal.
LIST = BOTH
The report is output to both SYSLST and SYSOUT.
LIST = NONE
No report is generated.