Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved


Appendix A Documenting IMS 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 an IMS, press PF2 from the Table Definer.
Sample Documentation Screen

 
DESCRIPTION OF TABLE CUST_ORDERS UNIT: USR40
MODIFIED ON 20 JAN 1998 BY ACC CREATED ON 01 JAN 2000 BY USR40
KEYWORDS: ORDER
SUMMARY : IMS TABLE CONTAINING ORDER INFORMATION
DESCRIPTION
_ - - - - - - - - - - - - - - - - - - - - - - - - -
_ This table contains all information on current customer orders.
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:
Type individual words that briefly describe the table. These words are used by the TIBCO Object Service Broker Keyword Search. This field is one line long and can contain multiple entries, separated by commas or blanks.
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:
See Also
The TIBCO Object Service Broker Shareable Tools manual for more information on the SCRIPT tool.

Copyright © TIBCO Software Inc. All Rights Reserved
Copyright © TIBCO Software Inc. All Rights Reserved