This statement is used for recalling migrated files to processing level S0. The files that are located in an SM pubset environment are recalled to the volume set that best matches their file attributes.
This statement has different formats for nonprivileged users and HSMS administrators. Privileged operands or operand values are marked with *P).
Format
RECALL-MIGRATED-FILES | Alias: RMF | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
*P) Privileged operand or operand value
FILE-NAMES =
Serves to specify the files to be recalled. Specification of this operand is mandatory. The user can further restrict the selection made here by means of the operands EXCEPT-FILE-NAMES, FROM-STORAGE and DIALOG-FILE-SELECT.
The number of files recalled is limited by the amount of space available on S0 for the user ID involved.
The migration archive must be assigned to the S0 pubset affected by the specified files. If the files were migrated to S1, the S1 pubset must be imported.
If files from more than one pubset are specified, 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 recall request.
All nonprivileged users can also recall files belonging to other user IDs if they are co-owners of these files or they have read authorization.
FILE-NAMES = *OWN
All files of the user’s own ID residing on all imported pubsets of the specified environment (except for shared SF pubsets for which the home computer is the slave) are to be recalled.
FILE-NAMES = *ALL
All files residing on all imported pubsets of the specified environment (except for shared SF pubsets for which the home computer is the slave) are to be recalled.
FILE-NAMES = *SELECTED
The path names of the files to be recalled are to be taken from a list compiled within the same HSMS run by means of the HSMS statement SELECT-FILE-NAMES.
The selected path names must be available in the specified environment.
FILE-NAMES = *FROM-FILE(...)
The path names of the files to be recalled 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. The list file can be created, for instance, by means of the HSMS statement SELECT-FILE-NAMES or the BS2000 command SHOW-FILE-ATTRIBUTES.
The selected path names must be available in the specified environment.
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 recalled 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-gen-vers-with-wild> / <partial-filename 2..79 with-wild>
The path names of the files to be recalled 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 catalog ID which is either taken from the specified environment or from the default catalog ID of the user ID.
You can also use wildcard syntax to select the files.
If you wish to recall files of a foreign user ID, you must specify the complete user ID.
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 selected path names must be available in the specified environment.
EXCEPT-FILE-NAMES =
Serves to specify files that are to be excluded from recall.
EXCEPT-FILE-NAMES = *NONE
All files specified with the FILE-NAMES operand are to be recalled.
EXCEPT-FILE-NAMES = *FROM-FILE(...)
The path names of the files to be excluded from recall 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. The list file can be created, for instance, by means of the BS2000 command SHOW-FILE-ATTRIBUTES. File names must be in uppercase characters only.
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 recalled 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 recall 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 catalog ID which is either taken from the specified environment or from the default catalog ID of the user 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.
ENVIRONMENT =
Defines the HSMS environment to which this HSMS statement applies.
ENVIRONMENT = *STD
Meaning for privileged users: *STD is set to the value *SINGLE-FEATURE.
Meaning 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 HSMS statement relates only to the SF pubset environment.
ENVIRONMENT = *SYSTEM-MANAGED(...)
The HSMS statement relates only to the specified SM pubset environment.
CATALOG-ID = <cat-id>
Catalog ID of the SM pubset to which the HSMS statement applies.
NEW-DATA-SUPPORT =
Displays the support on an SM pubset on which the recalled data is to be stored.
NEW-DATA-SUPPORT = *BEST-VOLUME-SET
The data is recalled to the volume set of the SM pubset that best matches the file attributes. The specification of the best volume set does not take S1 volume sets into account.
NEW-DATA-SUPPORT = *SAME
The data is recalled to the volume set on which it resided before being migrated. Only users with a specification privilege for a certain volume set are allowed to do this.
NEW-DATA-SUPPORT = <cat-id>
The data is recalled to the specified volume set of the SM pubset. This value is only allowed for users who have the privilege to carry out physical allocation. An S1 volume set can be stated.
FROM-STORAGE =
This operand is only available to the HSMS administrator.
Defines the storage level from which the files are to be recalled.
FROM-STORAGE = *ANY
The files are to be recalled from the last save version in which they are contained, irrespective of the storage level (S1 or S2) on which it resides.
FROM-STORAGE = *S1-STORAGE-LEVEL
The files are to be recalled from S1 only. Any specified file that has been migrated to S2 is not recalled.
FROM-STORAGE = *S2-STORAGE-LEVEL
The files are to be recalled from S2.
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 recall by means of FILE-NAMES and other operands.
This 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 output in a screen mask. The user can then mark individual files from the set on display, thereby selecting them for or excluding them from recall.
Only files migrated from S0 are included in the selection list displayed.
Details on the content of the screen mask are provided in the section "Dialog selection when recalling migrated files".
OPERATION-CONTROL =
Enables the user to define certain parameters which are relevant for the execution of the recall run.
OPERATION-CONTROL = *STD
The default values of the operands described below apply.
OPERATION-CONTROL = *PARAMETERS(...)
The operands controlling the recall 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 by the short code “RMF#” and the TSN of the calling user task yyyy as follows: RMF#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 preset global HSMS parameters.
Interactive tasks are permitted to carry out synchronous HSMS statement processing during tape sessions only.
PERFORMANCE-ANALYSIS =
Specifies whether a statistics file is to be produced for each ARCHIVE subtask.
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 recall request and to determine the scope of this report.
REPORT = *SUMMARY
A summary of the results of the recall request, including any error messages, is to be output.
REPORT = *FULL
A full report is to be output, including a list of all files recalled.
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 recall 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 recall 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 recall 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 recall request 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.
For nonprivileged callers the report files must be under the user’s own user ID. If not, co-ownership is a prerequisite.
Note on the migration archive
A migration archive need not be specified, since migration is possible only to a default system archive assigned by the HSMS administrator.
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 HSMS administrators.
If recall is requested by a nonprivileged user, the migration archive must permit read access for all users.
Dialog selection when recalling migrated files
//RECALL-MIGRATED-FILES ...,DIALOG-FILE-SELECT=*YES,...
RECALL-MIGRATED-FILES : DIALOG-FILE-SELECT #FILES = @@@@@@@@@@ ENVIRONMENT = @@@@@@@@ FROM-STORAGE = @@@@@@@@@@@@@@@@ -------------------------------------------------------------------------------- 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, blank = file is not 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 |
| |
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].
Example
Using default values, a nonprivileged user recalls migrated files of a project that had been processed only intermittently; the TSN is 3456.
/RECALL-MIGRATED-FILES FILE-NAMES=proj.
All files of the user’s own ID which have the default catalog ID and whose names start with PROJ. are recalled from the default system migration archive.
The files are recalled from the most recent save file that contains the files.
The request is given the name RMF#3456.
The request is processed asynchronously.
Depending on the global HSMS parameter OUTPUT a summary report is printed or sent as an email attachment.