Input Parameter Statements

Utility Programs › IDMSDBAN › Input Parameter Statements

Input Parameter Statements

IDMSDBAN processing is controlled by the following input parameter statements. If coded, the three types of statements must be coded in the order shown. If not coded, all reports are provided for all areas and sets for the named subschema or SQL-defined database.

Statement descriptions

Statement	Required/ Optional	Description
PROCESS	Required	For non SQL-defined database: Identifies subschema and DMCL module Specifies whether areas are to be locked before processing For SQL-defined database: Identifies that an SQL-defined database will be processed Specifies whether areas are to be locked before processing
REPORT	Optional	Controls generation of reports 2, 3, 4, and 5
AREA	Optional	Specifies area(s) to be processed
SET	Optional	Specifies set(s) or constraints and indexes to be processed

PROCESS statement

The PROCESS statement identifies the database to be processed and specifies whether areas are to be locked before processing begins. One PROCESS statement is required for each IDMSDBAN run.

Syntax

Code on one line only.

►►─ PROCESS ─┬─ SUBSCHEMA subschema-name subschema-specification ──────┬──────►
             └─ SQL ───────────────────────────────────────────────────┘

 ►─┬────────────┬─────────────────────────────────────────────────────────────►◄
   ├─ LOCKed ◄──┤
   └─ UNLocked ─┘

Expansion of subschema-specification

►►──┬──────────────────┬─┬────────────┬─┬──────────────┬──────────────────────►◄
    └─ DBNAME db-name ─┘ └─ OWNCHECK ─┘ └─ INComplete ─┘

Parameters

SUBSCHEMA subschema-name

Identifies the subschema containing the areas, sets, and records to be processed. The subschema must contain complete descriptions for all of its sets and records.

Note: When processing the DDLCAT and DDLCATX areas, you must use the SUBSCHEMA parameter and the IDMSCATZ subschema name.

When processing the DDLCATLOD area you must use the SUBSCHEMA parameter and the IDMSCATL subschema name.

DBNAME db-name:

Identifies the name of the database to bind to at run time. If no DBNAME is specified, the default is the DBNAME specified in the SYSIDMS parameter file.

OWNCHECK

Indicates that checks for ownerless loops in chained sets is to be performed. If this parameter is omitted, IDMSDBAN will not check for chained sets that form a loop but do not include an owner record occurrence.

Note: This check will increase the run time of the utility and may require that the allocation for the SYS002 file in the IDMSDBN2 step be increased.

INComplete

Specifies that the named subschema does not include all record types. INCOMPLETE suppresses messages that would otherwise appear for record types not included in the subschema.

SQL

Specifies that an SQL-defined database is to be processed.

Based upon the segments identified on the AREA statement and the sets or constraints identified on the SET statement, IDMSDBAN will build a subschema to process an SQL-defined database.

Note: When processing the DDLCAT and DDLCATX areas, you must use the SUBSCHEMA parameter and the IDMSCATZ subschema name.

When processing the DDLCATLOD area you must use the SUBSCHEMA parameter and the IDMSCATL subschema name.

LOCKed/UNLocked

Specifies whether IDMSDBAN is to lock the areas to be processed:

LOCKED (default) directs IDMSDBAN to lock the areas during IDMSDBN1 processing. When you specify LOCKED, the areas involved cannot be updated by another application during IDMSDBAN execution.
UNLOCKED directs IDMSDBAN not to lock the areas to be processed. When UNLOCKED is specified, the areas involved can be updated during IDMSDBAN execution.

REPORT statement

The optional REPORT statement controls the generation of reports 2, 3, 4, and 5. IDMSDBAN always generates reports 1 and 1A.

By default, if you do not supply a REPORT statement or if you supply a REPORT statement without any parameters, IDMSDBAN will generate all reports.

Syntax

Code on one line only.

►►─┬──────────────────────────────────────────────┬───────────────────────────►◄
   └─── REPORT ─┬─────────────────────────────┬───┘
                └─ report-number ─┬─────────┬─┘
                                  └─ TERSE ─┘

Parameters

report-number:

Specifies the number of the report to be generated. Valid report numbers are 1, 1A, 2, 3, 4, and 5.

If no REPORTS statement is coded or if a REPORTS statement is provided without any report numbers, all reports are generated.

TERSE

Applies to reports 3, 4, and 5 only, as follows:

TERSE causes report 3 to be produced only for sets that have at least one non-empty set occurrence.
TERSE causes report 4 to be produced only for record types with at least one occurrence in the database.
TERSE causes report 5 to be produced only for sets with at least one occurrence in the database.

AREA statement

The AREA statement specifies the areas to be processed. If no AREA statement is coded, all areas in the named subschema or segment are processed.

Syntax

Code on one line only.

►►─┬────────────────────────────────────────┬─────────────────────────────────►◄
   └─── AREAs ─┬─ ALL ◄────────────────┬────┘
               └─ area-specification ──┘

Expansion of area-specification

►►─┬─────────────────┬─ area-name ─┬───────────────────────────────┬──────────►◄
   └─ segment-name. ─┘             └─ PAGE start-page TO end-page ─┘

Parameters

AREAs

Specifies the area(s) to process.

ALL

Specifies that all areas included in the specified subschema are to be processed.

ALL is the default.

You cannot use the ALL option if SQL was selected on the PROCESS statement.

segment.:

For SQL-defined databases, identifies the name of the segment to be processed. You must specify segment-name if SQL was selected on the PROCESS statement.

When processing a non-SQL-defined database, do not specify segment-name.

Segment-name must be a 1 through 8-character value.

area-name:

Identifies the name of an area to be processed.

Area-name must be a 1 through 18-character value.

PAGE start-page-n TO end-page-n:

Specifies the range of pages to be processed within the named area. The specified page range must be included within the area page range.

By default, if you do not specify a page range, the entire area will be processed.

If you do specify a page range, be sure that the page range selected includes all database pages that can contain owner or member records of all sets to be processed. Otherwise, they won't be processed.

Start-page and end-page must contain numeric values and can be from 1 through 10-characters in length.

SET Statement

The SET statement specifies the sets, constraints, or indexes to be processed.

Syntax

Code on one line only.

►►───┬──────────────────┬────┬───────────────────────────────────────┬────────►◄
     └─┬─ SETs ───────┬─┘    ├─ ALL ◄──┬──────────┬─┬─────────┬──────┤
       ├─ CONSTRAINT ─┤      │         └─ NOCALC ─┘ └─ NOVLR ─┘      │
       └─ INDEX ──────┘      ├─ set-name ─┬────────────────────────┬─┤
                             │            └─ ON schema.table-id ───┘ │
                             ├─ CALC ────────────────────────────────┤
                             └─ VLR ─────────────────────────────────┘

Parameters

SETs/CONSTRAINT/INDEX

Identifies the sets, constraints, or indexes to process.

The keywords SET, CONSTRAINT, and INDEX are synonyms and can be used interchangeably.

All owners and members must be included in the area to be analyzed and page ranges must be identified in the AREA statement or no sets or constraints are processed.

ALL

Indicates that all of the following sets associated with a specified subschema or segment are to be processed for either a non-SQL or SQL-defined database:

All chained and indexed sets defined in the subschema specified in the PROCESS statement
All constraints within the specified segment
The CALC set
Sets of variable-length record fragments located within the areas specified in the AREA statements

ALL is the default.

NOCALC

Removes the CALC set from the list of sets specified by ALL.

NOVLR

Removes the set of variable length record chains from the list of sets specified by ALL.

set-name:

Identifies the name of a set to be processed.

ON schema.table-id:

If SQL was specified on the PROCESS statement, you must identify the name of the SQL schema and table identifier the constraint or index is associated with. You do not specify a schema.table-id for non-SQL-defined databases. Schema is a 1 through 18-character value and table-id is a 1 through 18-character value.

CALC

Directs IDMSDBAN to process the CALC set within the specified area(s).

VLR

Directs IDMSDBAN to process all sets of variable-length record fragment chains located within the specified area(s).