| File | 211 |
|---|---|
| Statement | PROCESS
|
| Task | Run ARCHIVE utility.
|
| Code | Text |
|---|---|
| 530 | Access denied by Security Facility. |
| 531 | Password missing or incorrect. |
| 565 | Syntax error in dataset name. |
| 658 | Dataset is not cataloged. |
| 722 | Requested dataset not found. |
| 733 | User ID does not exist. |
| 734 | ARCHIVE run with errors.
|
| 750 | Invalid operand within operand list. |
| 756 | Job variable name missing or invalid. |
| 798 | Task was not started under TSOS. |
| 799 | Entire Systems Management Adapter internal error. |
| 853 | Retention cycle unexpired / NEWNAME
exists.
|
| 881 | Error occurred while opening file. |
| 984 | Server is not authorized to access. |
| 992 | Requested job variable not found. |
For detailed information, refer to documentation of SNI's product
ARCHIVE. Some field descriptions simply refer to the corresponding
ARCHIVE command to avoid duplicate explanations.
| Dictionary Field Name | Format/
Length/ Desc/Mu |
Description |
|---|---|---|
| BACKUP-TYPE | (A1) | Relevant for function SAVE. Minimum backup level. |
| D | ||
| CAT-ONLY | (A3) | Relevant for functions SAVE, EXPORT: |
| D | YES Only catalog entries are saved. | |
| NO Files are saved including catalog entry. Default. | ||
| CHANGED | (A12) | Relevant for function SAVE. Possible values: |
| D | YES Default. Only changed files are saved. | |
| YES,LARGE Only changed LARGE files are saved. | ||
| YES,n Same as YES,LARGE, where n is the | ||
| minimum file size in PAM pages. | ||
| NO Save all objects. | ||
| COMPRESS | (A3) | Relevant for functions SAVE, EXPORT. Specifies whether a compress is to be done with save. Possible values: |
| D | YES Compress is performed. | |
| NO Compress is not performed. Default. | ||
| CONTINUE | (A13) | Relevant for functions SAVE, EXPORT. Continuation of a previous SAVE/EXPORT run. Possible values: |
| D | SVID SAVE-ID must be given. | |
| SVID,VSN-LIST SAVE-ID and | ||
| CONTINUE-VOLSER-ARRAY must be given. | ||
| VSN-LIST CONTINUE-VOLSER-ARRAY must be given. | ||
| CONTINUE-VOLSER-ARRAY | (A6) | Relevant for functions SAVE, EXPORT. Maximum of 5 volumes if keyword VSN-LIST is specified in field CONTINUE. |
| D | ||
| M/5 | ||
| CONVERSION | (A4) | Relevant for functions RESTORE, IMPORT. PAM key conversion required to import or restore files to non-key disks. |
| D | Possible values: NO (default) | CONV | STD | |
| DAYS-UNUSED | (N5) | Relevant for functions SAVE, EXPORT. Number of days the object to be saved must have been unused. |
| D | ||
| DEVICE | (A8) | Relevant for functions SAVE, EXPORT, RESTORE, IMPORT, POOL, LIST. Device type, for example T9G. |
| D | ||
| DIRECTORY | (A54) | Relevant for functions SAVE, EXPORT, RESTORE, IMPORT, POOL, LIST, PURGE, INQUIRE. Name of directory file. Default is NONE. |
| D | ||
| DRIVES | (N2) | Relevant for functions SAVE, EXPORT, RESTORE, IMPORT, LIST. Number of drives to be used in parallel. |
| D | ||
| ERASE | (A7) | Relevant for functions SAVE, EXPORT. Specifies erasing of objects after SAVE or EXPORT. Possible values: |
| D | NO Default. Objects are not erased. | |
| ALL Erase objects. Ignore ACCESS and RETPD. | ||
| ALLP TSOS only: Erase objects. Ignore ACCESS, | ||
| RETPD and passwords. | ||
| ALLCNS Same as ALL, but also for CNS files. | ||
| ALLCNP TSOS only: Same as ALLCNS and ignore | ||
| passwords. | ||
| YES Objects are erased, if allowed by ACCESS, | ||
| RETPD and password definition. | ||
| EXCEPT-FILE-ARRAY | (A61) | Relevant for functions FILES, FILESC. Maximum of 20 file expressions for EXCEPT option of ARCHIVES FILES command. Same syntax as for FILE-ARRAY. |
| D | ||
| M/20 | ||
| EXCEPT-JOB-VARIABLE-ARRAY | (A61) | Relevant for functions JOBVAR, JOBVARC. Maximum of 20 JV expressions for EXCEPT option of ARCHIVES JOBVAR command. Same syntax as for JOB-VARIABLE-ARRAY. |
| D | ||
| M/20 | ||
| FILE-ARRAY | (A61) | Relevant for functions FILES, FILESC, INQUIRE. Maximum of 20 file expressions, where a file expression can be a file name of a file name prefixed by THRU= or RENAME=. |
| D | ||
| M/20 | ||
| FORCE-PURGE | (A3) | Relevant for function PURGE. Specify to force purging of saved versions. |
| D | Possible values: | |
| NO Default. Saved versions are not purged. | ||
| YES Saved versions are purged. | ||
| FROM-OPTION | (A24) | Relevant for functions RESTORE, IMPORT, LIST. Possible values: |
| D | LATEST | |
| LATEST,STATE | ||
| SVID | ||
| SVID,STATE,yymmdd.hhmmss | ||
| SVID,VSN-LIST | ||
| VSN-LIST | ||
| yymmdd.hhmmss | ||
| yymmdd.hhmmss,STATE | ||
| If SVID is specified, the field SAVE-ID must be specified. If VSN-LIST is specified, the VOLSER-ARRAY field must be specified. | ||
| FUNCTION | (A8) | The possible values for field FUNCTION relate to the corresponding ARCHIVE command to be executed, unless stated otherwise: |
| D | FILES | |
| FILESC Continuation of FILES for more file | ||
| definitions than are possible in one | ||
| call with FILES function. | ||
| JOBVAR | ||
| JOBVARC Continuation of JOBVAR for more job | ||
| variables than are possible in one | ||
| call with JOBVAR function. | ||
| DELETE | ||
| EXPORT | ||
| IMPORT | ||
| INQUIRE | ||
| LIST | ||
| POOL | ||
| PROCESS | ||
| PURGE | ||
| RESTORE | ||
| SAVE | ||
| STATUS | ||
| CLOSE This must be the last call and starts | ||
| the ARCHIVE execution. | ||
| INQUIRE-POOL-OPTION | (A14) | Relevant for function INQUIRE. Possible values: |
| D | POOL | |
| POOL, AVAILABLE | ||
| JOB-VARIABLE-ARRAY | (A61) | Relevant for functions JOBVAR, JOBVARC, INQUIRE. Maximum of 20 JV expressions, where a JV expression can be a JV name or a JV name prefixed by THRU= or RENAME=. |
| D | ||
| M/20 | ||
| LIST | (A10) | Relevant for functions SAVE, EXPORT, RESTORE, IMPORT, PURGE, LIST, INQUIRE. Destination for ARCHIVE report. Possible values: |
| D | BOTH | |
| NONE | ||
| SYSLST | ||
| SYSOUT | ||
| Some functions allow the adding of ,ALL, see the ARCHIVE documentation. | ||
| Note: | ||
| The destinations SYSLST and SYSOUT will be those of the Entire Systems Management Adapter task. | ||
| NEW-DIRECTORY | (A3) | Relevant for functions SAVE, EXPORT, POOL. Possible values: |
| D | NO Default. DIRECTORY field specifies existing directory. | |
| YES DIRECTORY field specifies new directory. | ||
| NOW | (A3) | Relevant for functions SAVE, EXPORT, RESTORE, IMPORT, POOL, PURGE, LIST. Possible values: |
| D | YES Default. Start immediately after function CLOSE is specified. | |
| NO Put ARCHIVE command to file for later | ||
| execution with function PROCESS (or cancel | ||
| with DELETE). | ||
| t Time in seconds: same as NO, where the time | ||
| specified is an execution time limit for an | ||
| ARCHIVE task started later. | ||
| PAR-CNS | (A3) | Parameter of ARCHIVE command PARAM. |
| D | Possible values: YES (default) or NO | |
| PAR-RESTART | (A3) | Parameter of ARCHIVE command PARAM. |
| D | Possible values: YES (default) or NO | |
| PAR-UNLOAD | (A3) | Parameter of ARCHIVE command PARAM. |
| D | Possible values: YES or NO (default) | |
| PAR-OPERATOR | (A3) | Parameter of ARCHIVE command PARAM. |
| D | Possible values: YES or NO (default) | |
| PAR-WRCHK | (A3) | Parameter of ARCHIVE command PARAM. |
| D | Possible values: YES or NO (default) | |
| PAR-SNR | (A3) | Parameter of ARCHIVE command PARAM. |
| D | Possible values: YES (default) or NO | |
| PAR-DESTROY | (A3) | Parameter of ARCHIVE command PARAM. |
| D | Possible values: YES or NO (default) | |
| PAR-CATID | (A3) | Parameter of ARCHIVE command PARAM. |
| D | Possible values: YES or NO (default) | |
| PAR-STREAM | (A3) | Parameter of ARCHIVE command PARAM. |
| D | Possible values: YES or NO (default) | |
| PAR-OLS | (A3) | Parameter of ARCHIVE command PARAM. |
| D | Possible values: YES or NO (default) | |
| PASSWORD-ARRAY | (A8) | Relevant for functions SAVE, EXPORT, RESTORE, IMPORT, POOL, PURGE, LIST, INQUIRE. If files or job variables are password-protected, maximum of 10 passwords. Only the first password will be used with function INQUIRE. |
| D | ||
| M/10 | ||
| POOL-OPERATION | (A6) | Relevant for function POOL. Possible values: |
| D | ADD | |
| REMOVE | ||
| REPLACE | (A4) | Relevant for functions RESTORE, IMPORT. |
| D | Possible values: | |
| NO Default. Objects are not replaced. | ||
| ALL Replace objects. Ignore ACCESS and RETPD. | ||
| ALLP TSOS only: Replace objects. Ignore ACCESS, | ||
| RETPD and passwords. | ||
| YES Objects are replaced, if allowed by ACCESS, | ||
| RETPD and password definition. | ||
| RETENTION-PERIOD | (N5) | Relevant for functions SAVE, EXPORT. Retention period for save version in number of days. |
| D | ||
| SAVE-ACL | (A3) | Relevant for function SAVE. Only for SECOS/FACS. Save ACL entries. Possible values: |
| D | NO Default. ACL entries are not saved. | |
| YES ACL entries are saved. | ||
| SAVE-DIRECTORY | (A3) | Relevant for functions SAVE, EXPORT. |
| D | Possible values: | |
| NO Directory is not saved. | ||
| YES Save directory also. | ||
| SAVE-ID | (A15) | Relevant for functions SAVE, EXPORT, PROCESS, DELETE. ARCHIVE. Save Identifier, in case the keyword SVID was specified in field FROM-OPTION or CONTINUE. |
| D | ||
| SAVE-PASSWORD | (A8) | Relevant for functions SAVE, EXPORT, RESTORE, IMPORT. Password for the SAVE run. |
| D | ||
| SHARE | (A3) | Relevant for functions SAVE, EXPORT. |
| D | Possible values: | |
| NO Saved objects and volumes are not shareable. | ||
| YES Saved objects and volumes are shareable. | ||
| SPACE | (A5) | Relevant for functions RESTORE, IMPORT. |
| D | Possible values: | |
| REORG Default. | ||
| KEEP | ||
| STATUS-TYPE | (A6) | Relevant for function STATUS. Type of ARCHIVE tasks for which status information is required. Possible values: |
| D | LATER Default. | |
| ACTIVE | ||
| STATUS-USER | (A8) | Relevant for function STATUS. Only for TSOS: user ID for which status information is required. |
| D | ||
| SV-OPTION | (A100) | Relevant for functions INQUIRE and PURGE. For possible values, see the SV option of the corresponding ARCHIVE commands. |
| D | ||
| TAPE-BLOCK-SIZE | (N2) | Relevant for functions SAVE, EXPORT. Block size in number of PAM pages. Maximum is 15. |
| D | ||
| TAPES | (A8) | Relevant for functions SAVE, EXPORT. |
| D | Possible values: | |
| OPERATOR Volumes are required from operator. | ||
| POOL Volumes are taken from pool of | ||
| directory. | ||
| VSN-LIST Volumes are specified in field VOLSER-ARRAY. | ||
| VOLSER-ARRAY | (A6) | Relevant for functions SAVE, EXPORT, POOL. A maximum of 10 volumes can be specified. Required also for functions RESTORE, IMPORT, UST when field FROM-OPTION=VSN-LIST. |
| D | ||
| M/10 |
The following ARCHIVE commands are created by the
example program shown below:
PARAM UNLOAD=YES |
FILES NAME=(MYFILE.1,MYFILE.2,MYFILE.SHARE.),
NAME=(BADFILE,RENAME=NICEFILE) |
EXPORT SHARE=YES,DEVICE=T-C1,LIST=BOTH,
TAPES=(MYTAPE) |
DEFINE DATA
LOCAL USING ARCHIV-L
END-DEFINE
*
* --- build first part of FILES command and set PARAM options ---
*
PROCESS ARCHIVE
USING NODE = 148
, FUNCTION = 'FILES'
, PAR-UNLOAD = 'YES'
, FILE-ARRAY = 'MYFILE.1' /* FIRST FILE
, FILE-ARRAY = 'MYFILE.2' /* SECOND FILE
, FILE-ARRAY = 'MYFILE.SHARE.' /* ALL FILES STARTING *
WITH THIS PREFIX
*
IF ERROR-CODE NE 0
WRITE ERROR-TEXT
ESCAPE ROUTINE
END-IF
*
* --- continue FILES command ---
*
PROCESS ARCHIVE
USING NODE = 148
, FUNCTION = 'FILESC'
, FILE-ARRAY = 'BADFILE' /* rename this file
, FILE-ARRAY = 'RENAME=NICEFILE' /* .. with this name
*
IF ERROR-CODE NE 0
WRITE ERROR-TEXT
ESCAPE ROUTINE
END-IF
*
* --- build EXPORT command ----
*
PROCESS ARCHIVE
USING NODE = 148
, FUNCTION = 'EXPORT'
, LIST = 'BOTH'
, SHARE = 'YES'
, DEVICE = 'T-C1'
, VOLSER-ARRAY = 'MYTAPE'
*
IF ERROR-CODE NE 0
WRITE ERROR-TEXT
ESCAPE ROUTINE
END-IF
*
* --- ready to go ---
*
PROCESS ARCHIVE
USING NODE = 148
, FUNCTION = 'CLOSE' /* execute ARCHIVE
*
IF ERROR-CODE NE 0
WRITE ERROR-TEXT
ESCAPE ROUTINE
END-IF
END