CICS region commands for CICS BAC
This section describes the syntax and purpose of the commands that
you can use to control the CICS® BAC component that runs in a CICS region. You enter these commands from a 3270 terminal connected
to a CICS region. The output destination for these commands
is the terminal from which you entered the command. For some of these
commands, the CICS BAC component also displays messages on the
system console.
The general format for CICS BAC request server commands is:
KBKM COMMAND,parm(value)
where
KBKM is the CICS BAC command processor transaction ID, COMMAND is one of the CICS BAC component commands; and parm(value) is
an optional parameter specified on the command. If a value is italicized,
it means that you can specify one of a range of values. If a value
is not italicized, you specify the value exactly as shown. The syntax
diagrams used for these commands is in the same form as the batch
request utility commands (see Syntax notation for batch request utility commands)
When you enter a KBKM command with a parameter, ensure
the parameter is separated from the command name by a comma or space.
DUMP
Purpose
Capture a CICS BAC component dump.
Format

DUMP
>>-DUMP--------------------------------------------------------><
Example: KBKM DUMP
Usage
Use the DUMP command to capture a dump of the CICS BAC component
data areas. The dump is directed to the current CICS dump
data set.
Note:
You might be asked to use this command to
assist a CICS BAC Technical Support representative with problem diagnosis.
There are no parameters on the DUMP command.
SHUTDOWN
Purpose
Shut down the CICS BAC component in the CICS region.
Format

SHUTDOWN
>>-SHUTDOWN----------------------------------------------------><
Example: KBKM SHUTDOWN
Usage
When you issue the SHUTDOWN command, from a CICS terminal,
the CICS BAC component in the region shuts down. When shutdown is completed,
the CICS region cannot service any batch request utility
or communication server requests. All resources are released, and
the CICS BAC global user exit programs are disabled.
Note:
Note:
The effect of SHUTDOWN command is as though the CICS BAC component
had never been started. To enable CICS BAC to resume accepting and processing
batch request utility and communication server requests, you must
restart the CICS BAC component.
There are no parameters on the SHUTDOWN command.
START
Purpose
Start the CICS BAC component in a CICS region.
Format

START
.-,CICSSTARTMODE(UPDATE)-.
>>-START--+------------------------+---------------------------->
'-,CICSSTARTMODE(SET)----'
.---,NODSN(CONTINUE)----------. .---,TRACESIZE(1000)---.
>--+-----------------------------+--+----------------------+---->
'---,NODSN(-+-CONTINUE--+-)---' '---,TRACESIZE(size)---'
+-PRIMARY---+
'-ALTERNATE-'
.---,TRACEOPTIONS(C0)--------.
>--+----------------------------+------------------------------><
'---,TRACEOPTIONS(flagbye)---'
Example: KBKM START,CICSSTARTMODE(SET)
Usage
Use this command to start the CICS BAC component in a CICS region. As soon as CICS BAC is active, the CICS region
can accept and process batch request utility and communication server
requests.
Note:
The KBKM START command is an alternative to starting CICS BAC using
the PLTPI program, CBKCMNDS (see
Using the CICS BAC PLTPI program for details).
If you use the PLT method, you can use the CICS system
initialization parameter INITPARM to provide the startup options.
Parameters
- CICSSTARTMODE({UPDATE | SET})
- Specifies the processing mode that to be used for the start
command.
- UPDATE
- Startup processing does not set the state of any resources during
startup processing. It updates the region control file only with the
current state of known resources.
This
is the default value only when you are using the KBKM START command.
When you start CICS BAC at region startup during PLTPI processing, the
default value for the CICSSTARTMODE parameter is SET.
- SET
- Startup processing reads the records of all resources defined
in the region control file and applies their last requested state
to the installed CICS resource definitions. As CICS BAC sets
each required state in the CICS region, it updates the region
control file with information indicating that the state has been set
in the CICS region.
Note:
Be aware when using
the SET option that starting CICS BAC after
control has been given to CICS could mean that some resources
are open and in use by CICS, contrary to their last requested
state in the CICS region control file. Using SET in these circumstances could have undesirable
consequences.
- NODSN({CONTINUE | PRIMARY
| ALTERNATE})
- Specifies the action taken by the CICS BAC request server when
it is about to attempt to open a file in the CICS region and the file
does not yet have a data set name associated with it. This can occur
either during startup processing or when processing a CICS BAC batch
request utility SET FILE command. Note that this parameter is ignored
if the file is currently allocated to the CICS region; for example,
if it is defined by a DD statement in the CICS region JCL.
- CONTINUE
- OPEN processing continues without attempting to alter the file
data set name beforehand. This typically results in an open failure
unless you use some other method to provide the data set name before
the operating system attempts to open the file.
- PRIMARY
- CICS BAC sets the file data set name, as part of the OPEN request,
to the primary data set name as specified in the CICS BAC control file
record for the file being opened. If the primary data set name is
blank, the OPEN request has the same result as if you had specified
CONTINUE.
- ALTERNATE
- CICS BAC sets the file data set name, as part of the OPEN request,
to the alternate data set name as specified in the CICS BAC control
file record for the file being opened. If the alternate data set name
is blank, the OPEN request has the same result as if you had specified
CONTINUE.
- TRACEOPTIONS({C0 | options})
- Specifies the types of trace entries you want CICS BAC to
create. There are eight trace entry types, each controlled by a single
bit in the TRACEOPTIONS hexadecimal byte flag. Specify this option
only at the direction of a Technical Support representative. For details
of the hexadecimal byte flag, see the TRACEOPTIONS parameter under Communication server runtime parameters
- C0
- The hexadecimal value C0 is the default trace setting.
- options
- Specify the hexadecimal byte flag that represents the type of
trace entries CICS BAC is to create, as directed by a Technical Support
representative.
- TRACESIZE({1000 | number-of-entries})
- Specifies the size of the trace table in terms of the number
of entries to be traced for diagnostic purposes. Change this value
only at the direction of Technical Support.
- 1000
- The default trace size.
- number
- Specify the trace table size as requested by Technical Support.
STATUS
Purpose
Display the current status of the CICS BAC component in the CICS region.
Format

STATUS
>>-STATUS------------------------------------------------------><
Example: KBKM STATUS
Usage
The CICS BAC component displays its response on the CICS terminal
at which you entered the STATUS command. The possible status values
displayed are:
- Active
- Shutting down
- Shut down
- Never started.
Additional information is displayed, depending on the status
of CICS BAC in the region.