Documenting terms

You can define a documentation property for each BOM element.

About this task

You document business terms to provide guidance to policy managers.

Procedure

To document a term:

  1. Copy the vocabulary file that you want to edit in the <referencefolder>/bom folder of your external library.
  2. Open the vocabulary file in a text editor.
  3. Look for the term that you want to document and add the required description or comment using the following syntax: 
    element.signature#documentation = <documentation>

    For example:

    org.samples.Customer.name#phrase.navigation.documentation = Represents the name of a customer
    org.samples.Session.DisplayMessage(java.lang.String)#phrase.action.documentation = Displays a message
  4. When you have finished, save your changes.