Configuring documentation properties: Message sets

Before you start:

To complete this task, you must have completed the following tasks:

This task topic describes how to document a message set within the workbench.

To configure the documentation for a message set:

  1. Switch to the Broker Application Development perspective.
  2. In the Message Set editor Properties Hierarchy, click Documentation. The documentation text field appears in the Details view.
  3. Type the appropriate text into the Documentation text field to document the message set to your requirements.
    Tip: Right-clicking in the text field displays menu items that give you the option of 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 the text in the field.
  4. Save your changes either by clicking File > Save messageSet.mset or by pressing Ctrl+S. Alternatively click File > Save All on the menu or press Ctrl+Shift+S.

Related concepts
Message sets

Related tasks
Working with a message set
Generating information from message sets

Related reference
Message Set editor
Documentation properties for all message set objects