FILECOPY Options

Certain options can be specified with the file specifications to indicate how the FILECOPY should be run.

Syntax

<option>

  ┌◄────────────────────────────────────────────────────────┐
  │                           ┌◄──── , ────┐                │
──┴─┬─ EXCLUDE ─┬─ FILEKIND( ─┴─<filekind>─┴──────────────┬─┴──────────┤
    ├─ INCLUDE ─┘                                         │
    ├─ INDEXLABEL ─┬─<file title>─────────────────────────┤
    ├─ DECKLABEL ──┤                                      │
    ├─ JOBNAME ────┘                                      │
    │                  ┌◄──────────── , ────────────┐     │
    ├─ PARTITION ── ( ─┴─ <letter><hyphen><letter> ─┴─ ) ─┤
    ├─ BACKUP ────────────────────────────────────────────┤
    ├─ CLASS ──<integer>──────────────────────────────────┤
    ├─ COMPARE ───────────────────────────────────────────┤
    ├─ DSONERROR ─────────────────────────────────────────┤
    ├─ JOBSUMMARY ────────────────────────────────────────┤
    ├─ JOBSYMBOL ─────────────────────────────────────────┤
    ├─ LOCKDECK ──────────────────────────────────────────┤
    ├─ LOCKINDEX ─────────────────────────────────────────┤
    ├─ NOCOPY ────────────────────────────────────────────┤
    ├─ NOSUMMARY ─────────────────────────────────────────┤
    ├─ NOZIP ─────────────────────────────────────────────┤
    ├─ REPORT ────────────────────────────────────────────┤
    ├─ SFACTORZERO ───────────────────────────────────────┤
    ├─ SKIPEXCLUSIVE ─────────────────────────────────────┤
    ├─ SKIPINUSE ─────────────────────────────────────────┤
    ├─ SYNTAX ────────────────────────────────────────────┤
    ├─ TASKFAULT ─────────────────────────────────────────┤
    ├─ VERIFY ────────────────────────────────────────────┤
    ├─ WAITONERROR ───────────────────────────────────────┤
    └─ WRAPLABEL ──<container prefix>─────────────────────┘

<filekind>

Any FILEKIND attribute defined in the File Attributes Reference Manual.

Explanation

FILECOPY Options lists the various FILECOPY options and their explanations or descriptions.

Table 28. FILECOPY Options

Option

Description or Explanation

EXCLUDE FILEKIND (<filekind>)

Prevents files from being copied based on their FILEKIND values (CODE, DATA, and so forth). You can also exclude files by name in an EXCLUDE list in the file specifications. You cannot use both kinds of EXCLUDE options in the same EXCLUDE statement, although each can appear alone several times in the following form:

EXCLUDE <file name> EXCLUDE FILEKIND(<filekind>)

If a file is in an EXCLUDE list, either by name or by FILEKIND value, but is explicitly included by name, the file is copied.

The EXCLUDE FILEKIND and INCLUDE FILEKIND options are mutually exclusive.

INCLUDE FILEKIND (<filekind>)

Causes files to be copied based on their FILEKIND values (that is, ALGOLCODE, DATA, and so on).

If you specify the INCLUDE FILEKIND option, only files of the specified kind are included, unless the file is explicitly included by name.

The INCLUDE FILEKIND and EXCLUDE FILEKIND options are mutually exclusive.

INDEXLABEL <file title>

Names the index file. The default name of the index file is INDEX/<identifier>, where the identifier is the name of the medium to which the files are to be copied. FILECOPY creates the index file only if you request LOCKINDEX. This file is a complete list of all files that meet the testing criteria of the task or have been processed by the INCLUDE command. The format of the index file is shown under “Index Files” later in this section.

DECKLABEL <file title>

Specifies the file title of the output WFL job. The default title of the file is T<n>OUTPUT, where <n> is the number of the task, such as T1OUTPUT or T3OUTPUT.

JOBNAME <file title>

Specifies the job title of the output WFL job. The default name is COPY. It is recommended that you set both JOBNAME and DECKLABEL to the same value if both options are used.

PARTITION <letter> –<letter>

Allows the files copied to be divided by volume based on the first character of the file name. FILECOPY uses ranges specified by <letter>–<letter> as test points. When the first character of a file name crosses a partition boundary, FILECOPY reflects this crossing by sending the copy to the current volume and starting a new copy statement to a new volume, but with the same KIND attribute value. Also, if an index file is being generated, FILECOPY closes and locks the file and then opens a new index file to handle the next partition.

The partition bounds are appended to the destination tape and index disk file title (either explicitly specified or assumed by default). For example, if the partition is A–H, the LABEL value is AHCREATED and the index filename is INDEX/CREATED/AH. A single-character partition such as P–P is valid. Partitions must not overlap in any way. Any unspecified partitions are interpolated: If you specify A–H,Q–T, FILECOPY assumes A–H,I–P,Q–T,U–Z. Files that start with special characters are placed in the first partition, while those starting with numbers are placed in the last.

BACKUP

On a cataloging system, causes library maintenance to store the backup information for any cataloged files. The volume library must list the destination disk or tape for the copied information.

CLASS <integer>

Specifies the CLASS of the WFL job. If you do not specify the CLASS option, the WFL job inherits the class of the FILECOPY that created it. The integer value must be within the range 0 through 1023.

COMPARE

Causes library maintenance option to compare each file after it is copied.

DSONERROR

Causes library maintenance to terminate if any irrecoverable errors occur during the copy operation. Library maintenance also terminates if any of the files to be copied are not resident on disk.

JOBSUMMARY

Adds a JOBSUMMARY = UNCONDITIONAL; statement to the task output WFL deck.

JOBSYMBOL

Causes the FILEKIND value of the WFL deck created by LOCKDECK to be JOBSYMBOL. The default FILEKIND value for the WFL deck is DATA unless you specified a BETWEEN<timestamp>–<timestamp> clause in your request, in which case the default FILEKIND for the WFL deck is JOBSYMBOL.

LOCKDECK

Locks the WFL deck on disk for future use. If you specify the LOCKDECK option, FILECOPY starts the WFL deck and leaves the WFL job file on disk. This feature permits FILECOPY to generate a WFL job that you can modify, use, and reuse. Refer also to the NOZIP option.

LOCKINDEX

Creates and locks an index file.

NOCOPY

Omits the COPY statement from the generated WFL job. If you specify the NOCOPY option along with the REMOVE option, FILECOPY removes the selected files without first copying them. NOCOPY is not allowed in a task that uses the PARTITION option.

NOSUMMARY

Suppresses the summary listing of the FILECOPY run.

NOZIP

Creates a WFL job but does not start it. You should use this option only in conjunction with the LOCKDECK option.

REMOVE

Causes the output WFL job to remove the copied files from disk as soon as the copy is complete. The operator must OK the removal before it takes place.

REPORT

Causes library maintenance to print a report of the success or failure of each file copied.

SFACTORZERO

Only valid for the EXPIRED task request. When you specify SFACTORZERO, FILECOPY uses the zero SAVEFACTOR value of a file, rather than the modifier SAVECONSTANT, for all files having a SAVEFACTOR value of zero.

SKIPEXCLUSIVE

Causes library maintenance to not copy files that are opened with EXCLUSIVE = TRUE or are KEYEDIOII files marked as being updated.

SKIPINUSE

Omits in-use files from the file selection criteria. SKIPINUSE applies only to the files selected by the FILES modifier. The INCLUDE modifier overrides the SKIPINUSE option. If a file is included because it is specified in an INCLUDE modifier, then the file is copied irrespective of whether it is in use or not. SKIPINUSE only affects files that are in-use at the time FILECOPY is run, not when the copy job is initiated.

SYNTAX

Causes FILECOPY to do syntax checking of only the input. If you use the SYNTAX option in any task request of a multitask FILECOPY run, all task requests stop after the input syntax checking completes.

TASKFAULT

Adds an ON TASKFAULT, GO TO <label> statement followed by the “<label>:” label to the output WFL deck prior to each COPY statement. Any abnormal termination, including operator use of the DS command, restarts the aborted COPY operation. The default value of this option is RESET.

VERIFY

Causes library maintenance to write checksum records on the tape for each file. After library maintenance has copied all the files to a tape, the tape rewinds, and library maintenance reads all the files on the tape to test their checksums. If the checksum does not match, library maintenance issues an error message and waits for the operator to reply to an RSVP message.

WAITONERROR

Causes library maintenance to wait for an operator to acknowledge an RSVP message if any irrecoverable errors occur during the copy operation. Library maintenance also waits for an operator acknowledgment if any of the files to be copied are not resident on disk.

WRAPLABEL <container prefix>

Causes FILECOPY to generate a WRAP statement. A suffix of “.CON” is added to the prefix specified, and the resulting name is used for the container title.