Use the WebSphere® Message Broker Explorer to configure the Long Description and Short Description on your brokers, execution groups and deployed message flows.
Alternatively, you can use the Message Broker API to
configure the Long Description properties.
The Short Description is stored and used by the WebSphere Message
Broker Toolkit. The Long Description is stored by the broker, and can be viewed within the WebSphere Message Broker Explorer or Message Broker API. You can also use the Long Description to add keywords to your message flows.
To configure the Long Description and Short Description on your brokers,
execution groups, or message flows:
- In the Navigator view, expand the Brokers folder.
- Right-click the object with which you want to work, and
click Properties. This object can be a broker, execution group, or message flow. The Properties window
is displayed. The Long Description and Short Description are fields on the General tab.
- Enter the values for the Long
Description, Short Description,
or both. If you are working with a message flow, you can
add keywords into the Long Description field.
When you define a keyword, you must follow certain rules to ensure
that the information can be parsed. The following example shows some
values that you might want to define in the Long Description property:
$MQSI Author=John Smith MQSI$
$MQSI Flow 1 Version=v1.3.2 MQSI$
Do not use the following characters within keywords,
because they cause unpredictable behavior:
^ $ . | \ < > ? + * = & [ ] ( )
You
can use these characters in the values that are associated with keywords;
for example:
- $MQSI RCSVER=$id$ MQSI$ is acceptable
- $MQSI $name=Fred MQSI$ is not acceptable
- Click Apply to update the description
properties.
- Click OK to exit the Properties window.
The description properties for the
selected object are now updated, and you can view these properties
in the Properties QuickView for the object
in the WebSphere Message Broker Explorer.