Previous Topic: DB.4.4 - Data Set Documentation PanelNext Topic: DB.4.6 - Application System Documentation Panel


DB.4.5 - DD Statement Documentation Panel

The DB.4.5 - DD Statement Documentation panel lets you define DD level documentation.

To display the panel, enter:

To exit the panel:

--------------------- CA-7 DD STATEMENT DOCUMENTATION ---------------------- FUNCTION: xxxxxxxx (APPEND,CLEAR,DELETE,EDIT,FE,FETCH,LIST,REPL,SAVE,UPD) JOB: xxxxxxxx SYSTEM: xxxxxxxx DESC: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx LINK: nnnnnn STEP: xxxxxxxx DDNAME: xxxxxxxx REPORT-ID: xxxxxxxxxxxxxxxxxxxx FORM: xxxxxxxx TRAIN: xx CARRIAGE: xxxx COPIES: nnn ACTIVE SIZE: nnnn PROGRAM: SM11 MSG-INDX: nn -- DB.4.5 -- yy.ddd / hh:mm:ss MESSAGE:

This panel contains the following fields:

FUNCTION

Specifies the function to perform. Value must be the name of some other panel or one of the following values:

APPEND

Retrieves documentation data from the database and attaches documentation text to the end of any existing lines in the Active Area (text work area).

CLEAR

Clears panel input data fields and clears the Active Area of the user.

DELETE

Deletes a documentation member from the database.

EDIT

Transfers the user to the EDIT facility and allows text processing.

FE

Combines FETCH and EDIT.

FETCH

Retrieves documentation data from the database and replaces the Active Area of the user with documentation text.

LIST

Lists documentation data only. In batch, a formatted panel is not listed; only a found or not found message is returned.

REPL

Replaces a documentation member in the database.

SAVE

Adds a documentation member to the database.

UPD

Updates formatted panel fields only. UPD does not affect the documentation text.

Batch keyword: Positional parameter

n/a

Contains a constant value of DD for the DD documentation.

Limits: Required for batch only.

Batch keyword: Positional parameter

JOB

Specifies the job containing the ddname for the documentation being defined.

Limits: 1 to 8 alphanumeric characters

Batch keyword: JOB

SYSTEM

(Optional) Specifies the system name or system ID for which the documentation is being defined.

Limits: 1 to 8 alphanumeric characters

Batch keyword: SYSTEM

DESC

(Optional) Specifies a description of the data set.

Limits: 1 to 45 alphanumeric characters

Batch keyword: DESC

LINK

(Optional) Specifies the number of another documentation member to link to the documentation member listed. Linking documentation members together causes them to be listed together as if they were a single member. The LINK member is listed after the requested member when using the LPROS command only.

Limits: 1 to 6 numeric characters

Batch keyword: LINK

Note: You can create an LPROS loop. Do not link linked documentation to itself. The following example shows a loop:

A linked to B
B linked to C
C linked to A
STEP

Specifies the step of the JOB for the DD documentation being defined.

Limits: 1 to 8 alphanumeric characters

Batch keyword: STEP

DDNAME

Specifies the ddname for which the documentation is being defined.

Limits: 1 to 8 alphanumeric characters

Batch keyword: DD

The following fields are informational only:

REPORT-ID

(Optional) Provides identification of a printed report.

Limits: 1 to 20 alphanumeric characters

Batch keyword: REPORT

FORM

(Optional) Specifies the output form number.

Limits: 1 to 8 alphanumeric characters

Batch keyword: FORM

TRAIN

(Optional) Specifies the type of printer train required.

Limits: 1 to 2 alphanumeric characters

Batch keyword: TRAIN

CARRIAGE

(Optional) Specifies the type of carriage control required.

Limits: 1 to 4 alphanumeric characters

Batch keyword: CARR

COPIES

(Optional) Specifies the number of original copies required.

Limits: 1 to 3 numeric characters from 0 to 255

Batch keyword: COPIES

ACTIVE SIZE

Identifies a system-generated field that shows the number of lines of text existing in the Active Area for the current terminal session.

More information:

Using the Edit Facility