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 : Maintaining Object Documentation

Maintaining Object Documentation
 
The SEARCH tool in the TIBCO Object Service Broker Shareable Tools manual for information on the Keyword Search facility
The SCRIPT tool in the TIBCO Object Service Broker Shareable Tools manual for a list of Script commands
Maintaining the Fields
Tools like the Table Definer or the Screen Definer update some of the fields on the Documentation screen automatically but you must maintain the following fields:
KEYWORDS Field
Enter individual words that briefly describe the object. These words are used by the Keyword Search facility in TIBCO Object Service Broker. This field is one line long and can contain multiple entries separated by commas or blanks. For example, EMPLOYEE EXPENSE is treated as two keywords.
SUMMARY Field
Enter a one line summary of the DESCRIPTION field. For example, Total Expense By Employee By Month.
DESCRIPTION Field
Enter information about the object (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 enter in this field.
 
 

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