Previous Topic: How to Use the Console CommandNext Topic: Example JCL


How to Use the DBUTLTY Command

Multi-User mode is required to execute this command. Execute the COMM function with the following command format:

Close a Full Database

                       ┌──────────────────┐
►►─ COMM OPTION=CLOSE ─▼─┬──────────────┬─┴─┬──────────────────────┬──────────►◄
                         └─ ,DBID=nnnn ─┘   └─ ,IGN68= ─┬─ NO ◄ ─┬─┘
                                                        └─ YES ──┘

Close an Area in a Database

►►─ COMM OPTION=CLOSE,DBID=nnnn,AREA=name ─┬──────────────────────┬───────────►◄
                                           └─ ,IGN68= ─┬─ NO ◄ ─┬─┘
                                                       └─ YES ──┘

Command

COMM

Invokes the function to pass communication to the Multi-User Facility.

Required Keywords

OPTION=CLOSE

Requests database or area closure.

,AREA=name

Specifying AREA=name lets you close a single area. If you specify the AREA= keyword you must also specify the DBID= keyword.

Use the AREA= keyword when you need to initialize, load, or extend it through DBUTLTY, and the database is currently open.

For more information on area level DBUTLTY control, see Area Level DBUTLTY Control.

Valid Entries:

Valid area name

Default Value:

(No default)

,DBID=nnnn

At the area level, you must specify a single database ID.

Valid Entries:

One valid database ID

Default Value:

(No default)

Optional Keyword

,DBID=nnnn

At the database level, DBID= is optional and may repeat. Each occurrence may specify one or more valid database IDs or a range of DBIDs nnnn-mmmm (a range, for example, such as 100-250).

If DBID= is not specified, all databases are processed.

Every database specified by a DBID keyword is processed. Each database that is not defined generates an error and fails the function after all the databases are processed, except that a database in a range not defined is ignored.

If you request the closure of a particular database and that database is virtual or has an open URT, the command fails with a return code 46(1). If you request (by not specifying a particular DBID) the closure of all open databases, all that can be closed are closed. In addition to any closing, if any are virtual databases a warning message is issued, and if any are not virtual but have open URTs, a return code 46(1) is issued.

Valid Entries:

One or more valid database IDs or a range of DBIDs as already described.

Default Value:

ALL

IGN68=

Specify IGN68=YES to ignore a return code 68. IGN68= is allowed for every ACCESS and COMM function. By ignoring return code 68, you can set up and run JCL that incorporates a stack of DBUTLTY functions without requiring that the MUF be enabled. IGN68= would therefore be useful, for example, if you wanted to load a database without first enabling the MUF, perhaps to allow restart to properly occur. Following is an example showing a stack of DBUTLTY functions that use IGN68=.

 ACCESS STATUS=UTLTY,DBID=997,USERS=WAIT,IGN68=YES
 COMM   OPTION=CLOSE,DBID=997,IGN68=YES
 INIT   AREA=IXX,DBID=997
 INIT   AREA=A01,DBID=997
 LOAD   AREA=A01,DBID=997,FORMAT=NONE,KBYTES=9999,SORT=1
 ACCESS STATUS=WRITE,DBID=997,IGN68=YES

Note: If the CXX is externally secured, the INIT and LOAD functions do not execute without the MUF being available, and IGN68=YES is therefore not recommended.

A function or functions specified with IGN68=YES generates message DB13001E to note that the function did not occur. Because no error was recognized, however, other functions in the stack continue to execute, and the DBUTLTY step ends without a recognizable error. Message DB13001E signals that the MUF was not enabled For details about DB13001E, see the CA Datacom/DB Message Reference Guide.

Valid Entries:

NO or YES

Default Value:

NO