Delete catalog entry of files (file export)
Component: | BS2000 |
Functional area: | File processing |
Domain: | FILE |
Privileges: | STD-PROCESSING |
Routing code: | $ (with NBCONOPI=N) or E (with NBCONOPI=Y) |
Function
The EXPORT-FILE command deletes the catalog entries for files which are contained on a private volume or Net-Storage volume (i.e. exports files). The storage space and data in the files is retained.
By default, the command exports files to private disk. When files on a Net-Storage volume of the NETSTOR type are to be exported, either the volume or the storage type *NET-STORAGE must be specified explicitly. Files on a Net-Storage volume of the NETVOL type cannot be exported, because there is no file catalog (.bs2fscat) on the Net-Storage volume.
The IMPORT-FILE command allows their catalog entries to be recreated (i.e. the files to be imported).
Privileged functions
System support staff may export files belonging to any user ID. It may ignore the passwords of protected files and also branch to guided dialog whenever the user ID is changed.
By default, systems support (TSOS privilege) is a co-owner of all the files (and can therefore export files under any user ID). When SECOS is used, this co-ownership can be restricted.
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 export a file.
Overview of functions
Function / Meaning | Level 1 operands | Level 2/3 operands |
|---|---|---|
Identifier of the volume to be exported | ||
Name of the file or file generation to be exported | ||
| =*NAME | |
| =*GENERATIONS-BEFORE | |
| =*GENERATIONS-AFTER | |
Selection criteria for the files to be deleted | ||
Date specification | ||
| ||
| ||
| ||
| ||
| SUPPORT = | |
Storage space | ||
| ||
| ||
| ||
| ||
| ||
| ||
File security/file protection | ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
| ||
Control parameters | DIALOG-CONTROL | |
| ||
| ||
| ||
| ||
| ||
| ||
Message for successfully exported files | ||
| =*NO | |
| =*SYSOUT | |
Ignore password protection | ||
Ignore password protection provided by the specified passwords | ||
Suppress error situations |
Format
EXPORT-FILE | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Operands
VOLUME = *ANY / <alphanum-name 1..6>
The VSN of the volume on which the file to be exported is stored. From the set of files selected by the FILE operand, only the files which are held on the specified volume will be exported. The VOLUME operand must not be used for file generation groups on tape.
If a file generation is to be exported from a private disk specified in the VOLUME operand, which holds a file generation group including the generation to be exported, but does not hold the group entry, gaps can result in the generation group. This gap will only be in the catalog entry; the file generation group remains complete on the disks.
VOLUME = *ANY
All the files identified by the FILE operand and contained on private volumes or Net-Storage volumes of the NETSTOR type will be exported.
FILE = *NAME(...) / *GENERATIONS-BEFORE(...) / *GENERATIONS-AFTER
Specifies the files or file generation groups to be exported. *DUMMY designates a dummy file, or dummy generations which “always exist” and which satisfy all the selection criteria. Any other operands (except for DIALOG-CONTROL, OUTPUT and SUPPRESS-ERRORS) will be checked for their formal correctness, but otherwise ignored. The main use of *DUMMY is in testing procedures.
FILE = *NAME(...)
From within the volumes identified by VOLUME, the files named as follows will be selected:
FILE-NAME = *ALL / <filename 1..54 with-wild(80)> / *DUMMY
The name of the file to be exported. Only the user’s own user ID or a user ID for which the user is co-owner may be specified.
FILE = *GENERATIONS-BEFORE(...)
From within the volumes identified by VOLUME, all the file generations which are older than the one whose identification follows will be exported:
GENERATION-NAME = <filename 1..54 with-wild(80)> / *DUMMY
The name of a reference generation. All those file generations which have a number less than the reference generation will be exported.
FILE = *GENERATIONS-AFTER(...)
From within the volumes identified by VOLUME, all the file generations which are younger than the one whose identification follows will be exported:
GENERATION-NAME = <filename 1..54 with-wild(80)> / *DUMMY
The name of a reference generation. All those file generations which have a number greater than the reference generation will be exported.
SELECT = *ALL
All the files in the set specified by the FILE-NAME operand are selected.
SELECT = *BY-ATTRIBUTES(...)
Restricts the files in the set specified in the FILE-NAME operand to files which satisfy the criteria which follow. The default values, *ANY and ANY, each indicates that the file set is not to be restricted to any particular values for the attribute concerned.
CREATION-DATE = *ANY / *NONE / *TODAY / *YESTERDAY / <integer -99999..991231> /
<date> / *INTERVAL(...)
The user can select the files to be exported by their creation date. See also the CRE-DATE and CRE-TIME output fields in the SHOW-FILE-ATTRIBUTES command.
CREATION-DATE = *ANY
The creation date is not to be used as a selection criterion.
CREATION-DATE = *NONE
Only those files which have the value NONE entered in the CREATION-DATE field in their catalog entry are exported, i.e. files which have never been opened.
CREATION-DATE = *TODAY
Only those files which have today’s date entered in the CREATION-DATE field in their catalog entry are exported.
CREATION-DATE = *YESTERDAY
Only those files which have yesterday’s date entered in the CREATION-DATE field in their catalog entry are exported.
CREATION-DATE = <integer -99999..991231>
Only those files which have the specified date entered in the CREATION-DATE field in their catalog entry are exported. Here, the user can specify the creation date in either of two ways:
as an absolute date value: (6 digits), a specific date in the form yymmdd (yy = year, mm = month, dd = day)
as a relative date value: (6 digits, with preceding sign) the number of days from today’s date, in the form -n for dates in the past, and +n for dates in the future; (YESTERDAY corresponds to -1, TODAY corresponds to ±0)
CREATION-DATE = <date>
Only those files which have the specified date entered in the CREATION-DATE field in their catalog entry are exported. The user can specify the creation date in the form [yy]yy-mm-dd.
CREATION-DATE = *INTERVAL(...)
Only those files which were created within the specified time period are exported. The range of dates covered by the specification includes the two end dates (see also the explanation of how dates are specified using <integer> values). It is also possible to specify limits using only the operand FROM (lower limit) or TO (upper limit). Whichever of the operands is not specified will be replaced by the default value for use as the limit of the range. The use of range limits for export can only be meaningful if the chosen lower limit <= the upper limit.
FROM = *EARLIEST / *TODAY / *YESTERDAY / <integer -99999..991231> / <date>
Only those files which have been created since the specified date (i.e. CREATION-DATE >= specified date) are exported. If EARLIEST is specified, the system will use the earliest possible date.
FROM = *TODAY
Exports only those files which were created on the current date.
FROM = *YESTERDAY
Exports only those files which were created as of yesterday’s date (i.e. files for which CREATION-DATE >= date of preceding day).
FROM = <integer -99999..991231>
Exports only those files which were created after the specified date (i.e. files for which CREATION-DATE >= specified date).
FROM = <date>
Exports only those files which were created after the specified date (i.e. files for which CREATION-DATE >= specified date).
TO = *TODAY / *YESTERDAY / <integer -99999..991231> / <date>
Exports only those files which were created before the specified date (i.e. files for which CREATION-DATE <= specified date).
TO = *TODAY
Exports only those files which were created up to today’s date (i.e. files for which CREATION-DATE <= current date).
TO = *YESTERDAY
Exports only those files which were created up to yesterday’s date (i.e. files for which CREATION-DATE <= date of preceding day).
TO = <integer -99999..991231>
Exports only those files which were created before the specified date (i.e. files for which CREATION-DATE <= specified date).
TO = <date>
Exports only those files which were created before the specified date (i.e. files for which CREATION-DATE <= specified date).
EXPIRATION-DATE = *ANY / *NONE / *TOMORROW / *TODAY / *YESTERDAY /
<integer -99999..991231> /<date> / *INTERVAL(...)
The user can select the files to be exported by their release date (expiration date). See also the EXPIR-DATE and EXPIR-TIME output fields in the SHOW-FILE-ATTRIBUTES command.
EXPIRATION-DATE = *ANY
The expiration date is not to be used as a selection criterion.
EXPIRATION-DATE = *NONE
Only those files which have no expiration date (i.e. the value NONE) entered in the EXPIRATION-DATE field in their catalog entry are exported.
EXPIRATION-DATE = *TOMORROW
Only those files which have tomorrow’s date entered as the EXPIRATION-DATE in their catalog entry are exported.
EXPIRATION-DATE = *TODAY
Only those files which have today’s date entered as the EXPIRATION-DATE in their catalog entry are exported.
EXPIRATION-DATE = *YESTERDAY
Only those files which have yesterday’s date entered as the EXPIRATION-DATE in their catalog entry are exported.
EXPIRATION-DATE = <integer -99999..991231>
Only those files which have the specified date entered as the EXPIRATION-DATE in their catalog entry are exported. Here, the user can specify the expiration date in either of two ways:
- as an absolute date value: (6 digits), a specific date in the form yymmdd (yy = year, mm = month, dd = day)
- as a relative date value: (6 digits with preceding sign), the number of days from today’s date, in the form -n for dates in the past, and +n for dates in the future; (YESTERDAY corresponds to -1, TODAY corresponds to ±0, TOMORROW corresponds to +1)
EXPIRATION-DATE = <date>
Only those files which have the specified date entered as the EXPIRATION-DATE in their catalog entry are exported. The user can specify the expiration date in the form [yy]yy-mm-dd.
EXPIRATION-DATE = *INTERVAL(...)
Only those files for which the expiration date lies within the specified time period, i.e. files for which the retention period ends within the specified time period, will be exported. The range of dates covered by the specification includes the two end dates (see also the explanation of how dates are specified for EXPIRATION-DATE = <integer...>). It is also possible to specify limits using only the operand FROM (lower limit) or TO (upper limit). Whichever of the operands is not specified will be replaced by the default value for use as the limit of the range. The use of range limits for export can only be meaningful if the chosen lower limit <= the upper limit.
FROM = *EARLIEST / *TOMORROW / *TODAY / *YESTERDAY /
<integer -99999..991231> / <date>
If EARLIEST is specified, the system will use the earliest possible date. Only those files for which the retention period expires on or after the specified date (EXPIRATION-DATE >= specified date) are exported.
FROM = *TOMORROW
Exports only those files for which the EXPIRATION-DATE >= the next day.
FROM = *TODAY
Exports only those files for which the EXPIRATION-DATE >= the current date.
FROM = *YESTERDAY
Exports only those files for which the EXPIRATION-DATE >= the specified date.
FROM = <integer -99999..991231>
Exports only those files for which the EXPIRATION-DATE >= the specified date.
FROM = <date>
Exports only those files for which the EXPIRATION-DATE >= the specified date.
TO = *LATEST / *TOMORROW / *TODAY / *YESTERDAY /
<integer -99999..991231> /<date>
Only files for which the retention period expires on or before the specified date (EXPIRATION-DATE <= specified date) will be exported.
TO = *TOMORROW
Exports only those files for which the EXPIRATION-DATE <= the next day.
TO = *TODAY
Exports only those files for which the EXPIRATION-DATE <= the current date.
TO = *YESTERDAY
Exports only those files for which the EXPIRATION-DATE <= yesterday’s date.
TO = <integer -99999..991231>
Exports only those files for which the EXPIRATION-DATE <= the specified date.
TO = <date>
Exports only those files for which the EXPIRATION-DATE <= the specified date.
LAST-ACCESS-DATE = *ANY / *NONE / *TODAY / *YESTERDAY /
<integer -99999..991231> /<date> / *INTERVAL(...)
The user can select the files to be exported by the date when they were last accessed. See also the ACC-DATE and ACC-TIME output fields in the SHOW-FILE-ATTRIBUTES command.
LAST-ACCESS-DATE = *ANY
The date of last access is not to be used as a selection criterion.
LAST-ACCESS-DATE = *NONE
Exports only those files which have the value NONE entered in the LADATE field in their catalog entry, i.e. files which have never been opened.
LAST-ACCESS-DATE = *TODAY
Exports only those files for which today’s date has been entered as the LAST-ACCESS-DATE in the catalog entry.
LAST-ACCESS-DATE = *YESTERDAY
Exports only those files for which yesterday’s date has been entered as the LAST-ACCESS-DATE in the catalog entry.
LAST-ACCESS-DATE = <integer -99999..991231>
Exports only those files for which the specified date has been entered as the LAST-ACCESS-DATE in the catalog entry. Here, the user can specify the last access date in either of two ways:
- as an absolute date value: (6 digits), a specific date in the form yymmdd (yy = year, mm = month, dd = day)
- as a relative date value: (6 digits, with preceding sign) the number of days from today’s date, in the form -n for dates in the past, and +n for dates in the future; (YESTERDAY corresponds to -1, TODAY corresponds to ±0)
LAST-ACCESS-DATE = <date>
Exports only those files for which the specified date has been entered as the LAST-ACCESS-DATE in the catalog entry. The user can specify the creation date in the form [yy]yy-mm-dd.
LAST-ACCESS-DATE = *INTERVAL(...)
Only files which were last accessed within the specified time period will be exported. The range of dates covered by the specification includes the two end dates (see also the explanation of how dates are specified using <integer> values). It is also possible to specify limits using only the operand FROM (lower limit) or TO (upper limit). For whichever operand is not specified, the default value will be used as the limit for the range. The use of range limits for export can only be meaningful if the chosen lower limit <= the upper limit.
FROM = *EARLIEST / *TODAY / *YESTERDAY / <integer -99999..991231> / <date>
Only files which have been accessed since the specified date (i.e. for which LAST-ACCESS-DATE >= specified date) will be exported. If EARLIEST is specified, the system will use the earliest possible date.
FROM = *TODAY
Exports only those files which have been accessed up to the date of the current date.
FROM = *YESTERDAY
Exports only those files which have been accessed up to the date of the preceding day. Returns information on files for which the LAST-ACCESS-DATE >= the specified date.
FROM = <integer -99999..991231>
Exports only those files for which the LAST-ACCESS-DATE >= the specified date.
FROM = <date>
Exports only those files for which the LAST-ACCESS-DATE >= the specified date.
TO = *TODAY / *YESTERDAY / <integer -99999..991231> / <date>
Only those files which were last accessed on or before the specified date (i.e. files for which LAST-ACCESS-DATE <= the specified date) are exported.
TO = *TODAY
Exports only those files which have been accessed up to the current date.
TO = *YESTERDAY
Exports only those files which have been accessed up to the date of the preceding day.
TO = <integer -99999..991231>
Exports only those files which were most recently accessed up to the specified date.
TO = <date>
Exports only those files which were most recently accessed up to the specified date.
SUPPORT = *ANY / list-poss(2): *PRIVATE-DISK / *TAPE
The user can select which files are to be exported by the EXPORT-FILE command by the type of their volumes.
SUPPORT = *ANY
The volume type is not to be used as a selection criterion.
SUPPORT = *PRIVATE-DISK
Only files on private disks are to be exported.
SUPPORT = *TAPE
Only files on tape or tape cartridge are to be exported.
STORAGE-TYPE =*ANY / *NET-STORAGE(...)
The user can select which files are to be exported with EXPORT-FILE by the type of the storage location of the file.
STORAGE-TYPE = *ANY
The storage type is not a selection criterion.
STORAGE-TYPE = *NET-STORAGE(...)
Only files on a Net-Storage volume of the NETSTOR type are exported. Files on a Net-Storage volume of the NETVOL type cannot be exported, because there is no file catalog (.bs2fscat) on the Net-Storage volume.
FILE-TYPE = *ANY / *BS2000 / *NODE-FILE
The user can select which files are to be exported with EXPORT-FILE by the file type.
FILE-TYPE = *ANY
The file type is not a selection criterion.
FILE-TYPE = *BS2000
Only BS2000 files on Net-Storage volumes of the NETSTOR type are exported.
FILE-TYPE = *NODE-FILE
Only node files on Net-Storage volumes of the NETSTOR type are exported.
SIZE = *ANY / *FREESIZE / <integer 0..2147483647> / *INTERVAL(...)
Only for files on disks and Net-Storage volumes: the user can select which files are to be exported by the EXPORT-FILE command on the basis of their size or the size of their reserved storage area (= number of PAM pages).
The value of the SIZE operand specifies the number of PAM pages: the upper and lower limits are both included in the range specified.
SIZE = *ANY
The file size is not to be used as a selection criterion.
SIZE = *FREESIZE
Only files for which storage space has been reserved but which do not yet occupy any of it (HIGH-US-PA=0) are to be exported.
SIZE = <integer 0..2147483647>
Only files for which the number of PAM pages reserved is exactly equal to the number specified here are to be exported.
SIZE = *INTERVAL(...)
Only files for which the number of pages lies within the specified range are to be exported. The upper and lower limits are both included in the range specified (see description of SIZE=<integer...>). It is also possible to specify limits using only the operand FROM (lower limit) or TO (upper limit). For whichever operand is not specified, the default value will be used as the limit for the range. The use of range limits for export can only be meaningful if the chosen lower limit <= the upper limit. Only files for which the number of PAM pages reserved is at least equal to the FROM value and at most equal to the TO value will be processed (FROM <= SIZE <= TO).
FROM = 0 / <integer 0..2147483647>
Only files for which the number of PAM pages reserved is at least equal to the specified number are to be exported (SIZE >= specified value).
TO = 2147483647 / <integer 0..2147483647>
Only files for which the number of PAM pages reserved is at most equal to the specified number are to be exported (SIZE <= specified value).
NUMBER-OF-EXTENTS = *ANY / <integer 0..65535> / *INTERVAL(...)
Only for disk files: the user can select the files to be processed by EXPORT-FILE by the number of extents into which the file is “split”. An extent is a contiguous area on a disk, occupied by one file; the output field EXTENTS shows how many extents the file has.
NUMBER-OF-EXTENTS = *ANY
The number of extents is not to be used as a selection criterion.
NUMBER-OF-EXTENTS = <integer 0..65535>
Only disk files with exactly the specified number of extents (EXTENDS = integer) are to be exported.
NUMBER-OF-EXTENTS = *INTERVAL(...)
Selects all the files whose number of extents lies within the specified range. The upper and lower limits are both included in the range specified. It is also possible to specify limits using only the operand FROM (lower limit) or TO (upper limit). For whichever operand is not specified, the default value will be used as the limit for the range. The use of range limits for export can only be meaningful if the chosen lower limit <= the upper limit. Only disk files which have at least as many EXTENTS as specified by the FROM value and at most as many as given by the TO value will be processed (FROM <= EXTENTS <= TO).
FROM = 0 / <integer 0..65535>
Only files for which the number of extents is at least equal to the specified number are to be exported (EXTENTS >= integer).
TO = 65535 / <integer 0..65535>
Only files for which the number of extents is at most equal to the specified number are to be exported (EXTENTS <= integer).
NUMBER-OF-FREE-PAGES = *ANY / *SIZE / <integer 0..2147483647> / *INTERVAL(...)
Only for files on disks and Net-Storage volumes: the user can select the files to be processed according to their number of free PAM pages, i.e. the number of pages reserved for a file but unused.
NUMBER-OF-FREE-PAGES = *ANY
The number of free PAM pages is not to be used as a selection criterion.
NUMBER-OF-FREE-PAGES = *SIZE
Only files which actually occupy no storage space are to be exported (i.e. no PAM page has been written yet).
NUMBER-OF-FREE-PAGES = <integer 0..2147483647>
Only files which have exactly the number of reserved but unused (=free) PAM pages specified by <integer...> are to be exported.
NUMBER-OF-FREE-PAGES = *INTERVAL(...)
Selects all files for which the number of unused PAM pages lies within the specified range. The upper and lower limits are both included in the range specified (see description of NUMBER-OF-FREE-PAGES = <integer...>). It is also possible to specify limits using only the operand FROM (lower limit) or TO (upper limit). For whichever operand is not specified, the default value will be used as the limit for the range. The use of range limits for export can only be meaningful if the chosen lower limit <= the upper limit.
Only disk files which have at least as many free PAM pages as specified by the FROM value and at most as many as given by the TO value will be exported (FROM <= FREE <= TO).
FROM = 0 / <integer 0..2147483647>
Only files for which the number free PAM pages is at least equal to the specified number are to be exported (FREE >= integer).
TO = 2147483647 / <integer 0..2147483647>
Only files for which the number free PAM pages is at most equal to the specified number are to be exported (FREE <= integer).
ACCESS = *ANY / *READ / *WRITE
The specified access type will be used as a selection criterion (ACCESS output field).
ACCESS = *ANY
The ACCESS value is not to be used as a selection criterion.
ACCESS = *READ
Only files for which write access is prevented by ACCESS=READ, i.e. for which only read access is permitted, will be exported.
ACCESS = *WRITE
Only files for which write access is permitted will be exported.
PASSWORD = *ANY / list-poss(4): *NONE / *READ-PASSWORD /
*WRITE-PASSWORD / *EXEC-PASSWORD
The user can select files with specific password types for processing by the EXPORT-FILE command.
PASSWORD = *ANY
Password protection is not to be used as a selection criterion.
PASSWORD = *NONE
Only files for which there is no password protection are to be exported.
PASSWORD = *READ-PASSWORD
Only files which are protected by a read password are to be exported.
PASSWORD = *WRITE-PASSWORD
Only files which are protected by a write password are to be exported.
PASSWORD = *EXEC-PASSWORD
Only files which are protected by an execute password are to be exported.
USER-ACCESS = *ANY / listposs(3): *OWNER-ONLY / *ALL-USERS / *SPECIAL
The user can select files using their access authorizations as a criterion.
USER-ACCESS = *ANY
The access authorization is not to be used as a selection criterion.
USER-ACCESS = *OWNER-ONLY
Only files which the owner alone may access are to be exported.
USER-ACCESS = *ALL-USERS
Only files which can be accessed by all users are to be exported.
USER-ACCESS = *SPECIAL
Only files which can be accessed by all user IDs including the maintenance IDs (i.e. user IDs with HARDWARE-MAINTENANCE privilege) are to be exported.
FILE-STRUCTURE = *ANY / list-poss(5): *PAM / *SAM / *ISAM / *BTAM / *NONE
The user can select files for processing according to their access method (FILE-STRUC output field).
FILE-STRUCTURE = *ANY
The access method is not to be used as a selection criterion.
FILE-STRUCTURE = *PAM
Only PAM files should be processed.
FILE-STRUCTURE = *SAM
Only SAM files are to be processed.
FILE-STRUCTURE = *ISAM
Only ISAM files are to be processed.
FILE-STRUCTURE = *BTAM
Only BTAM files are to be processed. BTAM files are tape files.
FILE-STRUCTURE = *NONE
Only files for which FILE-STRUC=NONE, i.e. files which have not yet been opened, are to be exported.
BACKUP-CLASS = *ANY / list-poss(5): *A / *B / *C / *D / *E
The user can select files for export by their BACKUP-CLASS level.
BACKUP-CLASS = *ANY
The BACKUP-CLASS level is not to be used as a selection criterion.
BACKUP-CLASS = *A
Only the files for which the value A is entered in the catalog as the BACKUP-CLASS (most frequent backup) are exported.
BACKUP-CLASS = *B
Only the files for which the value B is entered in the catalog as the BACKUP-CLASS are exported.
BACKUP-CLASS = *C
Only the files for which the value C is entered in the catalog as the BACKUP-CLASS are exported.
BACKUP-CLASS = *D
Only the files for which the value D is entered in the catalog as the BACKUP-CLASS are exported.
BACKUP-CLASS = *E
Only the files for which the value E is entered in the catalog as the BACKUP-CLASS are exported.
BLOCK-CONTROL-INFO = ANY / list-poss(4): NONE / NO / WITHIN-DATA-BLOCK /
WITHIN-DATA-2K-BLOCK / WITHIN-DATA-4K-BLOCK / PAMKEY / NK / NK2 / NK4
The user can select files for export by their file format ( BLK-CONTR output field).
BLOCK-CONTROL-INFO = *ANY
The BLOCK-CONTROL entry is not to be used as a selection criterion.
BLOCK-CONTROL-INFO = *NONE
Only files for which no BLK-CNTRL value has been defined, i.e. files which have not yet been opened, are to be exported.
BLOCK-CONTROL-INFO = *NO
Only files which contain no block control field are to be exported.
BLOCK-CONTROL-INFO = *WITHIN-DATA-BLOCK
Only files which were created with BLOCK-CONTROL-INFO=WITHIN-DATA-BLOCK (i.e. files for which block control information is held in a block control field at the start and within the data block) are to be exported.
BLOCK-CONTROL-INFO = *WITHIN-DATA-2K-BLOCK
Only files which were created with BLOCK-CONTROL-INFO=WITHIN-DATA-2K-BLOCK (i.e. files for which block control information is located at the start of each 2K block) are to be exported.
BLOCK-CONTROL-INFO = *WITHIN-DATA-4K-BLOCK
Only files which were created with BLOCK-CONTROL-INFO=WITHIN-DATA-4K-BLOCK (i.e. files for which block control information is located at the start of each 4K block) are to be exported.
BLOCK-CONTROL-INFO = *PAMKEY
Only files which use a separate PAM key for the block control field (i.e the block control information is held in a separate key field, outside the PAM block) are to be exported.
BLOCK-CONTROL-INFO = *NK
Only the NK files are to be exported, i.e. files which can also be stored on NK volumes (NK2 and NK4).
BLOCK-CONTROL-INFO = *NK2
Only files which can also be stored on NK2 volumes (but not NK4 volumes) are to be exported.
BLOCK-CONTROL-INFO = *NK4
Only files which can also be stored on NK4 volumes are to be exported.
MIGRATE = *ANY / list-poss(2): *ALLOWED / *INHIBITED / *FORBIDDEN
The user can specify which files are to be processed by the EXPORT-FILE command by the migration entry in the catalog (see the CREATE-FILE command, MIGRATE operand).
MIGRATE = *ANY
The specified files are to be exported, irrespective of the value in the MIGRATE operand in each of their catalog entries.
MIGRATE = *ALLOWED
Only files for which the catalog entry specifies the appropriate operand value, i.e. files which may be migrated to storage levels S1 and S2, are to be exported.
MIGRATE = *INHIBITED
Only files for which the catalog entry specifies the appropriate operand value, i.e. files which may not be migrated, are to be processed.
MIGRATE = *FORBIDDEN
Only files for which the catalog entry specifies the appropriate operand value are to be exported, i.e. files for which an intensified migration lock is declared. The files may not even be migrated for a brief period (e.g. for reorganization purposes).
STATUS = *ANY / *PARAMETERS(...)
The current file status is used as a selection criterion.
STATUS = *ANY
The file status is not to be used as a selection criterion.
STATUS = *PARAMETERS(...)
Only the files which have the specified status are selected for export. The following selection criteria are possible:
CLOSED-OUTPUT = *ANY / *YES / *NO
Specifies whether the “file closed” status is to be used as a selection criterion.
CLOSED-OUTPUT = *YES
Only the files which have already been closed are exported.
CLOSED-OUTPUT = *NO
Only the output files which have been opened in a program (OPEN OUTIN, INOUT or OUTPUT) and files which were not closed in an earlier system run or because a job was aborted are selected for export.
REPAIR-NEEDED = *ANY / *YES
Specifies whether files which were not closed in an earlier system run and not reconstructed with REPAIR-DISK-FILES are to be selected.
REPAIR-NEEDED = *ANY
Exports files regardless of whether they need to be repaired.
REPAIR-NEEDED = *YES
Only the files which were not closed in an earlier system run and which have not yet been reconstructed are selected for export.
BASIC-ACL = *ANY / *NONE / *YES / *PARAMETERS(...)
The BASIC-ACL entry in the file catalog is used as a selection criterion.
BASIC-ACL = *ANY
The BASIC-ACL entry is not to be used as a selection criterion.
BASIC-ACL = *NONE
Only the files that have no BASIC-ACL entry in the catalog are to be exported.
BASIC-ACL = *YES
Only the files which have a BASIC-ACL entry in the catalog are to be exported.
BASIC-ACL = *PARAMETERS(...)
Only the files which have the specified BASIC-ACL entry in the catalog are to be exported. NO-ACCESS means that no access rights were granted.
OWNER = *ANY / *NO-ACCESS / *PARAMETERS(...)
Specifies which access rights must already be defined for the owner.
OWNER = *PARAMETERS(...)
Access rights that must be present for the owner (logically ORed together):
READ = *ANY / *NO / *YES
Specifies whether read access authorization must be present.
WRITE = *ANY / *NO / *YES
Specifies whether write access authorization must be present.
EXEC = *ANY / *NO / *YES
Specifies whether execute access authorization must be present.
GROUP = *ANY / *NO-ACCESS / *PARAMETERS(...)
Specifies which access rights should already be defined for the owner’s user group.
GROUP = *PARAMETERS(...)
Access rights that must be present for the owner’s user group (logically ORed together):
READ = *ANY / *NO / *YES
Specifies whether read access authorization must be present.
WRITE = *ANY / *NO / *YES
Specifies whether write access authorization must be present.
EXEC = *ANY / *NO / *YES
Specifies whether execute access authorization must be present.
OTHERS = *ANY / *NO-ACCESS / *PARAMETERS(...)
Specifies which access rights should already be defined for all other users.
OTHERS = *PARAMETERS(...)
Access rights that must be present for all other users (logically ORed together):
READ = *ANY / *NO / *YES
Specifies whether read access authorization must be present.
WRITE = *ANY / *NO / *YES
Specifies whether write access authorization must be present.
EXEC = *ANY / *NO / *YES
Specifies whether execute access authorization must be present.
PROTECTION-ACTIVE = *ANY / list-poss(3): *LEVEL-0 / *LEVEL-1
The highest activated access control method (protection level) is used as a selection criterion. Only the files which have access protection at specified protection level are exported. Protection level 2 cannot be explicitly specified for EXPORT-FILE.
When the file is accessed, the highest activated protection level applies. The following table shows the method used for access control, the protection attributes, and the job variable protection hierarchy (protection levels):
Access control | Protection attribute | Prot. level |
|---|---|---|
Standard access control | ACCESS and USER-ACCESS | 0 |
Basic access control list | BASIC-ACL | 1 |
Access control via guards | PASSWORD | 2 |
All other protection attributes of the file (e.g. passwords) are evaluated independently, without regard to the implemented protection level.
PROTECTION-ACTIVE = *ANY
The access control method is not to be used as a selection criterion.
PROTECTION-ACTIVE = *LEVEL-0
Only the files for which access is controlled via standard access control are to be exported.
PROTECTION-ACTIVE = *LEVEL-1
Only the files for which access is controlled via a basic access control list (BASIC-ACL protection) are to be exported.
ACCESS-COUNTER = *ANY / <integer 0..2147483647> / *INTERVAL(...)
The access counter for the file is used as a selection criterion (see the ACC-COUNT output field of the SHOW-FILE-ATTRIBUTES command).
ACCESS-COUNTER = *ANY
The access counter is not to be used as a selection criterion.
ACCESS-COUNTER = <integer 0..2147483647>
Only the files for which the access counter exactly matches the specified value are selected for export.
ACCESS-COUNTER = *INTERVAL(...)
Only the files for which the access counter lies in the specified value range which follows are to be exported.
FROM = 0 / <integer 0..2147483647>
Only those files for which the access counter >= the specified value are exported.
TO = 2147483647 / <integer 0..2147483647>
Only those files for which the access counter <= the specified value are exported.
HIGHEST-USED-PAGE = *ANY / <integer 0..2147483647> / *INTERVAL(...)
The number of PAM pages used serves as a selection criterion here, i.e. the last page pointer points to the specified page (see also the HIGH-US-PA output field of the SHOW-FILE-ATTRIBUTES command).
HIGHEST-USED-PAGE = *ANY
The number of PAM pages used is not used as a selection criterion.
HIGHEST-USED-PAGE = <integer 0..2147483647>
Only the files for which the specified number of PAM pages are used (i.e. files for which the last page pointer points to the specified page) are exported.
HIGHEST-USED-PAGE = *INTERVAL(...)
Exports only those files which use a number of pages that falls within the specified range.
FROM = 0 / <integer 0..2147483647>
Only the files in which the number of used pages >= the specified number are exported.
TO = 2147483647 / <integer 0..2147483647>
Only the files in which the number of used pages <= the specified number are exported.
TYPE-OF-FILES = *ANY / list-poss(2): *FILE / *PLAM-LIBRARY
Specifies whether files are to be selected on the basis of information specific to the file type. The files to be exported can be restricted to normal files or to PLAM libraries.
TYPE-OF-FILES = *ANY
Exports files without taking the file type into account.
TYPE-OF-FILES = *FILE
Only files are exported.
TYPE-OF-FILES = *PLAM-LIBRARY
Only PLAM libraries are exported.
DIALOG-CONTROL = *STD / *NO / *ERROR / *FILE-CHANGE / *MORE-THAN-ONE-FILE /
*CATALOG-CHANGE/ *USER-ID-CHANGE
Specifies whether and under what conditions a verification dialog is to be conducted with the user during the export process. A control dialog is only possible in dialog mode but, in this mode, may also be used in procedures. The only operand value that you can specify in batch mode is *STD or *NO.
The user can intervene with the following inputs:
Y: the specified file or file set will then be exported.
N: the specified file or file set will not be exported.
T: processing of the command will be terminated.
?: the possible responses will be listed, with an explanation of each.
In addition, the following options can be specified, separated by commas:
,CHECK = NO
The DIALOG-CONTROL mode will be changed to ‘*NO’.,CHECK = PVS
The DIALOG-CONTROL mode will be changed to ‘*CATALOG-CHANGE’.,CHECK = MULTIPLE
The DIALOG-CONTROL mode will be changed to ‘*MORE-THAN-ONE-FILE’.,CHECK = SINGLE
SINGLE The DIALOG-CONTROL mode will be changed to ‘*FILE-CHANGE’.,CHECK = ERROR
The DIALOG-CONTROL mode will be changed to ‘*ERROR’.,IGNORE = list-poss(3): RDPASS / WRPASS / EXPASS Only privileged users may make this specification. Specifies the type of password protection that is to be ignored on export. The specification only applies to a single file in the control dialog.
,PASSWORD = list-poss(3): <c-string 1..4> / <x-string 1..8> / <integer -2147483648..2147483647>
Enables password-protected files to be exported (maximum of 3 passwords). The specification only applies to a single file in the control dialog.
DIALOG-CONTROL = *STD
The default *STD setting is equivalent to *MORE-THAN-ONE-FILE in an interactive dialog (when SYSCMD is connected to the terminal) and to *NO in procedures and in batch mode.
DIALOG-CONTROL = *NO
The user cannot intervene in EXPORT-FILE processing; all the specified files will be exported (without a verification dialog).
DIALOG-CONTROL = *ERROR
If exporting of the selected files proceeds without error, they will be exported immediately, as when *NO is specified (i.e. no verification dialog). However, if a user-correctable error occurs during export, then a verification dialog takes place as for DIALOG-CONTROL = *FILE-CHANGE. DIALOG-CONTROL = *ERROR applies implicitly if DIALOG-CONTROL = *FILE-CHANGE is set. In the event of an error, the user may acknowledge the error message, abort EXPORT-FILE processing or attempt to rectify the error. If he wishes, he can also change the DIALOG-CONTROL mode (see also the possible forms of intervention listed under the first DIALOG-CONTROL operand).
DIALOG-CONTROL = *FILE-CHANGE
For each file which is to be exported, the user has the intervention options described for the first of the DIALOG-CONTROL operands. For each file which is to be processed, the user can decide interactively whether it should be exported or not (response: YES/NO). If in the verification dialog he specifies protection attributes under “IGNORE”, or one or more passwords under “PASSWORD”, these will be taken into account for any selected file and, if satisfied, the file will be exported without further queries (“YES” must also be specified). The user can also abort EXPORT-FILE processing, or change the DIALOG-CONTROL mode.
The files which have been exported will be listed in alphanumeric order.
DIALOG-CONTROL = *MORE-THAN-ONE-FILE
If exactly one file is specified, this will be exported immediately. If the file is specified in partially qualified form, which means that more than one file is selected, or if the file name contains wildcards, the user can decide, each time the catalog ID changes, whether files from the new catalog are to be exported (see the intervention options described for the first of the DIALOG-CONTROL operands). He must respond to the question issued by the system with “YES” or “NO”. DIALOG-CONTROL=*MORE-THAN-ONE-FILE is useful if wildcards are specified for “catid” in the FILE-NAME. In the verification dialog, EXPORT-FILE processing can be terminated, or the DIALOG-CONTROL mode can be changed.
DIALOG-CONTROL = *CATALOG-CHANGE
As with DIALOG-CONTROL = *MORE-THAN-ONE-FILE, the EXPORT-FILE processing routine branches to a verification dialog if files in different catalogs (pubsets) are affected. The user can determine whether the files in the current pubset should be exported (YES/NO), EXPORT-FILE processing should be terminated, or the DIALOG-CONTROL mode should be changed.
DIALOG-CONTROL = *USER-ID-CHANGE
Whenever the user ID is changed when deleting the catalog entries, a branch is made to guided dialog.
OUTPUT = *STD / *NO / *SYSOUT
The user can specify whether a message (DMS0800) with the name of the exported file is to be output to SYSOUT for each successfully exported file. The default setting *STD is equivalent to OUTPUT=*NO.
OUTPUT = *NO
No messages are output to SYSOUT for successfully exported files.
OUTPUT = *SYSOUT
For each file that is successfully exported, a message with the name of the file is output to SYSOUT.
IGNORE-PROTECTION = *NONE / list-poss(3): *WRITE-PASSWORD /
*READ-PASSWORD / *EXEC-PASSWORD
Only privileged users may enter operand values other than *NONE. Systems support may specify that password protection is to be ignored. The specification IGNORE-PROTECTION in the EXPORT-FILE command thus makes it unnecessary to issue MODIFY-FILE-ATTRIBUTES commands to reset the protection attributes before the files can be exported.
IGNORE-PROTECTION = *WRITE-PASSWORD
System support staff are authorized to ignore the protection attribute write password when deleting the catalog entry.
IGNORE-PROTECTION = *READ-PASSWORD
System support staff are authorized to ignore the protection attribute read password when deleting the catalog entry.
IGNORE-PROTECTION = *EXEC-PASSWORD
System support staff are authorized to ignore the protection attribute execute password when deleting the catalog entry.
PASSWORDS-TO-IGNORE = *NONE / *SECRET / list-poss(3): <x-string 1..8> / <c-string 1..4> /
<integer -2147483648..2147483647>
The user can specify one or more passwords, which will permit files protected by these passwords to be exported. The passwords entered here are not recorded in the password table for the job, and are valid only for the current EXPORT-FILE processing. Up to 3 passwords may be specified in the form of a list.
In order to export a password-protected file, the password at the highest access level must be specified (see the ADD-PASSWORD command).
The operand has the following special characteristics:
The password entered is not logged.
The input field is automatically blanked out in the guided dialog.
In unguided dialog and foreground procedures, the entry *SECRET or ^, SDF provides a blanked out input field for inputting the password.
PASSWORDS-TO-IGNORE = *NONE
No passwords are specified.
SUPPRESS-ERRORS = *NONE / list-poss(3): <alphanum-name 7..7>
In procedures, the user can specify whether the spin-off mechanism or SDF-P error handling is to be triggered every time an error occurs (apart from syntax errors), or whether specific error conditions are to be ignored.
SUPPRESS-ERRORS = *NONE
All errors will trigger the spin-off mechanism or SDF-P error handling.
SUPPRESS-ERRORS = list-poss(3): <alphanum-name 7..7>
The user can define which errors are to be ignored by means of their DMS error codes (alphanum-name 7..7). If the specified error occurs, the spin-off mechanism will not be triggered. A maximum of 3 error codes may be specified.
DMS error code: 7 characters, of which the first three are always “DMS”; the last 4 characters identify the error; the digits 0..9 and letters A..F are permitted. When error codes are entered, no check is made to verify that valid error codes have been specified.
A detailed list of valid DMS error codes can be found on the manual server (URL: http://bs2manuals.ts.fujitsu.com ) by means of an HTML application and on the “BS2000 SoftBooks” DVD.
Return codes
(SC2) | SC1 | Maincode | Meaning |
|---|---|---|---|
0 | CMD0001 | Command executed | |
1 | 0 | CMD0001 | No action required |
2 | 0 | DMS05F7 | File generation does not exist, but group entry is updated |
2 | 0 | DMS06D6 | Error on deleting certain files |
1 | CMD0202 | Syntax or semantic error in command | |
32 | DMS0584 | A state that does not allow the function to continue was reported during processing | |
64 | CMD0102 | Interrupted by K2 key | |
64 | CMD0216 | Privilege errors | |
64 | DMS0501 | Requested catalog not available | |
64 | DMS0512 | Requested catalog not found | |
64 | DMS051B | Requested user ID not in pubset | |
64 | DMS051C | User not authorized to access pubset | |
64 | DMS0535 | Specified file not shareable | |
64 | DMS055C | The catalog entry could not be found on the assigned volume | |
64 | DMS057B | Invalid operand for migrated file | |
64 | DMS057C | Processing not possible due to HSMS error | |
64 | DMS057D | File has been migrated and cannot be recalled without delay | |
64 | DMS057E | File has been migrated, and HSMS is not available | |
64 | DMS0585 | Error detected when processing catalog or multiprocessor system | |
64 | DMS0586 | It is not possible to access or reserve a volume at present | |
64 | DMS0587 | Use of the specified command has been restricted by the system administrator | |
64 | DMS05C9 | Only files on private volumes or files on Net-Storage volume of the NETSTOR type can be exported | |
64 | DMS05FC | Specified user ID not in HOME pubset | |
64 | DMS0609 | Access to system file not permitted | |
64 | DMS06FF | BCAM connection severed | |
130 | DMS0524 | System address space exhausted | |
130 | DMS0582 | File is currently locked or being used and cannot be processed | |
130 | DMS0585 | Error detected when processing catalog or multiprocessor system | |
130 | DMS0586 | It is not possible to access or reserve a volume at present | |
130 | DMS0594 | Not enough virtual memory available |
Examples
For examples of using the EXPORT-FILE command see the IMPORT-FILE command.
Notes
If a file that is stored on a private disk or a Net-Storage volume is to be exported, then the device on which this disk is mounted will be requested for the job. After deletion of the file, the device will be returned to the system.
For files stored on private disks, if OPTION=*DESTROY-ALL or MOUNT=*ALL-DISK is specified then all the volumes which hold the file must be already mounted at the time the command is executed. Otherwise, only the first volume which holds the file has to be mounted. The following volumes will not be requested until the command is being executed.
This rule also applies if a partially qualified file name is specified in the DELETE-FILE command, thus addressing a number of files. In this situation, it is not necessary that all the volumes for all the files are mounted simultaneously. The system will determine which of the files requires the most devices and will request the corresponding number of devices.