File maintenance utility commands
The section covers the following topics:
- Command format
- Syntax notation for file maintenance utility commands
- The commands
Command format
The basic format of a CICS BAC file maintenance utility input command is as
follows:
COMMAND NAME Parameter1(value1),Parameter2(value2),...,Parametern(valuen)
The rules for coding commands are
as follows:
- The command line is restricted to column positions 1 to 71 inclusive
- You indicate that a parameter string continues on the next line
by specifying any non-blank character in column
72.
- The command name must be the first non-blank word on the line,
and it must be followed by one or more spaces.
- You follow the command name with one or more parameter(value) strings (or none).
- You can abbreviate parameters and enumerated parameter values
(such as "OPEN" and "CLOSED") to their shortest
unique string. However, CICS BAC does not guarantee that an abbreviation
that is valid in this release will be valid in a future release. Therefore,
you should consider using abbreviations that are not the shortest
abbreviation possible for a parameter.
- If you specify more than one parameter string they must be separated
by a comma.
- Some parameters are optional, and others are required.
- If you omit an optional parameter, that parameter is not used
in the command.
- You pass your commands to the CICS BAC file maintenance utility in a data set with
the DDNAME CBKIN.
- The order in which command parameters are shown in the
syntax diagrams in this chapter does not imply a required sequence.
You can order the parameters within a command in any sequence.
The above rules are explained in further detail, as appropriate,
in the description of each command. The commands provided by CICS BAC are:
Syntax notation for file maintenance utility commands
The syntax for each file maintenance utility input command is presented in the form
of a diagram, commonly referred to as a railroad
diagram. The syntax, which is interpreted by following the dashed
lines and arrows from left to right, and top to bottom, is described
in the following table.
Symbol |
Meaning |
>>-----A-----><
|
A required parameter that you must provide. |
>>-----A-----><
+-B-+
+-C-+
|
A set of alternative parameters, one of which
you must provide |
+-A-+
>>-----------><
+-B-+
+-C-+
|
A set of optional parameters, where A is the
default. You may provide only one of these options. |
>>-----------><
+-A-+
+-B-+
|
A set of optional parameters. None are required,
and there is no default. You may provide only one of these. |
>>-- Name +-><
Name:
>>--A----B---->
|
Denotes a named section provided elsewhere in
the command syntax. |
Punctuation and upper case characters
|
Code exactly as documented. |
Lowercase, italicized characters
|
Requires you to code your own text to replace
these fields. |
Generic character usage
The command syntax for the file maintenance utility supports the
use of a generic character, which you can use in the following commands:
- In the DELETE objecttype(objname)
command, objname can contain generic characters
- On any of the REMOVExxxx parameters of
the various objects.
- FILE and TDQUEUE objects have the REMOVETRANSIDS and REMOVEPROGRAMS
parameters
- APPGROUP object has the REMOVEFILES, REMOVETDQUEUES, REMOVETRANSIDS
and REMOVEPROGRAMS parameters.
All these named parameters accept generic characters in the name
operand.
The generic character is an * (asterisk), where an * matches none
or one or more characters. Thus * by itself means all names, so to
remove all the files from an application group, use REMOVEFILES(*).
Operand ab* matches anything beginning with the characters ab, such
as abc, abcde, and so on.
Omitting parameters from commands
Except for the REPLACE parameter on an ADD resource command
and the ADDIFNEW parameter on an UPDATE resource command,
none of the other parameters have defaults. If you omit a parameter
from an ADD resource or UPDATE resource command,
the file maintenance utility takes the value for a missing parameter as follows:
- If you omit a parameter from an ADD FILE, ADD PROGRAM, ADD TDQUEUE,
or ADD TRANSID command, the file maintenance utility derives the missing parameter value
from the $Default record on the CICS control file for the object type.
There is no action for ADD GROUP and ADD LIST commands because these
objects do not have a $Default record.
- If you omit a parameter from an UPDATE command, the value in the
existing record is unchanged.
The following sections describe all the commands that you can use
to maintain a CICS BAC VSAM control file using the file maintenance utility in a batch
job.