Previous Topic: OverviewNext Topic: Edit Parameters


OUTPUT Parameter

More information:

OUTPUT Parameter

Purpose

Specifies how each report in the CA Culprit run is to be output.

Syntax

      Col
      2
      ▼
►►─── nnOUTput ─┬───────────────┬─┬─ T ───┬───────────────────────────────────►
                └─ record-size ─┘ └─ D ◄ ─┘

 ►─── TABLE = entry-name TYPE = ──┬─ CREate ───┬──────────────────────────────►
                                  ├─ ADD ──────┤
                                  ├─ REPlace ──┤
                                  ├─ DELete ───┤
                                  └─ GENerate ─┘
 ►─┬────────────────────┬──┬─────────────────┬──┬──────────────────────┬──────►
   └─ USER = user-name ─┘  └─ PW = password ─┘  └─ OWNER = owner-name ─┘

 ►─┬──────────────────────────┬──┬────────────────────────────┬───────────────►
   └─ CATALOG = catalog-name ─┘  └─ LOCATION = location-name ─┘

 ►─┬────────────────────────┬──┬────────────────────────────┬─────────────────►
   └─ SYSCTL = sysctl-name ─┘  └─ CVMACH = cv-machine-name ─┘

 ►─┬───────────────────────────┬──────────────────────────────────────────────►
   └─ COMMIT = ─┬─ interval ─┬─┘
                └─ NO ───────┘
 ►─┬───────────────────────┬─┬────────────────────┬─┬───────────────────────┬─►
   └─ COMMENT = 'comment' ─┘ └─ AREA = area-name ─┘ └─ ONLINE = ─┬─ Yes ◄─┬─┘
                                                                 └─ No ───┘

 ►─┬─────────────────────────┬─┬──────────────────────┬───────────────────────►
   └─ DISPLAY = ─┬─ Yes ◄─┬──┘ └─ LOAD = ─┬─ Yes ◄─┬──┘
                 └─ No ───┘               └─ No ───┘

 ►─┬────────────────────────┬─┬───────────────────────┬───────────────────────►◄
   └─ CHANGE = ─┬─ Yes ◄─┬──┘ └─ ERASE = ─┬─ Yes ◄─┬──┘
                └─ No ───┘                └─ No ───┘

Syntax Rules

Syntax rules follow:

nn

Identifies the report associated with the OUTPUT parameter. It is a 2-digit number in the range 00 through 99 and must be coded starting in column 2.

OUTPUT

Specifies the parameter type. It must be coded starting in column 4.

record-size

Specifies the length of the rows in the table. It is an integer in the range 1 through 32,760. Specify the record size for documentation purposes only; the default is the record size of the table.

T/D

Indicates a totals-only (T) or details-only (D) report. The default is D.

TABLE = entry-name

Names the table. TABLE must be the first keyword on the OUTPUT parameter. Entry-name is a 1- to 64-character value. If the name contains embedded blanks or special characters, it must be enclosed in single or double quotation marks. If enclosed in quotation marks, the entire name must appear on a single line. Otherwise, the name can span several lines:

 01OUTPUT TABLE=MZC.        $Owner.Folder.Object
*               REPORT01    $Note that the period
*               .BUDGET     $can appear on either line
TYPE =

Specifies keywords to create or update tables. TYPE= must be the second keyword expression on the OUTPUT parameter.

CREATE

Defines, generates, and populates a new table. When a table is created, it is defined automatically to the data dictionary.

Note: A table gets defined to the data dictionary in the CULL step of processing, even if the CA Culprit job contains run-time errors.

ADD

Adds rows to an existing table. The edit parameters coded for the report must specify the same length, format, and order as those defined for the original table.

REPLACE

Erases previously stored data and stores new data. The edit parameters coded for the report must specify the same length, format, and order as those defined for the original table.

DELETE

Deletes a stored table and all associated data. DELETE also removes the table definition from the data dictionary.

Note: A table gets deleted in the CULL step of processing, even if the CA Culprit job contains run-time errors.

To delete a table, code the OUTPUT parameter as well as a dummy INPUT parameter, REC parameter, and type 5 edit parameter to satisfy CA Culprit's coding requirements. For example, in a z/OS environment, the code appears as follows:

//SYS010  DD DUMMY
 INPUT 80
 REC RECORD-NAME 1 80
 01OUTPUT TABLE=PERSONNEL TYPE=DELETE
 0151*010 ' '
GENERATE

Regenerates a table definition that has been modified. You must regenerate a table under the following conditions:

Note: A table gets generated in the CULL step of processing, even if the CA Culprit job contains run-time errors.

To regenerate a table, code the OUTPUT parameter as well as a dummy INPUT parameter, REC parameter, and type 5 edit parameter to satisfy CA Culprit's coding requirements. For example, in a z/OS environment, the code appears as follows:

//SYS010  DD DUMMY
//SYSIN   *
 INPUT 80
 REC RECORD-NAME 1 80
 01OUTPUT TABLE=PERSONNEL TYPE=GENERATE
 0151*010 ' '
USER = user-name

Identifies the individual with authority to sign on to the catalog and overrides the user specified on the PROFILE parameter, if any. User-name is a 1- to 32-character value.

PW = password

Indicates the user's 1- to 8-character alphanumeric password. It overrides the password specified on the PROFILE parameter.

OWNER = owner-name

Identifies the table owner. When the user is not the table owner, this keyword expression is required. CA Culprit determines whether the owner has assigned the user passkey authority to update the table.

CATALOG = catalog-name

Identifies the catalog (dictionary) containing the table definition. This keyword expression allows you to output tables to any number of catalogs. Catalog-name is an optional 1- to 8-character alphanumeric expression. To determine valid specifications, see your DBA.

If catalog-name is omitted, the default is as follows:

LOCATION = location-name

(DDS users only) Identifies the DDS node used to access the catalog containing the table. This keyword expression allows you to output tables to any number of nodes in a given DDS network.

Location-name is a 1- to 8-character value. The default is the value specified in the DICTNODE= keyword expression on the DATABASE parameter. To determine valid specifications, see your DBA.

SYSCTL = sysctl-name

(z/OS and z/VSE users only) Overrides the SYSCTL= clause on the DATABASE parameter. If there is no SYSCTL value on the DATABASE parameter, CA Culprit uses the default value in IDMSOPTI. The SYSCTL= keyword expression allows users to output tables to any number of central versions.

CVMACH = cv-machine-name

(z/VM users only) Overrides the value of the CVMACH= clause on the DATABASE parameter and the central version specified in an IDMSOPTI module. Cv-machine-name is a 2- to 8-character value that identifies the virtual machine in which the CA IDMS/DB central version system is executing. With this keyword expression, CA Culprit can output tables to any number of central versions in the same CA Culprit job step.

COMMIT =

Specifies the interval at which DML COMMIT statements are issued when a table is updated:

interval

An integer that specifies the interval at which COMMITs are to be issued. The default is 100.

COMMIT statements are issued when:

NO

Indicates that no COMMIT statements are to be issued.

Note: For more information about COMMIT statements, see the CA IDMS Navigational DML Programming Guide.

The following keywords modify fields that appear on the ASF Table Definition screen and the Extended Table Definition screen. For more information about these screens, see the CA IDMS ASF User Guide.

AREA = area-name

(CREATE and GENERATE functions only) Names the database area in which the table's data is stored. If specified, it updates the AREA field on ASF's Extended Table Definition screen. Area-name must be the name of a valid area defined by the ASF administrator.

ONLINE = YES/NO

(CREATE and GENERATE functions only) Specifies whether maps and dialogs are generated when a table is created or regenerated. The default is NO. If specified, this keyword expression updates the GENERATE MAP/DIALOG field on ASF's Extended Table Definition screen.

When maps and dialogs are generated, users can display, add, and modify data in the table online by using ASF.

DISPLAY = YES/NO

(CREATE and GENERATE functions only) indicates whether ASF should generate An OBTAIN logical record path in the ASF-generated subschema. The default is YES. If specified, this keyword expression updates the DISPLAY ACCESS field on ASF's Extended Table Definition screen.

LOAD = YES/NO

(CREATE and GENERATE functions only) Indicates whether ASF should generate a STORE logical record path in the ASF-generated subschema. The default is YES. If specified, this keyword expression updates the LOAD ACCESS field on ASF's Extended Table Definition screen.

CHANGE = YES/NO

Indicates whether ASF should generate a MODIFY logical record path in the ASF-generated subschema. The default is YES. If specified, the keyword expression updates the CHANGE ACCESS field on ASF's Extended Table Definition screen.

ERASE = YES/NO

Indicates whether ASF should generate an ERASE logical record path in the ASF-generated subschema. The default is YES. If specified, this keyword expression updates the ERASE ACCESS field on ASF's Extended Table Definition screen.

Examples

Example 1: Creating a Table

 DATABASE DICTNAME=ASFDICT
 PROFILE USER=MZC PW=HAZELNUT
  -
  -
 34OUTPUT TABLE=EMPTABLE TYPE=CREATE ONLINE=YES
*         COMMENT='TABLE OF COMPANY EMPLOYEES'

Report 34 defines and populates a table EMPTABLE. By default, MZC owns the table, which is defined in ASFDICT, the dictionary named on the DATABASE parameter. Also by default, the report contains details-only information. Because the code includes ONLINE=YES, MZC can display and update the table's data online by using ASF.

Example 2: Replacing a Table

 DATABASE DICTNAME=DOCANWK
 PROFILE USER=PPETERS PW=PANDA
 INPUT DB SS=EMPSS01,EMPSCHM,100
 PATHAA DEPARTMENT EMPLOYEE EMPOSITION
   -
   -
   -
 34OUTPUT TABLE=BUDGET TYPE=REPLACE CATALOG=ASFDICT
*         OWNER=PMS
 3451*010 DEPT-ID-0410        FN
 3451*020 EMP-NAME-0415
 3451*030 SALARY-AMOUNT-0420  FP

CA Culprit accesses dictionary DOCANWK for the subschema definitions and input for the CA Culprit run. The OUTPUT parameter instructs CA Culprit to replace the existing data in table BUDGET with new information. User PPETERS must have passkey authority to access the table, which is owned by PMS.

BUDGET is defined in the ASFDICT catalog. The sequence and format of the edit parameters are the same as when the table was created.

Example 3: Adding Rows to a Table

 INPUT 80 F 320
 REC EMP-ID       1  4  2
 REC EMP-NAME     5 25
 01OUTPUT TABLE=EMPLOYEES TYPE=ADD
*         USER=DEH PW=CHESTNUT CATALOG=ASFDICT
 01510001 EMP-ID    FN
 01510026 EMP-NAME

CA Culprit reads input data from a sequential file and adds new rows of data to table EMPLOYEES. To run the job successfully, the data type and sequence of the edit parameters are the same as defined for the table.

Example 4: Deleting Tables

//SYS010 DD DUMMY
//SYSIN  *
 DATABASE DICTNAME=ASFDICT
 PROFILE USER=DOC1 PW=DOC1
 INPUT 80
 REC DUMMY-NAME 1 80
 01OUTPUT TABLE=EMPLOYEES TYPE=DELETE
 01510001 ' '
 02OUTPUT TABLE='PERSONNEL BUDGET' TYPE=DELETE
 02510001 ' '

The OUTPUT parameters instruct CA Culprit to delete two stored tables. To satisfy CA Culprit's coding requirements, the code includes a dummy INPUT parameter, REC parameter, and a type 5 edit parameter for each report. By default, the owner of both tables is DOC1 and the tables are defined in the ASFDICT catalog.

Example 5: Regenerating a Modified Table

//SYS010 DD DUMMY
//SYSIN  *
 INPUT 80 F 320
 REC DUMMY-NAME 1 80
 01OUTPUT TABLE=ACCOUNTING TYPE=GENERATE
*         USER=DOC1 PW=DOC1 CATALOG=ASFDICT
*         COMMENT='TABLE REGENERATED WITH CULPRIT'
 01510001 ' '

In this example, user DOC1 modified the column definitions of table ACCOUNTING on ASF's Column Definition screen. To regenerate the table, DOC1 codes a CA Culprit report that specifies GENERATE on the OUTPUT parameter. The COMMENT= keyword expression updates the description of the table contained in the COMMENTS field of ASF's Table Definition screen.

To satisfy CA Culprit's coding requirements, the code also includes a dummy INPUT parameter, REC parameter, and a type 5 edit parameter.