Archive Syntax

Processing Element Actions › The Archive Statement › Archive Syntax

Archive Syntax

►►─ 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 ─┘

►─┬──────────────────────────────────────────────┬─ . ───────────────────────►◄
  └─ 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 ─┴─ ) ─────────────────────────┤
                     └─ = ──┘

ARCHIVE ELEMENTS element-name

Indicates the element(s) to be archived. 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 archived, beginning with the element coded in the ARCHIVE 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 sys-name

SUBSYSTEM subsys-name

TYPE type-name

STAGE stage-id

STAGE NUMBER stage-no

The FROM clause indicates the location of the element being archived. 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.

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.

TO FILE (DDNAME) dd-name

The TO clause indicates where the element is being archived. CA Endevor SCM uses both the TO clause in an action and any preceding SET TO clause to determine the "to" criteria for that action.

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

The DCB must specify variable blocked records (RECFM=VB), and the DSORG should be PS.

The minimum LRECL should be 2940 or the TYPE-LENGTH plus (+) 14, whichever is greater.
When archiving to disk, the recommended block size is one-half a track, and the recommended LRECL is one-half a track minus (-) 4 unless the previous rule requires a bigger LRECL/BLKSIZE.
When archiving to tape, the recommended block size is 32760 and the recommended LRECL is 32756.

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 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 you to further specify requests.

CCID ccid/COMMENTcomment

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 ARCHIVE action fails.

This is the CCID that CA Endevor SCM looks for if WHERE ARCHIVE CCID is specified for the LIST, COPY, RESTORE, and TRANSFER actions.

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. Note, however, that OVERRIDE SIGNOUT does not apply when you select the BYPASS ELEMENT DELETE option for 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.

BYPASS ELEMENT DELETE

Use this option if you do not want the element automatically deleted (the default) after it is archived. Otherwise, CA Endevor SCM deletes the element, that is, the base and all change levels.

Example: Archive SCL

This SCL archives all of the elements from the Payroll Reporting subsystem. The archived elements will be written to the preallocated DD name "ARCHOUT.' The signout status will be overridden, if necessary.

ARCHIVE ELEMENT '*'
   FROM ENVIRONMENT 'PROD'
        		SYSTEM 'PAYROLL'
        		SUBSYSTEM 'REPORTS'
        		TYPE 'COBOL'
        		STAGE NUMBER 1
  TO DDNAME ARCHOUT
  OPTIONS CCID REQ#44145
        		COMMENT 'ARCHIVE REPORTING SUBSYSTEM PROGRAMS'
        		OVERRIDE SIGNOUT .