IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

Guidance for defining keywords

You can add extra information to an object in the form of one or more keywords.

This information can display information about an object after the object has been deployed. The default information that is displayed is the time the object was deployed and the last time the object was modified.

You can define custom keywords, and their values that the IBM® Integration Toolkit interprets as additional information to be displayed, in the properties view. For example, you can define keywords for "Author" and "Subflow 1 Version":

$MQSI Author=John Smith MQSI$
$MQSI Subflow 1 Version=v1.3.2 MQSI$

The following table contains the information that is displayed by the IBM Integration Toolkit:

Object name	Example
Deployment Time	28-Aug-2009 15:04
Modification Time	28-Aug-2009 14:27
Version	v1.0
Author	John Smith
Subflow 1 Version	v1.3.2

In this display, the version information has been defined by using the Version property of the object. If the version information had not been defined, it would be omitted from this display.

Use the following syntax to define a keyword and its associated value:

$MQSI KeywordName = KeywordValue MQSI$

Where:

$MQSI: $MQSI opens the definition. It can be followed by an optional underscore or white-space character that is ignored.
KeywordName: The name of the keyword for which you are setting the value. It is made up of a sequence of alphanumeric characters apart from the equals (=) sign. It can contain white-space characters, but leading or trailing white-space characters are omitted.
=: The equals (=) sign is the delimiter between the keyword and the value that you are setting it to.
KeywordValue: The value to which the keyword is set. It is made up of a sequence of alphanumeric characters. It can contain white-space characters, but leading or trailing white-space characters are omitted.
MQSI$: MQSI$ closes the keyword definition.

Examples

Example definitions	Interpreted keyword and value	Comments
$MQSIAuthor=JohnMQSI$ or $MQSI Author=John MQSI$ or $MQSI Author = John MQSI$	Keyword = "Author" Value = "John"	Each of these examples shows what can be set and that the leading and trailing white-space characters for the name and value parameters are ignored.
$MQSI_Author = John MQSI$	Keyword = "Author" Value = "John"	The first character after $MQSI can be an underscore character. The underscore character is omitted in the interpreted keyword. If a second underscore character appears, this forms part of the keyword name.
$MQSI Flow designer = John Smith MQSI$	Keyword = "Flow designer" Value = "John Smith"	White-space characters are accepted for each parameter value.
$MQSI bar = MQSI$	Keyword = "bar" Value = ""	The keyword value can be set to an empty ("") string.
$MQSI_mqsitag=$MQSI$MQSI$	Keyword = "mqsitag" Value = "$"	This example is a poorly formatted definition. After defining the keyword name, the parser is looking to find the delimiters that form the boundary of the value to be set. In this case, the only character before the MQSI$ that closes the definition is a '$', and that is set as the keyword value.
$MQSI=barMQSI$		This pattern is ignored because the keyword name cannot be an empty string.
$MQSItagbarMQSI$		This pattern is ignored because there is not a separator (=) between the keyword name and the keyword value.

Do not use the following keywords:

VERSION: When you use the IBM Integration Toolkit to edit message flows and dictionaries, it is possible to set the Version property in the Properties pane, which you can then view in the Broker Archive file editor. If you set this property, a keyword called VERSION is added to the resulting .cmf or dictionary file. For this reason, do not add $MQSI_VERSION=...MQSI$ to these files.
BAR: The BAR keyword is associated with each object automatically when it is deployed and it contains the full path name of the broker archive file that deployed the object.

The values of both keywords are defined programmatically in the class com.ibm.broker.config.proxy.DeployedObject.

Restrictions within keywords

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

ac35480_.htm |

Last updated Friday, 21 July 2017