SCL Reference Guide
SCL Reference Guide
Change Manager
SCL Reference Guide
r7
F00182-1E
This documentation and related computer software program (hereinafter referred to as the
“Documentation”) is for the end user's informational purposes only and is subject to change or
withdrawal by Computer Associates International, Inc. (“CA”) at any time.
This documentation may not be copied, transferred, reproduced, disclosed or duplicated, in whole or
in part, without the prior written consent of CA. This documentation is proprietary information of CA
and protected by the copyright laws of the United States and international treaties.
Notwithstanding the foregoing, licensed users may print a reasonable number of copies of this
documentation for their own internal use, provided that all CA copyright notices and legends are
affixed to each reproduced copy. Only authorized employees, consultants, or agents of the user who
are bound by the confidentiality provisions of the license for the software are permitted to have access
to such copies.
This right to print copies is limited to the period during which the license for the product remains in
full force and effect. Should the license terminate for any reason, it shall be the user's responsibility to
return to CA the reproduced copies or to certify to CA that same have been destroyed.
To the extent permitted by applicable law, CA provides this documentation “as is” without warranty
of any kind, including without limitation, any implied warranties of merchantability, fitness for a
particular purpose or noninfringement. In no event will CA be liable to the end user or any third
party for any loss or damage, direct or indirect, from the use of this documentation, including without
limitation, lost profits, business interruption, goodwill, or lost data, even if CA is expressly advised of
such loss or damage.
The use of any product referenced in this documentation and this documentation is governed by the
end user's applicable license agreement.
Provided with “Restricted Rights” as set forth in 48 C.F.R. Section 12.212, 48 C.F.R. Sections
52.227-19(c)(1) and (2) or DFARS Section 252.227-7013(c)(1)(ii) or applicable successor provisions.
All trademarks, trade names, service marks, and logos referenced herein belong to their respective
companies.
Contents
Contents iii
2.3.2 Example 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-8
2.3.3 Example 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
2.3.4 Example 4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
Contents v
4.11.2 Printing from Endevor . . . . . . . . . . . . . . . . . . . . . . . . 4-61
4.11.3 Printing from an Output Library . . . . . . . . . . . . . . . . . . 4-61
4.11.4 Print Element Statement . . . . . . . . . . . . . . . . . . . . . . . 4-62
4.11.5 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-62
4.11.5.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-63
4.11.6 Print Member Statement . . . . . . . . . . . . . . . . . . . . . . . 4-68
4.11.7 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-68
4.11.7.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-68
4.11.8 Example of Print SCL . . . . . . . . . . . . . . . . . . . . . . . . . 4-69
4.12 The Restore Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-70
4.12.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-70
4.12.2 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-70
4.12.2.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-71
4.12.3 Example of Restore SCL . . . . . . . . . . . . . . . . . . . . . . . 4-75
4.13 The Retrieve Statement . . . . . . . . . . . . . . . . . . . . . . . . . . 4-76
4.13.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-76
4.13.2 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-76
4.13.2.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-77
4.13.3 Example of Retrieve SCL . . . . . . . . . . . . . . . . . . . . . . . 4-82
4.14 The Signin Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-83
4.14.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-83
4.14.2 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-83
4.14.2.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-84
4.14.3 Example of Signin SCL . . . . . . . . . . . . . . . . . . . . . . . . 4-86
4.15 The Transfer Statement . . . . . . . . . . . . . . . . . . . . . . . . . . 4-87
4.15.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-87
4.15.2 Transfer from Endevor to Endevor Statement . . . . . . . . . . 4-87
4.15.3 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-88
4.15.3.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-89
4.15.4 Transfer from Endevor to Archive Data Set Statement . . . . . 4-97
4.15.5 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-97
4.15.5.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-98
4.15.6 Transfer from Archive Data Set or Unload Tape to Endevor
Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-104
4.15.7 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-105
4.15.7.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-106
4.15.8 Example of Transfer SCL . . . . . . . . . . . . . . . . . . . . . . . 4-113
4.16 The Update Statement . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-114
4.16.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-114
4.16.2 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-114
4.16.2.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-114
4.16.3 Example of Update SCL . . . . . . . . . . . . . . . . . . . . . . . 4-118
Contents vii
5.12.3 Example of Execute Package SCL . . . . . . . . . . . . . . . . . . 5-27
5.13 Export Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
5.13.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
5.13.2 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
5.13.2.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-28
5.13.3 Example of Export Package SCL . . . . . . . . . . . . . . . . . . 5-29
5.14 Inspect Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
5.14.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
5.14.2 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
5.14.2.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-30
5.15 Reset Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31
5.15.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31
5.15.2 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31
5.15.2.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-31
5.15.3 Example of Reset Package SCL . . . . . . . . . . . . . . . . . . . 5-31
5.16 Submit Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32
5.16.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32
5.16.2 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32
5.16.2.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5-32
5.16.3 Example of Submit Package SCL . . . . . . . . . . . . . . . . . . 5-35
Contents ix
6.6.3 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-73
6.6.3.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-73
6.6.4 Delete Approver Relation . . . . . . . . . . . . . . . . . . . . . . . 6-75
6.6.5 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-75
6.6.5.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-75
6.6.6 Delete Processor Group . . . . . . . . . . . . . . . . . . . . . . . . 6-77
6.6.7 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-77
6.6.7.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-77
6.6.8 Delete Processor Symbol . . . . . . . . . . . . . . . . . . . . . . . . 6-78
6.6.9 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-78
6.6.9.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-78
6.6.10 Delete Shipment Destination . . . . . . . . . . . . . . . . . . . . . 6-80
6.6.11 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-80
6.6.11.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-80
6.6.12 Delete Shipment Mapping Rule . . . . . . . . . . . . . . . . . . . 6-81
6.6.13 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-81
6.6.13.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-81
6.6.14 Delete Subsystem . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-82
6.6.15 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-82
6.6.15.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-82
6.6.16 Delete System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-83
6.6.17 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-83
6.6.17.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-83
6.6.18 Delete Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-84
6.6.19 Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-84
6.6.19.1 Syntax Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-84
Because of its consistent nature, SCL is easy to learn and use. For example,
you can establish global settings that can be used over and over. This
provides a concise and consistent set of options or location information which
can be applied to any number of actions, and you need code this information
only once in each job stream. Conversely, you can override any pre-
established settings by entering like information in a particular request.
There are many features and benefits to using SCL. The following list
emphasizes those aspects of SCL that both facilitate and enhance Endevor
processing.
■ SCL allows you to set up a single list or multiple lists of element actions
for further manipulation in Endevor.
■ SCL allows you to manipulate elements or members singly, on a
module-by-module level. SCL also allows you to manipulate several
library members or module elements at a time. You can tailor your coding
to meet your requirements at any time.
■ SCL is extremely flexible. You can establish global settings for element
action requests (using a SET statement), and override one or all of your
selections on a local level; that is, within each individual element action
request. In addition:
– You can define the files you want to manipulate either within the
language (for example, using a clause such as SET DSNAME...) or
external to the language (for example, using a clause such as SET
FILE...).
1.1.1 Overview
Element action SCL statements are processed in type sequence order. The type
specified in the FROM or TO clause determines the sequence in which element
action requests are processed.
An element's type is indicated in the FROM clause or TO clause (or both). The
exact type entry used to determine the processing sequence (that is, type as
defined in the FROM clause or the TO clause) depends upon the element
action requested.
When Global Type Sequencing IS NOT in Effect: Actions are put into the
appropriate sequence and executed within each system. In the following
example, actions have been requested for twsystems: System A and System B .
Assume that the system administrator has established the following type
processing sequences:
■ For System A: COPYBOOK, then COBOL
■ For System B: MACRO, then ASSEMBLER
Given the element type definitions shown for each action, processing would
occur in the following sequence.
1. SYSTEM A: ADD ELEMENTS...TYPE COPYBOOK
2. SYSTEM A: GENERATE ELEMENTS...TYPE COPYBOOK...
3. SYSTEM A: ADD ELEMENTS...TYPE COBOL...
4. SYSTEM B: RETRIEVE ELEMENTS...TYPE MACRO
5. SYSTEM B: ADD ELEMENTS...TYPE ASSEM...
Note: The element type must have been previously defined by your
administrator, and placed in the appropriate sequence using the Type
Processing Sequence panel. For details, refer to the discussion about defining
type sequence processing in the Administrator Guide.
When Global Type Sequencing IS in Effect Actions are put into the
appropriate type sequence and executed as defined by your administrator. For
example, assume that the system administrator has established the following
type sequence:
1. COPYBOOK
2. MACRO
3. COBOL
4. ASSEMBLER
Given the element type sequencing definition, processing would occur in the
following sequence.
1. ADD ELEMENTS...TYPE COPYBOOK
2. GENERATE ELEMENTS...TYPE MACRO
3. RETRIEVE ELEMENTS...TYPE MACRO
4. ADD ELEMENTS...TYPE COBOL
5. ADD ELEMENTS...TYPE ASSEMBLER
1.2.1 Overview
When you submit your SCL requests, Endevor follows a specific processing
flow to execute the actions.
Note: If the option Global Type Sequencing is enabled at your site, the
processing order is different. SCL element actions execute in type sequence
order defined at the site level by the Endevor administrator, regardless of the
action's inventory location. For details, see Global Type Sequence Processing
Order.
If Global Type Sequencing is not enabled at your site, the process flow is as
follows:
1. Endevor first parses, or validates, the SCL syntax, assigning a statement
number to each SCL statement coded.
A Syntax Report is produced, echoing the SCL statements entered and
flagging any syntax errors.
2. When all requests have been validated, Endevor checks for errors. If
errors exist within the syntax, processing is terminated.
If no errors exist, processing continues.
3. Endevor checks whether any statements have been entered with an archive
file designated as the FROM location. All such actions are performed first,
as they are encountered.
For example, assume you code both an ARCHIVE action and a RESTORE
action. If you want Endevor to perform the RESTORE action before the
ARCHIVE action, designate an archive file as the RESTORE action's FROM
location. If you want to perform the ARCHIVE action before the
RESTORE action, however, you need to execute SCL twice—first to
perform the ARCHIVE action and then to perform the RESTORE action.
For elements that are restored, transferred, copied, or listed from an archive
file, processing occurs as follows:
■ The element(s) is restored (or transferred, copied, or listed), but it is
not generated at this time.
■ Endevor continues processing the remaining actions, as described in
the following steps (beginning with Step 4, below).
4. Endevor expands any name mask that may have been entered for system,
subsystem, stage, and type.
■ Beginning with the first SCL syntax request, Endevor checks for use of
the name mask with the system name.
If a name mask has not been used with the system name in the first
SCL syntax request, Endevor checks for the name mask in the next
syntax request. If no name mask is found and the system name is the
same, Endevor checks the system name of the third syntax request.
This procedure continues until a system name is found with a name
mask or a new system name is encountered, or until all syntax
requests have been searched.
When one of the three situations mentioned above occurs, Endevor
returns to the first syntax request and checks for a name mask with the
type name.
Again, if no name mask is found, the second syntax request is checked,
and so on until a type name is found with a name mask or a new type
name is encountered, or until all syntax requests have been checked.
This procedure is repeated for stage and subsystem.
Endevor examines each clause (SYSTEM and STAGE) in the syntax
request until a non-match is found. Once a difference is encountered,
Endevor executes the previous syntax requests—in type sequence
order (see Step 5). Processing then continues accordingly with the next
syntax request.
■ If a name mask has been used with the system name in the first syntax
request, Endevor expands the entries. Then, within each system of the
first syntax request, any remaining name masks are expanded (in the
appropriate order).
5. Endevor sorts the types based on type sequence order.
Processing involves syntax requests for stage within a particular system.
Type processing sequence conventions still apply, however. If a name
mask is not used with type, the syntax requests themselves are sorted in
type sequence order.
If a name mask is used with type, actions across all syntax requests are
executed in type sequence order. So, depending on the elements indicated
(see Step 6 below), it is not unusual to see an ADD from syntax #2,
followed by a GENERATE from syntax #3, followed by an ADD from
syntax #2. When all information has been generated for the first (set of
matching) syntax request(s), Endevor executes the next (set of) syntax
request(s).
6. Once all types have been defined, Endevor checks the stage identifier
involved within the first type. If a name mask has been used with the
stage identifier, Endevor expands the entries.
Still within the first type, and within the first stage identified, Endevor
expands any subsystem name masks that have been coded.
7. Endevor expands the element name mask if it exists (element is the
element-name entered in the first [action] clause of the statement) and
executes each action within the system, including those actions previously
performed but not generated (because they were from an archive file).
Remember: all SCL statements are executed in type sequence order.
8. Endevor assigns each action an action number. As all actions are
processed, an Execution Report is produced. The Execution Report fully
expands the action request, providing the complete system name,
subsystem name, type, and stage for the element being processed. In
addition, the report lists all options in effect for the action. Endevor also
produces a Summary Report. This report provides one line of summary
information for each action performed.
1.2.2 Example
The example above displays a typical set of SCL requests. The type processing
sequence has been determined as COPYBOOK, COBOL, MACRO. Processing
takes place as follows:
1. Endevor first checks the system specification. No name mask is found, but
the system in request #4 —PERSONEL—differs from the system in the first
three requests—FINANCE.
Any types that are not included in the Type Sequence member are processed
after all the types in the Type Sequence member have completed processing.
1.4.1 Usage
There are three ways to mask names: by using the wildcard character (*), by
using the placeholder character (%), and by using both together.
The wildcard (*) can be used in one of two ways to specify external file names:
■ When coded as the only character of a search string, Endevor returns all
members of the search field. For example, if you coded the statement
ADD ELEMENT *, all elements would be added.
■ When coded as the last character of a search string, Endevor returns all
members of the search field beginning with the characters in the search
string preceding the wildcard. For example:
– The statement ADD ELEMENT UPD* would add all elements
beginning with "UPD", such as UPDATED or UPDATE.
– PKG* would return all package IDs beginning with PKG.
Note: You cannot use more than one wildcard in a string. The statement
ADD ELEMENT U*PD* would result in an error.
The placeholder (%), which represents any one character in a string, can also
be used in one of two ways:
■ When coded as the last character in a string, Endevor returns all members
of the search field, beginning with the characters in the search string
preceding the placeholder, but which have no more characters than were
coded in the search string.
– If you coded the statement ADD ELEMENT UPD%, only those
elements with four-character-long names beginning with "UPD" (UPD1
or UPDA, for example) would be added.
– PKG% returns PKGS, PKGB, PKGC, and so on.
■ It is also possible to use the placeholder multiple times in a single search
string. The statement ADD ELEMENT U%PD% would return all elements
with five-character-long names that have U as the first character, and PD
third and fourth.
The wildcard and the placeholder can be used together, provided that the
wildcard appears only at the end of the search string and is used only once.
For example:
■ The statement ADD ELEMENT U%D*, which uses both the wildcard and
the placeholder, would add elements with names of any length that have
U as the first character, any one character as the second character, and D
as the third character.
■ P%G* returns PKGABCD, POGS, PIGGY, PPG1234NDVR, and so on.
Use the asterisk to specify all names, or all names beginning with a particular
character string. Enter the asterisk as the last or only character in any of the
eligible fields, including element name, system name, subsystem name, type
name, and stage. Multiple asterisks are not allowed.
Use the percent sign as a substitute for a single character in a name. For
example, if you typed COPY% as the element name, Endevor would locate all
elements with 5-character names beginning with COPY. You can use multiple
instances of the % character. You can also use the % and * characters together.
Syntax Explanation
────────────────────────────────── Represents the beginning of a
syntax statement.
────────────────────────────────── Represents the end of a syntax
statement.
─────────────────────────────────── Represents the continuation of a
syntax statement to the following
line.
─────────────────────────────────── Represents the continuation of a
syntax statement from the
preceding line.
Syntax Explanation
Syntax Explanation
──ARChive ELEment──element-name──┬───────────────────────────┬───────
└─┬─THRough─┬──element-name─┘
└─THRu────┘
──FROm──ENVironment──env-name──SYStem──sys-name───────────────────────
──SUBsystem──subsys-name──TYPe──type-name─────────────────────────────
──┬─STAge──stage-id────────┬──TO──┬─FILe───┬──dd-name─────────────────
└─STAge NUMber──stage-no─┘ └─DDName─┘
──┬───────────────────────────┬───────────────────────────────────────
└─WHEre──¤──┬──────────┬──¤─┘
├─┤ CCID ├─┤
└─┤ PRO ├──┘
──┬─────────────────────────────────────────┬──.─────────────────────
└─OPTion──¤──┬───────────────────────┬──¤─┘
├─CCId──ccid────────────┤
├─COMment──comment──────┤
├─OVErride SIGNOut──────┤
└─BYPass ELEment DELete─┘
CCID:
┌─EQual─┐ ┌─,────┐
─ccid─┴──)───────────────┤
├──CCId──┬──────────────────┬──┼───────┼──(───
│ ┌─CURrent──┐ │ └─=─────┘
└─OF──┼─ALL──────┼─┘
└─RETrieve─┘
PRO:
┌─,──────────┐
─group name─┴──)───────────────────────┤
├──PROcessor GROup──┬─EQ─┬──(───
└─=──┘
Syntax Explanation
ARChive ELEment The keyword ARChive ELEment appears on the
element-name main line, indicating that it is required. The
variable element-name, also on the main line, must
be coded.
THRough / THRu The keywords THRough and THRu appear below
element-name the main line, indicating that they are optional.
They are also mutually exclusive.
FROm ENVironment ... Each keyword and variable in this segment appear
TYPe type-name on the main line, indicating that they are required.
STAge stage-id / STAge The keywords STAge and STAge NUMber appear
NUMber stage-no on and below the main line, indicating that they
are required, mutually exclusive keywords.
Syntax Explanation
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 stars (¤) indicate that they are
not mutually exclusive. For details on the CCID
and PRO fragments, see the bottom of this table.
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 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 any and all variables in a
single set of parenthesis.
Syntax Explanation
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
any and all variables in a single set of parenthesis.
The following characters are allowed when coding syntax, but must be
enclosed in either single (') or double (") quotation marks:
■ Space
■ Tab
■ New line
■ Carriage return
■ Comma (,)
■ Period (.)
■ Equal sign (=)
■ Greater than sign (>)
You must enter a period at the end of each statement. If no period is found,
you receive an error message and the job terminates.
If you use the &&ACTION statement, you must have previously coded a SET
ACTION statement. Refer to the descriptions of SET ACTION in the Set
Action section of Chapter 3, “Set, Clear, and EOF Statements”, and the
description of &&ACTION in the &&ACTION Statement section of Chapter 4,
“Element Action Statements”, for complete coding information.
■ The SCL parser does not look for information in columns 73-80 of the
input. Therefore, be sure that all relevant information is coded in columns
1-72.
■ The SCL parser does not catch duplicate clauses coded for an SCL request.
If you code the same clause twice, SCL uses the Boolean "AND" to
combine the clauses. If the result is invalid, you receive an error message.
■ If you enter an asterisk (*) in column 1, the remainder of the line is
considered a comment by the SCL parser and is ignored during
processing.
■ Any value found to the right of the period terminating the SCL statement
is considered a comment by the SCL parser and is ignored during
processing.
SCL keyword parameters cannot span multiple lines; however, the parameter
values can span multiple lines. All SCL parameter values that span multiple
lines must be enclosed in single or double quotes. The syntax required to span
a parameter value must start with a single or double quote at the beginning of
the specification and a trailing single or double quote at the end of the value.
Spaces at the beginning or end of the spanned lines, must be surrounded by
non-blank characters in order to be included in the text string. Example:
ADD ELEMENT 'Spanned
ElementName' CCID 'CC
ID1'
A filename can include a suffix, or extension, that indicates its file type. An
extension consists of a period (.) and several characters. For example, files that
are C code could have the extension .c, as in the filename dbmod3.c. Having
groups of files with identical suffixes makes it easier to run commands against
many files at once.
SET statements also allow consistency across several actions. If you want to
use a particular option (such as CCID or comments) for several actions or
perform actions against those elements in a specific location (TO or FROM),
code the appropriate SET statement. The data you enter is applied to every
subsequent action. SET statements are in effect until another SET statement or
a CLEAR statement is encountered, or processing ends.
You can enter either EOF or EOJ. Use the value to which you are most
accustomed.
2.2.1 Overview
References are made to statements and clauses throughout this manual. For SCL
purposes, these terms are defined as follows:
■ A statement begins with an action (for example, ADD or DEFINE) and ends
with a period (.). A statement consists of one or more clauses, depending
on how you code the SCL syntax.
■ A clause is an individual line of information within each statement (for
example, FROM ENVIRONMENT TEST or WHERE CCID EQ 'FIX01').
Any number of clauses may be contained within one statement.
3. SYSTEM FINANCE
4. SUBSYSTEM ACCTPAY
5. TYPE COBOL
Lines 1-7 form a statement. Line 1 begins with an action (MOVE) and line 7
ends with a period.
Lines 2-5 constitute a single clause (a FROM clause). Lines 6 and 7 are
individual clauses. Each of these clauses provide information essential to the
statement.
In the example above, you might code the FROM clause last and the OPTIONS
clause immediately after the MOVE ELEMENTS clause. Within the FROM
clause, though, you must enter ENVIRONMENT first, followed by SYSTEM,
followed by SUBSYSTEM, followed by TYPE.
2.3.1 Example 1
Example 1 illustrates long-hand SCL. The TRANSFER, FROM, TO, WHERE,
and OPTIONS statements are repeated for each element.
Note that the information coded in the FROM clauses (except in the last FROM
clause where TYPE is different), TO clause, WHERE clause, and OPTIONS
clause is the same. Although there is nothing wrong with coding every line of
a request, you may find it time-consuming when you need to code several
requests. Therefore, it is important to consider several "shortcuts" when
coding the element action syntax. Examples 2 - 4 on the following pages
demonstrate these shortcuts.
2.3.2 Example 2
Example 2 illustrates the concept of global settings, using SET statements to
assign the location (FROM and TO) information, as well as common WHERE
and OPTIONS data.
STAGE NUMBER2.
STAGE NUMBER 1.
In this example, all SET statements coded at the beginning of the syntax are
applied to the first two TRANSFER action requests. Because the type is
different for the third TRANSFER action request, however, a new SET FROM
statement has been entered—containing only the different information.
This new type will be applied to the subsequent TRANSFER request. But, all
other previously-coded information will be applied also. Remember: the data
entered in a SET statement remains in effect until a new, like SET statement (or
a CLEAR statement) is encountered.
2.3.3 Example 3
Example 3 illustrates a combination of global and local settings.
In this example, the SET statements are applied to all three TRANSFER action
requests, with the exception of type in the third request.
2.3.4 Example 4
Example 4 illustrates the use of the name mask. The name mask indicates that
all elements beginning with the indicated letters should be considered for an
action.
In this example, use of the asterisk alone in the TRANSFER ELEMENTS clause
indicates that all elements—as long as the remaining selection criteria is
met—should be selected for the TRANSFER.
Use of the name mask in the TYPE clause indicates that any type will be
acceptable in the TRANSFER action.
Using the name mask with the element name and the type eliminates the need
to set and change SET statements (as was done in examples 2 and 3). Example
4 instructs Endevor to look for all elements, no matter what type, from the
Endevor location indicated (in the environment, system, subsystem, and stage
number clauses), associated with a CCID of FIX01. And, the comment FIX
BUG will be applied to all elements meeting that selection criteria.
This chapter illustrates the syntax for SET, CLEAR, and EOF statements, and
explains the coding rules specific to each statement. SET, CLEAR, and EOF
statements apply only to element action statements (described in the next
chapter). See the About the SCL Language section for examples of syntax using
SET and CLEAR statements.
You can remove a SET statement by using a CLEAR statement for the same
keyword. Be sure to issue the CLEAR statement after the related element
action statement; otherwise, the SET statement is canceled and you may
receive an error message. (CLEAR statements are explained later in this
chapter.)
Note: The SET statement establishes default values; it is never executed.
Therefore, no element processing is involved.
3.1.1 Conventions
The following conventions apply to all SET statements.
■ SET statements are applied globally to all element action statements
following the entry. Each SET statement remains in effect until one of the
following conditions occurs:
– Endevor encounters another, like SET statement, which overrides the
existing SET statement.
– Endevor encounters a CLEAR statement for that particular SET
statement. For example, a CLEAR WHERE statement would cancel a
SET WHERE statement.
– Processing for this job ends; that is, an EOF or EOJ statement is
encountered.
■ SET statements, and the information contained in each, apply only
where similar data appears on a "local" level; that is, within a specific
action statement. For example, if one of the actions following a SET TO
statement does not require any TO data, the SET TO statement is ignored.
■ Information in the SET statement will be replaced by any overriding SET
values coded locally. That is, if the element action syntax contains the
variable specified in the SET statement, the like information in the SET
statement is ignored. For example, if you enter system and subsystem
names in the FROM clause for a COPY action, Endevor uses those names
rather than the names coded in the related SET FROM statement.
3.1.3 Syntax
──SET ACTion──┬─ADD──────┬──.───────────────────────────────────────
├─ARChive──┤
├─COPy─────┤
├─DELete───┤
├─GENerate─┤
├─LISt─────┤
├─MOVe─────┤
├─PRInt────┤
├─REStore──┤
├─RETrieve─┤
├─SIGnin───┤
├─TRAnsfer─┤
└─UPDate───┘
SET ACTION
When you use this statement, Endevor sets the action in all following
&&ACTION statements to the action you indicate in this statement. The action
specifed applies until the system encounters another SET ACTION or a CLEAR
ACTION statement, or when processing is terminated.
Although you can enter more than one SET ACTION statement in your syntax,
only the action indicated in the SET ACTION statement immediately preceding
the &&ACTION statement is performed.
You can code the following actions in the SET ACTION statement:
LIST—lists elements from the Master Control File or an archive data set, or
lists members from a library.
3.1.5 Syntax
──SET BUIld──¤──┬──────────────────────┬──¤──.──────────────────────
├─ACTion──┬─&&Action─┬─┤
│ ├─ADD──────┤ │
│ ├─ARChive──┤ │
│ ├─COPy─────┤ │
│ ├─DELete───┤ │
│ ├─GENerate─┤ │
│ ├─LISt─────┤ │
│ ├─MOVe─────┤ │
│ ├─PRInt────┤ │
│ ├─REStore──┤ │
│ ├─RETrieve─┤ │
│ ├─SIGnin───┤ │
│ ├─TRAnsfer─┤ │
│ └─UPDate───┘ │
├─LEVel──┬─CURrent─┬───┤
│ ├─NONe────┤ │
│ └─ACTUal──┘ │
└─WITh COMponent───────┘
LIST—lists elements from the Master Control File or an archive data set, or
lists members from a library.
SET BUILD LEVEL applies only to elements in Endevor (as opposed to those
elements currently in external files). The level coded stays in effect until
Endevor encounters the next SET BUILD LEVEL or a CLEAR BUILD LEVEL
statement, or processing ends.
The exact information used from the SET FROM statement depends on both
the specific action and the data you have entered in that action statement.
What you enter in the action's FROM clause overrides that particular entry in
the SET FROM statement. For example, you code all Endevor location
information (environment, system, subsystem, type, and stage number or stage
ID) in a SET FROM statement. Then, when coding a RETRIEVE statement,
you enter a different type. Endevor determines the FROM location by
applying all SET FROM information except for the type, which is taken from
the RETRIEVE statement.
3.1.7 Syntax
──SET FROm──┬─SYSOut────────────────────────────────────────┬──.────
├─C1Print───────────────────────────────────────┤
├─┬─FILe───┬──dd-name───────────────────────────┤
│ └─DDName─┘ │
├─DSName──dataset-name──┬─────────────────────┬─┤
│ └─MEMber──member-name─┘ │
└─┤ LOCATION ├──────────────────────────────────┘
LOCATION:
├──ENVironment──env-name──SYStem──sys-name──SUBsystem──subsys-name─────
──TYPe──type-name──┬────────────────────────┬─────────────────────────┤
├─STAge──stage-id────────┤
└─STAge NUMber──stage-no─┘
You can use a name mask with the system, subsystem, and type names, as
well as with both stage indicators.
Depending on the particular action, you may have a choice when entering a
stage indicator (that is, ID or number). In this situation, the indicator is
required, but you decide whether to enter an ID or stage number. If only one
type of stage indicator appears in the SCL syntax, you must enter that specific
value.
SET FROM FILE (DDNAME) dd-name
SITE site-id
ENVIRONMENT env-name
SYSTEM sys-name
SUBSYSTEM subsys-name
TYPE type-name
STAGE stage-id
STAGE NUMBER stage-no
DSNAME dataset-name
Often, an action requires that only a file name or data set name be entered to
indicate a FROM location. Follow these rules when specifying this clause:
■ When you enter a file name (DDname), be sure that the appropriate JCL is
coded for the entry.
■ When you enter a data set name, be sure to enclose the name in quotes
(single or double) if there is a period in the name; for example, the data set
TEST.LIB must be coded as 'TEST.LIB'.
Note: You cannot code both a file name (or DDname) and a data set name. If
you do, you receive an error message. You also receive an error message if
you code Endevor location information along with a data set name.
Occasionally, you are required to enter both a file name and Endevor location
information for the element. Review the conventions listed above for coding
information about each of these entries.
3.1.9 Syntax
──SET OPTion──¤──┬─────────────────────────────────────────┬──¤──.──────────
├─CCId──ccid──────────────────────────────┤
├─COMment──comment────────────────────────┤
├─COPyback────────────────────────────────┤
├─DELete input source─────────────────────┤
├─DETail report───────────────────────────┤
├─EXPand includes─────────────────────────┤
├─IGNore generate failed──────────────────┤
├─JUMp────────────────────────────────────┤
├─NEW VERsion──version────────────────────┤
├─NOCc────────────────────────────────────┤
├─NO SIGNOut──────────────────────────────┤
├─OVErride SIGNOut────────────────────────┤
├─ONLy COMPonent──────────────────────────┤
├─REPlace MEMber──────────────────────────┤
├─SHOw TEXt──┬──────────────┬─────────────┤
│ └─PLUs n lines─┘ │
├─SYNchronize─────────────────────────────┤
├─UPDate if present───────────────────────┤
├─WITh HIStory────────────────────────────┤
├─┬─BYPass DELete PROcessor─┬─────────────┤
│ └─BYPass ELEment DELete───┘ │
├─┬─BYPass GENerate PROcessor───────────┬─┤
│ └─PROcessor GROup──┬─EQ─┬──group name─┘ │
│ └─=──┘ │
├─COMPonent──┬─BROwse──┬──────────────────┤
│ ├─CHAnge──┤ │
│ ├─HIStory─┤ │
│ ├─SUMmary─┤ │
│ └─MASter──┘ │
├─┬─NOSearch─┬────────────────────────────┤
│ └─SEArch───┘ │
└─┬─RETain SIGNOut─────┬──────────────────┘
├─SIGNin─────────────┤
└─SIGNOut TO──userid─┘
SET OPTIONS
The SET OPTIONS statement tells Endevor to apply one or a series of options
to all subsequent actions, until the next SET OPTIONS statement or a CLEAR
OPTIONS statement is encountered, or processing ends. The exact options
used depend on the action you specify and the data you enter in that element
action statement:
You can code the following options in the SET OPTIONS statement:
CHANGES—tells Endevor to print all inserts and deletes made to the element
at the level specified.
SHOW TEXT PLUS n LINES—tells Endevor to print the line of source code
that contains a specified text string, plus a designated number of lines of code
before and after the text string.
The following table indicates the action(s) for which you can code each option,
and provides notes on the use of each option.
During execution, Endevor checks the Endevor return code (NDVR RC) for the
current action before proceeding with the next action.
3.1.11 Syntax
The STOPRC statement identifies your highest acceptable return code for the
current action processing. You can specify a return code value in the range of
4 through 99. If the Endevor return code is equal to or exceeds the return
code entered in the STOPRC statement, Endevor stops processing and the
remaining actions are not executed.
3.1.12 Set To
The SET TO statement applies to each element action that uses—but does not
contain all or part of—a TO clause, and remains in effect until Endevor
encounters another SET TO statement or a CLEAR TO statement, or when
processing ends.
The exact information used from the SET TO statement depends on both the
specific action and the data you have entered in that element action statement.
What you enter in the action's TO clause overrides that particular entry in the
SET TO statement. For example, you code all Endevor location information
(environment, system, subsystem, type, and stage ID or stage number) in the
SET TO statement. Then, when coding an UPDATE statement, you enter a
different subsystem. Endevor determines the TO location by applying all SET
TO information except for subsystem, which is taken from the UPDATE
statement.
The SET TO information you enter differs from action to action; see the
individual element action descriptions in Chapter 4, "Element Action
Statements" to determine the requirements for each. Remember that you
cannot use a name mask with any TO location field names.
3.1.13 Syntax
──SET TO──┬─SYSOut────────────────────────────────────────┬──.──────
├─C1Print───────────────────────────────────────┤
├─┬─FILe───┬──dd-name───────────────────────────┤
│ └─DDName─┘ │
├─DSName──dataset-name──┬─────────────────────┬─┤
│ └─MEMber──member-name─┘ │
└─┤ LOCATION ├──────────────────────────────────┘
LOCATION:
├──ENVironment──env-name──SYStem──sys-name──SUBsystem──subsys-name─────
──TYPe──type-name──┬────────────────────────┬─────────────────────────┤
├─STAge──stage-id────────┤
└─STAge NUMber──stage-no─┘
SET TO SYSOUT
SYSOUT applies to the LIST action only. Normally when you execute the LIST
action, Endevor lists the action cards in both the listing (Execution Report) and
the location you have indicated in the TO clause. If you do not enter any
information in the TO clause for the LIST action, Endevor checks the SET TO
statement for information. If the appropriate information has not been entered
in the SET TO statement or the SET TO statement indicates only SYSOUT,
Endevor defaults to SYSOUT alone.
When SYSOUT alone is selected, the action cards requested in the LIST action
are printed immediately after the LIST request, as part of the listing. You
cannot perform any editing on these action cards because they are available
only in the printout. If you have indicated another location (such as a library)
in the TO clause, however, you can access, and therefore edit, the action cards
generated.
SET TO C1PRINT
C1PRINT applies to the PRINT action only. If you do not enter any
information in the TO clause for the PRINT action, Endevor checks the SET TO
statement for information. If the appropriate information has not been entered
in the SET TO statement or the SET TO statement indicates C1PRINT, Endevor
defaults to C1PRINT and prints the specified element or member in a listing.
Note: If you want to use C1PRINT, be sure you have included the
appropriate JCL. See the examples below:
■ To send your output to the queue, code the following:
//C1PRINT DD SYSOUT=
When the TO location for the element is external to Endevor (for example,
a library, sequential file, or PDS), you can enter either a file name (or
DDname) or a data set name in the TO clause.
■ When you enter a file name (DDname), be sure that the appropriate
JCL is coded for the entry.
■ When you enter a data set name, be sure to enclose the name in quotes
(single or double) if there is a period in the name; for example, the
data set TEST.LIB must be coded as 'TEST.LIB'.
Note: You cannot code both a file name (or DDname) and a data set
name. If you do, you receive an error message. You also receive an error
message if you enter Endevor location information along with a data set
name.
SET TO ENVIRONMENT env-name
SYSTEM sys-name
SUBSYSTEM subsys-name
TYPE type-name
STAGE stage-id
STAGE NUMBER stage-no
See the User Guide for complete information about each term.
SET TO MEMBER applies only to the LIST action. If you do not enter a
member name in the LIST action, Endevor checks the related SET TO
statement for a member name. If a member name has not been coded, the
system defaults to SYSOUT and the list is produced in the listing
immediately following the request.
Note: If this statement is used for any other action other than LIST it will
be ignored.
SET WHERE differs from the SET BUILD, SET FROM, and SET TO
statements in that the WHERE (and consequently the SET WHERE) clause
is optional. If you do not enter WHERE information for a specific action
and a SET WHERE statement has not been coded, the system continues
processing; you do not receive an error message nor does processing
terminate.
The WHERE clause is most useful when you are using a name mask, as it
further qualifies the criteria you have entered for the element(s). When
you use a name mask, the designated action is performed for only those
elements matching the WHERE criteria entered (along with any other
qualifying data entered).
3.1.15 Syntax
──SET WHEre──¤──┬──────────────┬──¤──.──────────────────────────────────
├─┤ CCID ├─────┤
├─┤ GENERATE ├─┤
├─┤ ARCHIVE ├──┤
├─┤ SPEC ├─────┤
└─┤ PRO ├──────┘
CCID:
┌─EQual─┐ ┌─,────┐
├──CCId──┬──────────────────┬──┼───────┼──(───
─ccid─┴──)───────────────────┤
│ ┌─CURrent──┐ │ └─=─────┘
└─OF──┼─ALL──────┼─┘
└─RETrieve─┘
GENERATE:
├──GENerate──┬─FAIled─────────────┬────────────────────────────────────────┤
├─┤ DATE ├───────────┤
├─┤ FROM ├───────────┤
├─┤ THROUGH ├────────┤
└─┤ FROM - THROUGH ├─┘
ARCHIVE:
├──┬─┤ DATE ├───────────┬──────────────────────────────────────────────────┤
├─┤ FROM ├───────────┤
├─┤ THROUGH ├────────┤
└─┤ FROM - THROUGH ├─┘
DATE:
├──DATe──┬─EQ─┬──date──┬────────────────────┬──────────────────────────────┤
└─=──┘ └─TIMe──┬─EQ─┬──time─┘
└─=──┘
FROM:
├──FROm──DATe──┬─EQ─┬──date──┬────────────────────┬────────────────────────┤
└─=──┘ └─TIMe──┬─EQ─┬──time─┘
└─=──┘
THROUGH:
├──┬─THRough─┬──DATe──┬─EQ─┬──date──┬────────────────────┬─────────────────┤
└─THRu────┘ └─=──┘ └─TIMe──┬─EQ─┬──time─┘
└─=──┘
SPEC:
├──┬─TEXt──┬─text-spec───────────────────────────────────┬─┬───────────────┤
│ │ ┌─,─────────┐ ┌─,─────────┐ │ │
│ └─(───
─text-spec─┴──┬─AND─┬───
─text-spec─┴──)─┘ │
│ └─OR──┘ │
└─ACM──┬─comp-spec───────────────────────────────────┬──┘
│ ┌─,─────────┐ ┌─,─────────┐ │
└─(───
─comp-spec─┴──┬─AND─┬───
─comp-spec─┴──)─┘
└─OR──┘
PRO:
┌─,──────────┐
├──PROcessor GROup──┬─EQ─┬──(───
─group name─┴──)───────────────────────────┤
└─=──┘
The SET WHERE statement applies to each element action that uses—but
does not contain all or part of—a WHERE clause, and remains in effect
until the system encounters another SET WHERE statement or a CLEAR
statement, or processing ends. There are two forms of WHERE CCID SCL:
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 examples below illustrate the two forms of WHERE CCID SCL.
Example 1: WHERE CCID EQ PROJ
Example 2: WHERE CCID OF CURRENT (PROJ1, PROJ2, PROJ4)
Example 3: WHERE CCID OF ALL (PROJ)
The date(s) must be in mm/dd/yy format (leading zeros are not required).
The time(s) must be in hh:mm format. If you enter a time in this clause,
you must enter a date.
WHERE ARCHIVE SCL allows you to set an archive date and, optionally,
time as a selection criteria. There are four possible forms for this clause:
■ WHERE ARCHIVE DATE mm/dd/yy TIME hh:mm—Tells Endevor to
select only those elements with this archive date, and optionally, this
time stamp.
■ WHERE ARCHIVE FROM DATE mm/dd/yy TIME hh:mm—Tells
Endevor to select all elements with an archive date and, optionally, a
time stamp on or after the specified date and time stamps.
■ WHERE ARCHIVE THROUGH DATE mm/dd/yy TIME hh:mm—Tells
Endevor to select all elements with an archive date and, optionally, a
time stamp earlier than and including the specified date and time
stamp.
■ WHERE ARCHIVE FROM DATE mm/dd/yy TIME hh:mm
THROUGH DATE mm/dd/yy TIME hh:mm—Tells Endevor to select
only those elements with an archive date and, optionally, a time stamp
within the specified range.
The date(s) must be in mm/dd/yy format (leading zeros are not required).
The time(s) must be in hh:mm format. If you enter a time in this clause,
you must enter a date.
WHERE TEXT SCL limits a list to elements that contain (or do not contain)
one or more specified 1- to 70-character text strings. The examples below
show how you might code WHERE TEXT SCL. See The List Statement
section of Chapter 4, "Element Action Statements," for an illustration of
WHERE TEXT syntax.
■ This example tells Endevor to list all elements containing the text
string "WO9- LINKAGE:"
WHERE TEXT 'WO9-LINKAGE'
■ This example tells Endevor to list all elements that contain the text
strings "COPY COPY005" and "COPY COPY010" between columns 8
and 40 of the element source:
WHERE TEXT ('COPY COPY5' COLUMN 8 4 AND 'COPY COPY1' COLUMN 8 4)
■ This example tells Endevor to list all elements that do not contain the
text string "REMARKS" between columns 8 and 15 of the element
source:
WHERE TEXT DOES NOT CONTAIN 'REMARKS' COLUMN 8 15
■ This example tells Endevor to list all elements that contain either the
text string "M605SUB" or the text string "M607SUB" and do not contain
the text string "M606SUB:"
WHERE TEXT (('M65SUB' OR 'M67SUB')AND DOES NOT CONTAIN 'M66SUB')
Note: The WHERE TEXT EQUAL clause cannot be used with the
WHERE ACM clauses.
WHERE ACM SCL limits a list to component lists containing (or not
containing) the designated 1- to 10-character component name.
Wildcards are acceptable in the component name specification. See
The List Statement section of Chapter 4,
See the Set Statements section at the beginning of this chapter for
complete explanations of "Element Action Statements," for an
illustration of WHERE ACM syntax.. There are four clauses:
■ WHERE INPUT COMPONENT tells Endevor to list only input
components matching your entry. This is the default.
■ WHERE RELATED INPUT COMPONENT—tells Endevor to list
only related input components matching your entry.
3.2.1 Overview
A CLEAR statement clears the information that has been designated by
a SET statement. The CLEAR statement must be in the same syntax as
the SET statement to which it applies, and must be entered (at some
point in your code) after that SET statement. The CLEAR statement
affects all syntax following it until a new SET statement is encountered
or processing ends. The CLEAR statement does not affect the related
information coded within each individual element action's syntax.
Because these statements are not executed, no source or output
management is involved.
3.2.3 Syntax
──CLEar BUIld──¤──┬────────────────┬──¤──.──────────────────
├─ALL────────────┤
├─ACTion─────────┤
├─LEVel──────────┤
└─WITh COMPonent─┘
CLEAR BUILD
You can code the following options in the CLEAR BUILD statement.
3.2.5 Syntax
──CLEar──┬─TO───┬──¤──┬─────────────┬──¤──.─────────────────
└─FROm─┘ ├─┬─FILe───┬──┤
│ └─DDName─┘ │
├─DSName──────┤
├─MEMber──────┤
├─ALL─────────┤
├─SITe────────┤
├─ENVironment─┤
├─SYStem──────┤
├─SUBsystem───┤
├─TYPe────────┤
└─STAge───────┘
CLEAR/TO FROM
You can enter the following values in the CLEAR TO and CLEAR
FROM statements:
3.2.7 Syntax
──CLEar OPTion──¤──┬─────────────────────────────────────────┬──¤────
├─ALL─────────────────────────────────────┤
├─CCId──ccid──────────────────────────────┤
├─COMment──comment────────────────────────┤
├─COPyback────────────────────────────────┤
├─DELete input source─────────────────────┤
├─DETail report───────────────────────────┤
├─EXPand includes─────────────────────────┤
├─IGNore generate failed──────────────────┤
├─JUMp────────────────────────────────────┤
├─NEW VERsion──version────────────────────┤
├─NOCc────────────────────────────────────┤
├─NO SIGNOut──────────────────────────────┤
├─OVErride SIGNOut────────────────────────┤
├─ONLy COMPonent──────────────────────────┤
├─REPlace MEMber──────────────────────────┤
├─SHOw TEXt──┬──────────────┬─────────────┤
│ └─PLUs n lines─┘ │
├─SYNchronize─────────────────────────────┤
├─UPDate if present───────────────────────┤
├─WITh HIStory────────────────────────────┤
├─┬─BYPass DELete PROcessor─┬─────────────┤
│ └─BYPass ELEment DELete───┘ │
├─┬─BYPass GENerate PROcessor───────────┬─┤
│ └─PROcessor GROup──┬─EQ─┬──group name─┘ │
│ └─=──┘ │
├─COMponent──┬─BROwse──┬──────────────────┤
│ ├─CHAnge──┤ │
│ ├─HIStory─┤ │
│ ├─SUMmary─┤ │
│ └─MASter──┘ │
├─┬─NOSearch─┬────────────────────────────┤
│ └─SEArch───┘ │
└─┬─RETain SIGNOut─────┬──────────────────┘
├─SIGNin─────────────┤
└─SIGNOut TO──userid─┘
──.──────────────────────────────────────────────────────────────────
CLEAR OPTIONS
3.2.9 Syntax
──CLEar WHEre──¤──┬─────────────────┬──¤──.─────────────────
├─ALL─────────────┤
├─TEXt────────────┤
├─CCId────────────┤
├─GENerate FAIled─┤
├─GENerate DATe───┤
├─ARChive DATe────┤
└─ACM─────────────┘
CLEAR WHERE
You can enter the following values in the CLEAR WHERE statement:
3.3.1 Overview
The EOF (EOJ) statement tells Endevor to stop parsing the SCL syntax
at a particular point. For example, if you have listed two actions and
want to perform only the first action, you would enter EOF. (or EOJ.)
immediately after the last line of the first action (or immediately before
the first line of the second action).
If you do not use the EOF (EOJ) statement, you need to manually
delete the actions (lines of code) you do not want performed.
3.3.2 Syntax
──┬─EOF─┬──.────────────────────────────────────────────────
└─EOJ─┘
EOF (EOJ)
Simply code either EOF or EOJ in the appropriate place in the syntax.
This chapter illustrates the syntax for each Endevor element action,
and explains the coding rules specific to that statement.
4.2.1 Overview
As mentioned previously in this manual, you can use batch panels to
enter your element action requests. The standard JCL required for
execution is already defined. You most likely do not need to code
additional JCL, except in special situations (for example, when you
reference a file by DDname).
If you decide not to use the batch panels, you must code specific JCL
in order to execute your requests. A sample of the JCL required is
provided on the installation tape and loaded to the JCL library
(iprfx.iqual.JCL) during installation. The sample JCL is shown below:
4.3.1 Overview
The &&ACTION statement allows you to substitute any action for a
specified element at run time. This statement normally is generated
when you use the LIST action.
For example, at the beginning of a month, you may want to see a list
of elements involved with a particular project, although you may not
know what actions you will request for those elements. If you request
the list without indicating any specific actions, &&ACTION appears, in
lieu of a specific action, for every action card generated. When you are
ready to perform individual actions, simply specify those actions with
the necessary SET ACTION clause(s).
4.3.2 Syntax
──&&Action ELEment──┬─element─────┬──────────────────────────
└─member-name─┘
──┬─THRough─┬──element name──┬─────────┬──┬─────────┬─────────
└─THRu────┘ └─VERsion─┘ └─version─┘
──┬───────┬──┬────────┬──────────────────────────────────────
└─LEVel─┘ └─level.─┘
VERSION version
Indicates the version you want to see for the specified element.
Acceptable values are 1-99.
You must code a full element name if you want to indicate a version
number.
If you code the VERSION clause, it must follow the THROUGH clause.
LEVEL level
Indicates the level you want to see for the specified element.
Acceptable values are 00-99. By default, Endevor retrieves the current
level of the element.
The LEVEL option is not available for all actions. Check the individual
action to see if this clause can be used.
4.4.1 Overview
The ADD statement allows you to add an element to an environment's
entry stage in Endevor. The entry stage for an environment is defined
through the C1DEFLTS table.
Note: If you are working with a sequential file, the THROUGH clause
is ignored.
FROM FILE (DDNAME) dd-name
DSNAME dataset-name
MEMBER member-name
PATH hfspath
HFSFILE filename
The FROM clause indicates the location of the element being added.
Endevor uses both the FROM clause in the 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, Endevor uses these values.
The SET FROM statement allows you to specify only a file (DDname)
or data set name, not a member name.
HFSFILE
The file in the HFS directory that you want to put under the control of
Endevor.
You must specify an environment, system, subsystem, and type for the
ADD action. Remember that you cannot use a name mask with any
field in the TO location.
OPTIONS
NEW VERSION version—If the element exists up the map, the version
number associated with the existing element will be assigned, by
default. If the element does not exist up the map, the element is
assigned version 1.
4.5.1 Overview
The ARCHIVE statement writes the base level and all change levels of
an element to a sequential file (known as an archive data set). In
addition, for Endevor ACM users, the ARCHIVE action writes the base
level and all change levels of the Component List to the archive data
set.
4.5.2 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──┬─FILe───┬──dd-name─────────
└─STAge NUMber──stage-no─┘ └─DDName─┘
──┬───────────────────────────┬───────────────────────────────
└─WHEre──¤──┬──────────┬──¤─┘
├─┤ CCID ├─┤
└─┤ PRO ├──┘
──┬─────────────────────────────────────────┬──.─────────────
└─OPTion──¤──┬───────────────────────┬──¤─┘
├─CCId──ccid────────────┤
├─COMment──comment──────┤
├─OVErride SIGNOut──────┤
└─BYPass ELEment DELete─┘
CCID:
┌─EQual─┐ ┌─,────┐
─ccid─┴──)───────┤
├──CCId──┬──────────────────┬──┼───────┼──(───
│ ┌─CURrent──┐ │ └─=─────┘
└─OF──┼─ALL──────┼─┘
└─RETrieve─┘
PRO:
┌─,──────────┐
─group name─┴──)───────────────┤
├──PROcessor GROup──┬─EQ─┬──(───
└─=──┘
The FROM clause indicates the location of the element being archived.
Endevor 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, Endevor uses these values.
The DCB must specify variable blocked records (RECFM=VB), and the
DSORG should be PS.
■ The minimum LRECL should be the greater of 3 times the
maximum MCF-record length or the TYPE-LENGTH plus (+) 14.
■ 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
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 (PROJ1, PROJ2, PROJ4)
Example 2: WHERE CCID OF ALL (PROJV)
OPTIONS
This is the CCID that Endevor looks for if WHERE ARCHIVE CCID is
specified for the LIST, COPY, RESTORE, and TRANSFER actions.
4.6.1 Overview
The COPY statement copies an element from an archive data set to a
user data set (that is, a data set external to Endevor). The user data set
can be a library (an AllFusion CA-Panvalet file, an AllFusion
CA-Librarian file, or a PDS) or a sequential file. The element is not
restored to the Master Control File.
The COPY action is available in batch only. Note, also, that copy
processing is strictly external to Endevor.
4.6.2 Syntax
──COPy ELEment──element-name─────────────────────────────────
──┬───────────────────────────┬──┬──────────────────┬─────────
└─┬─THRough─┬──element-name─┘ └─VERsion──version─┘
└─THRu────┘
──FROm──┬─FILe───┬──dd-name──┬───────────────┬────────────────
└─DDName─┘ └─SITe──site-id─┘
──ENVironment──env-name──SYStem──sys-name─────────────────────
──SUBsystem──subsys-name──TYPe──type-name─────────────────────
──STAge NUMber──stage-no──TO──────────────────────────────────
──┬─┬─FILe───┬──dd-name───────────────────────────┬───────────
│ └─DDName─┘ │
├─DSName──dataset-name──┬─────────────────────┬─┤
│ └─MEMber──member-name─┘ │
└─PATH──hfspath──HFSFILE──filename──────────────┘
──┬───────────────────────────────────────────────┬───────────
└─WHERE──¤──┬──────────────────────────────┬──¤─┘
│ ┌─,────┐ │
─ccid─┴──)─┤
├─CCId──┬─EQ─┬──(───
│ └─=──┘ │
└─ARChive──┬─┤ DATE ├────┬─────┘
├─┤ FROM ├────┤
└─┤ THROUGH ├─┘
──┬─────────────────────────────┬──.─────────────────────────
└─OPTions──┬────────────────┬─┘
└─REPlace member─┘
DATE:
├──DATe──┬─EQ─┬──date──┬────────────────────┬──────────────────┤
└─=──┘ └─TIMe──┬─EQ─┬──time─┘
└─=──┘
FROM:
├──FROm──DATe──┬─EQ─┬──date──┬────────────────────┬────────────┤
└─=──┘ └─TIMe──┬─EQ─┬──time─┘
└─=──┘
THROUGH:
├──┬─THRough─┬──DATe──┬─EQ─┬──date──┬────────────────────┬─────┤
└─THRu────┘ └─=──┘ └─TIMe──┬─EQ─┬──time─┘
└─=──┘
Indicates the element(s) you want to copy. Code the required syntax
and enter the appropriate element name; up to 10 characters are
allowed. In addition, you can use a name mask with the element
name.
VERSION version
You must code a full element name if you want to indicate a version
number.
If you code the VERSION clause, it must follow the THROUGH clause.
FROM FILE (DDNAME) dd-name
ENVIRONMENT env-name
SYSTEM sys-name
SUBSYSTEM subsys-name
TYPE type-name
STAGE NUMBER stage-no
The FROM clause indicates the location of the element being copied.
Endevor 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, Endevor uses these values.
The FILE (DDNAME) portion of the clause is required. The file name
indicates from which archive file the element is being copied. Enter
this information first when coding the syntax.
The TO clause indicates the file or data set name to which the element
is being copied. Endevor 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, Endevor uses these values.
If you do not enter a member name, Endevor assumes that the element
name and member name are the same.
■ You can enter a member name only if a full element name has
been coded in the COPY ELEMENTS clause; that is, if you have
not used a name mask.
■ If you want to code a member name, you must do so in the COPY
statement; the SET TO MEMBER clause does not apply to the
COPY action. If you do enter a member name, you cannot use the
THROUGH clause.
WHERE
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.
This clause tells Endevor to copy only those elements with this date,
and optionally, time stamp.
This clause tells Endevor to copy all elements with a date and,
optionally, time stamp on or after the specified date and time stamps.
This clause tells Endevor to copy all elements with a date and,
optionally, time stamp earlier than and including the specified date
and time stamp.
This clause tells Endevor to copy only those elements with a date, and
optionally, time stamps within the specified range. If you enter a time,
you must enter the date with it.
If the element you are copying exists in the target location, Endevor
rejects the request unless you code the REPLACE MEMBER option.
Specify this option when you want to replace the existing member in
the library.
4.7.1 Overview
The DELETE statement deletes an element from the specified inventory
location.
4.7.2 Syntax
──DELete ELEment──element-name───────────────────────────────
──┬───────────────────────────┬───────────────────────────────
└─┬─THRough─┬──element-name─┘
└─THRu────┘
──FROm──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─┤
├─ONLy COMPonent───┤
└─OVErride SIGNOut─┘
CCID:
┌─EQual─┐ ┌─,────┐
─ccid─┴──)───────┤
├──CCId──┬──────────────────┬──┼───────┼──(───
│ ┌─CURrent──┐ │ └─=─────┘
└─OF──┼─ALL──────┼─┘
└─RETrieve─┘
PRO:
┌─,──────────┐
─group name─┴──)───────────────┤
├──PROcessor GROup──┬─EQ─┬──(───
└─=──┘
The FROM clause indicates the location of the element being deleted.
Endevor 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, Endevor uses these values.
WHERE
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.
OPTIONS
4.8.1 Overview
The GENERATE statement executes the generate processor for the
current level of an element, in either Stage 1 or Stage 2.
4.8.2 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────────────────────┤
│ ┌─SEArch───┐ │
├─COPyback──┴─NOSearch─┴──────────────┤
└─PROcessor GROup──┬─EQ─┬──group name─┘
└─=──┘
CCID:
┌─EQual─┐ ┌─,────┐
├──CCId──┬──────────────────┬──┼───────┼──(───
─ccid─┴──)────────────────────────┤
│ ┌─CURrent──┐ │ └─=─────┘
└─OF──┼─ALL──────┼─┘
└─RETrieve─┘
PRO:
├──PROcessor GROup──┬─EQ─┬──────────────────────────────────────────────────────┤
└─=──┘
If you use a name mask, Endevor 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
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.
OPTIONS
Endevor 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, Endevor first copies the current
level of the element back to the FROM stage, then generates the
element.
Endevor searches for the element first in the current environment, then
in other stages along the map. You can restrict the search to the
current environment by coding the NOSEARCH option.
If the element currently exists in the FROM stage, Endevor ignores the
COPYBACK option and simply generates the element.
4.9.1 Overview
The LIST statement scans elements or members in the Master Control
File, an archive data set, or a library, and generates a list of
elements/members that meet your selection criteria. The LIST action is
available in batch only. The WHERE clause supplies the selection
criteria for the LIST action. It selects the elements based on content as
opposed to the names of the elements.
The processing involved is the same for each type of LIST request.
The clauses required, however, depend on the location being searched.
Similarly, the options available depend on the location of the element
or member. This section of the chapter addresses each type of LIST
request separately; the appropriate syntax is illustrated first, followed
by a complete discussion of the associated LIST action rules.
4.9.3 Syntax
──LISt ELEment──element-name──┬─THRough─┬──element-name──FROm──ENVironment──env-name─────
└─THRu────┘
──SYStem──sys-name──SUBsystem──subsys-name──TYPe──type-name───────────────────────────────
──┬─STAge──stage-id────────┬──────────────────────────────────────────────────────────────
└─STAge NUMber──stage-no─┘
──┬───────────────────────────────────────────────────────┬───────────────────────────────
│ ┌─SYSOut────────────────────────────────────────┐ │
└─TO──┼─┬─FILe───┬──dd-name───────────────────────────┼─┘
│ └─DDName─┘ │
└─DSName──dataset-name──┬─────────────────────┬─┘
└─MEMber──member-name─┘
──WHEre──¤──┬─────────────────────┬──¤──┬──────────────────────────────────────────┬──────
├─┤ CCID ├────────────┤ └─BUIld──¤──┬─────────────────────────┬──¤─┘
├─┤ GENERATE ├────────┤ │ ┌─&&Action────┐ │
├─┤ SPEC ├────────────┤ ├─ACTion──┴─action-name─┴─┤
└─┤ PROCESSOR GROUP ├─┘ │ ┌─CURrent─┐ │
├─LEVel──┼─NONe────┼──────┤
│ └─ACTual──┘ │
└─WITh COMponent──────────┘
──┬──────────────────────────────────────────────┬──.────────────────────────────────────
└─OPTion──¤──┬────────────────────────────┬──¤─┘
├─REPlace member─────────────┤
├─DETail REPort──────────────┤
├─SHOw TEXt──┬─────────────┬─┤
│ └─PLUs n line─┘ │
│ ┌─NOSearch─┐ │
└─┴─SEArch───┴───────────────┘
CCId:
┌─EQual─┐ ┌─,────┐
├──┬──────────────────┬──┼───────┼──(───
─ccid─┴──)─────────────────────────────────────────┤
│ ┌─CURrent──┐ │ └─=─────┘
└─OF──┼─ALL──────┼─┘
└─RETrieve─┘
GENERATE:
├──GENerate──┬─FAIled──────────────────────────────────────────────────┬───────────────────┤
│ ┌─EQual─┐ │
├─DATe──┴─=─────┴──date──┬──────────────────────────────┬─┤
│ └─TIMe──┬──────────────┬──date─┘ │
│ │ ┌─EQual─┐ │ │
│ └─┴───────┴──=─┘ │
├─┤ FROM ├────────────────────────────────────────────────┤
├─┤ THROUGH ├─────────────────────────────────────────────┤
└─┤ FROM-THROUGH ├────────────────────────────────────────┘
FROM:
┌─EQual─┐
├──FROM──DATe──┼───────┼──date──┬───────────────────────┬──────────────────────────────────┤
└─=─────┘ │ ┌─EQual─┐ │
└─TIMe──┴─=─────┴──time─┘
THRough:
┌─EQual─┐
├──┬─────────────┬──DATe──┼───────┼──date──┬─────────────────┬─────────────────────────────┤
└─┬─THRough─┬─┘ └─=─────┘ │ ┌─EQual─┐ │
└─THRu────┘ └─TIMe──┼───────┼─┘
├─=─────┤
└─time──┘
FROM-THROUGH:
┌─EQual─┐ ┌─EQual─┐
├──FROM──DATe──┴─=─────┴──date──┬───────────────────────┬──┬─THRough─┬──DATe──┼───────┼────
│ ┌─EQual─┐ │ └─THRu────┘ └─=─────┘
└─TIMe──┼───────┼──time─┘
└─=─────┘
──date──┬───────────────────────┬─────────────────────────────────────────────────────────┤
│ ┌─EQual─┐ │
└─TIMe──┼───────┼──time─┘
└─=─────┘
SPEC:
├──┬─TEXt──┬─text-spec─────────────────────────────┬─┬─────────────────────────────────────┤
│ │ ┌─,─────────┐ ┌─,─────────┐ │ │
│ └──
─text-spec─┴──┬─AND─┬───
─text-spec─┴─┘ │
│ └─OR──┘ │
└─ACM──┬─comp-spec─────────────────────────────┬──┘
│ ┌─,─────────┐ ┌─,─────────┐ │
└──
─comp-spec─┴──┬─AND─┬───
─comp-spec─┴─┘
└─OR──┘
PROCESSOR GROUP:
┌─EQuAL─┐ ┌─,──────────┐
├──PROcessor GROup──┼───────┼──(───
─group name─┴──)────────────────────────────────────────┤
└─=─────┘
──┬───────────────────────┬──text──┬─────────────────────────────────┬──────────────────
│ ┌─EQual───┐ │ └─┬─────────┬──start-pos──end-pos─┘
└─DOEs NOT──┼─────────┼─┘ └─columns─┘
├─CONTain─┤
└─=───────┘
┌─INPut─────┐
──┬─────────┬──┼───────────┼──COMPonent──┬───────────────────────────┬───────────────────
└─RELated─┘ ├─OUTput────┤ └─┬──────────┬──┬─────────┬─┘
├─PROcessor─┤ └─DOEs NOT─┘ ├─CONTain─┤
└─ALL───────┘ ├─EQ──────┤
└─=───────┘
──comp-name──¤──┬─────────────────────────────────────────────────────────┬──¤────────────
├─┬─THRough─┬──comp-name──────────────────────────────────┤
│ └─THRu────┘ │
├─ENVironment──env-name──¤──┬────────────────────────┬──¤─┤
│ ├─SYStem──sys-name───────┤ │
│ ├─SUBsystem──subsys-name─┤ │
│ ├─TYPe──type-name────────┤ │
│ ├─STAge NUMber──stage-no─┤ │
│ ├─VERsion──version───────┤ │
│ └─LEVel──level───────────┘ │
├─┬─FILe───┬──dd-name─────────────────────────────────────┤
│ └─DDName─┘ │
└─DSNname──dataset-name───────────────────────────────────┘
──RELated──┬─────────────────┬──COMponent─────────────────────────────────────────────────
└─OBJect──COMment─┘
──┬──────────────────────────────────────────────────────────────────────┬──.────────────
└─┬──────────┬──┬─────────┬──text──┬─────────────────────────────────┬─┘
└─DOEs NOT─┘ ├─CONTain─┤ └─┬─────────┬──start-pos──end pos─┘
├─EQ──────┤ └─columns─┘
└─=───────┘
TO
If you are using PDSs and do not provide a member name, Endevor
assigns a temporary name of TEMPNAME. If you wish to use the
temporary naming capability, do not code multiple list requests to the
same external data set.
If you are using a PDS and have multiple list statements with only one
member name on a SET statement, then all lists go to same member
name and only first LIST results are available.
WHERE
WHERE CCID OF ccid — Limits the list to those elements that match
one of the supplied CCIDs. You can use a name mask in this field.
■ CURRENT—Tells Endevor to look through the CCID fields in the
MCF (Master Control File) to find a specified CCID(s). This is the
default.
■ ALL—Tells Endevor to search both the Master Control File and the
SOURCE DELTA levels for a specified CCID(s). If you have ACM,
Endevor also searches the COMPONENT LIST DELTA levels for
the specified CCID(s).
■ RETRIEVE—Tells Endevor 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.
WHERE TEXT text spec—Limits the list to elements that contain (or do
not contain) one or more specified 1- to 70-character text strings.
Examples:
In this example, Endevor lists all elements containing the text string
WO9-LINKAGE.
In this example, Endevor lists all element containing the text strings
COPY COPY005 and COPY COPY010 between columns 8 and 40 of the
element source.
In this example, Endevor lists all elements that do not contain the text
string REMARKS between columns 8 and 15 of the element source.
In this example, Endevor lists all elements that contain either the text
string M605SUB or the text string M607SUB and do not contain the
text string M606SUB.
The WHERE TEXT EQUAL clause cannot be used with the WHERE
ACM clauses.
You can further specify the component using the following clauses.
BUILD
OPTIONS
SHOW TEXT [ PLUS n LINES ]—This option allows you to print the
line of source code that contains a specified text string, plus a
designated number of lines of code before and after the text string.
You must code the WHERE TEXT clause if you use the SHOW TEXT
option. Otherwise, you receive a syntax error.
4.9.5 Syntax
──LISt ELEment──element-name──┬───────────────────────────┬──FROm─────────────
└─┬─THRough─┬──element-name─┘
└─THRu────┘
──┬─FILe───┬──dd-name──┬───────────────┬──ENVironment──env-name────────────────
└─DDName─┘ └─SITe──site-id─┘
──SYStem──sys-name──SUBsystem──subsys-name──TYPe──type-name────────────────────
──STAge NUMber──stage-no───────────────────────────────────────────────────────
──┬───────────────────────────────────────────────────────┬────────────────────
│ ┌─SYSOut────────────────────────────────────────┐ │
└─TO──┼─┬─FILe───┬──dd-name───────────────────────────┼─┘
│ └─DDName─┘ │
└─DSName──dataset-name──┬─────────────────────┬─┘
└─MEMber──member-name─┘
──┬──────────────────────────────────────────────────┬─────────────────────────
└─WHEre──¤──┬─────────────────────────────────┬──¤─┘
├─┤ CCID ├────────────────────────┤
├─┤ PRO ├─────────────────────────┤
└─ARChive──┬─┤ DATE ├───────────┬─┘
├─┤ FROM ├───────────┤
├─┤ THROUGH ├────────┤
└─┤ FROM - THROUGH ├─┘
──┬────────────────────────────────┬───────────────────────────────────────────
│ ┌─&&Action────┐ │
└─BUIld──ACTion──┴─action-name─┴─┘
──┬───────────────────────────────────────────────┬──.────────────────────────
└─OPTion──¤──┬─────────────────────────────┬──¤─┘
├─REPlace member──────────────┤
├─DETail REPort───────────────┤
└─SHOw TEXt──┬──────────────┬─┘
└─PLUs n lines─┘
CCID:
┌─,────┐
├──CCId──┬─EQ─┬──(───
─ccid─┴──)─────────────────────────────────────────────────┤
└─=──┘
DATE:
├──DATe──┬─EQ─┬──date──┬────────────────────┬───────────────────────────────────┤
└─=──┘ └─TIMe──┬─EQ─┬──time─┘
└─=──┘
FROM:
├──FROm──DATe──┬─EQ─┬──date──┬────────────────────┬─────────────────────────────┤
└─=──┘ └─TIMe──┬─EQ─┬──time─┘
└─=──┘
THROUGH:
├──┬─THRough─┬──DATe──┬─EQ─┬──date──┬────────────────────┬──────────────────────┤
└─THRu────┘ └─=──┘ └─TIMe──┬─EQ─┬──time─┘
└─=──┘
PRO:
┌─,──────────┐
├──PROcessor GROup──┬─EQ─┬──(───
─group name─┴──)────────────────────────────────┤
└─=──┘
You must code at least a FILE or DDNAME for this request, indicating
the archive data set to be searched for the specified element. Enter this
information first when coding the syntax.
TO
If you are using PDSs and do not provide a member name, Endevor
assigns a temporary name of TEMPNAME. If you wish to use the
temporary naming capability, do not code multiple list requests to the
same external data set.
If you are using a PDS and have multiple list statements with only one
member name on a SET statement, then all lists go to same member
name and only first LIST results are available.
WHERE
WHERE CCID ccid —Limits the list to those elements that match one
of the supplied CCIDs. You can use a name mask in this 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.
BUILD ACTION&&ACTION
action-name
Determines the action that appears in the LIST action syntax for the
specified element. If you do not enter required BUILD information
here, Endevor looks for a SET BUILD clause containing the appropriate
information. (See the description of SET BUILD, in Chapter 3, "Set,
Clear, and EOF Statements, for additional coding information.) If a
SET BUILD clause has not been coded, the system defaults to
&&ACTION.
You can enter a specific action (for example, ADD or MOVE) in this
clause or the variable &&ACTION. &&ACTION indicates that a
specific action will be designated for this element at a later time. This
action can be entered manually or using the SET ACTION statement.
(See the description of SET ACTION, in Chapter 3, "Set Clear, and EOF
Statements," for additional coding information.)
OPTIONS
SHOW TEXT [ PLUS n LINES ]—This option allows you to print the
line of source code that contains a specified text string, plus a
designated number of lines of code before and after the text string.
4.9.7 Syntax
──LISt MEMber──member-name──┬──────────────────────────┬──FROm────────────────
└─┬─THRough─┬──member-name─┘
└─THRu────┘
──┬─┬─FILe───┬──dd-name──┬─────────────────────────────────────────────────────
│ └─DDName─┘ │
└─DSName──dataset-name─┘
──┬───────────────────────────────────────────────────────┬────────────────────
│ ┌─SYSout────────────────────────────────────────┐ │
└─TO──┼─┬─FILe───┬──dd-name───────────────────────────┼─┘
│ └─DDName─┘ │
└─DSName──dataset-name──┬─────────────────────┬─┘
└─MEMber──member-name─┘
──┬───────────────────────────────────────────────────────────────────┬────────
└─WHEre TEXt──┬─text-spec─────────────────────────────────────────┬─┘
│ ┌─,─────────┐ ┌─,─────────┐ │
└─(───
─text-spec─┴──)──┬─AND─┬──(───
─text-spec─┴──)─┘
└─OR──┘
──┬───────────────────────────────┬────────────────────────────────────────────
│ ┌─&&Action────┐ │
└─BUIld ACTion──┴─action-name─┴─┘
──┬──────────────────────────────────────────────┬──.─────────────────────────
└─OPTion──¤──┬────────────────────────────┬──¤─┘
├─REPlace member─────────────┤
├─DETail REPort──────────────┤
└─SHOw TEXt──┬─────────────┬─┘
└─PLUs n line─┘
──┬───────────────────────┬──text──┬────────────────────────────────┬────────
│ ┌─EQual───┐ │ └─┬────────┬──start-pos──end-pos─┘
└─DOEs NOT──┼─────────┼─┘ └─column─┘
├─CONTain─┤
└─=───────┘
The FROM clause indicates the location of the member being listed.
Endevor 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, Endevor uses these values.
TO
If you are using PDSs and do not provide a member name, Endevor
assigns a temporary name of TEMPNAME. If you wish to use the
temporary naming capability, do not code multiple list requests to the
same external data set.
If you are using a PDS and have multiple list statements with only one
member name on a SET statement, then all lists go to same member
name and only first LIST results are available.
WHERE
WHERE TEXT text spec—Limits the list to elements that contain (or
do not contain) one or more specified 1- to 70-character text strings.
Examples:
WHERE TEXT 'WO9-LINKAGE'
In this example, Endevor lists all elements containing the text string
WO9-LINKAGE.
In this example, Endevor lists all elements containing the text strings
COPY COPY005 and COPY COPY010 between columns 7 and 41 of the
element source.
In this example, Endevor lists all elements that do not contain the text
string REMARKS between columns 8 and 15 of the element source.
In this example, Endevor lists all elements that contain either the text
string M605SUB or the text string M607SUB and do not contain the
text string M606SUB.
Determines the action that appears in the LIST action syntax for the
specified element. If you do not enter required BUILD information
here, Endevor looks for a SET BUILD clause containing the appropriate
information. (See the description of SET BUILD, in Chapter 3, "Set,
Clear, and EOF Statements," for additional coding information.) If a
SET BUILD clause has not been coded, the system defaults to
&&ACTION.
You can enter a specific action (for example, ADD or MOVE) in this
clause or the variable &&ACTION. &&ACTION indicates that a
specific action will be designated for this element at a later time. This
action can be entered manually or using the SET ACTION statement.
(See the description of SET ACTION, in Chapter 3, "Set, Clear, and
EOF Statements," for additional coding information.)
OPTIONS
SHOW TEXT [ PLUS n LINES ]—This option allows you to print the
line of source code that contains a specified text string, plus a
designated number of lines of code before and after the text string.
You must code the WHERE TEXT clause if you use the SHOW TEXT
option. Otherwise, you receive a syntax error.
4.10.1 Overview
The MOVE statement moves elements between inventory locations
along a map.
4.10.2 Syntax
──MOVe 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───────┤
├─SYNchronize────────────┤
├─WITh HIStory───────────┤
├─BYPass ELEment DELete──┤
│ ┌─SIGnin─────────────┐ │
├─┼─RETAin SIGNOut─────┼─┤
│ └─SIGNOut TO──userid─┘ │
└─JUMp───────────────────┘
CCID:
┌─EQual─┐ ┌─,────┐
─ccid─┴──)───────┤
├──CCId──┬──────────────────┬──┼───────┼──(───
│ ┌─CURrent──┐ │ └─=─────┘
└─OF──┼─ALL──────┼─┘
└─RETrieve─┘
PRO:
┌─,──────────┐
─group name─┴──)───────────────┤
├──PROcessor GROup──┬─EQ─┬──(───
└─=──┘
The FROM clause indicates the location of the element being moved.
Endevor 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, Endevor uses these values.
WHERE
See the description of the SET WHERE statement, in Stage 3, for more
information.
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.
OPTIONS
When moving with history, if the sync point is found, Endevor moves
the element from the FROM location to the TO location, appending the
FROM location delta levels after the sync-point element. If the two
levels are different, and SYNC is specified, Endevor first creates a sync
level at the target reflecting the differences between the base level of
the FROM element and the target, then moves the element to the TO
location and appends the FROM location delta levels to the target.
If you do not code this option, Endevor moves the element(s) without
history. When you move the element without history Endevor
searches through the element levels at the source location to find a
matching level at the target location. Endevor then compares the two
and creates a new level at the target location that reflects the
differences.
If the base level of the source element differs from the current level at
the target, the move fails unless you code the SYNCHRONIZE option.
If the element was signed out at the target before the MOVE, it will be
signed out to that same ID—at the target—after the MOVE.
If the element was not signed out at the target before the MOVE, it
will not be signed out at the target after the MOVE.
If you do not use this option, the element at the target location is not
signed out, regardless of whether it was signed out at the target before
the MOVE took place.
4.11.1 Overview
The PRINT statement prints selected information about an element(s)
or library member(s), depending on the data entered in the FROM
clause. You can print from either Endevor or selected output libraries
(for example, a PDS, AllFusion CA-PANVALET, and so on).
4.11.5 Syntax
──PRInt ELEment──element-name────────────────────────────────
──┬───────────────────────────┬──┬──────────────────┬─────────
└─┬─THRough─┬──element-name─┘ └─VERsion──version─┘
└─THRu────┘
──┬──────────────┬──FROm──ENVironment──env-name───────────────
└─LEVel──level─┘
──SYStem──sys-name──SUBsystem──subsys-name────────────────────
──TYPe──type-name──STAge NUMber──stage-no─────────────────────
┌─C1Print─────────────┐
──TO──┴─┬─FILe───┬──dd-name─┴─────────────────────────────────
└─DDName─┘
──┬───────────────────────────┬───────────────────────────────
└─WHEre──¤──┬──────────┬──¤─┘
├─┤ CCID ├─┤
└─┤ PRO ├──┘
──┬───────────────────────────────────────────┬──.───────────
└─OPTions──¤──┬────────────────────────┬──¤─┘
├─NOCc───────────────────┤
│ ┌─BROwse──┐ │
├─COMPonent──┼─CHAnge──┼─┤
│ ├─HIStory─┤ │
│ └─SUMmary─┘ │
├─MASter─────────────────┤
│ ┌─NOSearch─┐ │
└─┴─SEArch───┴───────────┘
CCID:
┌─EQual─┐ ┌─,────┐
─ccid─┴──)───────┤
├──CCId──┬──────────────────┬──┼───────┼──(───
│ ┌─CURrent──┐ │ └─=─────┘
└─OF──┼─ALL──────┼─┘
└─RETrieve─┘
PRO:
┌─,──────────┐
─group name─┴──)───────────────┤
├──PROcessor GROup──┬─EQ─┬──(───
└─=──┘
VERSION version
LEVEL level
Tells Endevor to print data for the designated level of the element.
Acceptable values are 00-99. By default Endevor prints information for
the current level.
If you enter a LEVEL clause, you cannot use the THROUGH clause,
and you must code a full element name in the PRINT ELEMENT
clause.
FROM ENVIRONMENT env-name
SYSTEM sys-name
SUBSYSTEM subsys-name
TYPE type-name
STAGE NUMBER stage-no
The FROM clause indicates the location of the element being printed.
Endevor 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, Endevor uses these values.
WHERE
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.
OPTIONS
4.11.7 Syntax
──PRInt MEMber──member-name──┬──────────────────────────┬────
└─┬─THRough─┬──member-name─┘
└─THRu────┘
──FROm──┬─┬─FILe───┬──dd-name──┬──────────────────────────────
│ └─DDName─┘ │
└─DSName──dataset-name─┘
┌─C1Print─────────────┐
──TO──┴─┬─FILe───┬──dd-name─┴──.─────────────────────────────
└─DDName─┘
The FROM clause indicates the location of the member being printed.
Endevor 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, Endevor uses these values.
You must enter a FILE, DDNAME, or DSNAME (enter one and only
one); be sure the appropriate JCL is coded for a FILE or DDNAME. If
you enter any other information in the FROM clause, it is ignored.
TO C1PRINT..
FILE (DDNAME) dd-name
The SCL in the second example prints member "PAYRPT12" from the
Endevor Listing Library. The output is sent to the default DDname
(C1PRINT).
PRINT MEMBER 'PAYRPT12'
FROM DSNAME 'ENDEVOR.PAYROLL.STAGE1.LISTINGS' .
4.12.1 Overview
The RESTORE statement restores an element from an archive data set
back to Endevor, "copying" the source as it was before the element was
archived or transferred to the data set.
4.12.2 Syntax
──REStore ELEment──element-name──┬───────────────────────────┬──FROm──────────
└─┬─THRough─┬──element-name─┘
└─THRu────┘
──┬─FILe───┬──dd-name──┬───────────────┬──ENVironment──env-name────────────────
└─DDName─┘ └─SITe──site-id─┘
──SYStem──sys-name──SUBsystem──subsys-name──TYPe──type-name────────────────────
──STAge NUMber──stage-no──TO──ENVironment──env-name──SYStem──sys-name──────────
──SUBsystem──subsys-name──TYPe──type-name──┬─STAge──stage-id────────┬──────────
└─STAge NUMber──stage-no─┘
──ELEment──element-name────────────────────────────────────────────────────────
──┬──────────────────────────────────────────────────┬─────────────────────────
└─WHERE──¤──┬─────────────────────────────────┬──¤─┘
│ ┌─,────┐ │
├─CCId──┬─EQ─┬──(───
─ccid─┴──)────┤
│ └─=──┘ │
└─ARChive──┬─┤ DATE ├───────────┬─┘
├─┤ FROM ├───────────┤
├─┤ THROUGH ├────────┤
└─┤ FROM - THROUGH ├─┘
──┬────────────────────────────────────────────────────────────┬──.───────────
└─OPTions──¤──┬─────────────────────────────────────────┬──¤─┘
├─CCId──ccid──────────────────────────────┤
├─COMment──comment────────────────────────┤
├─NEW VERsion──version────────────────────┤
└─┬─BYPass GENerate PROcessor───────────┬─┘
└─PROcessor GROup──┬─EQ─┬──group-name─┘
└─=──┘
DATE:
├──DATe──┬─EQ─┬──date──┬────────────────────┬───────────────────────────────────┤
└─=──┘ └─TIMe──┬─EQ─┬──time─┘
└─=──┘
FROM:
├──FROm──DATe──┬─EQ─┬──date──┬────────────────────┬─────────────────────────────┤
└─=──┘ └─TIMe──┬─EQ─┬──time─┘
└─=──┘
THROUGH:
├──┬─THRough─┬──DATe──┬─EQ─┬──date──┬────────────────────┬──────────────────────┤
└─THRu────┘ └─=──┘ └─TIMe──┬─EQ─┬──time─┘
└─=──┘
The FROM clause indicates the location of the element being restored.
Endevor 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, Endevor uses these values.
You must also specify the environment, system, subsystem, type, and
stage number (either 1 or 2). The environment name must be explicit.
You can use a name mask with the system, subsystem, type, and stage
number.
TO ENVIRONMENT env-name
SYSTEM system-name
SUBSYSTEM subsys-name
TYPE type-name
STAGE stage-id
STAGE NUMBER stage-no
ELEMENT element-name
Remember that you cannot use a name mask with a TO field name.
WHERE
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.
This clause tells Endevor to archive only those elements with this date,
and optionally, time stamp.
This clause tells Endevor to archive all elements with a date and,
optionally, time stamp on or after the specified date and time stamps.
This clause tells Endevor to archive all elements with a date and,
optionally, time stamp earlier than and including the specified date
and time stamp.
This clause tells Endevor to archive only those elements with date, and
optionally, time stamps within the specified range.
Note: If you enter a time, you must enter the date with it.
OPTIONS
Endevor sets the source, source delta, and RETRIEVE CCID and/or
COMMENT fields based on the archive data set.
4.13.1 Overview
The RETRIEVE statement copies an element to a user data set.
4.13.2 Syntax
──RETrieve ELEment──element-name──┬───────────────────────────┬──────
└─┬─THRough─┬──element-name─┘
└─THRu────┘
──┬──────────────────┬──┬──────────────┬──FROm────────────────────────
└─VERsion──version─┘ └─LEVel──level─┘
──ENVironment──env-name──SYStem──sys-name──SUBsystem──subsys-name─────
──TYPe──type-name──┬─STAge──stage-id────────┬──TO─────────────────────
└─STAge NUMber──stage-no─┘
──┬─┬─FILe───┬──dd-name───────────────────────────┬───────────────────
│ └─DDName─┘ │
├─DSName──dataset-name──┬─────────────────────┬─┤
│ └─MEMber──member-name─┘ │
└─PATH──hfspath──HFSFILE──filename──────────────┘
──┬───────────────────────────┬───────────────────────────────────────
└─WHEre──¤──┬──────────┬──¤─┘
├─┤ CCID ├─┤
└─┤ PRO ├──┘
──┬────────────────────────────────────┬──.──────────────────────────
└─OPTion──¤──┬──────────────────┬──¤─┘
├─CCId──ccid───────┤
├─COMment──comment─┤
├─REPlace member───┤
├─NO SIGNOut───────┤
├─EXPand include───┤
├─OVErride SIGNOut─┤
│ ┌─SEArch───┐ │
└─┴─NOSearch─┴─────┘
CCID:
┌─EQual─┐ ┌─,────┐
├──CCId──┬──────────────────┬──┼───────┼──(───
─ccid─┴──)───────────────┤
│ ┌─CURrent──┐ │ └─=─────┘
└─OF──┼─ALL──────┼─┘
└─RETrieve─┘
PRO:
┌─,──────────┐
├──PROcessor GROup──┬─EQual─┬──(───
─group name─┴──)────────────────────┤
└─=─────┘
If you use the THROUGH clause, you cannot enter a member name in
the TO clause or a different level in the LEVEL clause.
VERSION version
You must specify a full element name if you want to indicate a version
number.
LEVEL level
If you enter a LEVEL clause, you cannot use the THROUGH clause,
and you must code a full element name in the RETRIEVE ELEMENT
clause.
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 retrieved.
Endevor 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, Endevor uses these values.
If you use a name mask with the stage, Endevor begins searching for
the specified element(s) in Stage 1 of the current environment, and
retrieves the first element that matches the specified element name,
regardless of its location, version or level.
TO FILE (DDNAME) dd-name
DSNAME dataset-name
MEMBER member-name
PATH hfspath
HFSFILE filename
The SET TO MEMBER clause does not apply to the RETRIEVE action.
PATH
The HFS directory you want to retrieve the element from. This has a
maximum of 768 characters.
HFSFILE
The name of the file for the retrieved element. The file name has a
maximum of 255 characters.
WHERE
OPTIONS
4.14.1 Overview
The SIGNIN statement removes a user signout associated with an
element. It also enables you to sign out or reassign an element to
another user.
4.14.2 Syntax
──SIGnin 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──¤──┬────────────────────┬──¤─┘
├─OVErride SIGNOut───┤
├─SIGNOut TO──userid─┤
│ ┌─NOSearch─┐ │
└─┴─SEArch───┴───────┘
CCID:
┌─EQual─┐ ┌─,────┐
─ccid─┴──)───────┤
├──CCId──┬──────────────────┬──┼───────┼──(───
│ ┌─CURrent──┐ │ └─=─────┘
└─OF──┼─ALL──────┼─┘
└─RETrieve─┘
PRO:
┌─,──────────┐
─group name─┴──)───────────────┤
├──PROcessor GROup──┬─EQ─┬──(───
└─=──┘
Indicates the element(s) to be signed in. Code the required syntax and
enter the appropriate element name; up to 10 characters are allowed.
In addition, you can use a name mask with the element name.
The FROM clause indicates the location of the element being signed in.
Endevor 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, Endevor uses these values.
If you use a name mask with the stage, Endevor begins searching for
the specified element(s) in Stage 1 of the current environment, and
signs in the first element that matches the specified element name,
regardless of its location, version or level.
WHERE
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 (PROJ1, PROJ2, PROJ4)
Example 2: WHERE CCID OF ALL (PROJV)
OPTIONS
4.15.1 Overview
The TRANSFER statement transfers an element from one location to
another. There are three types of transfers:
■ Endevor to Endevor transfers elements from one Endevor location
to another.
■ Endevor to an archive data set transfers elements from Endevor to
an archive data set.
■ Archive/unload data set to Endevor transfers elements from an
archive data set or an unload tape to Endevor.
4.15.3 Syntax
──TRAnsfer ELEment──element-name──┬──────────────────┬──┬──────────────┬──────
└─VERsion──version─┘ └─LEVel──level─┘
──┬───────────────────────────┬──FROm──┤ DEF ├─────────────────────────────────
└─┬─THRough─┬──element-name─┘
└─THRU────┘
──TO──┤ DEF ├──┬───────────────────────┬──┬───────────────────────────┬────────
└─ELEment──element-name─┘ └─WHEre──¤──┬──────────┬──¤─┘
├─┤ CCID ├─┤
└─┤ PRO ├──┘
──┬───────────────────────────────────────────────────────────┬──.────────────
└─OPTION──¤──┬─────────────────────────────────────────┬──¤─┘
├─CCId──ccid──────────────────────────────┤
├─COMment──comment────────────────────────┤
├─NEW VERsion──version────────────────────┤
├─IGNore generate failed──────────────────┤
├─OVErride SIGNOut────────────────────────┤
├─WITh HIStory────────────────────────────┤
├─SYNchronize─────────────────────────────┤
├─┬─BYPass GENerate PROcessor───────────┬─┤
│ └─PROcessor GROup──┬─EQ─┬──group-name─┘ │
│ └─=──┘ │
├─┬─BYPass ELEment DELete───┬─────────────┤
│ └─BYPass DELete PROcessor─┘ │
│ ┌─SIGnin─────────────┐ │
└─┼─RETain SIGNOut─────┼──────────────────┘
└─SIGNOut TO──userid─┘
DEF:
├──ENVIronment──environment-name──SYStem──system-name───────────────────────────
──SUBSYStem──subsystem-name──TYPe──type-name──┬─STAge──stage-id────────┬───────┤
└─STAge NUMber──stage-no─┘
CCID:
┌─EQual─┐ ┌─,────┐
├──CCId──┬──────────────────┬──┼───────┼──(───
─ccid─┴──)────────────────────────┤
│ ┌─CURrent──┐ │ └─=─────┘
└─OF──┼─ALL──────┼─┘
└─RETrieve─┘
PRO:
┌─,──────────┐
├──PROcessor GROup──┬─EQ─┬──(───
─group name─┴──)────────────────────────────────┤
└─=──┘
VERSION
Identifies the version (1-99) of the element you want to transfer. If you
use this clause you must specify a full element name.
LEVEL
Identifies the level (00-99) of the element you want to transfer. If you
use the LEVEL clause you:
■ Cannot use the THROUGH clause.
■ Must specify a full element name.
If you do not specify a LEVEL clause, the Transfer action transfers all
levels to the target location. If you specify this clause, Endevor only
transfers the level you indicate.
If the specified level is not the current level, the execution of the
generate processor at the target location is forced, regardless of the
setting specified by the processor group definition.
Remember that you cannot use a name mask with a TO field name.
WHERE
OPTIONS
If you enter this option, however, you can perform the action whether
or not the element was previously generated or moved successfully.
If the base level of the source element differs from the current level at
the target, the TRANSFER fails unless you code the SYNCHRONIZE
option.
4.15.5 Syntax
──TRAnsfer ELEment──element-name──┬──────────────────┬───────
└─VERsion──version─┘
──┬──────────────┬──┬───────────────────────────┬─────────────
└─LEVel──level─┘ └─┬─THRough─┬──element-name─┘
└─THRU────┘
──FROm──┤ DEF ├──TO──┬─FILe───┬──dd-name──────────────────────
└─DDName─┘
──┬───────────────────────────┬───────────────────────────────
└─WHEre──¤──┬──────────┬──¤─┘
├─┤ CCID ├─┤
└─┤ PRO ├──┘
──┬───────────────────────────────────────────────┬──.───────
└─OPTION──¤──┬─────────────────────────────┬──¤─┘
├─CCId──ccid──────────────────┤
├─COMment──comment────────────┤
├─NEW VERsion──version────────┤
├─IGNore generate failed──────┤
├─OVErride SIGNOut────────────┤
└─┬─BYPass ELEment DELete───┬─┘
└─BYPass DELete PROcessor─┘
DEF:
├──ENVironment──environment-name──SYStem──system-name──────────
──SUBSYStem──subsystem-name──TYPe──type-name──────────────────
──┬─STAge──stage-id────────┬──────────────────────────────────┤
└─STAge NUMber──stage-no─┘
CCID:
┌─EQual─┐ ┌─,────┐
─ccid─┴──)───────┤
├──CCId──┬──────────────────┬──┼───────┼──(───
│ ┌─CURrent──┐ │ └─=─────┘
└─OF──┼─ALL──────┼─┘
└─RETrieve─┘
PRO:
┌─,──────────┐
─group name─┴──)───────────────┤
├──PROcessor GROup──┬─EQ─┬──(───
└─=──┘
VERSION
Identifies the version (1-99) of the element you want to transfer. If you
use this clause you must specify a full element name.
LEVEL
Identifies the level (00-99) of the element you want to transfer. If you
use the LEVEL clause you:
■ Cannot use the THROUGH clause.
■ Must specify a full element name.
If you do not specify a LEVEL clause, the Transfer action transfers all
levels to the target location. If you specify this clause, Endevor only
transfers the level you indicate.
If the specified level is not the current level, the execution of the
generate processor at the target location is forced, regardless of the
setting specified by the processor group definition.
WHERE
If you enter this option, however, you can perform the action whether
or not the element was previously generated or moved successfully.
4.15.7 Syntax
──TRAnsfer ELEment──element-name──┬──────────────────┬──┬──────────────┬──────
└─VERsion──version─┘ └─LEVel──level─┘
──┬───────────────────────────┬──FROm──┤ DEF ├─────────────────────────────────
└─┬─THRough─┬──element-name─┘
└─THRU────┘
──TO──┤ DEF ├──ELEment──element-name───────────────────────────────────────────
──┬──────────────────────────────────────────────────┬─────────────────────────
└─WHEre──¤──┬─────────────────────────────────┬──¤─┘
├─┤ CCID ├────────────────────────┤
├─┤ PRO ├─────────────────────────┤
└─ARChive──┬─┤ DATE ├───────────┬─┘
├─┤ FROM ├───────────┤
├─┤ THROUGH ├────────┤
└─┤ FROM - THROUGH ├─┘
──┬───────────────────────────────────────────────────────────┬──.────────────
└─OPTION──¤──┬─────────────────────────────────────────┬──¤─┘
├─CCId──ccid──────────────────────────────┤
├─COMment──comment────────────────────────┤
├─NEW VERsion──version────────────────────┤
├─OVErride SIGNOut────────────────────────┤
├─┬─BYPass GENerate PROcessor───────────┬─┤
│ └─PROcessor GROup──┬─EQ─┬──group-name─┘ │
│ └─=──┘ │
├─WITh HIStory────────────────────────────┤
├─SYNchronize─────────────────────────────┤
│ ┌─SIGnin─────────────┐ │
└─┼─RETain SIGNOut─────┼──────────────────┘
└─SIGNOut TO──userid─┘
DEF:
├──┬─FILe───┬──ddname──ENVIronment──environment-name──SYStem──system-name───────
└─DDName─┘
──SUBSYStem──subsystem-name──TYPe──type-name──STAge NUMber──stage-no───────────┤
CCID:
┌─EQual─┐ ┌─,────┐
├──CCId──┼───────┼──(───
─ccid─┴──)──────────────────────────────────────────────┤
└─=─────┘
DATE:
├──DATe──┬────┬──date──┬────────────────────┬───────────────────────────────────┤
├─EQ─┤ └─TIMe──┬────┬──time─┘
└─=──┘ ├─EQ─┤
└─=──┘
FROM:
├──FROm──DATe──┬────┬──date──┬────────────────────┬─────────────────────────────┤
├─EQ─┤ └─TIMe──┬────┬──time─┘
└─=──┘ ├─EQ─┤
└─=──┘
THROUGH:
├──┬─────────┬──DATe──┬─EQ─┬──date──┬────────────────────┬──────────────────────┤
├─THRough─┤ └─=──┘ └─TIMe──┬────┬──time─┘
└─THRu────┘ ├─EQ─┤
└─=──┘
PRO:
┌─,──────────┐
├──PROcessor GROup──┬─EQ─┬──(───
─group-name─┴──)────────────────────────────────┤
└─=──┘
VERSION
Identifies the version (1-99) of the element you want to transfer. If you
use this clause you must specify a full element name.
LEVEL
Identifies the level (00-99) of the element you want to transfer. If you
use the LEVEL clause you:
■ Cannot use the THROUGH clause.
■ Must specify a full element name.
If you do not specify a LEVEL clause, the Transfer action transfers all
levels to the target location. If you specify this clause, Endevor only
transfers the level you indicate.
If the specified level is not the current level, the execution of the
generate processor at the target location is forced, regardless of the
setting specified by the processor group definition.
You must code a FILE or DDNAME for this request, indicating the
archive data set from which the element is being transferred. Enter
this information first when coding the syntax.
Remember that you cannot use a name mask with a TO field location.
WHERE
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.
OPTIONS
If the base level of the source element differs from the current level at
the target, the transfer fails unless you code the SYNCHRONIZE
option.
After creating the sync level, Endevor transfers the element(s), either
with or without history.
4.16.1 Overview
The UPDATE statement updates an element in the entry stage, thereby
creating a new level for the element in the entry stage. The entry stage
for the environment is defined through the C1DEFLTS table. Elements
are updated only if there are differences between the incoming source
in the FROM location and the target entry stage source.
4.16.2 Syntax
──UPDate ELEment──element-name──┬───────────────────────────┬────────
└─┬─THRough─┬──element-name─┘
└─THRu────┘
──FROm──┬─┬─FILe───┬──dd-name───────────────────────────┬─────────────
│ └─DDName─┘ │
├─DSName──dataset-name──┬─────────────────────┬─┤
│ └─MEMber──member-name─┘ │
└─PATH──hfspath──HFSFILE──filename──────────────┘
──TO──ENVironment──env-name──SYStem──sys-name─────────────────────────
──SUBsystem──subsys-name──TYPe──type-name─────────────────────────────
──┬──────────────────────────────────────────────────────────────┬────
└─OPTion──¤──┬────────────────────────────────────────────┬──¤─┘
├─CCId──ccid─────────────────────────────────┤
├─COMment──comment───────────────────────────┤
├─DELete input source────────────────────────┤
├─OVErride SIGNOut───────────────────────────┤
└─┬─BYPass GENerate PROcessor──────────────┬─┘
└─PROcessor GROup──┬─EQual─┬──group name─┘
└─=─────┘
──.──────────────────────────────────────────────────────────────────
Note: If you are working with a sequential file, the THROUGH clause
is ignored.
FROM FILE (DDNAME) dd-name
DSNAME dataset-name
MEMBER member-name
PATH hfspath
HFSFILE filename
The FROM clause indicates the location of the element being updated.
Endevor 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, Endevor uses these values.
PATH
HFSFILE
The file in the HFS directory that you want to put under the control of
Endevor.
For more information see 1.6.1, “HFSFile Syntax Rules” on page 1-23.
the beginning of this chapter.
TO ENVIRONMENT env-name
SYSTEM sys-name
SUBSYSTEM subsys-name
TYPE type-name
OPTIONS
Endevor also clears the entry stage retrieve CCID and/or COMMENT
fields when you update an element. If you use the BYPASS
GENERATE PROCESSOR option, the UPDATE action will not set the
generate or component delta CCID and/or COMMENT fields.
Note that SCL inside of packages may not contain any wildcards.
5.2.1 Overview
The Batch Package Facility, program ENBP1000, performs package
actions by executing SCL statements specified in the ENPSCLIN DD
statement. See the chapter, "About the SCL Language," for information
on SCL coding conventions. The following general rules apply to
ENBP1000 execution:
■ There is no defined limit to the number of package actions the
facility can process.
■ There is no defined limit to the number of SCL statements that you
can specify.
■ Statements are executed in the sequence provided.
■ Statements are parsed before any package actions are executed.
■ If parse errors are detected, none of the actions are executed.
■ Actions are processed as long as the action return code is 12 or
less. If a return of greater than 12 is received, all remaining
actions are bypassed.
■ If the same clause is specified multiple times in a statement, the
last clause specified is the one used.
//
//JCLIN DD DSN=iprfx.iqual.JCLLIB(JOBCARD),
// DISP=SHR
//JCLOUT DD SYSOUT=(A,INTRDR),
// DCB=(LRECL=8,RECFM=F,BLKSIZE=8)
//ENPSCLIN DD
DD Statement Descriptions
DD Statement Description
ENPSCLIN Defines the Batch Package Facility control statements. The DD statement can
refer to instream data, a sequential data set, or a partitioned data set with an
explicit member.
Where a partitioned data set option is used, only one archive action
permitted. You may archive multiple packages, however it must be done in
the same command. If you use a separate archive action for each package
being archived, only the last package in the PDS member will appear. For
example:
Archive Package to DDN ddname
Options where older than N days will archive all eligible packages to a PDS
member. Whereas the SCL:
Archive Package A to DDN ddname
Archive Package B to DDN ddname
will result in only package B residing in the Archive file.
The archive package file must be defined with variable length records and
have a minimum record length of 4200. The data set blocksize must be 4 bytes
greater than the record length. We recommend that you define a blocksize of
0 and let the system default to the optium block size.
If any of the data set attributes are incorrect, an error message is written and
a return code 12 is set.
C1MSGS1 Defines the destination of the Batch Package Facility execution reports. You
can write the Batch Package Facility Summary report to a different location by
uncommenting the C1MSGS2 DD statement in the sample JCL.
JCLIN Identifies the default location of the JCL jobcard to be used by the SUBMIT
PACKAGE action. The data set can be a sequential data set or a partitioned
data set with an explicit member. The DD statement is used only with the
SUBMIT PACKAGE action.
JCLOUT Identifies the default output of the SUBMIT PACKAGE action. Generally, the
DD statement refers to an internal reader but it can also refer to a sequential
data set or a partitioned data set with a explicit member name. The DD
statement is used only with the SUBMIT PACKAGE action.
5.3.1 Overview
The APPROVE PACKAGE action approves packages for execution.
Use the APPROVE PACKAGE action against a package only if the
package has a status of In-approval or Denied.
5.3.2 Syntax
──APPRove PACkage──package-id────────────────────────────────
──┬──────────────────────────────────────────┬──.────────────
│ ┌─,───────────┐ │
─'note text'─┴──)─┘
└─OPTions──NOTEs──=──(───
OPTIONS
5.4.1 Overview
The ARCHIVE PACKAGE action offloads a package definition to an
external data set. The ARCHIVE PACKAGE action can, optionally,
delete the package after it is successfully written to the external data
set.
You can use the ARCHIVE action against a package that has a status
of Executed or against a package that has a status of Committed.
Regardless of whether the status is Executed or Committed, you
cannot use the ARCHIVE action with the delete option against any
package that has backout members.
5.4.2 Syntax
──ARChive PACkage──package-id──TO────────────────────────────────────
──┬─DDName──ddname────────────────────────────────────────┬───────────
└─DSNname──dsname──┬──────────────────────────────────┬─┘
└─MEMber──member-name──┬─────────┬─┘
└─REPlace─┘
──┬──────────────────────────────────────────────────┬──.────────────
└─OPTion──¤──┬─WHEre OLDer THAn──number──DAYs─┬──¤─┘
└─DELete──┬───────────────┬──────┘
└─AFTer ARChive─┘
You can include imbedded spaces in the package ID. If the package
ID contains an imbedded space or comprises only numeric characters
(for example, 12345) then enclose the package ID in either single or
double quotation marks.
TO DDNAME ddname
DSNAME dsname
MEMBER member-name
REPLACE
The TO clause identifies the data set to which you are archiving the
package. You must enter either a DDname or a data set name.
Specify only one of the two statements. The archive package file must
be defined with variable length records and have a minimum record
length of 4200. The data set blocksize must be 4 bytes greater than the
record length. We recommend that you define a blocksize of 0 and let
the system default to the optium block size
OPTIONS
5.5.1 Overview
The BACKIN action reverses the BACKOUT action and returns outputs
to a status of Executed. You can use the BACKIN action against a
package that has a status of Executed and has been backed-out.
5.5.2 Syntax
──BACKIn PACkage──package-id──.─────────────────────────────
5.6.1 Overview
The BACKOUT action allows a package to be backed-out after it has
been executed. The BACKOUT action restores the executable and
output modules to the status they were in prior to execution. You can
use the BACKOUT action against a package only if the package has a
status of Executed, In-execution, or Exec-failed and was created with
the BACKOUT option enabled.
5.6.2 Syntax
──BACKOut PACkage──package-id──.────────────────────────────
5.7.1 Overview
The CAST action prepares the package for review and subsequent
execution. Casting a package freezes the contents of the package and
prevents further changes to the package. You can use the CAST action
against a package that has a status of In-edit.
5.7.2 Syntax
──CASt PACkage──package-id───────────────────────────────────────────
──┬───────────────────────────────────────────────────────┬──.───────
└─OPTion──¤──┬─────────────────────────────────────┬──¤─┘
├─┬─BACKOut──┬────┬──ENAbled─┬────────┤
│ │ └─IS─┘ │ │
│ └─BACKOut──IS NOT──ENAbled─┘ │
│ ┌─VALidate COMPonent──────────────┐ │
├─┼─VALidate COMPonent WITh WARning─┼─┤
│ └─DO NOT VALidate COMPonent───────┘ │
├─EXECUTion WINdow──┤ FROM TO ├───────┤
│ ┌─,───────────┐ │
└─NOTE=──(───
─'note-text'─┴──)────────┘
FROM TO:
├──FROm from-date from-time──┬─────────────────────┬───────────────────┤
└─ TO to-date to-time─┘
The CAST PACKAGE clause identifies the package you are casting.
The package ID can be either fully specified, partially wildcarded or
fully wildcarded.
You can include imbedded spaces in the package ID. If the package
ID contains an imbedded space or if the ID is comprised of only
numeric digits (for example, 12345) then enclose the package ID in
either single or double quotation marks.
OPTIONS
5.8.1 Overview
The COMMIT PACKAGE action removes all backout/backin data
while retaining package event information. You can use the COMMIT
action against a package only if the package has a status of Executed
or Exec-failed.
5.8.2 Syntax
──COMMit PACkage──package-id─────────────────────────────────
──┬──────────────────────────────────────┬──.────────────────
└─OPTion──WHEre OLDer THAn number DAYs─┘
You can include imbedded spaces in the package ID. If the package
ID contains an imbedded space or comprises only numeric digits (for
example, 12345), enclose the package ID in either single or double
quotation marks.
OPTIONS
Example One
COMMIT PACKAGE PAYROLLPKG1.
Example Two
COMMIT PACKAGE PAYROLLPKG
OPTIONS WHERE OLDER THAN 3 DAYS.
5.9.1 Overview
The DEFINE PACKAGE action creates a new package or updates an
existing one. If you use the DEFINE PACKAGE action to update an
existing package, the package must be in In-edit status.
5.9.2 Syntax
──DEFine PACkage──package-id─────────────────────────────────────────
──┬─COPy──┬──────┬──PACkage──package-id──────────────────────────┬────
│ └─FROm─┘ │
└─IMPort SCL FROm──┬─DDName──ddname──────────────────────────┬─┘
└─DSName──dsname──┬─────────────────────┬─┘
└─MEMber──member-name─┘
┌─DO NOT APPEnd─┐
──┼───────────────┼───────────────────────────────────────────────────
└─APPEnd────────┘
──DEScription──description-text──┬─────────────────────┬──.──────────
└─OPTion──┤ OPTIONS ├─┘
OPTIONS:
├──¤──┬──────────────────────────────────┬──¤──────────────────────────┤
│ ┌─STANdard──┐ │
├─┴─EMErgency─┴──┬─────────┬───────┤
│ └─PACkage─┘ │
│ ┌─NONsharable─┐ │
├─┴─SHArable────┴──┬─────────┬─────┤
│ └─PACkage─┘ │
│ ┌─BACKOut──┬────┬──ENAbled─────┐ │
│ │ └─IS─┘ │ │
├─┴─BACKout──┬────┬──NOT ENAbled─┴─┤
│ └─IS─┘ │
├─EXECUTion WINdow──┤ FROM TO ├────┤
│ ┌─,───────────┐ │
└─NOTEs──=──(───
─'note text'─┴──)──┘
FROM TO:
├──FROm──from-date──from-time──┬──────────────────────┬────────────────┤
└─TO──to-date──to-time─┘
The DEFINE PACKAGE clause identifies the package you are creating
or updating. An update occurs if the package ID exists and a create
occurs if it does not exist.
You must use a fully specified non-blank package ID. If you specify a
blank package ID and have the GENPKGID exit defined, the
GENPKGID exit invokes to generate a new package ID. If you do not
have the GENPKGID exit installed or if the GENPKGID exit does not
supply a package ID, an error message generates and the DEFINE
PACKAGE action fails.
See the Exits Guide for information on the GENPKID exit function.
The COPY FROM PACKAGE clause directs the DEFINE action to copy
the SCL from the package you specify into the package you are
creating or updating. You must use a fully specified package ID.
If you are creating a new package you must specify either the COPY
FROM PACKAGE or the IMPORT SCL FROM clause. If you are
updating an existing package, the clauses are optional.
The IMPORT SCL FROM clause directs the DEFINE action to copy the
SCL from the DD statement or data set name you specify into the
package you are creating or updating.
If you are creating a new package you must specify either the COPY
FROM PACKAGE or the IMPORT SCL FROM clause. If you are
updating an existing package, the clauses are optional.
The APPEND clause indicates whether to append the SCL you are
adding to the existing package SCL or to replace it. You can only use
the clause if you specify the COPY PACKAGE or IMPORT SCL FROM
clauses. The default is DO NOT APPEND.
DESCRIPTION
OPTIONS
If you specify the from-date, you must also specify the from-time. If
you specify neither the from-date nor the from-time and you are
creating a new package, the from-date and the from-time default to the
current date and time, respectively.
If you specify the to-date, you must also specify the to-time. If you
specify neither the to-date nor the to-time and you are creating a new
package, the to-date and the to-time default to 31DEC99 and 00:00,
respectively.
5.10.1 Overview
The DELETE PACKAGE action allows you to delete packages. You
can use the DELETE PACKAGE action to delete packages of any status
type.
5.10.2 Syntax
──DELEte PACkage──package-id──────────────────────────────────────────────────
──┬───────────────────────────────────────────────────┬──.────────────────────
└─OPTions──¤──┬────────────────────────────────┬──¤─┘
├─WHEre OLDer THAn──number──DAYS─┤
└─┤ WHERE PACKAGE STATUS ├───────┘
WHERE PACKAGE STATUS:
┌──
────────┐
├──WHEre PACkage STATus──┬────┬──ALLstate───
─┬────┬─┴──┬─INEdit──────┬──────────┤
└─IS─┘ └─OR─┘ ├─INApproval──┤
├─DENied──────┤
├─APProved────┤
├─INEXecution─┤
├─EXECUTED────┤
├─EXECFailed──┤
└─COMMITTEd───┘
The DELETE PACKAGE clause identifies the package you are deleting.
You can use a fully specified, partially wildcarded or fully wildcarded
package ID. If you wildcard the package ID, you must specify the
WHERE PACKAGE STATUS IS clause. If you use a fully specified
package ID, the WHERE PACKAGE STATUS IS and the WHERE
OLDER THAN clauses are ignored.
OPTIONS
5.11.1 Overview
The DENY PACKAGE action changes the status of a package to
Denied. You can use the DENY action against a package that has a
status of In-approval.
5.11.2 Syntax
──DENY PACkage──package-id──┬──────────────────────────────────┬─────
└─OPTion──┬──────────────────────┬─┘
│ ┌─,────────────────┐ │
└──
NOTE=('note-text')┴─┘
──.──────────────────────────────────────────────────────────────────
The DENY PACKAGE clause identifies the package you wish to deny.
You must use a fully specified package ID.
OPTIONS
NOTES — You can use the NOTES clause to add remarks to the
package definition. Enclose the note text in either single or double
quotation marks. If you use multiple text lines, enclose each text line
in quotation marks, and separate by commas. You can specify up to 8
text lines of up to 60 characters each. The text replaces any text that is
already associated with the package.
5.12.1 Overview
The EXECUTE PACKAGE action executes a package. You can use the
EXECUTE PACKAGE action against packages that have a status of
Approved or Execfailed. The default is to only execute approved
packages.
5.12.2 Syntax
──EXEcute PACkage──package-id────────────────────────────────────────
──┬──────────────────────────────────────────────────────┬──.────────
│ ┌─WHEre PACkage STATus─┬────┬─APPROVED─┐ │
│ │ └─IS─┘ │ │
└─OPTions──¤──┼──────────────────────────────────────┼─┘
├─EXECUTIon WINdow──┤ FROM TO ├────────┤
├─┬────┬──EXECFailed───────────────────┤
│ └─OR─┘ │
└─¤────────────────────────────────────┘
FROM TO:
├──FROm from-date from-time TO to-date to-time─────────────────────────┤
OPTIONS
5.13.1 Overview
The EXPORT PACKAGE action writes the SCL associated with a
package to an external data set. You can use the EXPORT PACKAGE
action against a package of any status type.
5.13.2 Syntax
──EXPort PACkage──package-id──TO─────────────────────────────────────
──┬─DDName──ddname────────────────────────────────────────┬──.───────
└─DSNname──dsname──┬──────────────────────────────────┬─┘
└─MEMber──member-name──┬─────────┬─┘
└─REPlace─┘
The TO clause identifies where to write the package SCL. Enter either
a DDname or a data set name, not both. The data set defined by the
TO DDNAME/DSNAME clause must be allocated with either fixed or
variable length records. If fixed, the record length must be 80. If
variable, the record length must be at least 84.
5.14.1 Overview
The Inspect Package action checks the elements contained within a
package for conflicts that would effect its successful execution. The
Inspect action checks for security, signout, and synchronization
conflicts as well as changes in source. You can use the Inspect
Package action to inspect packages that have the following status:
■ In-approval
■ Approved
■ Exec-failed
5.14.2 Syntax
──INSpect PACkage──package-id──.────────────────────────────
5.15.1 Overview
The RESET PACKAGE action allows you to set the status of a package
back to In-edit so you can modify it. You can use the RESET action
against a package of any status type.
5.15.2 Syntax
──RESet PACkage──package-id──.──────────────────────────────
The RESET PACKAGE clause identifies the package you are resetting.
You must use a fully specified package ID. The RESET PACKAGE
action resets a package of any status type.
5.16.1 Overview
Use the SUBMIT PACKAGE action to submit a JCL job stream to
execute one or more packages. The SUBMIT PACKAGE action is a
replacement for the existing Batch Package Submission Utility
C1BM6000. Users of C1BM6000 must migrate from C1BM6000 to
ENBP1000. For more information on ENBP1000 and SUBMIT
PACKAGE action see the Packages Guide.
5.16.2 Syntax
──SUBmit PACkage──package-id──────────────────────────────────────────────────
──┬──────────────────────────────────────────────────────┬─────────────────────
│ ┌─JCLIN──┐ │
└─JOBCard──┬─DDName──┴─ddname─┴──────────────────────┬─┘
└─DSName──dsname──┬─────────────────────┬─┘
└─MEMber──member-name─┘
──┬──────────────────────────────────────────────┬─────────────────────────────
└─TO──┬──────────────────────────────────────┬─┘
│ ┌─JCLOUT─┐ │
├─INTernal──REAder──DDName──┴─ddname─┴─┤
└─CA7──────────────────────────────────┘
──┬──────────────────────────────────────────────────────────────────┬─────────
└─OPTion──¤──┬────────────────────────────────────────────────┬──¤─┘
│ ┌─WHEre PACkage STATus─┐ ┌─APPROVED─┐ │
├─┴──────────────────────┴──┬────┬──┴──────────┴─┤
│ └─IS─┘ │
├─┬────┬──EXECFailed─────────────────────────────┤
│ └─OR─┘ │
├─MULtiple JOBStreams────────────────────────────┤
│ ┌─INCrement JOBName────────┐ │
├─┴─DO NOT INCrement JOBName─┴───────────────────┤
└─JCL PROcedure──┬──────┬──┬────┬──procname──────┘
└─NAMe─┘ └─IS─┘
──┬───────────────────────────────────────────┬──.────────────────────────────
└─CA7──OPTIONS──┬─────────────────────────┬─┘
└─DEPEndent──JOB──jobname─┘
The JOBCARD clause identifies the location of the data set that
contains the JCL jobcard. The location be either a DDname or data set
name. If you do not specify the JOBCARD clause, the JCLIN DD
statement is used by default as the JCL jobcard location. If you specify
this clause, the clause must identify either a sequential or a partitioned
data set with an explicitly specified member name. The data set must
have fixed length records and the record length (LRECL) must be
exactly 80.
CA7
OPTIONS
You can also use the INCREMENT JOBNAME clause when you submit
a single job stream and more than 200 eligible packages are found. If
an additional job stream is created, the INCREMENT JOBNAME clause
controls whether the additional job names are incremented. The
SUBMIT action uses the following rules when incrementing the last
character in the job name:
■ If the character is numeric, the next number is selected with
wrap-around to '0'.
■ If the character is alphabetic, the next letter is selected with
wrap-around to 'A'.
■ If the character is neither numeric nor alphabetic, it is not
incremented.
If you do not specify the JCL procedure name the SUBMIT PACKAGE
action creates JCL to invoke the Endevor procedure.
CA7 Translate the above SCL into CA7 syntax similar to this:
DEMAND,JOB=PILRO1C,DEPJOB=CICSDOWN,
SET=NDB,JCLLIB=&ENDEVOR
For more information on CA-7 DEMAND, please refer to the CA7
commands manual or contact you local CA7 Support.
Statement Function
Build Creates DEFINE SCL statements from an existing environment structure.
Define Creates a new or updates an existing environment definition.
Delete Deletes an existing environment definition.
6.2.1 Overview
The Batch Environment Administration Facility, ENBE1000, allows you
to administer environment definitions in batch mode by executing SCL
statements specified in the ENESCLIN DD statement. The following
general rules apply to ENBE1000 execution:
■ You can specify statements in any order after the action name.
■ There is no defined limit to the number of statements you can
specify and process in a single execution.
■ Statements are executed in the sequence you provide.
■ Statements are parsed before execution.
■ If any syntax errors are found, none of the statements are
processed.
■ Statements are processed as long as the action return code is less
than or equal to 12. If a return of greater than 12 is received all
remaining statements are bypassed.
DD Statement Description
ENESCLIN Defines the Batch Environment Administration Facility SCL statements.
The DD statement can refer to instream data, a sequential data set or a
partitioned data set with an explicit member.
If the ENESCLIN DD statement refers to a data set, the data set must
have either fixed length or variable length records. If the records are
fixed length, the record length must be exactly 80. If the records are
variable length, the record length must be at least 84.
If any of the data set attributes are incorrect, an error message is written
and a return code of 12 is set.
C1MSGS1 Defines the destination of the Batch Environment Administration Facility
Execution report. By default, the report is written to this destination.
You can write the report to a different location by uncommenting the
C1MSGS2 DD statement in the sample JCL.
Batch Environment Administration Facility Action Execution Report RELEASE X.XX SERIAL XXXXXX
7:25:22 ENBE1I Statement 1 Object 1
DEFINE SYSTEM 'MJFSYSB1'
TO ENVIRONMENT 'BATCHENV'
DESCRIPTION 'MJFSYSB1 - TEST SYSTEM '
NEXT SYSTEM 'MJFSYSB2'
COMMENTS REQUIRED
CCID NOT REQUIRED
ELEMENT JUMP ACKNOWLEDGEMENT REQUIRED
SIGNOUT IS ACTIVE
SIGNOUT DATASET VALIDATION IS ACTIVE
STAGE ONE LOAD LIBRARY IS
'BST.BATCHENV.S2LOAD'
STAGE ONE LIST LIBRARY
'BST.BATCHENV.S2LIST'
STAGE TWO LOAD LIBRARY IS
'BST.BATCHENV.S1LOAD'
STAGE TWO LIST LIBRARY IS
'BST.BATCHENV.S1LIST'
.
7:25:23 ENBE111I System MJFSYSB1 in Environment BATCHENV created
7:25:23 ENBE11I The DEFINE SYSTEM action has completed. Return Code is
7:25:24 ENBE1I Statement 2 Object 1
BUILD SCL FOR SYSTEM 'MJFSYSB1'
FROM ENVIRONMENT 'BATCHENV'
TO DSNAME 'DA1MF45.BUILD.SCL' MEMBER 'DEFTP16A' REPLACE
.
7:25:25 ENBE115I DEFINE SCL created for System MJFSYSB1 in Environment BATCHENV
7:25:25 ENBE11I The BUILD SYSTEM action has completed. Return Code is
7:25:26 ENBE1I Statement 3 Object 1
DEFINE TYPE 'MJFTYPB1'
TO ENVIRONMENT 'BATCHENV'
SYSTEM 'MJFSYSB1'
STAGE NUMBER 1
DESCRIPTION 'MJF TEST TYPE'
BASE LIBRARY IS
'BST.DEV361S1.SRCLIB'
DELTA LIBRARY IS
'BST.DEV.DELTA'
ELEMENT DELTA FORMAT IS FORWARD
COMPRESS BASE
SOURCE ELEMENT LENGTH IS 8
COMPARE FROM COLUMN 1 TO 72
CONSOLIDATE ELEMENT LEVELS
CONSOLIDATE ELEMENT AT LEVEL 55
NUMBER OF ELEMENT LEVELS TO CONSOLIDATE 4
LANGUAGE IS 'ASM'
PANVALET LANGUAGE IS 'BAL'
CONSOLIDATE COMPONENT LEVELS
CONSOLIDATE COMPONENT AT LEVEL 55
NUMBER OF COMPONENT LEVELS TO CONSOLIDATE 4
.
7:25:27 ENBE113I Type MJFTYPB1 in Environment BATCHENV, System MJFSYSB1, Stage 1 created
7:25:27 ENBE11I The DEFINE TYPE action has completed. Return Code is
Batch Environment Administration Facility Action Summary Report RELEASE X.XX SERIAL XXXXXX
Stmt Action
Number Number Action Object RC Location
------ ------ ------------------- ------------- -- ------------------------------------
1 1 DEFINE SYSTEM MJFSYSB1 To Env BATCHENV
2 1 BUILD SYSTEM MJFSYSB1 From Env BATCHENV
3 1 DEFINE TYPE MJFTYPB1 To Env BATCHENV Sys MJFSYSB1 Stage 1
4 1 BUILD TYPE MJFTYPB1 From Env BATCHENV Sys MJFSYSB1 Stage 1
6.3.1 Overview
The Batch Environment Administration Facility provides commands,
implemented as ISPF/PDF edit macros, that assist you in creating SCL
by providing model SCL statements. The edit macros are written in
REXX. Therefore, they are only available on TSO/E Version 2 or
higher and ISPF/PDF Version 2.3 or higher.
──COMMAND NAME──object_type──┬─────────────┬──.─────────────────────
└─object_name─┘
Command Name
The command name identifies the SCL action you are creating and
places model SCL statements at the current cursor location of the data
set you are editing. The following list identifies the command names
and the functions that each perform.
Object Type
Object Name
6.4.1 Overview
Use BUILD statements to create DEFINE SCL statements from an
existing environment definition or structure. You can create DEFINE
SCL statements for a single environment definition (for example
system, subsystem, or type) or for an entire environment structure (for
example the Production environment). The SCL statements are written
to either a sequential data set or a partitioned data set member. You
can modify the data set that the BUILD action creates or transmit it to
a remote Endevor location for execution.
6.4.3 Syntax
──BUIld SCL──┬─────┬──APProver GROup──group-name─────────────────────
└─FOR─┘
──FROm──ENVironment──environment-name─────────────────────────────────
──TO──┬─DDName──ddname───────────────────────────────────────┬──.────
└─DSName──dsname──┬──────────────────────────────────┬─┘
└─MEMber──member-name──┬─────────┬─┘
└─REPlace─┘
The TO clause indicates where you wish to have the BUILD SCL
written. Enter either a DDname or a data set name, not both. The
data set you specify in the TO DDNAME/DSNAME clause must be
allocated with either fixed or variable length records. If fixed, the
record length must be 80. If variable, the record length must be at
least 84.
6.4.5 Syntax
──BUIld SCL──┬─────┬──APProver RELation──────────────────────────────
└─FOR─┘
──FROm──ENVironment──environment-name──APProver GROup──group-name─────
──TO──┬─DDName──ddname───────────────────────────────────────┬──.────
└─DSName──dsname──┬──────────────────────────────────┬─┘
└─MEMber──member-name──┬─────────┬─┘
└─REPlace─┘
The TO clause indicates where you wish to have the BUILD SCL
written. Enter either a DDname or a data set name, not both. The
data set you specify in the TO DDNAME/DSNAME clause must be
allocated with either fixed or variable length records. If fixed, the
record length must be 80. If variable, the record length must be at
least 84.
6.4.7 Syntax
──BUIld SCL──┬─────┬──ENVironment──environment-name──────────────────
└─FOR─┘
──TO──┬─DDName──ddname───────────────────────────────────────┬──.────
└─DSName──dsname──┬──────────────────────────────────┬─┘
└─MEMber──member-name──┬─────────┬─┘
└─REPlace─┘
The TO clause indicates where you wish to have the BUILD SCL
written. Enter either a DDname or a data set name, not both. The
data set you specify in the TO DDNAME/DSNAME clause must be
allocated with either fixed or variable length records. If fixed, the
record length must be 80. If variable, the record length must be at
least 84.
6.4.9 Syntax
──BUIld SCL──┬─────┬──PROcessor GROup──group-name────────────────────
└─FOR─┘
──FROm──ENVironment──environment-name──SYStem──system-name────────────
──TYPe──type-name──┬─STAge ID──stage-id─────┬─────────────────────────
└─STAge NUMber──stage-no─┘
──┬─────────────────────┬─────────────────────────────────────────────
└─INCLUDE SUBOrdinate─┘
──TO──┬─DDName──ddname───────────────────────────────────────┬──.────
└─DSName──dsname──┬──────────────────────────────────┬─┘
└─MEMber──member-name──┬─────────┬─┘
└─REPlace─┘
The TO clause indicates where you wish to have the BUILD SCL
written. Enter either a DDname or a data set name, not both. The
data set you specify in the TO DDNAME/DSNAME clause must be
allocated with either fixed or variable length records. If fixed, the
record length must be 80. If variable, the record length must be at
least 84.
6.4.11 Syntax
The BUILD SCL FOR PROCESSOR SYMBOL clause indicates that you
are to build DEFINE SCL for processor symbols. You must specify
this clause.
FROM ENVIRONMENT environment-name
SYSTEM system-name
TYPE type-name
STAGE ID stage-id
STAGE NUMBER stage-no
PROCESSOR GROUP group-name
The TO clause indicates where you wish to have the BUILD SCL
written. Enter either a DDname or a data set name, not both. The
data set defined by the TO DDNAME/DSNAME clause must be
allocated with either fixed or variable length records. If fixed, the
record length must be 80. If variable, the record length must be at
least 84.
6.4.13 Syntax
──BUIld SCL──┬─────┬──SHIPMent──DESTination──destination-name────────
└─FOR─┘
──TO──┬─DDName──ddname───────────────────────────────────────┬──.────
└─DSName──dsname──┬──────────────────────────────────┬─┘
└─MEMber──member-name──┬─────────┬─┘
└─REPlace─┘
The TO clause indicates where you wish to have the BUILD SCL
written. Enter either a DDname or a data set name, not both. The
data set defined by the TO DDNAME/DSNAME clause must be
allocated with either fixed or variable length records. If fixed, the
record length must be 80. If variable, the record length must be at
least 84.
6.4.15 Syntax
──BUIld SCL──┬─────┬──SUBSystem──subsystem-name──────────────────────
└─FOR─┘
──FROm──ENVironment──environment-name──SYStem──system-name────────────
──TO──┬─DDName──ddname───────────────────────────────────────┬──.────
└─DSName──dsname──┬──────────────────────────────────┬─┘
└─MEMber──member-name──┬─────────┬─┘
└─REPlace─┘
The TO clause indicates where you wish to have the BUILD SCL
written. Enter either a DDname or a data set name, not both. The
data set defined by the TO DDNAME/DSNAME clause must be
allocated with either fixed or variable length records. If fixed, the
record length must be 80. If variable, the record length must be at
least 84.
6.4.17 Syntax
──BUIld SCL──┬─────┬──SYStem──system-name────────────────────────────
└─FOR─┘
──FROm──ENVironment──environment-name──┬─────────────────────┬────────
└─INCLUDE SUBOrdinate─┘
──TO──┬─DDName──ddname───────────────────────────────────────┬──.────
└─DSName──dsname──┬──────────────────────────────────┬─┘
└─MEMber──member-name──┬─────────┬─┘
└─REPlace─┘
The TO clause indicates where you wish to have the BUILD SCL
written. Enter either a DDname or a data set name, not both. The
data set defined by the TO DDNAME/DSNAME clause must be
allocated with either fixed or variable length records. If fixed, the
record length must be 80. If variable, the record length must be at
least 84.
6.4.19 Syntax
──BUIld SCL──┬─────┬──TYPe──type-name────────────────────────────────
└─FOR─┘
──FROm──ENVironment──environment-name──SYStem──system-name────────────
──┬─STAge ID──stage-id─────┬──┬─────────────────────┬─────────────────
└─STAge NUMber──stage-no─┘ └─INCLUDE SUBOrdinate─┘
──TO──┬─DDName──ddname───────────────────────────────────────┬──.────
└─DSName──dsname──┬──────────────────────────────────┬─┘
└─MEMber──member-name──┬─────────┬─┘
└─REPlace─┘
The BUILD SCL FOR TYPE clause identifies the 1- to 8-character name
of the type from which you are building DEFINE SCL. You can
specify a partially or fully wildcarded type name.
FROM ENVIRONMENT environment-name
SYSTEM system-name
STAGE ID stage-id
STAGE NUMBER stage-no
INCLUDE SUBORDINATES
The FROM clause identifies inventory location of the type from which
you wish to build DEFINE SCL. You must use a fully specified and
non-wildcarded environment name. The system name can be partially
or fully wildcarded. Specify either the stage ID or stage number to
which the type is defined.
The TO clause indicates where you wish to have the BUILD SCL
written. Enter either a DDname or a data set name, not both. The
data set defined by the TO DDNAME/DSNAME clause must be
allocated with either fixed or variable length records. If fixed, the
record length must be 80. If variable, the record length must be at
least 84.
The following is an example of the BUILD SCL FOR TYPE SCL. The
example builds DEFINE SCL for all types using environment DEVEL,
system ACCT, and stage number 1. The SCL is written to the DD
statement SCLOUT.
BUILD SCL FOR TYPE ""
FROM ENVIRONMENT "DEVEL"
SYSTEM "ACCT"
STAGE NUMBER 1
TO DDNAME "SCLOUT" .
6.4.21 Syntax
──BUIld SCL──┬─────┬──TYPe SEQuence──────────────────────────────────
└─FOR─┘
──FROm──ENVironment──environment-name──SYStem──system-name────────────
──┬─STAge ID──stage-id─────┬──────────────────────────────────────────
└─STAge NUMber──stage-no─┘
──TO──┬─DDName──ddname───────────────────────────────────────┬──.────
└─DSName──dsname──┬──────────────────────────────────┬─┘
└─MEMber──member-name──┬─────────┬─┘
└─REPlace─┘
The BUILD SCL FOR TYPE SEQUENCE indicates that you are to
create DEFINE SCL from an existing type sequence definition. You
must specify this clause.
FROM ENVIRONMENT environment-name
SYSTEM system-name
STAGE ID stage-id
STAGE NUMBER stage-no
The FROM clause identifies the inventory location of the type sequence
from which you are building DEFINE SCL. The environment name
you specify in the FROM clause must be fully specified and
non-wildcarded. The system name can be partially or fully wild
carded. Specify either the stage ID for stage number to which the type
sequence is defined.
TO DDNAME ddname
DSNAME dsname
MEMBER member-name
REPLACE
The TO clause indicates where you wish to have the BUILD SCL
written. Enter either a DDname or a data set name, not both. The
data set defined by the TO DDNAME/DSNAME clause must be
allocated with either fixed or variable length records. If fixed, the
record length must be 80. If variable, the record length must be at
least 84.
6.5.1 Overview
Use DEFINE statements to create or update environment definitions.
An environment definition is created if it does not exist. An update
occurs if the environment definition exists.
6.5.3 Syntax
TO ENVIRONMENT environment-name
TITLE title-text
6.5.5 Syntax
You must use the STAGE ID clause if you wild card the stage. Values
specified in a wildcarded STAGE clause are not expanded. The
approver group relationship is built with the wildcarded values.
TYPE IS STANDARD/EMERGENCY
6.5.7 Syntax
DESCRIPTION description
6.5.9 Syntax
You must fully specify the environment name, system name, and type
name.
6.5.11 Syntax
──DEFine SHIPMent DESTination──destination-name──DESCription──description─────
──TRANSMission METhod──method-name──REMote NODename──node-name─────────────────
──┬────────────────────────────────────────┬───────────────────────────────────
│ ┌─DO NOT SHIp─┐ │
└─┴─SHIp────────┴──COMPLementary DATaset─┘
──HOSt DATaset PREfix──value──¤──┬──────────────────────────────┬──¤───────────
│ ┌─DELete─┐ │
├─HOSt DISposition──┴─KEEp───┴─┤
│ ┌─SYSDA─┐ │
├─HOSt UNIt──┴─value─┴─────────┤
└─HOSt VOLume SERial──value────┘
──REMote DATaset PREfix──value──¤──┬────────────────────────────────┬──¤───────
│ ┌─DELete─┐ │
├─REMote DISposition──┴─KEEp───┴─┤
│ ┌─SYSDA─┐ │
├─REMote UNIt──┴─value─┴─────────┤
└─REMote VOLume SERial──value────┘
──REMote JOBcard──┬─EQ─┬──┤ JOBCARD ├──.──────────────────────────────────────
└─=──┘
JOBCARD:
├──(──'jobcard1'──┬───────────────────────────────────────────────┬──)──────────┤
└─,'jobcard2'──┬──────────────────────────────┬─┘
└─,'jobcard3'──┬─────────────┬─┘
└─,'jobcard4'─┘
DESCRIPTION description
The REMOTE UNIT clause specifies the unit type on which the staging
data set will be allocated. The default value is SYSDA. You can use
any string of up to eight alphanumeric characters. The utility does not
verify that the value you enter is defined to the system.
6.5.13 Syntax
──DEFine SHIpment MAPping RULe───────────────────────────────────────
──TO──DESTination──destination-name──DESCription──description─────────
──HOSt DATaset──dataset-name──────────────────────────────────────────
──┬───────────────────────────────────────────┬──┬─────────┬──.──────
└─MAPS TO──┬──────────────────────────────┬─┘ └─EXClude─┘
└─REMote DATaset──dataset-name─┘
TO DESTINATION destination-name
DESCRIPTION description
EXCLUDE
Use the EXCLUDE clause if you do not want to transmit the package
outputs of a data set. You can only use the EXCLUDE clause if you
do not specify the MAPS TO REMOTE DATASET clause. The two
clauses are mutually exclusive.
6.5.15 Syntax
──DEFine SUBSystem──subsystem-name───────────────────────────────────
──TO──ENVironment──environment-name──SYStem──system-name──────────────
──DESCription──description──┬────────────────────────────────┬──.────
└─NEXt SUBSystem──subsystem-name─┘
DESCRIPTION description
6.5.17 Syntax
──DEFine SYStem──system-name──TO ENVironment──environment-name────────────────
──DESCription──description─────────────────────────────────────────────────────
──¤──┬────────────────────────────────────────────────┬──¤─────────────────────
├─NEXt SYStem──system-name───────────────────────┤
│ ┌─NOT REQuired─┐ │
├─COMMent──┴─REQuired─────┴──────────────────────┤
│ ┌─NOT REQuired─┐ │
├─CCId──┴─REQuired─────┴─────────────────────────┤
├─┬─┤ DUPlicate ELEment ├───┬────────────────────┤
│ └─┤ DUPlicate PROcessor ├─┘ │
│ ┌─REQuired─────┐ │
├─ELEment JUMp ACKnowledgement──┴─NOT REQuired─┴─┤
│ ┌─IS NOT ACTIVe─┐ │
├─SIGnout──┴─IS ACTIVe─────┴─────────────────────┤
│ ┌─IS NOT ACTIVe─┐ │
└─SIGnout DATaset VALidation──┴─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─┘
DUPlicate ELEment:
├──┬─DUPlicate ELEment──name──CHEck IS ACTIVe──┬───────────┬─┬──────────────────┤
│ └─┤ error ├─┘ │
└─DUPlicate ELEment──name──CHEck IS NOT ACTIVe────────────┘
DUPlicate PROcessor OUTput:
├──┬─DUPlicate PROcessor OUTput──type──CHEck IS ACTIVe──┬───────────┬─┬─────────┤
│ └─┤ error ├─┘ │
└─DUPlicate PROcessor OUTput──type──CHEck IS NOT ACTIVe────────────┘
error:
├──┬──────────────────────────────────────┬─────────────────────────────────────┤
└─error──SEVerity LEVel──is──┬───────┬─┘
└─W|E|C─┘
TO ENVIRONMENT environment-name
DESCRIPTION description
The NEXT SYSTEM clause identifies the name of the system in the
next environment. If you do not specify the NEXT SYSTEM clause, it
defaults to the name of the system you are creating or updating.
COMMENTS REQUIRED/NOT REQUIRED
The STAGE LOAD LIBRARY clauses indicate the data set names of the
processor load libraries for the system. The data set name must:
■ Be fully qualified and no longer than 44 characters in length.
■ Be predefined and catalogued in the system catalogue.
■ Be a partitioned data set.
■ Have an undefined record format (DCB=RECFM=U).
You must specify the STAGE LOAD LIBRARY clauses when creating
the system definition. The clauses are optional when updating a
system definition.
The STAGE ONE LIST LIBRARY and the STAGE TWO LIST LIBRARY
identifies the processor listing library for this system.
6.5.19 Syntax
──DEFine TYPe──type-name──TO ENVironment──environment-name──SYStem──system-name──────────
──┬─STAge ID──stage-id─────┬──DESCription──description──┬──────────────────────┬──────────
└─STAge NUMber──stage-no─┘ └─NEXt TYPe──type-name─┘
──BASe LIBRARY──┬────┬──dataset-name──DELta LIBRARY──┬────┬──dataset-name─────────────────
└─IS─┘ └─IS─┘
──┬───────────────────────────────────────┬──┬────────────────────────────┬───────────────
└─INCLUDE LIBRARY──┬────┬──dataset-name─┘ │ ┌─DO NOT EXPand INCLUDES─┐ │
└─IS─┘ └─┴─EXPand INCLUDES────────┴─┘
──┬─────────────────────────────────────────────┬─────────────────────────────────────────
└─SOUrce OUTput LIBRARY──┬────┬──dataset-name─┘
└─IS─┘
┌─NOPROC───┐
──DEFAult PROcessor GROup──┬────┬──┴─group-name─┴─────────────────────────────────────────
└─IS─┘
──┬───────────────────────────────────────────┬──┬──────────────────────────┬─────────────
│ ┌─FORWard─┐ │ │ ┌─COMPRess BASe────────┐ │
└─ELEment DELta FORMat──┬────┬──┴─REVerse─┴─┘ └─┴─DO NOT COMPRess BASe─┴─┘
└─IS─┘
──┬─────────────────────────────────────────────────────────┬─────────────────────────────
│ ┌─5────┐ │
└─REGression PERcentage──┬───────────┬──┬────┬──┴─value─┴─┘
└─THReshold─┘ └─IS─┘
──┬──────────────────────────────────────────────┬────────────────────────────────────────
│ ┌─CAUtion─────┐ │
└─REGression SEVerity──┬────┬──┼─INFormation─┼─┘
└─IS─┘ ├─WARning─────┤
└─ERRor───────┘
──SOUrce ELEment LENgth──┬────┬──value────────────────────────────────────────────────────
└─IS─┘
──COMPAre──┬──────┬──COLumn──value──┬────┬──value─────────────────────────────────────────
└─FROm─┘ └─TO─┘
──┬───────────────────────────────────────┬───────────────────────────────────────────────
│ ┌─CONsolidate ELEment──┬────────┬───┐ │
│ │ └─LEVELS─┘ │ │
└─┴─DO NOT CONsolidate ELEment LEVELS─┴─┘
──┬─────────────────────────────────────────┬─────────────────────────────────────────────
│ ┌─97────┐ │
└─CONsolidate ELEment AT LEVel──┴─value─┴─┘
──┬────────────────────────────────────────────────────┬──────────────────────────────────
│ ┌─5────┐ │
└─NUMber OF ELEment LEVELS TO CONsolidate──┴─value─┴─┘
──LANguage──┬────┬──language-name──┬─PANvalet──┬──LANguage──┬────┬──language-name─────────
└─IS─┘ └─LIBRARian─┘ └─IS─┘
──┬─────────────────────────────────┬──┬────────────────────────────────────────┬─────────
└─DATA FORMAT──┬────┬──┬─BINary─┬─┘ └─FILe EXTension──┬────┬──file-extension─┘
└─IS─┘ └─TEXt───┘ └─IS─┘
──┬─────────────────────────────────────────┬─────────────────────────────────────────────
│ ┌─CONsolidate COMPOnent──┬────────┬───┐ │
│ │ └─LEVELS─┘ │ │
└─┴─DO NOT CONsolidate COMPOnent LEVELS─┴─┘
──┬─────────────────────────────────────────────┬─────────────────────────────────────────
│ ┌─FORWard─┐ │
└─COMPOnent DELTa FORMat──┬────┬──┴─REVerse─┴─┘
└─IS─┘
──┬───────────────────────────────────────────┬───────────────────────────────────────────
│ ┌─99────┐ │
└─CONsolidate COMPOnent AT LEVel──┴─value─┴─┘
──┬──────────────────────────────────────────────────────┬────────────────────────────────
│ ┌─5────┐ │
└─NUMber OF COMPOnent LEVELS TO CONsolidate──┴─value─┴─┘
──┬─────────────────────────────┬──.─────────────────────────────────────────────────────
└─HFS RECFM──┬────┬──┬─COMP─┬─┘
└─IS─┘ ├─F────┤
├─CR───┤
├─CRLF─┤
├─LF───┤
├─NL───┤
└─V────┘
If you specify PROCESS as the type name you must specify the
language name in the LANGUAGE clause as CNTLPROC. If you use
the PANVALET/LIBRARIAN LANGUAGE clause, the language name
you specify cannot be CNTLPROC. Likewise, if the type name you
specify in the DEFINE TYPE clause is not PROCESS, then the language
name you specify in the LANGUAGE clause and the
PANVALET/LIBRARIAN cannot be CNTLPROC.
TO ENVIRONMENT environment-name
SYSTEM system-name
STAGE ID stage-id
STAGE NUMBER stage-no
DESCRIPTION description
The NEXT TYPE clause identifies the name of the type at the next map
location. If you do not specify the NEXT TYPE clause, it defaults to
the name of the type you are defining.
The BASE LIBRARY clause identifies the base library for this type.
You must use a fully qualified data set name of no longer than 44
characters in length. The data set can include the &C1 symbolic
variables. If the data set name does not contain a &C1 symbolic, the
data set must be catalogued. If the data set name does not contain any
&C1 symbolic values and the data set organization is partitioned, the
data set record length must be greater than or equal to the SOURCE
ELEMENT LENGTH. You must specify the BASE LIBRARY clause
when creating a new type definition. The clause is optional when
updating a type definition.
The DELTA LIBRARY clause identifies the name of the delta library
for the type. You must use a fully qualified data set name of no
longer than 44 characters in length. the data set can include the &C1
symbolic variables. If the data set name does not contain a &C1
symbolic, the data set must be catalogued. If the data set name does
not contain any &C1 symbolic values and the data set organization is
partitioned, the data set record length must be greater than or equal to
the SOURCE ELEMENT LENGTH. You must specify the DELTA
LIBRARY clause when creating a new type definition. The clause is
optional when updating a type definition.
INCLUDE LIBRARY IS dataset-name
EXPAND/DO NOT EXPAND INCLUDES
You can specify if members can be expanded from this library. The
default is DO NOT EXPAND INCLUDES. You can only specify the
EXPAND INCLUDES clause if you specify the INCLUDE LIBRARY
clause.
The SOURCE OUTPUT LIBRARY clause identifies the data set name of
the source output library. If the data set name does not contain a &C1
symbolic, the data set must be catalogued. If the data set name does
not contain any &C1 symbolic values and the data set organization is
partitioned, the data set record length must be greater than or equal to
the SOURCE ELEMENT LENGTH.
If you are creating a type definition and you do not specify the
DEFAULT PROCESSOR GROUP clause and the type name you specify
on the DEFINE TYPE action is 'PROCESS', the default value is set to
PROCESS. If you are creating a type definition and you do not specify
the DEFAULT PROCESSOR GROUP clause and the type name you
specify in the DEFINE TYPE action is not 'PROCESS', the default value
is set to *NOPROC*.
REGRESSION SEVERITY IS
INFORMATION/WARNING/CAUTION/ERROR/
HFS RECFM
The LANGUAGE clause defines the source language of the type. You
can use any alphanumeric string of up to eight characters in length.
You must specify the LANGUAGE clause when creating a type
definition. The clause is optional when updating a type definition.
6.5.21 Syntax
The DEFINE TYPE SEQUENCE clause indicates that you are updating
the relative sequence of processing for the various element types
defined within a system. You must specify this clause.
TO ENVIRONMENT environment-name
SYSTEM system-name
STAGE ID stage-id
STAGE NUMBER stage-no
6.6.1 Overview
Use DELETE statements to delete existing environment definitions.
The DELETE action will not delete an environment definition if any
elements are defined to the environment definition. For example, you
cannot delete a system if any subsystems or types are defined to that
system. You must delete the subsystems and types before you can
delete the system.
6.6.3 Syntax
6.6.5 Syntax
TYPE IS STANDARD/EMERGENCY
The TYPE IS clause identifies the approver type for this approver
group. An approver group designated as standard can only approve
standard packages. Likewise, an approver group designated as
emergency can only approve emergency packages. The default is
TYPE IS STANDARD.
6.6.7 Syntax
6.6.9 Syntax
The SYMBOL clause identifies one or more symbol names that are to
be deleted from the symbol override. If you specify more than one
name, enclose the symbol names in parentheses and separate by
commas. Deleted symbols revert to the defaults specified in the
processor definition. If you omit the SYMBOL clause, all the symbols
associated with the processor group are deleted.
6.6.11 Syntax
6.6.13 Syntax
6.6.15 Syntax
──DELete SUBSystem──subsystem-name───────────────────────────────────
──FROm──ENVironment──environment-name──SYStem──system-name──.────────
6.6.17 Syntax
──DELete SYStem──system-name──FROm──ENVironment──environment-name────
──.──────────────────────────────────────────────────────────────────
Note: You cannot delete a type definition if there are any elements
associated with it at the stage specified.
6.6.19 Syntax
──DELete──TYPe──type-name──FROm──ENVironment──environment-name───────
──SYStem──system-name──┬─STAge ID──stage-id─────┬──.─────────────────
└─STAge NUMber──stage-no─┘
The DELETE TYPE clause indicates that you are deleting a type
definition. You must specify this clause.
FROM ENVIRONMENT environment-name
SYSTEM system-name
STAGE ID stage-id
STAGE NUMBER stage-no
The FROM clause identifies the inventory location to which the type is
defined. Names you use in the FROM clause must be fully specified.
For example, you want to add an element called "ADD." If you code the
following line, you receive an error message:
ADD ELEMENT ADD.
ADD is a reserved word and must be typed with quotes. If you type the
statement below, the system accepts the entry:
ADD ELEMENT 'ADD'.