DBUTLTY Reference

ddb provides a single utility that performs all operations for creating and maintaining your information base. The program name of the utility is DBUTLTY.
datacom151
Datacom/DB
provides a single utility that performs all operations for creating and maintaining your information base. The program name of the utility is DBUTLTY.
This section contains an overview of the DBUTLTY operation and details of its command syntax. The DBUTLTY functions are presented in alphabetical order. Where a console command can be used to execute the function, the syntax for the
Datacom/DB
portion of the console command is also provided.
Following the syntax information for each function is a guideline for the JCL to execute the function. Sample reports are also included with an explanation of the content of each report.
Security considerations for DBUTLTY include the following:
  • If you are using external security with
    Datacom/DB
    , you must have program authorization for the DBUTLTY function and the appropriate access authorization for the database resources being accessed by the DBUTLTY function.
  • In z/OS environments the Multi-User Facility (MUF) and the
    Datacom/DB
    Utility (DBUTLTY) must run authorized. The MUF is authorized when all JOBLIB/STEPLIBs are authorized. DBUTLTY can run some of the functions not APF authorized, but the intent of DBUTLTY is to run authorized.
The following topics are discussed on this page:
Audience
This section is primarily intended for Database Administrators and systems programmers responsible for:
  • Administering the operations of the
    Datacom
    and
    Ideal for Datacom
    system
  • Maintaining data integrity and accessibility
  • Installing and supporting the CA system software
  • Managing and implementing definitions
  • Performing routine maintenance tasks
Multiple Commands
You can usually perform more than one function with a single execution of DBUTLTY. Multiple commands can usually be in any order. Those functions that must be run alone are ACCT OPTION=CATALOG, ACCT OPTION=EDIT, DBTEST, and the MASSADD functions.
Prerequisite Commands
Some commands, such as DBTEST and RECOVERY, have prerequisite commands which set up the environment for them.
Syntax Check
To check the syntax of your commands, place the EDIT command first in the command stream. EDIT validates those commands that follow for syntax errors but does not execute the commands.
Messages
Every DBUTLTY execution produces a listing that contains the command exactly as entered followed by an alphabetic listing of all keywords and values entered, (except if DDOVER= is found on the statement, the data after the = (equal sign) is set to blanks to the next blank or comma). If you omitted a required keyword, that keyword prints with dashes indicating the maximum length of the keyword value and an error message. When multiple errors exist for one keyword parameter, only one error is displayed.
You also receive messages that explain any operational errors or provide explanatory information. Any error normally terminates execution of the utility immediately. However, the EDIT syntax check function scans all input data and displays all errors found during basic editing.
Some edit errors are found in later editing and are not found with the EDIT function.
JCL Requirements for z/OS
If snapping is necessary,
Datacom/DB
looks for a DD statement with a name of SNAPER. If it is not provided,
Datacom/DB
dynamically allocates a DD statement for SNAPER with the value SYSOUT=*. Unless you want a specific SYSOUT class or other options, do not provide the DD statement.
Datacom/DB
also dynamically allocates a SYSPRINT DD statement when needed if you do not provide it. The SYSPRINT DCB BLKSIZE and LRECL defaulted or are set based upon the DBSIDPR module assembled with the DBSYSID macro with keyword LINE=NEW or LINE=OLD. With LINE=NEW (the default) the BLKSIZE defaults to 0 if not set and the LRECL defaults to 133 if not set. With LINE=OLD, the BLKSIZE defaults to 121 if not set and the LRECL is set to 121, overriding any value provided. With LINE=OLD, if you specify a different block size in the JCL, it must be a multiple of 121. The exception to this is the COMM OPTION=SNAPCSA. This utility requires the SNAPER DD statement. During certain errors or on request, DBUTLTY can direct an address space snap to DD statement SNAPAS
nn
, where
nn
is a sequential number such as 01.
The DBUTLTY parameters, PGMDT and PGMMONTH, produce DB00248I messages in the job log for load modules used by the DBUTLTY program. CA recommends that you use these parameters to identify the assemble date, release level, and current PTF applied for individual modules.
  • The PGMDT parameter accepts a value in the format
    ccyymmdd
    and causes the DB00248I messages to be produced as a module is loaded into memory by DBUTLTY for the first time. This will happen only if the assemble date of the module is on or after the PGMDT specified.
  • The PGMMONTH parameter accepts only the value of 1 and causes DB00248I messages to be produced for modules loaded into DBUTLTY memory with an assemble date on or after the date of one month prior to the current date. The PGMMONTH value is converted and stored internally as a PGMDT value.
Example
EXEC PGM=DBUTLTY,REGION=0M,PARM='PGMDT=20160226' - or - EXEC PGM=DBUTLTY,REGION=0M,PARM='PGMMONTH=1'
Note:
The value 1 is not a variable. Only PGMMONTH=1 is valid.
Requirement to Run APF-Authorized, z/OS
We recommend (and DBUTLTY always expects to be) running authorized.
Certain DBUTLTY functions require that the job run APF-authorized. See the documentation on the individual functions to know if it requires APF-authorization.