Adding version information and custom keyword values to your development resources
You can add a version and other custom keyword values to deployable resources during development.
About this task
Version information is assigned to a development resource
by including the following string in the source code of the resource:
$MQSI_VERSION=VersionIdentifier MQSI$
For
example:$MQSI_VERSION=v1.0 MQSI$
Custom
keywords are assigned to a development resource by including the following
string in the source code of the resource:
$MQSI KeywordName=KeywordValue MQSI$
For
example:$MQSI Author=John Smith MQSI$
Note: Do
not use BAR as a keyword name.
The BAR keyword is associated
with each object automatically when it is deployed and it contains
the full path name of the BAR file
that deployed the object.
Note: 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 (RCSVER
is a valid keyword name).$MQSI $name=Fred MQSI$
is not acceptable ($name
is not a valid keyword name).
The method for adding version information, custom keywords, and custom keyword values to the
source code varies depending on the resource type. The following table describes a method that you
can use to add version and custom keyword information to each type of resource:
Resource type | Method to add version and custom keywords |
---|---|
Message flows | Add the VersionIdentifier to the Version field in the message flow
properties. Information added to the Version field does not need to be encased in
$MQSI tags.Add custom keyword strings to the Short Description or Long Description fields in the message flow properties by using the IBM® App Connect Enterprise Toolkit or the web user interface. |
Subflows | Add the VersionIdentifier to the Version field in the subflow
properties. Information added to the Version field does not need to be encased in
$MQSI tags.Add custom keyword strings to the Short Description or Long Description fields in the subflow properties by using the IBM App Connect Enterprise Toolkit or the web user interface. Note: If you use Compile and in-line resources when
you build your BAR file, you must use a different keyword in each
instance of a subflow. Only the first recorded instance of each keyword within the message flow
.cmf file is available to applications that use the IBM Integration
API, which includes the IBM App Connect
Enterprise Toolkit.
The order that subflows appear in the .cmf file is not guaranteed. |
Applications and Libraries | It is not possible to add version or custom keyword strings to an application or library
during development. Instead, you must complete the following steps:
|
For information about viewing version or custom
keyword information in your packaged or deployed resources, see the
following topics: