This statement is used by HSMS administrators only. It replaces a save file of migrated files by restoring the data from a backup archive.
The currently migrated files are selected from the save files specified. The files selected are restored from the backup or version backup archive to the level on which the save file to be replaced resides. The new save file information is updated in the references in the files’ catalog entries.
If any of the affected files has only been partially saved in the backup archive, it is impossible to restore it to a migration level. The file is restored to S0 instead.
Format (only for HSMS administrators)
REPLACE-SAVE-FILE-BY-RESTORE | Alias: RFR | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
ENVIRONMENT =
Defines the HSMS environment where the specified migration and backup archives are located.
ENVIRONMENT = *SINGLE-FEATURE
The archive entered is defined in the SF environment.
ENVIRONMENT = *SYSTEM-MANAGED(...)
The specified archives are defined in an SM pubset environment.
CATALOG-ID = <cat-id>
Catalog ID of the SM pubset to which the HSMS statement applies.
SAVE-FILE-ID = <composed-name 15...15>
Names the save file which is to be replaced by the restore operation.
MIGRATE-ARCHIVE-NAME = <filename 1.22 without-cat-gen-vers>
Specifies the migration archive to be used in replacement.
BACKUP-ARCHIVE-NAME = <filename 1.22 without-cat-gen-vers>
Specifies the backup or version backup archive to be used for replacement.
COMPRESS-FILES =
Indicates whether the data are to be compressed during the restore process.
COMPRESS-FILES = *STD
The default setting is derived from the archive definition of the migration archive.
COMPRESS-FILES = *NO
The data is restored in uncompressed form.
COMPRESS-FILES = *YES
The data is restored in compressed form.
OPERATION-CONTROL =
Enables the user to define a number of parameters which are relevant for the execution of the restore run.
OPERATION-CONTROL = *STD
The default values of the operands described below apply.
OPERATION-CONTROL = *PARAMETERS(...)
The operands controlling the restore 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 SYSHSMS for the HSMS administrator) and a suffix in the form of a time stamp. Unless otherwise specified, the request name is formed from the short code “RFR#” and the TSN of the calling user request yyyy as follows: RFR#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
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 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 HSMS statement processing during tape sessions only.
PARALLEL-RUNS = *STD / <integer 1..16>
This operand is only significant if you are working at storage level S2. It specifies the number of save tasks (ARCHIVE subtasks) running in parallel.
For duplication there must be two tape devices available for each task.
Unless otherwise specified, the preset value from the archive definition applies.
For further information on parallel processing see the “HSMS Vol. 1” manual [1].
WRITE-CHECKPOINTS = *STD / *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).
Unless otherwise specified, the preset value from the archive definition applies.
OPERATOR-INTERACTION = *STD / *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]).
Unless otherwise specified, the default value from the archive definition applies.
TAPE-CONTROL =
Defines the parameters which are relevant for restoring files from tape.
TAPE-CONTROL = *STD
The preset values from the definition of the archive from which the files are to be restored apply.
TAPE-CONTROL = *PARAMETERS(...)
The operands relevant to restoring from tape can be modified as follows:
UNLOAD-TAPE = *STD / *YES / *NO
Specifies whether or not tapes are to be unloaded after processing.
The preset value from the archive definition applies unless otherwise specified.
It is possible that HSMS will ignore the value of this operand to avoid irrational processing of tapes, for example, to avoid unloading a tape several times while rewinding it.
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 and to determine the scope of this report.
REPORT = *SUMMARY
A summary of the result, including any error messages, is to be output.
REPORT = *RESTORED-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 restored 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 is to be printed.
OUTPUT = *NONE
No report is output. Regardless from that 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 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 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 is to 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.