Check file import procedure
Component: | BS2000 |
Functional area: | File processing |
Domain: | FILE |
Privileges: | TSOS |
Function
Simulates the effect of executing the IMPORT-FILE command (operand SUPPORT=DISK), but does not actually import the file, i.e the user receives a SYSOUT/SYSLST log which shows how the IMPORT-FILE command would have been processed.
The log provides a list of the files on the volume identified in the VOLUME operand, and the informative data/messages which would have been returned by actually executing the IMPORT-FILE command.
For files on the private disk or the Net-Storage volume, DMS will not check at this point whether there are file locks or protection attributes which might prevent importation. When the importation is actually performed, the user must ensure that the files are not locked, and that write access is permitted.
Privileged functions
As with the IMPORT-FILE command, systems support (TSOS privilege) can use the NEW-USER option to control which user ID the files are cataloged under.
By default, systems support (TSOS privilege) is a co-owner of all the files (and can therefore create files under all user logons). When SECOS is used, this co-ownership can be restricted for permanent files.
Systems support can generate files under any user ID (TSOS privilege). In conjunction with the SECOS software product a user can allow other user IDs to act as co-owners. Co-owners of a user ID are then also allowed to import files under that ID.
Format
CHECK-IMPORT-DISK-FILE | ||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||
Operands
VOLUME = <alphanum-name 1..6>
Specifies the VSN (volume serial number) of the volume which records the files whose importation is to be checked.
DEVICE-TYPE = <device>
Identifies the type of device on which the private disk is to be mounted.
Only device types known in the system are accepted. In interactive mode, DEVICE-TYPE=? calls up a list of the available device types.
The volume type NETSTOR must be specified for Net-Storage volumes.
Every specification of a disk device type known in the system is handled like the STDDISK specification.
FILE-NAME = *ALL / <partial-filename 2..50 without-cat> / <filename 1..51 without-cat>
Identifies the files, file generation groups or file generations for which the importation (cataloging) is to be checked.
By default, DMS will check the cataloging of all files etc. which are stored on the volume specified in the VOLUME operand under the user ID for the job which is currently running.
TYPE-OF-FILE = *ANY(...)
For file generation groups: specifies how file generation groups are to be treated.
GENERATIONS = *YES / *NO
Specifies whether the only check that is required is on the cataloging of the group entry, or whether the cataloging of the file generations which are stored on the same private disk is also to be checked.
GENERATIONS = *YES
If the group entry is held on the private disk, DMS will catalog this entry and all those of its generations which begin on this disk. If there is no group entry on the disk or in the user catalog, no file generations will be cataloged.
GENERATIONS = *NO
DMS transfers just the group entry for the FGG to the catalog.
OUTPUT = *SYSLST / *SYSOUT / *ALL
Specifies how the processing of commands is to be logged (see the table "CHECK-IMPORT-DISK-FILE: Special return codes and messages").
OUTPUT = *SYSLST
The execution of commands will be logged on SYSLST; this log contains the special return codes and message texts (see table "CHECK-IMPORT-DISK-FILE: Special return codes and messages").
OUTPUT = *SYSOUT
The execution of commands will be logged on SYSOUT; only the special return codes and file names are output in this log (see table "CHECK-IMPORT-DISK-FILE: Special return codes and messages").
OUTPUT = *ALL
The processing of commands will be logged on SYSLST and SYSOUT (see OUTPUT= *SYSLST and OUTPUT=*SYSOUT).
NEW-USER = *NONE / <name 1..8>
User ID under which the file is to be cataloged (see also the IMPORT-FILE command).
PUBSET = *STD / <cat-id 1..4>
Specifies the pubset on which the files are to be cataloged. If a Net-Storage volume is specified in the VOLUME operand, the pubset to which the Net-Storage volume is allocated must be specified here.
PUBSET = *STD
If no specification is provided for the PUBSET, the catalog entries will be set up under the default catalog ID for the user ID (see the SHOW-USER-ATTRIBUTES command).
PUBSET = <cat-id 1..4>
Specifies the pubset on which the files are to be cataloged.
Return codes
(SC2) | SC1 | Maincode | Meaning/Guaranteed messages |
|---|---|---|---|
0 | CMD0001 | Command executed | |
1 | CMD0202 | Syntactical or semantic error in command | |
32 | DMS0584 | A state that does not allow the function to continue was reported during processing | |
64 | CMD0216 | Privileges error | |
64 | DMS0501 | Requested catalog not available | |
64 | DMS0512 | Requested catalog not available | |
64 | DMS051B | Requested user ID not in pubset | |
64 | DMS051C | User not authorized to access pubset | |
64 | DMS0533 | Requested file not cataloged in pubset | |
64 | DMS0535 | Specified file not shareable | |
64 | DMS053E | File already cataloged on private volume | |
64 | DMS055C | Catalog entry not found on specified private disk | |
64 | DMS05FC | Specified user ID not in HOME pubset | |
64 | DMS05FE | Requested file(s) not found | |
64 | DMS0585 | Error detected during catalog processing or multihost processing | |
64 | DMS0586 | Currently not possible to access or reserve volume | |
130 | DMS0524 | System address space full | |
130 | DMS0582 | File is currently locked or in use and cannot be processed | |
130 | DMS0585 | Error detected during catalog processing or multihost processing | |
130 | DMS0586 | Currently not possible to access or reserve volume | |
130 | DMS0594 | Not enough virtual memory available |
Special return codes and messages
Code on | Message on SYSLST | Meaning |
|---|---|---|
0 | FILE DID NOT EXIST | There was no file with the same name and a new catalog entry would be created. |
2 | FILE EXISTS | A file of the same name already exists. |
4 | ERROR ON CATALOG ACCESS | System error during catalog access. |
5 | FILE ALREADY ON PRIVATE | The file is already cataloged and is stored on the private disk specified by VOLUME. |
6 | ERROR ON VTOC ACCESS | System error when accessing the F1 label of the private disk or the catalog of the Net-Storage volume. |
7 | GENERATION OUT OF RANGE | Invalid attempts to import a file generation: the absolute generation number of the generation to be imported conflicts with the limits defined in the group entry. |
8 | C.E. HAS BEEN REPLACED | A catalog entry already exists for the specified disk |
A | INVALID FILENAME | The path name of the file to be imported (including catid and userid) is longer than 54 characters. |
B | ERROR ON NET-STORAGE ACCESS | |
C | LARGE FILE NOT ALLOWED | |
D | RENAME OF NODE-FILES NOT ALLOWED |
Example
Check import for a private disk
/check-imp-disk-file vol=work01,dev-type=d3435,
file-name=*all,output=*sysout ———————————————————— (1)
% 0 :2OSG:$USER1.MAX.FILE.1 % 0 :2OSG:$USER1.MAX.FILE.2 % 0 :2OSG:$USER1.MAX.FILE.3 % 0 :2OSG:$USER1.MAX.FILE.4 % 2 :2OSG:$USER1.MAX.LIB
/show-file-attr max.lib ——————————————————————————————————————————————— (2)
% 3 :2OSG:$USER1.MAX.LIB %:2OSG: PUBLIC: 1 FILE RES= 3 FRE= 3 REL= 3 PAGES
/mod-file-attr max.lib,new-name=max.lib.old ——————————————————————————— (3)
/check-imp-disk-file vol=work01,dev-type=d3435,
file-name=*all,output=*sysout —————————————————————————————————— (4)
% 0 :2OSG:$USER1.MAX.FILE.1 % 0 :2OSG:$USER1.MAX.FILE.2 % 0 :2OSG:$USER1.MAX.FILE.3 % 0 :2OSG:$USER1.MAX.FILE.4 % 0 :2OSG:$USER1.MAX.LIB
(1) | The command checks whether all files of the user USER1 on the private disk WORK01 can be imported. The information returned by CHECK-IMPORT-DISK-FILE is to be output to SYSOUT. |
(2) | The code returned for the file MAX.LIB is 2, i.e. there is already an existing catalog entry for the file. The command SHOW-FILE-ATTRIBUTES returns information on the existing catalog entry for the file MAX.LIB. The file is stored on public disk. |
(3) | The command MODIFY-FILE-ATTRIBUTES is used to rename the file MAX.LIB to MAX.LIB.OLD. |
(4) | A repeated CHECK-IMPORT-DISK-FILE command (see Point 1) indicates that all files of the private disk WORK01 (including MAX.LIB) can be imported. |