Introduction › SCL Statement Syntax Conventions › Syntax Diagram

Syntax Diagram

The CA Endevor SCM syntax diagram lets you quickly see how to construct a statement or command. The following is a sample syntax diagram for the Archive Element action.

►►─ ARChive ELEment ─ element-name ─┬──────────────────────────────┬─ FROm ───►
                                    └─┬─ THRough ─┬─ element-name ─┘
                                      └─ THRu ────┘
 ►─ ENVironment ─ env-name ─ SYStem ─ sys-name ─ SUBsystem ─ subsys-name ─────►
 ►─ TYPe ─ type-name ─┬─ STAge ─ stage-id ────────┬─ TO ──────────────────────►
                      └─ STAge NUMber ─ stage-no ─┘
 ►─┬─ FILe ───┬─ dd-name ─┬──────────────────────────────┬────────────────────
   └─ DDName ─┘           └─ WHEre ─ ¤ ─┬──────────┬─ ¤ ─┘
                                        ├─┤ CCID ├─┤
                                        └─┤ PRO ├──┘
 ►─┬──────────────────────────────────────────────┬─ . ───────────────────────►◄
   └─ OPTion ─ ¤ ─┬─────────────────────────┬─ ¤ ─┘
                  ├─ CCId ─ ccid ───────────┤
                  ├─ COMment ─ comment ─────┤
                  ├─ OVErride SIGNOut ──────┤
                  └─ BYPass ELEment DELete ─┘

Expansion of CCID

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

Expansion of PRO

                                  ┌─ , ──────────┐
├── PROcessor GROup ─┬─ EQ ─┬─ ( ─▼─ group name ─┴─ ) ─────────────────────────┤
                     └─ = ──┘

This sample syntax diagram contains the following syntax:

ARChive ELEment element-name

The keyword ARChive ELEment appears on the main line, indicating that it is required. The variable element-name, also on the main line, must be coded.

THRough / THRu element-name

The keywords THRough and THRu appear below the main line, indicating that they are optional. They are also mutually exclusive.

FROm ENVironment ... TYPe type-name

Each keyword and variable in this segment appears on the main line, indicating that they are required.

STAge stage-id / STAge NUMber stage-no

The keywords STAge and STAge NUMber appear on and below the main line, indicating that they are required, mutually exclusive keywords.

TO ... dd-name

The keyword TO appears on the main line, indicating that it is required. The keywords FILe and DDName appear on and below the main line, indicating that they are required, mutually exclusive keywords. The variable dd-name also appears on the main line, indicating that it is required.

WHEre clause

This clause appears below the main line, indicating that it is optional. The keyword WHEre appears on the main line of the clause, indicating that it is required. CCID and PRO are syntax fragments that appear below the main line, indicating that they are optional. The boxed-shaped stars (¤) indicate that they are not mutually exclusive.

OPTion clause

This clause appears below the main line, indicating that it is optional. The keyword OPTion appears on the main line of the clause, indicating that it is required. The keywords CCId, COMment, OVErride SIGNOut, and BYPass ELEment DELete all appear below the main line, indicating that they are optional. The boxed-shaped stars (¤) indicate that they are not mutually exclusive.

CCID fragment

The keyword CCId appears on the main line, indicating that it is required. The OF clause appears below the main line, indicating that it is optional. If you code this clause, you must code the keyword OF, as it appears on the main line of the clause. CURrent, ALL, and RETrieve appear above, on, and below the main line of the clause, indicating that they are required, mutually exclusive keywords. CURrent appears above the main line, indicating that it is the default. If you code the keyword OF, you must choose one and only one of the keywords.

The keywords EQual and = appear above and below the main line, indicating that they are optional, mutually exclusive keywords. EQual appears above the main line, indicating that it is the default. You can include only one. The variable ccid appears on the main line, indicating that it is required. The arrow indicates that you can repeat this variable, separating each instance with a comma. Enclose all variables in a single set of parenthesis.

PRO fragment

The keyword PROcessor GROup appears on the main line, indicating that it is required. The keywords EQual and = appear on and below the main line, indicating that they are required, mutually exclusive keywords. You must include one. The variable group name appears on the main line, indicating that it is required. The arrow indicates that you can repeat this variable, separating each instance with a comma. Enclose all variables in a single set of parenthesis.