Component Definition Statements
GEN, OPTION, COMP, COMPOPT, COMPJOB, INPUTSOURCE, and AREA generation definition statements.
micsrm140
Required roles: systems programmer, security administrator, database administrator |
|---|
The generation definition statements that are used to define the component and information area to be generated and to control the MCG generation processing options are GEN, OPTION, COMP, COMPOPT, COMPJOB, INPUTSOURCE, and AREA.
The GEN statement controls the extent of component generation. Only one GEN statement is permitted in each cccGENIN member.
The optional OPTION statement defines optional processing and data element selection parameters unique to this component. User-written components typically do not use this statement. If present, only one OPTION statement is permitted per cccGENIN member.
The COMP statement defines the component. Only one COMP statement is permitted per cccGENIN member.
The optional COMPOPT statement defines the Essential and Derived data element options to be used for this component's files.
The optional COMPJOB statement defines whether the component is included in or excluded from operational processing.
The optional INPUTSOURCE statement defines the component's input source and the record types it processes.
The AREA statement defines the information areas within the defined component. A minimum of one AREA statement per cccGENIN member is required. Each AREA statement must be followed by one or more file statement groups. One AREA statement is coded per information area in the component. For example, the IMS Analyzer has one information area, and that information area's name is also IMS. The SCP and Hardware Analyzer, however, has two information areas, HAR and SCP.
Generation Type Statement (GEN)
This statement defines the type of generation to be performed, analyzes statement syntax, a database definition generation, or a "shell" module generation.
Statement Format
This statement is coded with the KEYWORD starting in column 1, free-form, and continuing through column 72. Continuation is not supported. The following illustration describes the format and coding rules for the Generation Type Statement.
GEN XXXXXXXXXX | | +---GENTYPE
Statement Option Definitions
GENTYPE
Defines the type of generation to be performed, with the valid options including:
SYNTAX
Analyzes first-level syntax for input statements. No generation is performed.
GENFILES
Generate system code and documentation for data elements and file definitions.
GENSHELL
Generate shell documentation members for data dictionary and exception entries, and shell SAS source code for management objective reports, user exit member, exception analyzers, and exception value evaluators. This option is ONLY used to build user components. Do
not
use this option for Broadcom
-distributed components.Statement Definition Example
GEN GENFILES
This generation statement is requesting a component generation to generate system code and documentation for data elements and file definitions.
Option Statement (OPTION)
The OPTION statement identifies which data element clusters are being included or excluded when a file's data element content is generated. This statement is optional.
Statement Format
The OPTION statement is free-form and coded with KEYWORDs in columns 1 through 72. Continuation is not supported. The following illustration describes the format and coding rules for the OPTION statement.
OPTION xxxxxx xxxxxx xxxxxx xxxxxx xxxxxx xxxxxx | | | | | | +------+------+------+------+------+ | +--- KEYWORDs
OPTION
Defines which data element clusters are to be included or excluded when generating the file's data element content.
KEYWORDs
Defines which of the data element clusters to include in or exclude from the file. KEYWORDs vary by product and are listed in each Product' Analyzer. All data element clusters that are shown for a product must be present.
See Parameters of the appropriate Product Analyzer for OPTION statement information.
Component Statements (COMP and COMPOPT)
The component statements define the component that is being generated by assigning the required identification name, job-step number, input file attributes, and Essential and Derived data element options.
Statement Format
The COMP and COMPOPT statements are always specified in a matched pair. There is one COMP statement per cccGENIN member. The COMPOPT statement may be omitted, in which case default values for the Essential and Derived options are taken. If the COMPOPT statement is present, it MUST immediately follow the COMP statement in cccGENIN.
The COMP statement is coded with the KEYWORD starting in column 1, free-form, and continuing through column 72. Continuation is not supported. The following illustration describes the format and coding rules for the component statements.
COMP ccc sss bbbbb rrr AAAA xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | | | | | | | | | | +--- COMPNAME - Name of the | | | | | component. | | | | | | | | | +--- ACCOUNTING - Definition of | | | | component's use of account | | | | level data elements. | | | | | | | +--- RECFM - Input file record format | | | to be used for input data. | | | | | +---BLKSIZE - Input file maximum block size | | to be used for input data. | | | +---STEPNUM - Job step number used to identify | this component in theMICSjobs. | +---COMPID - Component identification.
The COMPOPT statement is coded with the KEYWORD starting in column 1, free-form, and continuing through column 72. Continuation is not supported. The following describes the format and coding rules for the component option statement.
COMPOPT eeeeeeee dddddddd xxxxxxxx | | | | | | | | +--- BYPASS - Optional | | protection bypass for all | | files in this component. | | | +--- DERIVED - The derived data element | option to be used for all files in | this component. | +------ ESSENTIAL - The essential data element option to be used for all files in this component.
Statement Option Definitions
COMP
Defines the description of the component that is being generated.
COMPID
The three-character component identifier that identifies this component (for example, the CICS Analyzer's COMPID is CIC). A user component must have a 'U' or 'Z' as its first letter to denote that it is a user component and ensure the uniqueness in the component's identification. Also, MSI cannot be used as component identifier.
STEPNUM
The three-character job-step number that identifies this component's job steps in the DAILY, WEEKLY, MONTHLY, and YEARLY jobs. For example, the CICS Analyzer's STEPNUM is 040. Step numbers for user components should be restricted to those numbers from 150 through 190. If there is a concern about eventually using all the numbers in this range, one should define multiple information areas within user components wherever possible.
BLKSIZE
This parameter is obsolete and must be a "." or range from 18 to 32000 for compatibility.
RECFM
This parameter is obsolete and must be ".", F, FB, U, VB, or VBS for compatibility.
ACCOUNTING
The keywords ACCT or NOACCT define whether this component has files that contain account level data elements. ACCT causes the ACCTGEN process to be performed and is used if the data element name @@ACCT appears on any file in the component's definition.
This parameter controls the interpretation of the @@ACCT NAME statement in this component's files. If files contain @@ACCT NAME statements, specifying NOACCT here causes @@ACCT to be ignored. Specifying ACCT causes @@ACCT to expand into one or more account code data elements. If no @@ACCT names appear in any file in the component, this parameter is ignored.
For user components, specify ACCT to generate component shells that include the user component interface to
MICS Accounting and Chargeback
.COMPNAME
A 1-40 character name for the component.
COMPOPT
Defines the Essential and Derived data element options to be used for this component's files.
ESSENTIAL
Must take the value of DEFAULT, INITIAL, ONLY, or ALL. If DEFAULT is coded, the component is generated using the option for essential data elements set in sharedprefix.MICS.PARMS(CPLXDEF), which is activated by the CPLXGEN job. If INITIAL, ONLY, or ALL is specified, files in the component are generated using this essential option value. See the FOPT statement description for more information.
DERIVED
Must take the value of DISK, COMP, or DEFAULT. If DEFAULT is coded, the option for derived data elements set in sharedprefix.MICS.PARMS(CPLXDEF), which is activated by the CPLXGEN job, are used for all files in the component. If COMP or DISK is specified, the files in the component are generated using this derived option value. See the FOPT statement description for more information.
BYPASS
This optional parameter is typically left blank. There are safeguards in the evaluation of the Essential option that help prevent inadvertent data loss. If you want to bypass these safeguards and force the Essential option for all files in a component to a value of INITIAL or ONLY unless overridden on the FOPT statement, code the word BYPASS in this position on the COMPOPT statement. Otherwise, for the protection of the data on an existing database, do not code this parameter.
Statement Definition Example
COMP USL 150 . . NOACCT User SYSLOG Component COMPOPT DEFAULT DEFAULT
This component statement defines a user component (USL) named User SYSLOG Component, which is to execute as step 150. The component will not require account level data elements and will use the default Essential and Derived data element options set at the complex level in sharedprefix.MICS.PARMS(CPLXDEF).
Component Job Statement (COMPJOB)
The optional Component Job Statement defines the product's exclusion or inclusion of component processing in DAILY, WEEKLY, MONTHLY, and YEARLY jobs.
Statement Format
The COMPJOB statement may be omitted, in which case the product is not included in any operational job, exception, or MBO report generation, nor archive eligibility.
If the COMPJOB statement is present, it MUST follow the COMPOPT statement in cccGENIN.
The COMPJOB statement is coded with the KEYWORD starting in column 1. Parameters are free-form and can continue through column 72. Statement continuation is not supported. The following describes the format and coding rules for the COMPJOB statement.
COMPJOB dwmy edwm awm | | | | | | | +-- Audit/History indicators | | | | | +-- Exceptions/MBO report indicators | | | +-- Job indicators | +-- COMPJOB - statement identification
Statement Option Definitions
COMPJOB
Define that the product be excluded from or included in operational jobs, exception and MBO report generation, and archive eligibility.
dwmy
Indicators that show whether the product is processed in the
MICS DAILY
, WEEKLY, MONTHLY, or YEARLY jobs. Code a D, W, M, Y, or inactive (.) in the respective position.edwm
Indicators that show whether the product has exceptions that are generated and reported, and if management objective reports are to be produced by the DAILY, WEEKLY, or MONTHLY
MICS
reporting processes. Code an E, D, W, M, or inactive (.), respectively.awm
Indicators that show whether the product is eligible to create AUDIT, WEEKLY History, or MONTHLY History archives. Code an A, W, M, or inactive (.), respectively.
Statement Definition Example
COMPJOB DWM. EDWM .WM
These statements define a product that is processed in the DAILY, WEEKLY, and MONTHLY jobs. Exceptions and MBO reports are generated and reported in the daily, weekly, and monthly reporting processes. In addition, the product is eligible to create weekly and monthly history archives.
For more information about the COMPJOB statement, see Data Unavailable and Minimal Input Data.
Input Source Statement (INPUTSOURCE)
The optional input source statements define the product's input source type and the record types it processes.
Statement Format
If the INPUTSOURCE statement is present, it MUST follow the COMPJOB statement, if present, or the COMPOPT statement in cccGENIN.
The INPUTSOURCE statement is coded starting in column 1. Parameters are free-form and can continue through column 72. Although statement continuation is not supported, multiple INPUTSOURCE statements can be specified. The following illustration describes the format and coding rules for the INPUTSOURCE statement.
INPUTSOURCE source rtype ... | | | | | +-- Record type | | | +-- Type of input source | +-- INPUTSOURCE - statement identification
Statement Option Definitions
INPUTSOURCE
Defines the product's input source type and the record types that it processes.
source
A value of SMF, NONSMF, or MSI for the first INPUTSOURCE statement; a value of inactive (.) for subsequent statements.
recordtype
Ranges from 0 to 255. Multiple record types may be defined on a line. If a value of MSI is specified for the input source, record type is ignored.
Statement Definition Example
INPUTSOURCE SMF 30 35 70 INPUTSOURCE . 43 66 100
These statements define that the input source is SMF data and that record types 30, 35, 43, 66, 70, and 100 are supported.
Information Area Statement (AREA)
The Information Area statement defines an area identifying the Information Area ID and name.
Statement Format
This keyword is coded with the KEYWORD starting in column 1, free-form, and continuing through column 72. Continuation is not supported. The following illustration describes the format and coding rules for the Information Area Statement.
AREA iii xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | | | +--- INFONAME - Information Area Name. | +---INFOID - Information Area identification.
Statement Option Definitions
AREA
Defines an Information Area for the product.
This statement is required. If a product has only one Information Area, this Information Area ID may be the same as the component ID. The maximum number of information areas per component is nine.
INFONAME
Defines a 1-40 character name for this information area.
INFOID
Defines a 3-character ID for the information area identifier. A user information area must have U or Z as its first letter to denote that it is a user information area and ensure the uniqueness in the information area's identification. Also, MSI cannot be used as in information area name.
Statement Definition Example
AREA UOD User SYSLOG Operations Data
This statement defines a user information area (UOD) named User SYSLOG Operations Data.