Using the Documentation Screen

Copyright © Cloud Software Group, Inc. All Rights Reserved

Appendix A Documenting DB2 Tables : Using the Documentation Screen

Using the Documentation Screen

Each table definition in TIBCO Object Service Broker has a Documentation screen associated with it. You use this screen to create or modify documentation for the table. To display the Documentation screen for a TIBCO Object Service Broker DB2 table, press PF2 from the Table Definer. The Documentation screen associated with the EMPLOYEE table is shown below.

DESCRIPTION OF TABLE EMPLOYEE UNIT: USR40

MODIFIED ON 20 JAN 2000 BY ACC CREATED ON 02 JAN 2000 BY USR40

KEYWORDS: EMPLOYEE

SUMMARY : DB2 TABLE CONTAINING EMPLOYEE DATA

DESCRIPTION

_ - - - - - - - - - - - - - - - - - - - - - - - - -

_ This table contains all information on current employees.

PFKEYS: 3=END 5=VIEW DOCUMENT 13=PRINT 12=EXIT

Field Values

The Table Definer updates some of the fields on this screen. You must maintain the KEYWORDS, SUMMARY, and DESCRIPTION fields. Complete these fields as follows:

KEYWORDS

Type individual words that briefly describe the table. These words are used by the TIBCO Object Service Broker Keyword Search facility. This field is one line long and can contain multiple entries, separated by commas or blanks.

SUMMARY

Type a one line summary of the DESCRIPTION field.

DESCRIPTION

Type information about the table (for example, what its role is, what it does, and how it works) using TIBCO Object Service Broker SCRIPT commands. There is no limit to the amount of information you can type in this field.

PF Keys

The following function keys are supported from the Documentation screen:

PF1

Displays corresponding help for the current field or screen.

PF3

Saves changes and returns you to the Table Definer.

PF5

Toggles between browse and edit modes.

PF12

Cancels changes and returns you to the Table Definer.

PF13

Prints the version of the documentation that you are viewing.

See Also

TIBCO Object Service Broker Shareable Tools for more information on the SCRIPT tool.

KEYWORDS	Type individual words that briefly describe the table. These words are used by the TIBCO Object Service Broker Keyword Search facility. This field is one line long and can contain multiple entries, separated by commas or blanks.
SUMMARY	Type a one line summary of the DESCRIPTION field.
DESCRIPTION	Type information about the table (for example, what its role is, what it does, and how it works) using TIBCO Object Service Broker SCRIPT commands. There is no limit to the amount of information you can type in this field.

PF1	Displays corresponding help for the current field or screen.
PF3	Saves changes and returns you to the Table Definer.
PF5	Toggles between browse and edit modes.
PF12	Cancels changes and returns you to the Table Definer.
PF13	Prints the version of the documentation that you are viewing.