Statements

Utility Programs › IDMSRPTS › Statements

Statements

Statement descriptions

IDMSRPTS utility processing is controlled by the input statements listed in the following table.

Note: When specifying multiple input statements (other than SIGNON and REPORTS SELECTION), you must specify them in the order listed in the following table.

Statement	Description
SIGNON USER	Identifies the user running IDMSRPTS.
SCHEMA	Specifies the schema(s) to report on.
SUBSCHEMA	Specifies the subschema(s) to report on.
DMCL	Specifies the DMCL(s) to report on.
SEGMENT	Specifies the segment(s) to report on.
DBTABLE	Specifies the database name table(s) to report on.
REPORTS SELECTION	Specifies the report(s) to generate.

SIGNON USER statement

The SIGNON USER statement is provided to override the external user ID for IDD security checking at IDD signon and for entity type and entity occurrence levels for reports other than physical database definition reports.

Note: Your external user ID (from the job card) is always used for physical database definition security checking.

If you do not specify a SIGNON USER statement, your external user ID is also used for IDD security checking.

Use the SIGNON USER statement, specifying the user ID and password of an authorized user, if your external user ID is:

Not defined in the dictionary and IDD SIGNON IS ON
Is defined in the dictionary but does not have authority to sign on or access the entity-types and occurrences on which you wish to report

If the IDD USER SIGNON OVERRIDE option does not allow signon override, and the external user ID is different from the SIGNON user ID, CA IDMS/DB ignores the SIGNON user ID for all IDD security checking.

If the dictionary is unsecured, you do not need to specify either a user ID or a password.

Syntax

►►──┬──────────────────────────────────────────────────┬──────────────────────►
    └─ SIGnon USEr user-id ─┬────────────────────────┬─┘
                            └─ PASsword = password ──┘

Parameters

user-id

Identifies a user in the dictionary.

PASsword = password

Specifies the password assigned to the user in the data dictionary.

A password must be provided if a SIGNON statement has been processed, and the specified user ID is not the same as the external user ID and has been assigned a password in the dictionary.

SCHEMA statement

The SCHEMA statement identifies the schema(s) to report on.

A schema statement is required if the reports selection includes any of the following:

SCHRPT
AREALST
PGMLIST
RECDES
SETDES

Authorization

The identified user must hold authority for:

IDD SIGNON if IDD SIGNON is secured and
DISPLAY or higher if IDMS is secured and
DISPLAY or higher on named schema(s) if PUBLIC ACCESS for the occurrence is NONE

Syntax

 ►─┬────────────────────────────────────────────────┬─────────────────────────►
   └─ SCHema ─┬─────┬─┬─ schema-name ─────────────┬─┘
              └─ = ─┘ │     ┌────── , ──────┐     │
                      ├─ ( ─▼─ schema-name ─┴─ ) ─┤
                      └─ ALL ─────────────────────┘

 ►─┬────────────────────────────────────────────────────┬─────────────────────►
   └─ Version ─┬─────┬─┬─ version-number ─────────────┬─┘
               └─ = ─┘ │     ┌─────── , ────────┐     │
                       ├─ ( ─▼─ version-number ─┴─ ) ─┤
                       ├─ HIGhest  ◄──────────────────┤
                       └─ ALL ────────────────────────┘

Parameters

SCHema

Identifies the schema(s) for which specified schema-level reports are to be produced, and/or the schema(s) to which any specified subschema(s) are related.

schema-name

Specifies the name of a schema defined in the data dictionary. You can specify multiple occurrences of schema-name by enclosing them in parentheses and separating them with commas.

IDMSRPTS reports only on the named schema(s).

You can specify up to 25 schema names.

ALL

Directs IDMSRPTS to report on all schemas in the data dictionary.

Version

Specifies version numbers for all the schemas named in the SCHEMA parameter.

version-number

Directs IDMSRPTS to report on the specified versions of each schema.

You can specify up to 25 version numbers.

HIGhest

Directs IDMSRPTS to report on the highest numbered version of each specified schema.

This is the default.

ALL

Directs IDMSRPTS to report on all versions of each specified schema.

SUBSCHEMA statement

The SUBSCHEMA statement identifies the subschema(s) to report on.

Both a schema and subschema statement are required if the reports selection includes any of the following:

SSCRPT
DATDIR
LRACT
LRDEFS
LRPATH
SUBREC
SUBSET

Authorization

The identified user must hold authority for:

IDD SIGNON if IDD SIGNON is secured and
DISPLAY or higher if IDMS is secured and
DISPLAY or higher on requested schema(s) if PUBLIC ACCESS for the occurrence is NONE

Syntax

►─┬──────────────────────────────────────────────────────────┬───────────────►
  └─┬─ SUBschema ─┬─┬─────┬─┬─ subschema-name ─────────────┬─┘
    └─ SSC ───────┘ └─ = ─┘ │     ┌─────── , ────────┐     │
                            ├─ ( ─▼─ subschema-name ─┴─ ) ─┤
                            └─ ALL ────────────────────────┘

Parameters

SUBschema/SSC

Identifies the subschema(s) for which the specified subschema-level reports are to be produced.

SUBSCHEMA and SSC are synonyms and can be used interchangeably.

subschema-name

Specifies the name of a subschema compiled under a schema identified by the SCHEMA statement.

IDMSRPTS reports only on the named subschema(s).

You can specify up to 25 subschema names.

You can specify multiple occurrences of subschema-name by enclosing them in parentheses and separating them with commas.

ALL

Directs IDMSRPTS to reports on all subschemas compiled under the schema(s) identified by the SCHEMA statement.

DMCL statement

The DMCL statement identifies the DMCL(s) to report on.

A DMCL statement is required if the reports selection includes DMCLST.

Authorization

The external user ID must hold either DBADMIN authority for the dictionary or DISPLAY authority on requested DMCL(s).

Syntax

►─┬────────────────────────────────────────────┬─────────────────────────────►
  └─ DMCl ─┬─────┬─┬─ dmcl-name ─────────────┬─┘
           └─ = ─┘ │     ┌───── , ─────┐     │
                   ├─ ( ─▼─ dmcl-name ─┴─ ) ─┤
                   └─ ALL ───────────────────┘

Parameters

DMCl

Identifies the DMCL(s) for which the DMCLST report is to be produced.

dmcl-name

Identifies the name of a DMCL defined in the catalog component of the dictionary. You can specify multiple occurrences of dmcl-name by enclosing them in parentheses and separating them with commas.

IDMSRPTS reports only on the named DMCL(s).

You can specify up to 25 DMCL names.

ALL

Directs IDMSRPTS to reports on all DMCLs defined in the dictionary.

SEGMENT statement

The SEGMENT statement identifies the segment(s) to report on.

A SEGMENT statement is required if the reports selection includes SEGLST.

Authorization

The external user ID must hold either DBADMIN authority for the dictionary or DISPLAY authority on requested segment(s).

Syntax

►─┬──────────────────────────────────────────────────┬───────────────────────►
  └─ SEGment ─┬─────┬─┬─ segment-name ─────────────┬─┘
              └─ = ─┘ │     ┌────── , ───────┐     │
                      ├─ ( ─▼─ segment-name ─┴─ ) ─┤
                      └─ ALL ──────────────────────┘

Parameters

SEGment

Identifies the segment(s) for which the SEGLST report is to be produced.

segment-name

Specifies the name of a segment defined in the catalog component of the dictionary. You can specify multiple occurrences of segment-name by enclosing them in parentheses and separating them with commas.

IDMSRPTS reports only on the named segment(s).

You can specify up to 25 segment names.

ALL

Directs IDMSRPTS to reports on all segments defined in the dictionary.

DBTABLE statement

The DBTABLE statement identifies the database name table(s) to report on.

A DBTABLE statement is required if the reports selection includes DBTLST.

Authorization

The external user ID must hold either DBADMIN authority for the dictionary or DISPLAY authority on requested database names table(s).

Syntax

►─┬─────────────────────────────────────────────────┬────────────────────────►
  └─ DBTable ─┬─────┬───┬────── dbtable-name ─────┬─┘
              └─ = ─┘   │   ┌────── , ────────┐   │
                        ├─(─▼── dbtable-name ─┴─)─┤
                        └────── ALL ──────────────┘

Parameters

DBTable

Identifies the database name table(s) for which specified dbtable-level reports are to be produced.

dbtable-name

Identifies the name of a database name table defined in the catalog component of the dictionary. You can specify multiple occurrences of dbtable-name by enclosing them in parentheses and separating them with commas.

IDMSRPTS reports only on the named database name table(s).

ALL

Directs IDMSRPTS to report on all database name tables defined in the catalog segment of the dictionary.

REPORTS SELECTION statement

The REPORTS SELECTION statement identifies the reports to generate.

Syntax

►─┬───────────────────────┬──────────────────────────────────────────────────►◄
  └─┬─ ALLRPT ──────────┬─┘
    │ ┌───────────────┐ │
    └─▼─┬─ AREALST ─┬─┴─┘
        ├─ DATDIR ──┤
        ├─ DBTLST ──┤
        ├─ DMCLST ──┤
        ├─ GLBLRPT ─┤
        ├─ LRACT ───┤
        ├─ LRDEFS ──┤
        ├─ LRPATH ──┤
        ├─ MODLST ──┤
        ├─ MODULE ──┤
        ├─ PDBRPT ──┤
        ├─ PGMLST ──┤
        ├─ PROCESS ─┤
        ├─ PRTLST ──┤
        ├─ QFILE ───┤
        ├─ RECCOPY ─┤
        ├─ RECDES ──┤
        ├─ SCHRPT ──┤
        ├─ SEGLST ──┤
        ├─ SETDES ──┤
        ├─ SSCRPT ──┤
        ├─ SUBAREA ─┤
        ├─ SUBREC ──┤
        ├─ SUBSET ──┤
        ├─ TABLE ───┤
        └─ USER ────┘

Parameters

ALLRPT

Generates all non-database reports; all reports except DBTLST, DMCLST, and SEGLST.

AREALST

Generates the Area Listing for each specified schema.

DATDIR

Generates the Subschema Data Directory Listing for each specified subschema.

DBTLST

Generates the DBNAMES Table Report.

DMCLST

Generates the DMCL Listing for each specified DMCL.

GLBLRPT

Generates all database independent reports: MODULE, PROCESS, TABLE, RECCOPY, PRTLST, QFILE, and USER.

No SCHEMA, SUBSCHEMA, DMCL, or SEGMENT statement is required to generate these reports.

LRACT

Generates the Logical Record Activity Descriptions report for each specified subschema.

LRDEFS

Generates the Subschema Logical Record Descriptions report for each specified subschema.

LRPATH

Generates the Logical Record Path Descriptions report for each specified subschema.

MODLST

Generates the module, process, and table reports.

MODULE

Generates the Module Description Listing, which lists each module that you are authorized to display. Processes, tables, qfiles, and protocols are not included in this report.

PDBRPT

Generates the physical database reports: DBTLST, DMCLST, and SEGLST.

If specified:

DMCLST will be produced for all DMCLs identified on DMCL statements
SEGLST will be produced for all SEGMENTs identified on SEGMENT statements
DBTLST will be produced for all DBTABLES identified on DBTABLE statements

PGMLST

Generates the Program Cross-Reference Listing for each specified schema version.

PROCESS

Generates the ADS Process Description Listing, which lists each process that you are authorized to display.

PRTLST

Generates the Protocol Listing.

QFILE

Generates the OLQ Qfile Description Listing.

RECCOPY

Generates the Record Copy Description Listing, which lists each IDD-built record, report, and transaction that you are authorized to display.

RECDES

Generates the Schema Record Description Listing for each specified schema version.

SCHRPT

Generates all schema reports for each specified schema version: AREALST, PGMLST, RECDES, and SETDES.

The schema reports do not report on unvalidated schemas or schemas that have errors.

SEGLST

Generates the Segment Listing for each specified segment.

SETDES

Generates the Set Description Listing for each specified schema version.

SSCRPT

Generates all subschema reports for each specified subschema, schema, and version: DATDIR, LRACT, LRDEFS, LRPATH, SUBREC, and SUBSET.

The subschema reports do not report on unvalidated subschemas or subschemas that contain errors.

SUBAREA

Generates the Subschema Area Description Listing for each specified subschema.

SUBREC

Generates the Subschema Record Description Listing for each specified subschema.

SUBSET

Generates the Subschema Set Description Listing for each specified subschema.

TABLE

Generates the Table Description Listing, which lists each table that you are authorized to display.

USER

Generates the User Listing.