Workload Documentation › DB.4 Workload Documentation Panels › DB.4.6 - Application System Documentation Panel

DB.4.6 - Application System Documentation Panel

The DB.4.6 - Application System Documentation panel lets you define system level documentation.

To display the panel, enter:

• 6 as the FUNCTION on the DB.4 Menu panel.
• 4.6 as the FUNCTION on the DB Menu panel.
• DB.4.6 as the FUNCTION on any other menu or formatted input panel.
• DB.4.6 or PROSE,SYS as a top line command.

To exit the panel:

• Press PF3 to return to the DB.4 Menu panel except with the TSO/ISPF interface when PF3 has been assigned to another function.
• Move the cursor to the top line of the panel and enter the wanted top line command if yet another function is wanted.

 ------------------  CA-7 APPLICATION SYSTEM DOCUMENTATION  -------------------
 FUNCTION: xxxxxxxx  (APPEND,CLEAR,DELETE,EDIT,FE,FETCH,LIST,REPL,SAVE,UPD)



 SYSTEM: xxxxxxxx




 DESC: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx  LINK: nnnnnn






 ACTIVE SIZE: nnnn


 PROGRAM: SM11  MSG-INDX: nn  -- DB.4.6   --  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 the DESC and the LINK fields only. UPD does not affect the documentation text.

Batch keyword: Positional parameter

n/a

Contains a constant value of SYS for system documentation.

Limits: Required for batch only.

Batch keyword: Positional parameter

SYSTEM

Specifies the system name or system ID for which the documentation entry is being defined.

Limits: 1 to 8 alphanumeric characters

Batch keyword: SYSTEM

DESC

(Optional) Specifies an optional description of the system.

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

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