This statement is the counterpart of EXPORT-FILES. It is used for importing files and job variables from an EXPORT backup to a BS2000 system.
Files and job variables can on the one hand be transferred from exported backup volumes and renamed using the SINGLE-SVID structure. On the other hand, files and job variables can be transferred from exported backup volumes and renamed using the SEVERAL-SVID structure if the SVIDs are known and are specified as values under the SAVE-FILE-ID suboperand.
A directory created during the export run can be used but must be imported in a separate import run.
A directory which was saved to the save file with SAVE-DIRECTORY=*YES (with BACKUP-, ARCHIVE- or EXPORT-FILES) can be restored from the relevant volume or pubset with IMPORT-FILES with FILE-NAMES=*DIRECTORY.
IMPORT-FILES requests are entered in the HSMS global request file. In order to be able to output IMPORT-FILES jobs, users with an SM pubset as their default pubset must specify SHOW-REQUESTS ENVIRONMENT=*SINGLE-FEATURE.
This statement has different formats for nonprivileged users and HSMS administrators. Privileged operands or operand values are marked with *P).
Format
IMPORT-FILES | Alias: IMF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
*P) Privileged operand or operand value
FILE-NAMES =
Specifies the files to be imported. Specification of this operand is mandatory. The user can further restrict the selection made here by means of the operands EXCEPT-FILE-NAMES and ORIGINAL-SUPPORT (restricted to the HSMS administrator).
A file cannot be imported unless the pubset to which it is to be imported is available and the user ID involved has a JOIN entry for this pubset. Otherwise, the user ID must be renamed via NEW-FILE-NAMES.
When a user ID is missing on the available pubset, it is automatically entered in the pubset’s user catalog, and the files can thus be created. A message indicates that a new user ID has been created.
FILE-NAMES = *OWN
All files under the user’s own ID in the save file are imported.
FILE-NAMES = *ALL
All files in the save file are imported.
For nonprivileged users *ALL has the same effect as *OWN.
FILE-NAMES = *DIRECTORY
The directory that was saved on the specified volume with SAVE-DIRECTORY=*YES is restored under the same name. In the event of multiple backups the last directory saved is imported.
FILE-NAMES = *NONE
No files are imported.
FILE-NAMES = *SELECTED
The path names of the files to be imported 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 imported 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 imported 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 imported 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. The wildcards are replaced in accordance with the file names listed in the save file.
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 imported.
EXCEPT-FILE-NAMES =
Serves to specify files that are to be excluded from import.
EXCEPT-FILE-NAMES = *NONE
All files specified with the FILE-NAMES operand are to be imported.
EXCEPT-FILE-NAMES = *FROM-FILE(...)
The path names of the files to be excluded from import are to be taken from a file. The nonprivileged caller must be owner or co-owner of this file. Only upper-case characters may be used. This list file must be a SAM file with variable-length records containing one path name per record. 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 imported 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 import 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. Wildcards are replaced using the file names contained in the directory file.
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 import.
NEW-FILE-NAMES =
The files can be renamed before being imported. The user must ensure that the new path name conforms to the BS2000 conventions governing names. The total length must not exceed 54 characters; this implies that 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>.<prefix>.old-filename-without-cat-user.<suffix>
NEW-FILE-NAMES = *SAME
The files are to be restored 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 imported under a different catalog ID. The catalog ID must be specified without a colon. The user ID must have a JOIN entry for this catalog.
Unless otherwise specified, the files are imported under their original catalog ID.
NEW-USER-ID = *SAME / <name 1..8>
The files may be imported under a different user ID. The user ID must be specified without a leading “ $ ” character.
Unless otherwise specified, the files are imported under their original user ID.
PREFIX = *NONE / <name 1..8>
A prefix of up to 8 characters may be added to the file name and is automatically separated from the file name by a period (partial qualification). The prefix must not contain any letters 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 and is automatically separated from the file name by a period (partial qualification). The suffix must not contain any letters that are prohibited for file names.
Unless otherwise specified, no suffix is added to the file names.
ORIGINAL-SUPPORT =
The files to be imported can be selected according to the type of volume (public disk, private disk or tape) on which they resided before they were exported.
ORIGINAL-SUPPORT = *ANY
The type of volume from which the files originate is not a selection criterion.
ORIGINAL-SUPPORT = *PUBLIC-DISK(...)
Only files originating from from the disks of a pubset or of an assigned Net-Storage volume are imported.
STORAGE-TYPE =
Selects the storage type for the public volume from which the files originate.
STORAGE-TYPE = *ANY
The files are imported irrespective of the storage type. They can come from the disks of a pubset or a Net-Storage volume.
STORAGE-TYPE = *PUBLIC-SPACE
Only files which come from the disks of a pubset are imported. Files from a Net-Storage volume are ignored.
STORAGE-TYPE = *NET-STORAGE(...)
Only files which come from a Net-Storage are imported.
VOLUME = *ALL / list-poss(150): <vsn 1..6>
Specifies the VSN of one or more Net-Storage volumes from which the files are imported. *ALL selects all Net-Storage volumes.
FILE-TYPE =
Selects the file type of Net-Storage files that will be imported.
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.
ORIGINAL-SUPPORT = *PRIVATE-DISK(...)
Only files originating from private disks can be imported.
VOLUMES = list-poss(150): <vsn 1..6>
Volume serial numbers of the private disks.
NEW-SUPPORT =
Defines the volumes to which the files to be imported are to be written.
NEW-SUPPORT = *PUBLIC-DISK(...)
The files are written to the disks of the pubset concerned or to assigned Net-Storage volumes. Net-Storage volumes of type NETVOL can be used only on BS2000 V21.0A or higher.
STORAGE-TYPE =
Selects the storage type for public volumes.
STORAGE-TYPE = *STD
The files originally stored on public disk are restored to the original storage medium, files originally stored on private disk are restored on public volumes. Net-Storage files originally stored on volume of NETVOL type can be restored only on BS2000 V21.0A or higher.
STORAGE-TYPE = *PUBLIC-SPACE
The files are only written to disks of the pubset concerned.
STORAGE-TYPE = *NET-STORAGE(...)
The files are only written to the Net-Storage which is assigned to the pubset concerned.
Irrespectively of the specification, the files under system users (SERVICE, SYSAUDIT, SYSDUMP, SYSGEN, SYSHSMS, SYSMAREN, SYSNAC, SYSOPR, SYSPRIV, SYSROOT, SYSSNAP, SYSSNS, SYSSOPT, SYSSPOOL, SYSUSER) are imported on disks of the pubset concerned.
VOLUME = <vsn 1..6>
Specifies the VSN of the Net-Storage volume to which the files are written. Net-Storage volumes of type NETVOL can be used only on BS2000 V21.0A or higher.
FILE-TYPE =
Specifies the type in which files will be restored to Net-Storage.
FILE-TYPE = *STD
The files are restored with their original type.
FILE-TYPE = *BS2000
The files are restored with the type BS2000.
FILE-TYPE = *NODE-FILE
The files are restored with the type node file.
NEW-SUPPORT = *PRIVATE-DISK(...)
The files are to be written to private disks. All disks must be of the same device type.
VOLUMES = list-poss(150): <vsn 1..6>
Volume serial numbers of the private disks.
DEVICE-TYPE = STDDISK / <device>
Device type of the private disks. The default setting STDDISK selects the default device type. Only device types known in the system are accepted. In interactive mode, DEVICE-TYPE=? calls up a list of the available device types.
JV-NAMES =
Specifies the job variables to be imported.
A job variable cannot be imported unless the pubset to which it is to be imported is available and the user ID involved has a JOIN entry for this pubset. If this is not the case, the user ID must be renamed (see the NEW-JV-NAMES operand).
The nonprivileged caller can restore job variables on foreign IDs provided write access rights and co-ownership are given.
JV-NAMES = *NONE
No job variables are to be imported.
JV-NAMES = *OWN
All job variables of the user’s own ID in the save file to be imported.
JV-NAMES = *ALL
All job variables in the save file are to be imported.
However, unless imported by the HSMS administrator, job variables under other user IDs must be renamed to the user’s own ID (see the NEW-JV-NAMES operand).
JV-NAMES = *SELECTED
The path names of the job variables to be imported are taken from a list that is created in the same HSMS run with the HSMS statement SELECT-JV-NAMES.
JV-NAMES = *FROM-FILE(...)
The path names of the job variables to be restored 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 imported 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-gen-vers-with-wild> / <partial-filename 2..79 with-wild>
The path names of the job variables to be imported are specified directly. A list of up to 20 names may be specified.
The job variables can alternatively be selected using wildcards. Note, however, that only the HSMS administrator may use wildcards for user ID specification.
The wildcards are replaced in accordance with the job variable names listed in the save file.
EXCEPT-JV-NAMES =
Serves to specify job variables that are to be excluded from import.
EXCEPT-JV-NAMES = *NONE
All job variable specified in the JV-NAMES operand are imported.
EXCEPT-JV-NAMES = *FROM-FILE(...)
The path names of the job variables to be excluded from import 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 imported 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 import 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. Wildcards are replaced using the job variable names contained in the save file.
NEW-JV-NAMES = *SAME / *BY-RULE(...)
If the NEW-USER-ID operand and the LOGON use ID are the same, all users can specify a user ID which differs from that of the save run.
The job variables can be renamed with NEW-JV-NAMES=*BY-RULE(...) before being imported. The suboperands and options available are the same as for files (see NEW-FILE-NAMES=*BY-RULE(...)).
PASSWORDS = *NONE / *SECRET-PROMPT / list-poss(63): <c-string 1..4> / <x-string 1..8> /
<integer -2147483648..2147483647>
If files or job variables to be imported are protected by a read password, or if the save file was assigned a password, the passwords must be specified here. The HSMS administrator does not need to specify a password.
If a directory file is used and it is protected by passwords, all users must specify the read password and the write password.
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.
RELEASE-UNUSED-SPACE = *YES / *NO
Determines whether or not unused storage space (difference between the last-page pointer and the file size) is to be released after files are imported.
FILE-CONVERSION =
Determines whether files whose PAM key format is different from that of the output volume are to be converted when imported. This operand is ignored for job variables.
If *STD or *CONV-FORMAT is specified, PAMINT is called internally.
If a converted file to be imported already exists, it is always reorganized and RELEASE-UNUSED-SPACE is ignored.
FILE-CONVERSION = *STD
During an import run to an NK disk, files with a PAM key are converted by PAMINT according to the following rules:
K-ISAM files to NK-ISAM files
(BLOCK-CONTROL-INFO=*WITHIN-DATA-BLOCK)K-SAM files to NK-SAM files
(BLOCK-CONTROL-INFO=*WITHIN-DATA-BLOCK)K-UPAM files to NK-UPAM files
(BLOCK-CONTROL-INFO=*NO)
PAM files whose structure is known (load modules, libraries) are converted accordingly; if the structure of PAM files is unknown, the PAM key information is lost. A message is displayed if the PAM key contained information.
FILE-CONVERSION = *NO
Files with a PAM key are not converted when imported to an NK disk, which means they are not imported.
FILE-CONVERSION = *CONV-FORMAT
During an import run to an NK disk, files with a PAM key are converted by PAMINT to “CONV format”. The imported file contains all PAM keys at the end of the file in separate blocks.
REPLACE-FILES-AND-JV = *NO / *YES(...)
Determines whether already existing files and job variables are to be overwritten when the file is imported.
REPLACE-FILES-AND-JV = *YES(...)
Existing files and job variables are to be overwritten. In addition, the user can specify if and to what extent the file protection attributes, if any, are to be respected:
PROTECTION-RESPECTED = *ALL
Restricts overwriting to files and job variables that are not protected by a password, that permit write access, and whose retention period has expired.
PROTECTION-RESPECTED = *PASSWORDS
Restricts overwriting to files and job variables that are not protected by a password.
PROTECTION-RESPECTED = *NONE
This operand value is only available to the HSMS administrator.
All files and job variables are to be overwritten, irrespective of their protection attributes.
REORGANIZE-SPACE = *YES / *NO
Determines whether the existing files are to be erased before the import operation or whether the file is to continue to occupy the same extents on the disk. The operand is evaluated with existing files only.
SAVE-FILE =
Defines the save file from which the files to be imported are to be retrieved.
Although the operand is called “SAVE-FILE”, when working in a SEVERAL-SVID environment “SAVE-FILE” actually refers to a save version.
SAVE-FILE = *BY-VOLUME(...)
The save file or save version from which the files are to be imported is defined by the volume on which they reside.
SAVE-FILE-ID = *NOT-SPECIFIED
The save files on the specified volumes are selected irrespective of their save file ID.
SAVE-FILE-ID = <composed-name 15..15>
The files are imported either from the specified save file using the SINGLE-SVID structure or from the specified save version in a SEVERAL-SVID environment.The save file ID must be specified in the following format: S.yymmdd.hhmmss
VOLUMES = list-poss(100): <vsn 1..6>
Volume serial number of the volumes containing the save files with the files to be imported.
If a directory is to be imported with FILE-NAME=*DIRECTORY, the VSN of the volume on which the directory was saved must be specified (this is noted as the save tape in the report on the save or archive run).
VOLUMES = list-poss(16): *GROUPED-BY-RUN(...)
Only for importing in more than one parallel run:
a separate *GROUPED-BY-RUN specification must be made for each parallel run. Up to 16 entries can be made.
VOLUMES = list-poss(100): <vsn 1..6>
Volume serial number of the volumes in the individual parallel runs.
DEVICE-TYPE = *STD / <device>
Device type of the backup volumes. 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 value is the value defined with the S2-DEVICE-TYPE operand of the MODIFY-HSMS-PARAMETERS statement.
SAVE-FILE = *FROM-DIRECTORY(...)
The save file from which the files are to be imported is selected from a directory.
DIRECTORY-NAME = <filename 1..54 without-gen-vers>
Directory written to the volume during the export run and previously imported in a separate run. The nonprivileged caller must be owner or co-owner of this directory.
SAVE-FILE-ID = *LATEST
The data is imported from the last save file in the specified directory. *LATEST makes sense only for SINGLE-SVID save structure.
SAVE-FILE-ID = <composed-name 15..15>
The data is either imported from the specified save file with SINGLE-SVID structure or from the specified save version in a SEVERAL-SVID environment. The save file ID must be specified in the following format: S.yymmdd.hhmmss
DEVICE-TYPE = *STD / <device>
Device type of the volume on which the save version resides. This must be specified only if the save version was created in an ARCHIVE version < V2.6B. In higher ARCHIVE versions, the device type used for backup is indicated in the directory. 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 value is the value defined with the S2-DEVICE-TYPE operand of the MODIFY-HSMS-PARAMETERS statement.
SAVE-FILE = *BY-VOLUME-CATALOG(...)
MAREN as of V12.0 is required to use this operand.
The associated volumes for a save file which is named exactly are ascertained by MAREN.
SAVE-FILE-ID = <composed-name 15..15>
The files are only imported from the save file specified. The save file ID must be specified as follows: S.yymmdd.hhmmss
SAVE-FILE = *BY-PUBLIC-DISK(...)
Restores the files/job variables from a save file. The save file is defined by the pubset on which it resides.
SAVE-FILE-ID = <composed-name 15..15>
The files/job variables are imported from the specified save file. The save file ID must be specified in the following format: S.yymmdd.hhmmss
PUBSET-ID = <cat-id 1..4>
Specifies the catid of the pubset where the save file is located.
DATE-AND-PROTECTION = *STD-ATTRIBUTES / *ORIGINAL-ATTRIBUTES
Specifies how the date and protection attributes of files and JVs are set.
DATE-AND-PROTECTION = *STD-ATTRIBUTES
The following default values are set for date and protection attributes:
Date/Protection attribute | Existing file/JV is overwritten | |
Yes | No | |
Password protection | As for saved file/JV | As for saved file/JV |
USER-ACCESS | As for original on disk | *OWNER-ONLY |
ACCESS | As for original on disk | *WRITE |
BASIC-ACL, GUARDS | As for original on disk | *NONE |
CREATION-DATE, EXPIRATION-DATE, LAST-ACCESS-DATE | Current date | Current date |
DATE-AND-PROTECTION = *ORIGINAL-ATTRIBUTES
The date and protection attributes and taken from the saved catalog entries.
OPERATION-CONTROL =
Enables the user to define a number of parameters which are relevant for the execution of the import run.
OPERATION-CONTROL = *STD
The default values described for the operand apply to the following parameters.
OPERATION-CONTROL = *PARAMETERS(...)
The following parameters controlling the import 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 administration) and a suffix in the form of a time stamp.
Unless otherwise specified, the request name is formed by the short code “IMF#” and the TSN of the calling user task yyyy as follows: IMF#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 detail 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 HSMS statement has been checked (asynchronous processing).The maximum wait times for batch tasks and interactive tasks are different and are determined by global HSMS parameters.
Interactive tasks are permitted to carry out synchronous HSMS statement processing during tape sessions only.
CATALOG-ID-MODE = *YES / *NO
Determines whether or not the data in the save file has a catalog ID (corresponds to the CATID operand in ARCHIVE). Operand specification is the same as in the export run.
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 interrupt (INTERRUPTED state).
OPERATOR-INTERACTION = *NOT-ALLOWED / *ALLOWED
Determines whether messages requiring an operator response are to be output at the console (*ALLOWED) or not (*NOT-ALLOWED). If *NOT-ALLOWED applies, HSMS performs default handling (see the description of the PARAM statement in the “ARCHIVE” manual [2]).
TAPE-CONTROL =
Defines the parameters which are relevant for reading files from tape.
TAPE-CONTROL = *STD
The default values of the operands described below apply.
TAPE-CONTROL = *PARAMETERS(...)
You can modify the following operand for reading tapes:
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 =
Defines whether a report is to be output for this import request and to determine the scope of this report.
REPORT = *SUMMARY
A summary of the results of the import request, including any error messages, is to be output.
REPORT = *IMPORTED-FILES
A full report is to be output, including a list of all files actually restored.
REPORT = *FULL
A full report is to be output, including a list of all files which should have been imported but were not due to an error.
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 import 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 import 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 import 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 import 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 imports files using mainly default values and determines the save file by way of the volume; his TSN is 2345
//IMPORT-FILES FILE-NAMES=*OWN, - // SAVE-FILE=*BY-VOLUME(VOLUMES=tape01,DEVICE-TYPE='TAPE-U4')
All files under his user ID and located on the tape are imported. The files are not renamed.
The files are written to public volumes.
The data is imported from the save file residing on the magnetic tape cartridge with VSN 'TAPE01' .
The request is given the name IMF#2345.
The request is processed asynchronously.
Depending on the global HSMS parameter OUTPUT a summary report is printed or sent as an email attachment.