TOMREPRT syntax and parameters

The TOMREPRT syntax and parameters are as follows:
%TOMREPRT SSID(AO PAS id) TOM(TOM id) 
           OUTDSN(existing.sequential.dataset.name)       
           DISP(OLD|SHR)
           TAGSTART (tag starting point)
           TAGLEN (tag length)
           OBJNAME(object name)
           SYSTEM(Valid Systems list system name)
           DISPLAY(Y|N)
           REPORT(ALL|ATTR|DEPX|MODELX)
           DB(alternative definition base name)
           LOC(INLINE|VARS)

Note

The parameters can be specified in any order after the TOMREPRT EXEC name. Only the SSID and TOM parameters are required.

Table 1 lists and describes the parameters.

Table 1. TOMREPRT parameters

Parameter and description

Valid values

SSID

Specify the subsystem ID (SSID) of the MainView AutoOPERATOR PAS that TOMREPRT should use. (TOMREPRT uses MainView AutoOPERATOR services to write output to the BBI-2 journal.)

Subsystem ID

Default: none

Required: yes

TOM

Specify the TOM PAS ID from which to obtain report data.

TOM PAS ID

Default: none

Required: yes

OUTDSN

Specify the name of a preallocated, sequential data set for the report output. The report is also written to the BBI-2 journal unless you specify the DISPLAY(N) parameter.

The report data written to this data set is identical to the data written to the BBI-2 journal.

If the data set does not exist or is not available, an error message is written to the BBI-2 journal and TOMREPRT terminates.

Preallocated, sequential data set name

Note

You must allocate the data set as LRECL=80 and specify the BLKSIZE value during allocation.

Default: none

Required: no

DISP

Specify the disposition of the data set specified by the OUTDSN parameter. The DISP parameter is applicable only if the OUTDSN parameter is specified.

OLD

Indicates that other users cannot allocate the data set while the report is being written

SHR

Indicates that other users can browse the data set while the report is being written

OLD or SHR

Default: SHR

Required: no

OBJNAME

Specify an object name to limit the report to that object’s attributes when specifying the REPORT(ATTR) parameter.

Object name

Default: none

Required: no

SYSTEM

Specify system name to limit the report to attributes of the objects that are identified to run on that system. TOMREPRT searches the valid systems list for each object to find a match with the value in the SYSTEM parameter. If a match is found, the attributes for the object are displayed in the report. If no match is found, TOMREPRT moves to the next object in the definition base.

The SYSTEM parameter is applicable only if the REPORT(ATTR) parameter is specified.

Note

The set attribute portion of the report includes information about all sets on all systems regardless of the SYSTEM parameter.

System name

Default: none

Required: no

DISPLAY

Specify whether the report is to be written to the BBI-2 journal.

Y

Writes the report to the BBI-2 journal

N

Does not write the BBI-2 journal. Specify DISPLAY(N) to write the report only to the data set specified in the OUTDSN parameter

Y (Yes) or N (No)

Default: Y

Required: no

REPORT

Specify which reports should be generated. Only one value can be specified for each execution of TOMREPRT.

ATTR (object or set attributes)

Lists the attributes of objects and sets defined to the definition base

DEPX (dependency cross reference)

Lists the object dependencies in the definition base

MODELX (model to object cross reference)

Lists the models in the definition base and shows which objects refer to them

ALL

Lists all of the above reports

Note

If the REPORT parameter is not specified, all three reports are generated in the order ATTR, DEPX, and MODELX.

ALL, ATTR, DEPX, MODELX

Default: ALL

Required: no

TAGSTART

Specify which lines of the output contain all or part of the named object. This parameter can be used by itself or in conjunction with the TAGLEN parameter. The minimum value is one, and the maximum value is 64. If these optional parameters are not specified, the detail lines for the report are not tagged.

When you specify TAGSTART and TAGLEN, each detail line generated by TOMREPRT is tagged with the object or set name processed by TOMREPRT.

The tag can be the full name or a portion of the object or set name that TOMREPRT is processing. The TAGSTART parameter specifies at which position of the object or set name the tag name will begin. The TAGLEN parameter specifies the length, in characters, of the tag name. When these parameters are used together, the tag name is calculated as:

[(length of object or set name) -- (TAGSTART value)] + 1 = tag name length

If the object or set name that TOMREPRT is processing is 20 characters long and you specify a TAGSTART value of 8, the tag length will be 13.

(20 - 8) + 1 = 13

You can specify the TAGSTART parameter without the TAGLEN parameter. If TAGLEN is not specified, the tag length is the length of the object or set name that TOMREPRT is processing.

From 1 to 64

Default: 64

Required: no

TAGLEN

Specify the length of the object or set name tag that is written at the start of each detail line generated by TOMREPRT. This parameter is used together with the TAGSTART parameter. The minimum value is one, and the maximum value is 64.

See the description for the TAGSTART parameter for more information.

From 1 to 64

Default: 64

Required: no

DB

Specify a definition base name to override the active definition base in the TOM registry.

Note

Definition base names can contain mixed-case characters. By default, EXEC parameters are translated to uppercase characters. To prevent definition base names from being translated to uppercase characters, specify UCPARMS=NO in the MainView AutoOPERATOR parameter member AAOEXP00.

Existing definition base name

Default: active definition base

Required: no

LOC

Specify where to obtain the definition base name on which to report.

INLINE

Gets the definition base name from the TOMREPRT DB parameter

VARS

Gets the definition base name from the TOM_DB variable in the MainView AutoOPERATOR shared variable pool. To set the TOM_DB variable in the shared variable pool, schedule the following EXEC on the MainView AutoOPERATOR PAS where you intend to schedule with the TOMREPRT EXEC:

/* REXX */TOM_DB = 'One DB' 'IMFEXEC VPUT TOM_DB SHARED'

Note

Definition base names can contain mixed-case characters. By default, EXEC parameters are translated to uppercase characters. To prevent definition base names from being translated to uppercase characters, specify UCPARMS=NO in the MainView AutoOPERATOR parameter member AAOEXP00.

VARS or INLINE

Default: INLINE

Required: no

This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

Comments