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. Configure the documentation properties shown in the Details view to your requirements.
    Tip: The Documentation property can be used to set user defined keywords and their value. These are propagated to the Configuration Manager when the message set is deployed to the broker. These keywords are used to give additional information about the message set when the Configuration Manager is used to display the message set properties.
  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 overview
Message set version and keywords
Related tasks
Working with a message set
Generating information from message sets
Related reference
Message set editor
Documentation properties for all message set objects
Guidance for defining keywords