This statement archives files and job variables to a long-term archive. The files and job variables can be written to background level S2 or S1, to public discs or to Net-Storage volumes and can be deleted from processing level S0 after archival.
The following can be set for ARCHIVE-FILES requests using archive attributes:
Saving of the metainformation of PLAM libraries
Implicit deletion of obsolete save files or save versions
Specification concerning tape usage (TAPE-CONTROL)
This statement has different formats for nonprivileged users and HSMS administrators. Privileged operands or operand values are marked with *P).
Format
ARCHIVE-FILES | Alias: ARF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
*P) Privileged operand or operand value
FILE-NAMES =
Serves to specify the files to be archived. Specification of this operand is mandatory. The user can select individual files from the set of files specified here by means of the operands EXCEPT-FILE-NAMES and DIALOG-FILE-SELECT.
The files to be archived are not restricted to a specific environment.
If files from more than one pubset are specified and are to be saved to a default system archive, then the same default system archive must be assigned to all these pubsets. Otherwise, the HSMS statement will be rejected. To prevent this you should only specify files from one pubset for each archival request.
All nonprivileged users can also archive files belonging to other user IDs if they are co-owners of these files.
When PLAM libraries are archived the archive attribute SAVE-PLAM-INFO (see the operand of the same name in the CREATE-ARCHIVE statement in "CREATE-ARCHIVE Create archive" chapter) controls whether the information about the element structure is also saved. Only if this information is also saved can individual library elements be restored from the long-term archive. Otherwise a PLAM library can only be restored as a complete library file. For collector requests the archive attribute SAVE-PLAM-INFO is evaluated for the first request.
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 to be archived.
FILE-NAMES = *ALL
All files residing on any imported pubset (except for shared SF pubsets for which the home computer is the slave) are to be archived.
Specified by any other user, this has the same effect as *OWN.
FILE-NAMES = *NONE
No files are to be archived.
FILE-NAMES = *SELECTED
The path names of the files to be archived 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 archived 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 DMS 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 archived 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 archived 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.
You can also use wildcard syntax to select the files.
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 archived.
If the files of a shared pubset imported in slave mode are specified, no other pubset of a different master may be specified.
EXCEPT-FILE-NAMES =
Serves to specify files that are to be excluded from archival.
EXCEPT-FILE-NAMES = *NONE
All files specified with the FILE-NAMES operand are to be archived.
EXCEPT-FILE-NAMES = *FROM-FILE(...)
The path names of the files to be excluded from archival 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 DMS 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 archived 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 archival 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.
You can also use wildcard syntax to select the files.
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 archival.
ENVIRONMENT =
HSMS environment in which the statement is to be processed.
ENVIRONMENT = *STD
For privileged users: *STD is set to the value *SINGLE-FEATURE.
For nonprivileged users: *STD is the environment that is associated with the user’s default pubset (the default pubset is defined in the user catalog).
ENVIRONMENT = *SINGLE-FEATURE
The statement is valid in the SF environment.
Exception: A long-term archive and its directory which have been defined in an SF environment can be used globally both for SF and SM pubsets.
In all statements which are issued for a long-term archive the same HSMS environment must be specified as in the definition of the archive.
ENVIRONMENT = *SYSTEM-MANAGED(...)
The statement is valid in the specified SM pubset environment.
CATALOG-ID = <cat-id>
Catalog ID of the SM pubset for which the statement is valid.
SELECT-FILES =
This operand is only available to the HSMS administrator.
Indicates whether all files specified in the FILE-NAMES operand are to be archived.
SELECT-FILES = *ALL-FILES
All the files specified in the FILE-NAMES operand are archived.
SELECT-FILES =*MIGRATED-FILES(...)
Only migrated files are archived.
MIGRATED-BEFORE = <date with-compl> / *LATEST-DATE / <integer -99999..0 days >
Only those files which were migrated prior to or on the date specified for S0 are archived.
SAVE-DIRECTORY = *NO / *YES(...)
Determines whether the archive directory used for this run is written to the backup volume as the last file in the run.
JV-NAMES =
You can specify the job variables that are to be archived.
All non-privileged users can also archive job variables which belong to other user IDs as long as they are the co-owner of these job variables.
JV-NAMES = *NONE
No job variables are archived.
JV-NAMES = *OWN
All job variables of your own user ID on all imported pubsets (except for shared SF pubsets for which the home computer is the slave) are archived.
JV-NAMES = *ALL
All job variables of the specified environment of all imported pubsets (except for shared SF pubsets for which the home computer is the slave) are archived.
JV-NAMES = *SELECTED
The path names of the job variables that are to be archived are taken from a list. This list is created in the same HSMS run using the HSMS statement SELECT-JV-NAMES.
JV-NAMES = *FROM-FILE(...)
The path names of the job variables that are to be archived are taken from a file. The nonprivileged caller must be owner or co-owner of this file. This file must be a SAM file with variable record lengths which contains a single path name per record. Only upper-case characters may be used.
The job variables to be processed must be available in the environment specified.
LIST-FILE-NAME = <filename 1..54 without-gen-vers>
Path name of the file.
JV-NAMES = *FROM-LIBRARY-ELEMENT(...)
The path names of the job variables which are to be archived 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 name of the job variables that are to be archived are entered directly. You can enter a list containing a maximum of 20 names.
The job variables to be processed must be available in the specified environment. You can enter job variables using the wildcard syntax. When processing shared pubsets the resolution of the wildcard syntax using catalog IDs does not refer to SF pubsets for which the home computer is the slave.
If you specify job variables of an imported shared pubset that is in slave mode, you cannot specify a pubset belonging to a different master.
EXCEPT-JV-NAMES =
Specifies job variables that are not to be archived.
EXCEPT-JV-NAMES = *NONE
All job variables that are specified in the JV-NAMES operand are archived.
EXCEPT-JV-NAMES = *FROM-FILE(...)
The path names of the job variables that are not to be archived are taken from a file. The nonprivileged caller must be owner or co-owner of this file. This file must be a SAM file with variable record lengths which contains a single path name per record. Only upper-case characters may be used.
LIST-FILE-NAME = <filename 1..54 without-gen-vers>
Path name of the file.
EXEPT-JV-NAMES = *FROM-LIBRARY-ELEMENT(...)
The path names of the job variables which are not to be archived 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-gen-vers with-wild> /
<partial-filename 2..79 with-wild>
The job variables’ pathnames, which are not to be archived, are to be entered directly. You can enter up to 20 names in one list.
You can also select the job variables using wildcard syntax. When processing shared pubsets the resolution of the wildcard syntax using catalog IDs does not refer to SF pubsets for which the home computer is the slave.
DELETE-FILES-AND-JV = *NO / *YES(...)
Defines whether the archived files and job variables are to be deleted from the processing level after archival.
In the case of automatic duplication to a shadow archive, the files and job variables are not deleted until the duplication is completed.
DELETE-FILES-AND-JV = *YES(...)
The archived files and JV are to be deleted from S0. Files and job variables are excluded from deletion. Deletion can be restricted by specifying which file 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.
ARCHIVE-NAME = *SYSARCHIVE / <filename 1..22 without-cat-gen-vers>
Name of the archive in the central HSMS parameters to which the files are to be saved. The specified archive must already exist and be available for use as a long-term archive.
If the archive directory is protected by a password, this password must be entered by means of the ADD-PASSWORD command prior to statement entry. This also applies to the HSMS administrator.
To enable the nonprivileged user to use another user’s archive, either the archive must contain write access for foreign users (USER-ACCESS=*ALL-USERS and ACCESS=*WRITE) or he/she must be a co-owner of the directory of the archive. This does not apply to access by the HSMS administrator.
ARCHIVE-NAME = *SYSARCHIVE
The files and job variables are to be saved to the default long-term system archive (SYSARCHIVE).
SAVE-FILE =
Defines the save file to which the archived files are to be written.
SAVE-FILE = *STD
A standard save file is to be created or continued. The (physical) retention period valid for the save file is defined in the archive definition.
A standard save file is created only during archivals to S2 storage level. If the TO-STORAGE operand has another value than *S2-STORAGE-LEVEL, a new save file will be created on the specified storage. If a standard save file is created in periods according to the archive attributes, in succeeding runs with TO-STORAGE=*S2-STORAGE-LEVEL the existing standard save file will be continued.
SAVE-FILE = *NEW(...)
The user’s archived files and job variables are to be written to a new save file. A retention period for this save file can be defined here.
RETENTION-PERIOD = *STD / <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. Unless otherwise specified, the preset value from the archive definition applies.
SAVE-FILE = *CONTINUE(...)
The specified save file is to be continued. It must reside on storage level S2.
In the case of automatic duplication to a shadow archive, HSMS attempts to continue in the shadow archive the save file which has the same SFID as the original save file. If this save file does not exist, the save file will not be duplicated and any deletion of files and job variables that was requested (with DELETE-FILES_AND-JV=*YES) will not be carried out.
SAVE-FILE-ID = *LATEST
The most recently created save file for this archive is to be continued.
SAVE-FILE-ID = <composed-name 15..15>
The specified save file is to be continued. The save file ID must be specified as follows: S.yymmdd.hhmmss
SAVE-VERSION-NAME = *STD / <name 1..8>
Name of the save version generated by the archival request. This name can be used to refer to the save version for restore operations or in the HSMS statement SHOW-ARCHIVE. The name is extended internally by a prefix derived from the user ID (or, in the case of the HSMS administrator, by SYSHSMS). Any save version can be uniquely identified by its name and an internal time stamp.
Unless otherwise specified, the save version is given the name “ARCHIVAL”.
DESCRIPTOR = *NONE / <c-string 1..10>
Brief descriptive text of up to 10 characters which is output in the summary of save versions produced as a result of SHOW-ARCHIVE SELECT=*SAVE-VERSIONS,INFO=*SUMMARY.
Unless otherwise specified, no description is written.
USER-INFORMATION = *NONE / <c-string 1..720>
Comment of up to 720 characters with information about the save version, which is output as a result of SHOW-ARCHIVE SELECT=*SAVE-VERSIONS,INFO=*USER-INFORMATION. Unless otherwise specified, no comment is written.
FILE-EXPIRATION-DATE = *STD / <date with-compl> / <integer 0..99999 days >
File expiration date for the archived files. The specified date must not lie outside the (physical) retention period for the save files or save volumes unless this is permitted by the archive definition.
Unless otherwise specified, the file expiration date coincides with the end of the (physical) retention period defined for the save file or save volume.
If the specified file expiration date is lower than the expiration date of a file or a job variable to be archived, a warning message will be issued.
COMPRESS-FILES = *STD / *YES / *NO
Determines whether or not data is to be compressed before being written to the volume.Unless otherwise specified, the default value in the archive definition is used.
TO-STORAGE =
Defines the storage level at which the files and job variables are to be archived. Pubsets, Net-Storage and S1 storage level are permitted in addition to S2 storage level. Only save files on S2 storage level can be continued. In this case the same device type as for their creation must be used.
TO-STORAGE = *S2-STORAGE-LEVEL(...)
The files are to be archived to storage level S2 of the specified environment. The volumes to be used can be specified. If more than one volume is specified, all volumes must be of the same device type.
VOLUMES = *FROM-POOL
The volumes are to be taken from the volume pool of the specified archive, i.e. the pool of the archive directory or the associated MAREN pool.
VOLUMES = *FROM-OPERATOR
The volumes are to be allocated by the operator on request.
VOLUMES = list-poss(20): <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.
Unless otherwise specified, the preset value from the archive definition applies if a new save file is created (S2-DEVICE-TYPE). If an existing save file is continued, the device type specified when the save file was created is used.
LOCATION = *STD / *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 for LOCATION the value *ANY, or *STD if *ANY is the default location of the archive.
LOCATION = *STD
The default location of the archive is used.
LOCATION = *ANY
No location is to be used.
TO-STORAGE = *S1-STORAGE-LEVEL
This value applies in an SF pubset environment, as well as in an SM pubset environment. In an SF pubset environment, the files are stored on an S1 pubset. The same S1 pubset must be assigned to all pubsets from which files are stored.
In an SM pubset environment, the files are stored on the defined storage level S1 (S1 volume set). When an extended S1 level is defined for the SM pubset (S1-VOLUME-SET=*ALL-HSMS-CONTROLLED), TO-STORAGE=*S1-STORAGE-LEVEL is only accepted under the following circumstances:
SAVE-FILE-PROCESSING=*HSMS-V10-COMPATIBLE is set.
BS2000 OSD/BC V11.0 or higher is used on the system. In the case of a shared pubset network, all pubset sharers of the SM pubset must satisfy this requirement.
When SAVE-FILE-PROCESSING=*HSMS-V9-COMPATIBLE is set, saving to S1 level is possible only if a volume set is specified explicitly.
TO-STORAGE = *PUBLIC-DISK(...)
This operand value is only available to the HSMS administrator. This value is only valid in an SF pubset environment.
The files are archived to a pubset.
PUBSET-ID = <cat-id>
Catalog ID of the pubset.
TO-STORAGE = *NET-STORAGE(...)
The files are archived to Net-Storage.
VOLUMES = list-poss(16): <vsn 6..6>
Specifies the Net-Storage volume to which the files are archived. The specified volume 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).
DIALOG-FILE-SELECT =
Defines whether the user wishes to conduct a dialog in order to select individual files from the set of files selected for archival by means of FILE-NAMES.
The operand is evaluated in interactive mode only, for batch tasks it is ignored.
DIALOG-FILE-SELECT = *NO
The specified set of files is not to be further reduced.
DIALOG-FILE-SELECT = *YES
The specified set of files is to be displayed in a screen mask (see "Dialog selection of files"). The user can then mark individual files from the set on display, thus selecting them for or excluding them from archival.
Migrated files are included in the selection list displayed.
DIALOG-JV-SELECT =
Determines whether the set of job variables, which was selected by JV-NAMES to be archived should be restricted in the dialog. The operand is only evaluated in the dialog and is ignored in batch tasks.
DIALOG-JV-SELECT = *NO
The selected set of job variables is not restricted.
DIALOG-JV-SELECT = *YES
The selected set of job variables is shown on the screen (see "Dialog selection of job variables"). You can confirm or delete job variables by selecting them individually.
OPERATION-CONTROL =
Enables the user to define certain parameters which are relevant to the execution of the archival run.
OPERATION-CONTROL = *STD
The default values of the operands described below apply.
OPERATION-CONTROL = *PARAMETERS(...)
The parameters controlling the archival run can be modified as follows:
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, in the case of the HSMS administrator, by SYSHSMS) and a suffix in the form of a time stamp.
Unless otherwise specified, the request name is formed by the short code “ARF#” and the TSN of the calling user task yyyy as follows: ARF#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 during a complex processing operation, for example the processing of shadow archives.
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 preset global HSMS parameters.
Interactive tasks are permitted to carry out synchronous statement processing during tape sessions only.
SHADOW-COPY =
Specifies whether the save version is to be automatically duplicated to a shadow archive which may have been assigned.
SHADOW-COPY = *ALLOWED
If the relevant long-term archive has been assigned a shadow archive, the save version is automatically duplicated to this shadow archive after the archival run.
Whether a save file is updated in the shadow archive, a new one is created like in the main archive or a new one is always created is specified by the SHADOW-CONTROL archive attribute of the main archive.
SHADOW-COPY = *INHIBITED
The save version is not automatically duplicated to a shadow archive which may have been assigned.
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 =
Serves to define whether a report is to be output for this archival request and to determine the scope of this report.
REPORT = *SUMMARY
A summary of the results of the archival request, including any error messages, is to be output.
REPORT = *FULL
A full report is to be output, including a list of all archived 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 on this archival 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 archival 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 archival 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 archival request is be edited 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.
Screen mask(s)
Dialog selection of files
//ARCHIVE-FILES ...,DIALOG-FILE-SELECT=*YES
ARCHIVE-FILES : DIALOG-FILE-SELECT #FILES = @@@@@@@@@@ -------------------------------------------------------------------------------- M FILE-NAME UNUSED #PAGES ST BC _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@ @@@@@@@@@@ @@ @ -------------------------------------------------------------------------------- NEXT-PAGE : ____________ (+,-,++,--, E, 'STRING') MARK : __ (A: ALL, N: NONE) @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
Key:
Column | Values | Meaning |
M | Mark column (mark character = file is selected, | |
FILE-NAME | Path name of the file | |
UNUSED | Number of days since the file was last accessed | |
#PAGES | File size in PAM pages (last-page pointer) | |
ST | Storage level on which the file is resident | |
S0/S1/S2 |
| |
BC | Backup class of the file | |
A/B/C/D/E |
|
The procedure for selecting files is described in the “HSMS Vol. 1” manual [1].
Dialog selection of job variables
//ARCHIVE-FILES ...,DIALOG-JV-SELECT=*YES
ARCHIVE-FILES : DIALOG-JV-SELECT #JVS = @@@@@@@@@@ -------------------------------------------------------------------------------- M JV-NAME _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ _ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ -------------------------------------------------------------------------------- NEXT-PAGE : ____________ (+,-,++,--, E, 'STRING') MARK : __ (A: ALL, N: NONE) @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
Key:
Column Values | Meaning |
M | Mark column (mark character = job variable is selected, blank = job variable is not selected) |
JV-NAME | Pathname of the job variable |
Examples
A nonprivileged user archives his or her files using default values; the TSN is 1234
//ARCHIVE-FILES 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 to be archived.
The files are saved to the standard save file of the archive, the save volumes are taken from the volume pool of the archive.
The files are not deleted after archival.
The request is given the name ARF#1234, the save version name is ARCHIVAL.
The retention period is as specified in the archive definition, the file expiration date is identical with the volume expiration date.
The request is processed asynchronously.
Depending on the global HSMS parameter OUTPUT a summary report is printed or sent as an email attachment.
An HSMS administrator archives the files of user ID UID before deleting it
//ARCHIVE-FILES FILE-NAMES=:*:$uid., - // SAVE-VERSION-NAME=arfuid, - // DESCRIPTOR='severuid', - // FILE-EXPIRATION-DATE=2025-12-31, - // OPERATION-CONTROL=*PAR(REQUEST-NAME=uid, - // EXPRESS-REQUEST=*YES, - // REPORT=*FULL, - // OUTPUT=uid.filelist)
All files of user ID UID residing on any imported pubset are archived to the default long-term system archive. As a prerequisite, the same long-term system archive must have been assigned to all pubsets on which files of this user reside. Pubsets for which the home computer is the slave are not archived.
The files are saved to the standard save file of the archive, the save volumes are taken from the volume pool of the archive.
The files are not deleted after archival.
The request is given the name UID, the save version name is ARFUID.
The retention period is as specified in the archive definition, the file expiration date is 31.12.2025.
The request is processed asynchronously as an express request.
A full report is written to the file UID.FILELIST.