To configure the documentation properties
of an object contained within a message definition file:
Switch to the Broker Application Development perspective.
Ensure that the Outline view is visible in the Broker Application Development perspective of
the workbench and is displaying the following
information:
The name of the message definition file
Messages
Types
Groups
Elements and Attributes
If the Outline view is not visible, from the workbench menu,
click Window> Show View> Outline. If the information
listed above is not displayed, ensure that the message definition file is
open in the Message Definition editor. Message definition files have an .mxsd file
extension.
In the Outline view, select the message model object for which
you want to configure the documentation properties by doing the following:
Depending on the type of the object that you are selecting,
expand Messages, Types, Groups or Elements
and Attributes as appropriate by clicking +.
Click the object you want to select within the expanded node.
Display the Properties tab of the Message
Definition editor by clicking Properties in the bottom
left corner of the editor area. The Properties Hierarchy
displays the following nodes:
Logical Properties
Physical Properties
Documentation
The type (for example, Local Element or Global Element) of the message
model object that you selected in the Outline view is displayed under each
of these nodes.
Tip: If the items under Documentation are
not in view, expand Documentation by clicking +.
Display the logical properties of the selected object in the Details
view by clicking the appropriate item under Documentation.
Configure the documentation properties of the selected item to
your requirements by typing text into the Documentation text
field. Right-clicking in the text field allows you to select options
for undoing changes you have made, cutting or copying text from the text field,
pasting text into the text field, deleting highlighted text or selecting all
text in the field.
Save your changes by clicking File> Save message_definition_file.mxsd from
the menu or pressing Ctrl+S. Alternatively, from the menu, click File
> Save All or press Ctrl+Shift+S.