Define System Syntax

Performing Administrative Tasks in Batch › Define Statements › The Define System Action › Define System Syntax

Define System Syntax

►►─ DEFine SYStem ─ system-name ─ TO ENVironment ─ environment-name ──────────►

 ►─ DESCription ─ description ────────────────────────────────────────────────►

 ►─ ¤ ─┬────────────────────────────────────────────────────┬─ ¤ ─────────────►
       ├─ NEXt SYStem ─ system-name ────────────────────────┤
       ├─ COMMent ─┬─ NOT REQuired ◄ ─┬─────────────────────┤
       │           └─ REQuired ───────┘                     │
       ├─ CCId ─┬─ NOT REQuired ◄ ─┬────────────────────────┤
       │        └─ REQuired ───────┘                        │
       ├─┬─┤ DUPlicate ELEment ├───┬────────────────────────┤
       │ └─┤ DUPlicate PROcessor ├─┘                        │
       ├─ ELEment JUMp ACKnowledgement ─┬─ REQuired ◄ ───┬──┤
       │                                └─ NOT REQuired ─┘  │
       ├─ SIGnout ─┬─ IS NOT ACTIVe ◄ ─┬────────────────────┤
       │           └─ IS ACTIVe ───────┘                    │
       └─ SIGnout DATASet VALidation ─┬─ IS NOT ACTIVe ◄ ─┬─┘
                                      └─ IS ACTIVe ───────┘

 ►─ STAge ONE LOAd LIBRARY ─┬──────┬─ 'dataset-name' ─────────────────────────►
                            └─ IS ─┘

 ►─┬────────────────────────────────────────────────────┬─────────────────────►
   └─ STAge ONE LISt LIBRARY ─┬──────┬─ 'dataset-name' ─┘
                              └─ IS ─┘

 ►─ STAge TWO LOAd LIBRARY ─┬──────┬─ 'dataset-name' ─────────────────────────►
                            └─ IS ─┘

 ►─┬────────────────────────────────────────────────────┬─────────────────────►
   └─ STAge TWO LISt LIBRARY ─┬──────┬─ 'dataset-name' ─┘
                              └─ IS ─┘

 ►─┬───────────────────────────────────┬─ . ──────────────────────────────────►◄
   ├─┤ RETain ELEment LEVel BY AGE ├───┤
   └─┤ RETain COMPOnent LEVel BY AGE ├─┘

Expansion of DUPlicate ELEment

├──┬─ DUPlicate ELEment ─ name ─ CHEck IS NOT ACTIVe ◄ ─────────────┬──────────┤
   └─  DUPlicate ELEment ─ name ─ CHEck IS ACTIVe ─┬─────────────┬──┘
                                                   └─ ┤ error ├ ─┘

Expansion of DUPlicate PROcessor OUTput

├─ DUPlicate PROcessor OUTput type ┬ CHEck IS NOT ACTIVe ◄ ┬───────────────────►
                                   └── CHEck IS ACTIVe ────┘
►─┬───────────────────┬─┬─────────┬────────────────────────────────────────────┤
  └ ACRoss SUBSystems ┘ └┤ error ├┘

Expansion of error

├──┬───────────────────────────────────────┬───────────────────────────────────┤
   └─ error ─ SEVerity LEVel ─ is ─ W|E|C ─┘

Expansion of RETain ELEment LEVel BY AGE

├──┬─ DO NOT RETain ELEment LEVel BY AGE ◄ ──────────────────────────────┬─────┤
   ├─ RETain ELEment LEVel BY AGE ─┬───────────────────────────────────┬─┤ 
   │                               └─ RET ELE LEV FOR ─ nnn ─ MONths ──┘ │ 
   └─ RET ELE LEV FOR ─ nnn ─ MONths ────────────────────────────────────┘

Expansion of RETain COMPOnent LEVel BY AGE

├──┬─ DO NOT RETain COMPOnent LEVel BY AGE ◄ ───────────────────────────────┬──┤
   ├─ RETain COMPOnent LEVel BY AGE ─┬────────────────────────────────────┬─┤ 
   │                                 └─ RET COMPO LEV FOR ─ nnn ─ MONths ─┘ │ 
   └─ RET COMPO LEV FOR ─ nnn ─ MONths ─────────────────────────────────────┘

The Define System statement includes the following clauses and options.

DEFINE SYSTEM system-name

Specifies the one- to eight-character name of the System you are creating or updating. Name masking is allowed. A name masked System name updates all matching System definitions.

TO ENVIRONMENT environment-name

Specifies the Environment to which you are defining the System. The Environment name you specify must be fully qualified; name masking is not allowed.

DESCRIPTION description

Describes this System with text of up to 50 characters in length. If the text contains embedded spaces, enclose it in single or double quotation marks. This clause is required when you create a System definition. The clause is optional, when you update a System definition.

NEXT SYSTEM system-name

Specifies the name of the System in the next Environment. If you do not specify this clause, the value defaults to the name of the System you are creating or updating.

COMMENTS REQUIRED | NOT REQUIRED

Specifies whether comments are required for actions against elements in this System. The default is COMMENTS NOT REQUIRED.

CCID REQUIRED | NOT REQUIRED

Specifies whether CCIDs are required for actions against elements in this System. The default is CCID NOT REQUIRED.

DUPLICATE ELEMENT NAME CHECK IS ACTIVE | IS NOT ACTIVE

Specifies whether the element name registration feature is active. If this clause is omitted, the default is DUPLICATE ELEMENT NAME CHECK IS NOT ACTIVE. The following option applies to this clause:

ERROR SEVERITY LEVEL

Specifies the message severity level for messages that result when errors are found during an element name registration check. This clause is only valid if the Define System statement includes the clause DUPLICATE ELEMENT NAME CHECK IS ACTIVE. Valid values are:

W - Warning
C - Caution
E - Error - The default, if this clause is omitted.

DUPLICATE PROCESSOR OUTPUT TYPE CHECK IS ACTIVE | IS NOT ACTIVE

Specifies whether the duplicate processor output type check is active. If active, CA Endevor SCM compares element names across types and processors groups for the same processor output type. A conflict occurs if a user attempts to add or create an element and an element with the same name and processor output Type exists in the same System, with a different Type. If this clause is omitted, the default is DUPLICATE PROCESSOR OUTPUT TYPE CHECK IS NOT ACTIVE. The following options apply to this clause:

ACROSS SUBSYSTEMS

Specifies whether the check extends to the Subsystems defined to this System. This clause is only valid if DUPLICATE PROCESSOR OUTPUT TYPE CHECK IS ACTIVE.

ERROR SEVERITY LEVEL

Specifies the message severity level for messages that result when errors are found during a duplicate processor output Type check. This clause is only valid if the Define System statement includes the clause DUPLICATE PROCESSOR OUTPUT TYPE CHECK IS ACTIVE. Valid values are:

W - Warning
C - Caution
E - Error - The default, if this clause is omitted.

ELEMENT JUMP ACKNOWLEDGMENT REQUIRED | NOT REQUIRED

Specifies whether users must use ACKNOWLEDGE ELM JUMP=Y when moving elements. CA Endevor SCM uses this field when it finds an element being moved at a nonmapped Stage between the from and to locations of the move. The default is ELEMENT JUMP ACKNOWLEDGMENT REQUIRED.

SIGNOUT IS ACTIVE | NOT ACTIVE

Specifies whether the signin/signout facility is active for this System. If this option is active, CA Endevor SCM performs signin and signout processing. The default is SIGNOUT IS NOT ACTIVE.

SIGNOUT DATASET VALIDATION IS ACTIVE | NOT ACTIVE

Specifies whether data set validation is active for this System. If this option is active, when an element is retrieved, the name of the data set to which the element was retrieved to (and member name if the data set is a library) is placed in the element master record. When an Add or Update action is performed against an element, CA Endevor SCM compares the retrieve to data set name (and member name if applicable) to the source input data set and member name specified for the action. If the data set (and member) names match, the action continues. If the names do not match, CA Endevor SCM checks the override signout value on the request. If the override signout value is Y, processing continues, if N, the action fails.

The default is SIGNOUT DATASET VALIDATION IS NOT ACTIVE.

STAGE ONE | TWO LOAD LIBRARY is dataset-name

Specifies the data set names of the processor load libraries for the System. The data set name must meet the following requirements:

Fully qualified and no longer than 44 characters in length.
Predefined and cataloged in the system catalog.
Partitioned data set.
Undefined record format (DCB=RECFM=U).

This clause is required when creating the System definition. The clause is optional when updating a System definition.

STAGE ONE | TWO LIST LIBRARY is dataset-name

Specifies the processor listing libraries for this system.

RETAIN ELEMENT LEVEL BY AGE | DO NOT RETAIN ELEMENT LEVEL BY AGE | RETAIN ELEMENT LEVEL FOR nnn MONTHS

Optional. Specifies whether old element delta levels are retained and for how many months they are retained.

When creating a system, the clause has the following effect:

If you do not code any of the options, then the default is DO NOT RETAIN ELEMENT LEVEL BY AGE.
You can code RETAIN ELEMENT LEVEL BY AGE alone or with RETAIN ELEMENT LEVEL FOR nnn MONTHS.
- If you code RETAIN ELEMENT LEVEL BY AGE alone, then the retention time defaults to 999 months.
- If you code RETAIN ELEMENT LEVEL FOR nnn MONTHS alone, then RETAIN ELEMENT LEVEL BY AGE is assumed.

When updating a system, the clause has the following effect:

If the existing system is coded with DO NOT RETAIN ELEMENT LEVEL BY AGE and you want to enable the retention feature, then you must code RETAIN ELEMENT LEVEL BY AGE. If you want to specify a retention time less than 999 months, you must also code RETAIN ELEMENT LEVEL FOR nnn MONTHS.
If the existing system is coded with RETAIN ELEMENT LEVEL BY AGE and you want to specify a retention time less than 999 months, then you only need to code RETAIN ELEMENT LEVEL FOR nnn MONTHS.
If the existing system is coded with RETAIN ELEMENT LEVEL BY AGE and you want to turn off the retention feature, you must code DO NOT RETAIN ELEMENT LEVEL BY AGE.

RETAIN ELEMENT LEVEL BY AGE: Specifies that aged delta level retention for elements is in effect. If this clause is specified, but the RETAIN ELEMENT LEVEL FOR nnn MONTHS clause is not, then elements are retained for 999 months.
DO NOT RETAIN ELEMENT BY AGE: Specifies that aged delta level retention of element is not in effect. This clause is the default if neither RETAIN ELEMENT LEVEL BY AGE nor RETAIN ELEMENT LEVEL FOR nnn MONTHS are specified.
RETAIN ELEMENT LEVEL FOR nnn MONTHS: Specifies that aged delta level retention for elements is in effect and the number of months that element levels are retained. Valid values are 1 through 999. This clause can be specified alone or with RETAIN ELEMENT LEVEL BY AGE. When used either way the effect is the same.

RETAIN COMPONENT LEVEL BY AGE | DO NOT RETAIN COMPONENT LEVEL BY AGE | RETAIN COMPONENT LEVEL FOR nnn MONTHS

Optional. Specifies whether old component delta levels are retained and for how many months they are retained.

When creating a System, this clause has the following effects:

If you do not code any of the options, then the default is DO NOT RETAIN COMPONENT LEVEL BY AGE.
You can code RETAIN COMPONENT LEVEL BY AGE alone or with RETAIN COMPONENT LEVEL FOR nnn MONTHS.
- If you code RETAIN COMPONENT LEVEL BY AGE alone, then the retention time defaults to 999 months.
- If you code RETAIN COMPONENT LEVEL FOR nnn MONTHS alone, then RETAIN COMPONENT LEVEL BY AGE is assumed

When updating a system, this clause has the following effects:

If the existing system is coded with DO NOT RETAIN COMPONENT LEVEL BY AGE and you want to enable the feature, then you must code RETAIN COMPONENT LEVEL BY AGE. If you want to specify a retention time less than 999 months, you must also code RETAIN COMPONENT LEVEL FOR nnn MONTHS.
If the existing system is coded with RETAIN COMPONENT LEVEL BY AGE and you want to specify a retention time less than 999 months, then you only need to code RETAIN COMPONENT LEVEL FOR nnn MONTHS.
If the existing system is coded with RETAIN COMPONENT LEVEL BY AGE and you want to turn off the feature, you must code DO NOT RETAIN COMPONENT LEVEL BY AGE.

RETAIN COMPONENT LEVEL BY AGE: Specifies that aged delta level retention for components is in effect. If RETAIN COMPONENT LEVEL BY AGE is specified, but the RETAIN COMPONENT LEVEL FOR nnn MONTHS clause is not, then components are retained for 999 months.
DO NOT RETAIN COMPONENT BY AGE: Specifies that aged delta level retention of component is not in effect. This clause is the default if neither RETAIN COMPONENT LEVEL BY AGE nor RETAIN COMPONENT LEVEL FOR nnn MONTHS are specified.
RETAIN COMPONENT LEVEL FOR nnn MONTHS: Specifies that aged delta level retention for components is in effect and the number of months that component levels are retained. Valid values are 1 through 999. This clause can be specified alone or with RETAIN COMPONENT LEVEL BY AGE. When used either way the effect is the same.

Example: Define System SCL

In this example DEFINE SYSTEM statement, a System named ACCT is created in the DEVEL environment. When a user performs an action against any element in this System, the user must enter a comment. In addition, CA Endevor SCM signin/signout processing and signout data set validation are active for this System. This statement also specifies the location of the optional Stage One and Stage Two List libraries.

DEFINE SYSTEM "ACCT"
  	TO ENVIRONMENT "DEVEL"
  	DESCRIPTION "The Accounting System"
  	COMMENTS REQUIRED
  	SIGNOUT DATASET VALIDATION IS ACTIVE
  	SIGNOUT IS ACTIVE
  	STAGE ONE LOAD LIBRARY IS "ENDEVOR.LOAD1.ACCT"
  	STAGE ONE LIST LIBRARY IS "ENDEVOR.LIST1.ACCT"
  	STAGE TWO LOAD LIBRARY IS "ENDEVOR.LOAD2.ACCT"
  	STAGE TWO LIST LIBRARY IS "ENDEVOR.LIST2.ACCT" .