Generate Syntax

Processing Element Actions › The Generate Statement › Generate Syntax

Generate Syntax

►►─ GENerate ELEment ─ element-name ─┬──────────────────────────────┬─ FROm ──►
                                     └─┬─ THRough ─┬─ element-name ─┘
                                       └─ THRu ────┘
 ►─ ENVironment ─ env-name ─ SYStem ─ sys-name ─ SUBsystem ─ subsys-name ─────►
 ►─ TYPe ─ type-name ─┬─ STAge ─ stage-id ────────┬───────────────────────────►
                      └─ STAge NUMber ─ stage-no ─┘
 ►─┬──────────────────────────────┬───────────────────────────────────────────►
   └─ WHEre ─ ¤ ─┬──────────┬─ ¤ ─┘
                 ├─┤ CCID ├─┤
                 └─┤ PRO ├──┘
 ►─┬──────────────────────────────────────────────────────────────┬─ . ───────►◄
   └─ OPTion ─ ¤ ─┬─────────────────────────────────────────┬─ ¤ ─┘
                  ├─ CCId ─ ccid ───────────────────────────┤
                  ├─ COMment ─ comment ─────────────────────┤
                  ├─ OVErride SIGNOut ──────────────────────┤
                  ├─┬─ COPyback ─┬────────────┬──┬──────────┤
                  │ │            └─ SEArch ◄ ─┘  │          │
                  │ └─ NOSOurce ─────────────────┘          │
                  ├─ PROcessor GROup ─┬─ EQ ─┬─ group name ─┤
                  │                   └─ = ──┘              │
                  └─ AUTogen ─┬───────────────────┬─────────┘
                              ├─ SPAN NONe ───────┤
                              ├─ SPAN ALL ────────┤
                              ├─ SPAN SYStems ────┤
                              └─ SPAN SUBsystems ─┘

Expansion of CCID

                                                     ┌─ , ────┐
├── CCId ─┬──────────────────────┬─┬───────────┬─ ( ─▼─ ccid ─┴─ ) ────────────┤
          └─ OF ─┬─ CURrent ◄ ─┬─┘ ├─ EQual ◄ ─┤
                 ├─ ALL ───────┤   └─ = ───────┘
                 └─ RETrieve ──┘

Expansion of PRO

├── PROcessor GROup ─┬─ EQ ─┬──────────────────────────────────────────────────┤
                     └─ = ──┘

GENERATE ELEMENTS element-name

Indicates the element(s) to be generated. Code the required syntax and enter the appropriate element name. In addition, you can use a name mask with the element name.

THROUGH (THRU) element-name

Indicates that a range of elements should be generated, beginning with the element coded in the GENERATE ELEMENTS statement, up to and including the element specified in this statement. You can use a name mask with the element name.

FROM ENVIRONMENT env-name SYSTEM system-name SUBSYSTEM subsys-name TYPE type-name STAGE stage-id STAGE NUMBER stage-no

The FROM clause indicates the location of the element being generated. CA Endevor SCM uses both the FROM clause in an action and any preceding SET FROM clause to determine the "from" criteria for that action

A FROM clause in an action overrides values in a SET FROM clause that precedes the action.
If the SET FROM clause contains values that are not included in the FROM clause, CA Endevor SCM uses these values.

Note: For more information, see the description of the SET FROM statement in the chapter "Using Set Clear, and EOF Statements."

You must specify an environment, system, subsystem, type, and stage. The environment name must be explicit. You can use a name mask with the system, subsystem, type, and stage. The stage specification can be either one of the following:

STAGE ID-Enter a single alphanumeric stage identifier.
STAGE NUMBER-Enter either 1 or 2.

If you use a name mask, CA Endevor SCM begins searching for the specified element(s) in Stage 1 of the current environment, and generates the first element that matches the specified element name, regardless of its location, version or level.

WHERE

Use WHERE clauses to further qualify element selection criteria. CA Endevor SCM uses both the WHERE clause in an action and any preceding SET WHERE clause to determine the "where" criteria for that action.

A WHERE clause in an action overrides values in a SET WHERE clause that precedes the action.

If the SET WHERE clause contains values that are not included in the WHERE clause, CA Endevor SCM uses these values.

WHERE CCID OF ccid

Limits the processing to those elements that match one of the supplied CCIDs. You can use a name mask in this field.

CURRENT: Tells CA Endevor SCM to look through the CCID fields in the MCF (Master Control File) to find a specified CCID(s). This is the default.
ALL: Tells CA Endevor SCM to search both the Master Control File and the SOURCE DELTA levels for a specified CCID(s). If you have ACM, CA Endevor SCM also searches the COMPONENT LIST DELTA levels for the specified CCID(s).
RETRIEVE: Tells CA Endevor SCM to use the CCID in the Master Control File's RETRIEVE CCID field.

If you need to select elements identified under more than one CCID, you can specify multiple CCIDs by enclosing the CCIDs with parentheses and separating them with commas. The CCIDs may extend over multiple lines if necessary.

The next examples illustrate the use of this clause.

Example 1: WHERE CCID OF CURRENT (PROJ001, PROJ002, PROJ004)
Example 2: WHERE CCID OF ALL (PROJ00V)

WHERE PROCESSOR GROUP EQ/= group name

This clause allows you to select elements according to a specified processor group. You can use a name mask when specifying the processor group name.

If you need to select elements identified under more than one processor group, you can specify multiple distinct processor group selectors by enclosing the processor groups with parentheses and separating them with commas. The processor groups may extend over multiple lines if necessary.

The next examples illustrate the use of this clause.

Example 1: WHERE PROCESSOR GROUP (COBVS, COBII)
Example 2: WHERE PROCESSOR GROUP (COBV)

OPTIONS

OPTIONS clauses allow to further specify an action request.

CCID ccid/COMMENT comment

You can enter a 1- to 12- character CCID and/or a 1- to 40-character comment.

CCIDs and/or comments may be required. If you do not provide a required CCID and/or comment, the GENERATE action fails.

When you specify a CCID and/or comment in a GENERATE action, CA Endevor SCM updates the CCID and/or COMMENT fields differently, depending on whether you specify the GENERATE action with or without the COPYBACK option.

When you specify a CCID and/or comment in a GENERATE action without the COPYBACK option, CA Endevor SCM uses this CCID and/or comment to:

Set the generate CCID and/or COMMENT fields.
Set the last action CCID and/or COMMENT fields.
Set the component list delta CCID and/or COMMENT fields if running the generate processor creates a change.

When you specify a CCID and/or comment in a GENERATE action with the COPYBACK option, CA Endevor SCM uses this CCID and/or comment to:

Set the generate and component list delta CCID and/or COMMENT fields.
Set the last action CCID and/or COMMENT fields.

CA Endevor SCM also uses the CCID and comment associated with the copied-back element to set the source and source delta CCID and/or COMMENT fields when you generate that element using the COPYBACK option.

COPYBACK

If you select this option, CA Endevor SCM first copies the current level of the element back to the FROM stage, then generates the element. CA Endevor SCM searches for the element first in the current environment, then in other stages along the map.

If the element currently exists in the FROM stage, CA Endevor SCM ignores the COPYBACK option and simply generates the element.

COPYBACK cannot be used with NOSOURCE.

SEARCH

This option is only valid with the COPYBACK option. NOSEARCH is no longer valid on the COPYBACK clause. COPYBACK implies SEARCH. It is not necessary to specify SEARCH.

NOSOURCE

When the target location has a sourced element, the element is generated in place.

When the target location has a sourceless element, the element is generated at the target location using the source of the first occurance of the element found up the map.

When the element does not exist at the target location, the element is generated at the target location using the source of the first occurance of the element found up the map. The source is not fetched to the target. The MCF element created at the target location will contain data similiar to a fetched back element except that the element base and delta name fields will be blank and the record will be marked as a sourceless element.

NOSOURCE cannot be used with COPYBACK. It is not necessary to specify the SEARCH option with NOSOURCE, because NOSOURCE implies SEARCH.

OVERRIDE SIGNOUT

If the element has been signed out to a person other than yourself, you must code this option in order to perform this action. This option updates the SIGNOUT ID at the appropriate stage with the user ID of the person performing the override. Use OVERRIDE SIGNOUT with caution to avoid regressing changes made by another user.

PROCESSOR GROUP EQ/= group name

Select this option to specify a predefined, named group of processors. If you do not specify a processor group, CA Endevor SCM defaults to the processor group last used for this element.

AUTOGEN | SPAN NONE| SPAN ALL | SPAN SYSTEMS | SPAN SUBSYSTEMS

Applicable for Add, Update, and Generate actions in batch requests. This option cannot be used in packages and the option does not work if Bypass Generate Processor is set. The Global Type Sequencing batch processing method must be enabled. Autogen only acts on components whose Types are listed in the Global Type Sequencing table. If the component's Type is not listed in the Global Type Sequencing table, the Autogen request is ignored. In addition, your site must have purchased and activated the CA Endevor Automated Configuration. Autogen can be specified alone or with various Span keyword options. "Autogen Span" is not a valid option. Valid options follow:

AUTOGEN

Generates all elements that use the component that is the target of the action. These using elements are generated at the target location that is specified in the SCL statement. If they do not exist at the target location, they are brought back to the target location as sourceless elements. An administrator can change the behavior of the Autogen feature, by activating AUTOGEN_SOURCE in the Optional Features Table (ENCOPTBL). When this option is activated, the Generate actions for the using elements are built with the Copyback, instead of the NoSource, option. For more information about sourceless elements, see the NoSource option description in Generate Syntax.

Note: Using elements are elements that use the element that is the target of an Add , Update, or Generate action. For example, if Autogen is specified for copybook, COPYA, then the programs that use that copybook are known as using elements.

AUTOGEN SPAN NONE

Generates all elements that use the component being acted upon. This option has the exact same effect as the option "AUTOGEN."

AUTOGEN SPAN ALL

Generates using elements that are found in any System and Subsystem combinations within the Environment and Stage of the component's logical map.

AUTOGEN SPAN SYSTEMS

Generates using elements found in any System, provided the element's Subsystem name matches the name of the Subsystem of the target component. Only Systems found within the Environment and Stage of the component's logical map or higher up the map are searched. This option is different from the Autogen option in that it includes additional Systems with the same Subsystem name in the search.

AUTOGEN SPAN SUBSYSTEMS

Generates using elements from all Subsystems with the same-named System of the component specified. Only Subsystem found in the System of the target component within the Environment and Stage of the component's logical map or higher up the map are searched. This option is different from the Autogen option in that it includes additional Subsystems with the same System in the search.

The following restrictions apply to the SPAN options:

Common libraries must be included in the generate processor concatenations of the Systems and Subsystems of the using elements. If the libraries are not included, then the Generate action does include the changes made to the component element when searching across Systems or Subsystems.
The same Systems and Subsystems must exist in each Environment and Stage location. For example, if ELEMENTA is a using element in the PROD Environment, system A, then system A must exist in the DEV Environment also.
SPAN only includes using elements from Systems or Subsystems located in the target Environment and higher up the map.
SPAN does not include using elements from outside the Environment map.

Example: Generate SCL

This SCL generates COBOL program PAYRPT01 at Stage 1. The element will be fetched if it does not already exist at Stage 1.

GENERATE ELEMENT 'PAYRPT17'
   FROM ENVIRONMENT 'PROD'
    		SYSTEM 'PAYROLL'
    		SUBSYSTEM 'REPORTS'
    		TYPE COBOL
    		STAGE NUMBER 1
  OPTIONS CCID REQ#43023
    		COMMENT 'REGENERATE WITH NEW COPY BOOKS'
    		COPYBACK
    		SEARCH .