This statement is used for exporting files and job variables to magnetic tape cartridge, to public disc or Net-Storage. These files can then be imported to the other BS2000 system or the other user ID using IMPORT-FILES. For files on private volumes there is the option of saving the catalog entries only. A directory of the export run can be created and written to the backup volume.
EXPORT-FILES requests are entered in the HSMS global request file.
This statement has different formats for nonprivileged users and HSMS administrators. Privileged operands or operand values are marked with *P).
Format
EXPORT-FILES | Alias: EXF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
*P) Privileged operand or operand value
FILE-NAMES =
Serves to specify the files to be exported. The specification is mandatory
The selection can be restricted via the operands EXCEPT-FILE-NAMES and SUPPORT.
Nonprivileged users may export other users’ files. This requires specifying the user ID explicitly and that FILE-ATTRIBUTES=*RESET-TO-STD applies. The foreign files are also exported if they are readable for the caller, either through shareability or co-ownership.
FILE-NAMES = *OWN
All files of the user’s own ID residing on any imported pubset (except for shared SF pubsets for which the home computer is the slave) are exported.
FILE-NAMES = *ALL
All files residing on all imported pubsets (except for shared SF pubsets for which the home computer is the slave) are exported.
FILE-NAMES = *NONE
No files are exported.
FILE-NAMES = *SELECTED
The path names of the files to be exported are to be taken from a list that was compiled within the same HSMS run by means of the HSMS statement SELECT-FILE-NAMES.
FILE-NAMES = *FROM-FILE(...)
The path names of the files to be exported are to be taken from a file. The nonprivileged caller must be owner or co-owner of this file. This list file must be a SAM file with variable-length records containing one path name per record. Only upper-case characters may be used. The list file can be created, for instance, by means of the HSMS statement SELECT-FILE-NAMES or the BS2000 command SHOW-FILE-ATTRIBUTES.
LIST-FILE-NAME = <filename 1..54 without-gen-vers>
Path name of the list file.
FILE-NAMES = *FROM-LIBRARY-ELEMENT(...)
The path names of the files which are to be exported are taken from a PLAM library element (type S). The library element contains one path name per record. Only upper-case letters may be used.
LIBRARY = <filename 1..54 without-gen-vers>
Name of the PLAM library.
ELEMENT = <composed-name 1..64 with-under>
Name of the type-S element. The element of the highest existing version is used.
FILE-NAMES = list-poss(20): <filename 1..80 without-vers-with-wild> / <partial-filename 2..79 with-wild>
The path names of the files to be exported are specified directly. A list of up to 20 names may be specified.
The file names may be specified as fully or partially qualified names, with or without a catalog/user ID. If required, the file name is extended by the user ID of the request and the default catalog ID of the user ID.
The files can alternatively be selected using wildcards. Note, however, that only the HSMS administrator may use wildcards for user ID specification. In the case of shared pubsets, the replacement of wildcards for catalog IDs does not refer to SF pubsets for which the home computer is the slave.
The following applies to file generations:
When specifying fully qualified file names, the specification of a generation number (version) is permissible. Only the specified generations will be exported.
EXCEPT-FILE-NAMES =
Serves to specify files that are to be excluded from export.
EXCEPT-FILE-NAMES = *NONE
All files specified with the FILE-NAMES operand are to be exported.
EXCEPT-FILE-NAMES = *FROM-FILE(...)
The path names of the files to be excluded from export are to be taken from a file. The nonprivileged caller must be owner or co-owner of this file. This list file must be a SAM file with variable-length records containing one path name per record. Only upper-case characters may be used. The list file can be created, for instance, by means of the BS2000 command SHOW-FILE-ATTRIBUTES.
LIST-FILE-NAME = <filename 1..54 without-gen-vers>
Path name of the list file.
EXCEPT-FILE-NAMES = *FROM-LIBRARY-ELEMENT(...)
The path names of the files which are not to be exported are taken from a PLAM library element (type S). The library element contains one path name per record. Only upper-case letters may be used.
LIBRARY = <filename 1..54 without-gen-vers>
Name of the PLAM library.
ELEMENT = <composed-name 1..64 with-under>
Name of the type-S element. The element of the highest existing version is used.
EXCEPT-FILE-NAMES = list-poss(20): <filename 1..80 without-vers-with-wild> /
<partial-filename 2..79 with-wild>
The path names of the files to be excluded from export are specified directly. A list of up to 20 names may be specified.
The first character of the file names must not be a hyphen. The file names may be specified as fully or partially qualified names, with or without a catalog/user ID. If required, the file name is extended by the user ID of the request and the default catalog ID.
The files can alternatively be selected using wildcards. Note, however, that only the HSMS administrator may use wildcards for user ID specification because only the HSMS administrator is allowed to specify other user IDs. In the case of shared pubsets, the replacement of wildcards for catalog IDs does not refer to SF pubsets for which the home computer is the slave.
The following applies to file generations:
When specifying fully qualified file names, the specification of a generation number (version) is permissible. Only the specified generations will be excluded from export.
NEW-FILE-NAMES =
Allows files to be exported under a new name. Files can only be renamed during export without a directory file.
The user must ensure that the new path name conforms to the BS2000 conventions governing names. The total length must not exceed 54 characters; i.e. the file name without user ID and catalog ID should not exceed 38 characters (to allow for its extension by the catalog ID). The new file name is formed as follows:
:<cat-id>:$<user-id>.old-filename-without-cat-user.<suffix>
All users are allowed to specify a user ID other than their own.
NEW-FILE-NAMES = *SAME
The files are to be exported under their original names.
NEW-FILE-NAMES = *BY-RULE(...)
The files are to be renamed using a common rule.
NEW-CATALOG-ID = *SAME / <cat-id>
The files may be exported under a different catalog ID. The catalog ID must be specified without colons. The user ID must have a JOIN entry for this catalog.
Unless otherwise specified, the files are exported under their original catalog ID.
NEW-USER-ID = *SAME / <name 1..8>
The files may be exported under a different user ID. The user ID must be specified without a leading “ $ ” character.
Unless otherwise specified, the files are exported under their original user ID.
PREFIX = *NONE / <name 1..8>
A prefix of up to 8 characters may be added to the file name, automatically separated from the file name by a period (partial qualification).
The prefix must not contain any characters that are prohibited for file names.
Unless otherwise specified, no prefix is added to the file names.
SUFFIX = *NONE / <composed-name 1..8>
A suffix of up to 8 characters may be added to the file name, automatically separated from the file name by a period (partial qualification).
The suffix must not contain any characters that are prohibited for file names.
Unless otherwise specified, no suffix is added to the file names.
SUPPORT =
The files to be exported can be selected according to the type of volume (public disk, private disk or tape) on which they reside.
SUPPORT = *ANY
The type of volume on which the files reside is not a selection criterion.
SUPPORT = *PUBLIC-DISK(...)
Restricts export to files residing on the disks of a pubset or on the assigned Net-Storage.
STORAGE-TYPE =
Selects the storage type for public volumes.
STORAGE-TYPE = *ANY
The files are exported irrespective of the storage type. They can reside on the disks of a pubset or on a Net-Storage. Files residing on Net-Storage volumes of NETVOL volume type are exported only on BS2000 V21.0A or higher.
STORAGE-TYPE = *PUBLIC-SPACE
Only files which reside on the disks of a pubset are exported. Files on a Net-Storage are ignored.
STORAGE-TYPE = *NET-STORAGE(...)
Only files which reside on a Net-Storage are exported. Files residing on Net-Storage volumes of NETVOL volume type are exported only on BS2000 V21.0A or higher.
VOLUMES = *ALL / list-poss(150): <vsn 1..6>
Specifies the Net-Storage volume on which the files to be exported reside. If more than one Net-Storage is assigned to the pubset, the Net-Storage volumes from which files are to be exported can be specified in a list. *ALL selects all Net-Storage volumes which are assigned to the specified pubsets.
FILE-TYPE =
Selects the file type of Net-Storage files that will be exported.
FILE-TYPE = *ANY
The Net-Storage files are selected irrespective of the file type.
FILE-TYPE = *BS2000
Only Net-Storage files of the type BS2000 are selected.
FILE-TYPE = *NODE-FILE
Only Net-Storage files of the type node file are selected.
SUPPORT = *PRIVATE-DISK(...)
Restricts export to files which reside on private disks and which have been imported, i.e. recorded in the catalog of a pubset.
VOLUMES = *ALL
Files on all (imported) private disks are exported.
VOLUMES = list-poss(150): <vsn 1..6>
Volume serial numbers of private disks. All files having at least one extent on the specified disks are exported.
CATALOG-ENTRIES-ONLY = *NO / *YES
Determines whether or not only the catalog entries of the specified files on private disk are exported.
SUPPORT = *TAPE
Only the catalog entries of tape files are exported.
JV-NAMES =
Serves to specify the job variables to be exported.
The nonprivileged user can also export other users’ job variables by explicitly specifying the user ID. A prerequisite here is that FILE-ATTRIBUTES=*RESET-TO-STD is used. The foreign job variables are also exported if they are readable for the caller, either through shareability or co-ownership.
JV-NAMES = *NONE
No job variables are exported.
JV-NAMES = *OWN
All job variables of the user’s own ID residing on any imported pubset (except for shared SF pubsets for which the home computer is the slave) are exported.
JV-NAMES = *ALL
All job variables residing on all imported pubsets (except for shared SF pubsets for which the home computer is the slave) are exported.
JV-NAMES = *FROM-FILE(...)
The path names of the job variables to be exported are taken from a file. The nonprivileged caller must be owner or co-owner of this file. This list file must be a SAM file with variable-length records containing one path name per record. Only upper-case characters may be used.
LIST-FILE-NAME = <filename 1..54 without-gen-vers>
Path name of the list file.
JV-NAMES = *FROM-LIBRARY-ELEMENT(...)
The path names of the job variables which are to be exported are taken from a PLAM library element (type S). The library element contains one path name per record. Only upper-case letters may be used.
LIBRARY = <filename 1..54 without-gen-vers>
Name of the PLAM library.
ELEMENT = <composed-name 1..64 with-under>
Name of the type-S element. The element of the highest existing version is used.
JV-NAMES = list-poss(20): <filename 1..80 without-vers-with-wild> / <partial-filename 2..79 with-wild>
The path names of the job variables to be exported are specified directly. A list of up to 20 names may be specified.
The job variables can alternatively be selected using wildcards. In the case of shared pubsets, the replacement of wildcards for catalog IDs does not refer to SF pubsets for which the home computer is the slave.
EXCEPT-JV-NAMES =
Serves to specify job variables that are to be excluded from export.
EXCEPT-JV-NAMES = *NONE
All job variables specified with the JV-NAMES operand are to be exported.
EXCEPT-JV-NAMES = *FROM-FILE(...)
The path names of the job variables to be excluded from export are to be taken from a file. The nonprivileged caller must be owner or co-owner of this file. This list file must be a SAM file with variable-length records containing one path name per record. Only upper-case characters may be used.
LIST-FILE-NAME = <filename 1..54 without-gen-vers>
Path name of the list file.
EXCEPT-JV-NAMES = *FROM-LIBRARY-ELEMENT(...)
The path names of the job variables which are not to be exported are taken from a PLAM library element (type S). The library element contains one path name per record. Only upper-case letters may be used.
LIBRARY = <filename 1..54 without-gen-vers>
Name of the PLAM library.
ELEMENT = <composed-name 1..64 with-under>
Name of the type-S element. The element of the highest existing version is used.
EXCEPT-JV-NAMES = list-poss(20): <filename 1..80 without-vers-with-wild> /
<partial-filename 2..79 with-wild>
The path names of the job variables to be excluded from export are specified directly. A list of up to 20 names may be specified. The first character of the job variable names must not be a hyphen.
The job variables can alternatively be selected using wildcards. In the case of shared pubsets, the replacement of wildcards for catalog IDs does not refer to SF pubsets for which the home computer is the slave.
NEW-JV-NAMES =
This operand allows job variables to be exported under new names. Job variables can only be renamed during export without a directory file.
The user must ensure that the new path name conforms to the BS2000 naming conventions. The total length must not exceed 54 characters; this implies that the job variable name without user ID and catalog ID should not exceed 38 characters (to allow for the catalog ID extension). The new job variable name is formed as follows:
:<cat-id>:$<user-id>.old-jvname-without-cat-user.<suffix>
NEW-JV-NAMES = *SAME
The job variables are exported under their original names.
NEW-JV-NAMES = *BY-RULE(...)
The job variables are to be renamed using a common rule.
NEW-CATALOG-ID = *SAME / <cat-id>
The job variables may be exported under a different catalog ID. The catalog ID must be specified without colons. The user ID must have a JOIN entry for this catalog.
Unless otherwise specified, the job variables are exported under their original catalog ID.
NEW-USER-ID = *SAME / <name 1..8>
The job variables may be exported under a different user ID. The user ID must be specified without a leading “ $ ” character.
Unless otherwise specified, the job variables are exported under their original user ID.
PREFIX = *NONE / <name 1..8>
A prefix of up to 8 characters may be added to the job variable name, automatically separated from the job variable name by a period (partial qualification). The prefix must not contain any characters that are prohibited for job variable names.
Unless otherwise specified, no prefix is added to the job variable names.
SUFFIX = *NONE / <composed-name 1..8>
A suffix of up to 8 characters may be added to the job variable name, automatically separated from the job variable name by a period (partial qualification). The suffix must not contain any characters that are prohibited for job variable names.
Unless otherwise specified, no suffix is added to the job variable names.
EXPORTED-ENVIRONMENT =
Specifies the file / job variable attributes to be retained in the save file.
EXPORTED-ENVIRONMENT = *KEEP
All attributes are retained.
EXPORTED-ENVIRONMENT = *PARAMETERS(...)
Detailed specification of the attributes to be modified.
FILE-ATTRIBUTES = *KEEP / *RESET-TO-STD
Specifies whether the password and access protection attributes are to be retained or set to the default value.
CAT-AND-USER-ID = *KEEP / *IGNORE
Specifies whether or not the catalog ID and user ID are to be retained.
If the catalog ID and user ID are not transcribed to the save file, the files or job variables can be imported without knowledge of the exporting catalog/user ID.
If files were exported with the specification CAT-AND-USER-ID=*IGNORE, the catalog and user ID cannot be renamed when imported (HSMS statement IMPORT-FILES).
CATALOG-FORMAT = *KEEP / *BEFORE-OSD-V1
Specifies whether the catalog format is to be retained or converted to the format of the BS2000 versions preceding BS2000/OSD-BC V1.0.
DELETE-FILES-AND-JV = *NO / *YES(...)
Defines whether the exported files and job variables are to be deleted after being written to the export volumes.
DELETE-FILES-AND-JV = *YES(...)
The exported files and job variables are deleted.
Exception
Files and job variables of the SYSHSMS ID are excluded from deletion.
Deletion can be restricted by specifying which file and job variable protection attributes are to be respected:
PROTECTION-RESPECTED = *ALL
Deletion is to be restricted to files and job variables without password protection, with write access and whose retention period has expired.
PROTECTION-RESPECTED = *PASSWORDS
Deletion is to be restricted to files and job variables without password protection.
PROTECTION-RESPECTED = *NONE
This operand value is only available to the HSMS administrator.
All files and job variables are to be deleted, irrespective of their protection attributes.
SAVE-SAM-STRUCTURE = *YES/*NO
Determines whether the structure of SAM-Node files is to be saved.
SAM node files that have been saved without SAM structure can only be restored as a SAM node file again.
SAM node files that have been saved with SAM structure can be restored either as FILE-TYPE=*BS2000 (on public space or Net-Storage) or FILE-TYPE=*NODE-FILE.
PASSWORDS = *NONE / *SECRET-PROMPT / list-poss(63): <c-string 1..4> / <x-string 1..8> /
<integer -2147483648..2147483647>
If the files or job variables to be exported are protected by a password, the passwords must be specified here.
The PASSWORDS operand has the following special characteristics:
The password entered is not logged.
The input field is automatically blanked out in an interactive dialog.
In unguided dialog and foreground procedures, the entry *SECRET or ^ permits concealed input of the password.
DIRECTORY-NAME =
Determines whether a directory is used for the export run.
DIRECTORY-NAME = *NONE
A directory is not used for the export run.
DIRECTORY-NAME = <filename 1..54 without-gen-vers>(...)
The specified directory is used for the export run. The nonprivileged caller must be owner or co-owner of this directory.
If the name of an SM directory is specified or if the name refers to a directory belonging to a version backup archive, the request is rejected.
NEW-DIRECTORY = *NO / *YES
Determines whether or not the specified directory is created.
SAVE-DIRECTORY = *NO / *YES
Determines whether or not the directory is written to the export volume as the last file in the export run.
SAVE-FILE =
Defines the save file to which the exported files are to be written.
SAVE-FILE = *NEW(...)
The exported files are to be written to a new save file. The following attributes for this save file can be defined here:
RETENTION-PERIOD = 0 / <integer 0..16383 days>
Physical retention period in days. During this period, neither the save file nor the save volume may be modified or deleted.
USER-ACCESS = *ALL-USERS
The save file is created as a shareable file. The data can be imported under a different user ID.
USER-ACCESS = *OWNER-ONLY
The save file is created as a non-shareable file. The data can be imported only under the same user ID.
SAVE-FILE-PASSWORD = *NONE / *SECRET-PROMPT / <c-string 1..4> / <x-string 1..8> /
<integer -2147483648..2147483647>
The save file to be created can be assigned a password which must be entered when the file is continued or imported.
The SAVE-FILE-PASSWORD operand has the following special characteristics:
The password entered is not logged.
The input field is automatically blanked out in an interactive dialog.
In unguided dialog and foreground procedures, the entry *SECRET or ^ permits concealed input of the password.
SAVE-FILE = *CONTINUE(...)
The save file, which can subsequently be defined in greater detail, is continued.Continuation is subject to the same restrictions as the CONTINUE operand of the EXPORT statement in the software product ARCHIVE (see the EXPORT statement in the “ARCHIVE” manual [2]). A save file can not be continued if the operand of the save option SAVE-SAM-STRUCTURE was modified compared to the previous run that is to be continued.
SAVE-FILE-ID = *NOT-SPECIFIED
The save file to be continued is not defined by the SFID but rather by the volume on which it resides.
SAVE-FILE-ID = *LATEST
Only if a directory is used:
the most recently created save file is continued.
SAVE-FILE-ID = <composed-name 15..15>
The specified save file is continued. The save file ID must be specified in the following format: S.yymmdd.hhmmss
VOLUMES = *NOT-SPECIFIED
Only if a directory is used:
the volume is taken from the directory.
VOLUMES = list-poss(16): <vsn 1..6>
The most recently written volume is specified.
When creating the save file, a separate volume can be specified for each parallel run.
COMPRESS-FILES = *NO / *YES
Determines whether or not data is compressed before being written to the output volume.
TO-STORAGE =
Specifies the destination to which the files are to be exported.
TO-STORAGE = *TAPE(...)
The files are exported to tape. The volumes can be defined in greater detail; if two or more volumes are specified, they all must be of the same device type.
VOLUMES = *FROM-POOL
Only if a directory is used:
the volumes are taken from the volume pool of the specified archive or the associated MAREN pool.
VOLUMES = *FROM-OPERATOR
The volumes are to be allocated by the operator on request.
VOLUMES = list-poss(100): <vsn 1..6>
List of volume serial numbers, which will be requested in the specified order.
DEVICE-TYPE = *STD / <device>
Device type of the requested volumes. The device type must belong to the class “TAPE”. Only device types known in the system are accepted. In interactive mode, DEVICE-TYPE=? calls up a list of the available device types.
The default is the value set by the S2-DEVICE-TYPE operand of the HSMS statement MODIFY-HSMS-PARAMETERS.
LOCATION = *ANY / <alphanum-name 1..8>
Location used for requesting volumes. This location must be known to MAREN. If the location manager is in use, the location should be properly defined in MARENLM. Otherwise MAREN ignores the specified value.
If MAREN is not in use, you must specify the value *ANY for LOCATION.
LOCATION = *ANY
No location is used.
TO-STORAGE = *PUBLIC-DISK(...)
This operand value is only available to the HSMS administrator.
The save file is to be exported to a pubset.
PUBSET-ID = <cat-id>
Catalog ID of the pubset.
TO-STORAGE = *NET-STORAGE(...)
The save file is to be exported to a Net-Storage.
VOLUMES = list-poss(16): <vsn 1..6>
Specifies the Net-Storage volume to which the files are to be copied. The volume specified must be accessible.
More than one Net-Storage volume can also be specified in a list (e.g. when there is more than one save task).
OPERATION-CONTROL =
Allows you to define parameters for the execution of the export run.
OPERATION-CONTROL = *STD
The default values of the operands described below apply.
OPERATION-CONTROL = *PARAMETERS(...)
The following operands which control the export run can be modified:
REQUEST-NAME = *STD / <name 1..8>
Request name that can be used in the HSMS request management statements (DELETE-REQUESTS, RESTART-REQUESTS and SHOW-REQUESTS) to refer to this request. The name is extended internally by a prefix derived from the user ID (or SYSHSMS for the HSMS administrator) and a suffix in the form of a time stamp. Unless otherwise specified, the request name is formed by the short code “EXF#” and the TSN of the calling user task yyyy as follows: EXF#yyyy.
REQUEST-DESCRIPTOR = *NONE / <text 1..60>
It is possible to enter any text that describes the request in more detail.
This text is displayed at the operator console when the request is started. The text can be output using the HSMS statement SHOW-REQUESTS.
EXPRESS-REQUEST = *NO / *YES
This operand is only available to the HSMS administrator.
Determines whether tape access is to take place during the sessions defined for express requests.
CONTROL-JV = *NONE / <filename 1..54 without-gen-vers>
Specifies the name of a job variable that HSMS supplies with various values corresponding to important actions performed by HSMS/ARCHIVE.
The nonprivileged caller must be owner or co-owner of this job variable. The user issuing the request can query the job variable to obtain an overview of the current processing status. How to use the job variable is described in the “HSMS Vol. 1” manual [1] in the section “Job variable for request monitoring”.
WAIT-FOR-COMPLETION = *NO / *YES
Specifies whether the user wishes to wait until processing of his or her request has been completed (synchronous processing) or whether control is to be returned to the user after the validity of the statement has been checked (asynchronous processing). The maximum wait times for batch tasks and interactive tasks are different and are determined by preset global HSMS parameters.
Interactive tasks are permitted to carry out synchronous statement processing during tape sessions only.
CATALOG-ID-MODE = *YES / *NO
Determines whether the data is written to the save file with or without a catalog ID (corresponds to the CATID operand in ARCHIVE).
PARALLEL-RUNS = 1 / <integer 1..16>
Number of simultaneously active backup tasks (ARCHIVE subtasks).
For backups, a tape device must be available for each task.
Unless otherwise specified, only one save task is running.
For further information on parallel processing see the “HSMS Vol. 1” manual [1].
WRITE-CHECKPOINTS = *YES / *NO
Defines whether any checkpoints are to be written to the ARCHIVE checkpoint file during processing; these checkpoints permit a request to be restarted following an interruption (state INTERRUPTED).
TAPE-CONTROL =
Defines the parameters which are relevant for export to tape.
TAPE-CONTROL = *STD
The default values of the operands described below apply.
TAPE-CONTROL = *PARAMETERS(...)
The operands relevant for export to tape can be modified as follows:
BLOCKING-FACTOR = *STD / <integer 2..15 2Kbyte> / *MAX
Blocking factor to be used for writing the save file to tape, specified as the number of 2-Kbyte blocks (PAM pages) written to tape in a single input/output operation. As the higher blocking factor means that the occupancy level of the volume and the tape processing performance improve, values below 15 should not be selected.When the default value *STD is selected, the default values of the ARCHIVE parameters apply (BLOCK-SIZE-TAPE for tapes, BLOCK-SIZE-T-C for magnetic tape cartridges).
*MAX selects the maximum blocking factor possible in the current BS2000 version. Currently this is the value 128.
UNLOAD-TAPE = *NO / *YES
Specifies whether or not tapes are to be unloaded after processing.
PERFORMANCE-ANALYSIS =
Specifies whether a statistics file is to be produced for each ARCHIVE subtask. ARCHIVE writes a new line to this statistics file:
when it opens a save file ARCHIVE.SAVE.FILE.
when it closes this save file.
whenever it begins saving or restoring a new file.
every 2 seconds while it is saving/restoring.
This gives a detailed overview of the ARCHIVE activities taking place during the save and restore operations.
PERFORMANCE-ANALYSIS = *NO
No statistics file is to be produced.
PERFORMANCE-ANALYSIS = *YES(...)
A statistics file is to be produced for each ARCHIVE subtask.
SEPARATOR = ; / <c-string 1..1>
Character that is inserted between the different fields in the statistics files. This enables programs such as EXCEL or LOTUS to differentiate the different fields.The default value is “ ; ”. This corresponds to the EXCEL default setting.
REPORT =
Determines whether a report is to be output for this export request and to determine the scope of this report.
REPORT = *SUMMARY
A summary of the results of the export request, including any error messages, is to be output.
REPORT = *FULL
A full report is to be output, including a list of all exported files.
REPORT = *NONE
No report is to be output.
OUTPUT =
Specifies where the report is to be output.
OUTPUT = *STD
The output destination of the report is determined by the default value that is defined by the global HSMS parameter OUTPUT.
OUTPUT = *PRINTER
The report for this export request is to be printed.
OUTPUT = *NONE
No report is output. Nevertheless the report is available as a pdf file via the SE manager application Backup Monitoring, if the monitoring is activated in the global HSMS parameters.
OUTPUT = *MAIL
The report for this export request is sent as an email attachment to the address which is entered in the caller’s user entry. If it is not possible to send the report by email, it is printed out.
OUTPUT = *LIBRARY-ELEMENT(...)
The report for this export request is edited and output to the specified PLAM library element (type P). If this is not possible, the report is printed out.
LIBRARY = <filename 1..54 without-gen-vers>
Name of the PLAM library.
ELEMENT = <composed-name 1..64 with-under>
Name of the element. A type P element is created with a version which contains the user ID plus the date and time.
OUTPUT = <filename 1..54 without-gen-vers>
The report for this export request is to be prepared for printing and written to the specified file.
If the file already exists, the following applies:
if it is a non-empty SAM file, it is continued
if not, the report is printed.
For nonprivileged callers the report files must be under the user’s own user ID. If not, co-ownership is a prerequisite.
Example
A nonprivileged user exports files using mainly default values, but specifies the volume; his TSN is 1234
//EXPORT-FILES FILE-NAMES=*OWN, - // TO-STOR=*TAPE(VOLUMES=tape01,DEVICE-TYPE='TAPEU4')
All files under his user ID are exported from all imported pubsets; job variables are not exported.
The data is written to tape, using the MTC with VSN 'TAPE01'.
The files are not deleted after export.
The request is given the name EXF#1234.
The retention period is 0 days.
The request is processed asynchronously.
Depending on the global HSMS parameter OUTPUT a summary report is printed or sent as an email attachment.