Workplans define individual standard procedures for command execution, object selection and parameter or option settings which can be used to further automate function processing.
Workplans are Natural objects of the type Text. They are, by default, stored in the library WORKPLAN located in the current FUSER system file.
This section covers the following topics:
You can use the administration function (see the relevant
section) to create a Workplan, select a Workplan from a list, modify a
Workplan, or change the default library for Workplans. The default library can also be changed by specifying the
Workplan-Library parameter in your Object Handler
profile (see Profile
Settings).
A Workplan consists of a header (generated by the Object Handler) and an
associated instructional or textual part. Instructional parts contain Object
Handler commands and parameter and/or option settings. Textual parts contain
plain text only. Header and instructional or textual parts can contain comments
(for example, the short description of the Workplan) that must start with the
delimiter characters /* and are restricted to one line.
There are six types of Workplan: PROCEDURE, SELECTION, LIST, PARAMETER, OPTION and TEXT.
The table below lists the valid headers (to be entered if creating a Workplan outside the Object Handler) for the corresponding types of Workplan and describes the contents of the instructional or textual part. Additionally, it provides cross references to the clauses that apply when specifying Object Handler direct commands. The Object Handler direct commands provided are explained in the section Direct Commands.
| Valid Headers | Contents | Related Topic in Direct Commands |
|---|---|---|
TYPE PROCEDURE
|
An Object Handler command procedure. This Workplan can contain any combination of Object Handler commands available for PROCEDURE. Enter a sequence of commands separated by semicolons (;). |
Basic Command Syntax |
TYPE
SELECTION
|
Selection criteria for objects. This Workplan can be used in Object Handler Workplan commands. |
select-clause |
TYPE
LIST
|
A list of objects.
This Workplan can be used in Object Handler Workplan commands. |
select-clause |
TYPE PARAMETER
|
Parameters for the unload or load function. This Workplan can be used to change attributes for the objects to be processed such as the name of a new target library where objects are loaded.
|
parameter-setting |
TYPE OPTION
|
Options for the unload or load function, for example, report settings. This Workplan can be used in Object Handler Workplan commands. |
option-setting |
TYPE TEXT
|
Comments or any other text that can be used for documentation purpose. | Not applicable |
The following table lists examples of instructional parts contained in a Workplan.
| Workplan Type | Instruction | Explanation |
|---|---|---|
| PROCEDURE | FINDLIB * LIB TEST
|
Check whether the library TEST exists. |
| PROCEDURE | UNLOAD A* LIB TEST
|
Unload from the library TEST into Work File 1 all Natural
programming objects starting with |
| SELECTION | * LIB TEST
|
Process all objects from the library TEST. |
| TEXT | This is a Workplan comment.
|
Any text. |
This section covers the following topic:
The following is an example listing of a PROCEDURE Workplan where the
UNLOAD command is executed:
TYPE PROCEDURE /* VERSION=03.01 NATURAL VERSION=04.02.01 PL=0 AUTHOR=SAG DATE=2006-07-20 09:40:12 /* unload from library TEST with target library PROD01 UNLOAD * LIB TEST OBJTYPE N WITH NEWLIBRARY PROD01 WHERE REPORT MYREP01
You can reference a Workplan by using Object Handler menu functions or direct commands (see also the section Direct Commands).
The following syntax applies when referencing a Workplan with the Object Handler direct commands described in the section Direct Commands.
| ( workplan-name | |||||||
[ LIBRARY
library-name
]
|
|||||||
[DBID dbid
[FNR
fnr
] ] [NAME
vsam-name
]
|
|||||||
[CIPHER
cipher
]
|
|||||||
|
|
|
|
|
password |
|
||
| ) | |||||||
The syntactical options are explained in the following section:
The table below describes the keywords and values that apply to the syntax for referencing Workplans.
