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


Appendix A Common TIBCO Object Service Broker Text-Based Workbench Functionality : Common TIBCO Object Service Broker PF Keys : Object Documentation

Object Documentation
Documentation Screen
Object Service Broker provides an interface to document your application objects. Providing and maintaining documentation for all objects encourages better management of objects. You use the Documentation screen to create and modify documentation for a particular object.
Example
This example illustrates the Documentation screen for the screen SAVE_EXPENSES:

 
DESCRIPTION OF SCREEN SAVE_EXPENSES UNIT: USR40
MODIFIED ON BY CREATED ON 23 APR 2000 BY USR40
KEYWORDS: EMPLOYEE EXPENSE
SUMMARY : TOTAL EXPENSE BY EMPLOYEE BY MONTH
DESCRIPTION
_ - - - - - - - - - - - - - - - - - - - - - - - - -
_ THIS SCREEN LISTS THE EXPENSES FOR EACH EMPLOYEE ON A MONTHLY BASIS.
PFKEYS: 3=END 5=VIEW DOCUMENT 13=PRINT 12=EXIT

 
Invoking the Documentation Screen
To invoke the Documentation screen, complete the following steps:
1.
2.
The Documentation screen appears.
The Description field appears formatted in browse mode if information already exists in it. If you have modify-definition access to the object, you then have the ability to modify the contents of the screen. To toggle between edit and browse modes, use PF5.

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