Create or Edit a JMS Topic Configuration File

A JMS topic configuration file defines a number of different things.

It defines:

  • whether publication of JMS messages is enabled.
  • the connection details for the EMS server that hosts the topic.
  • the name and output format of the JMS topic to which TIBCO ActiveMatrix BPM audit data messages will be published.
  • which messages, as defined by message ID, by severity, or both, will be published.

The JMS topic configuration file must reside in the CONFIG_HOME\bpm\bpm_app_name\configuration folder. For example, C:\ProgramData\amx-bpm\tibco\data\bpm\amx.bpm.app\configuration

An example JMS topic configuration file, ECPublicationJMS.properties, is supplied as part of the default TIBCO ActiveMatrix BPM installation (in the CONFIG_HOME\bpm\bpm_app_name\configuration folder. For example, C:\ProgramData\amx-bpm\tibco\data\bpm\amx.bpm.app\configuration). The example file can be used to connect to the TIBCO Enterprise Message Service server that is hosted on the same machine as TIBCO ActiveMatrix BPM.

The JMS topic configuration file must contain the parameters and values described in the following table.

Note: The exact values and formats required by these parameters will depend on the configuration of your EMS server. For more information, contact your EMS server administrator, or see the TIBCO Enterprise Message Service User’s Guide.
Parameter Value
monitor.enable Whether TIBCO ActiveMatrix BPM should (true) or should not (false) monitor the file for changes. The default value is false.
PublicationEnabled Whether publication of JMS messages is (true) or is not (false) enabled. The default value is false.
InitialContextFactory Name of the initial context factory that will be used to create the connection to the EMS server. This is: com.tibco.tibjms.naming.TibjmsInitialContextFactory
InitialURL URL (host name, transport protocol and port id) for the connection to the EMS server, in the format: protocol://hostname:port where:
  • protocol is the transport protocol to be used (for example, TCP or SSL).
  • hostname is the DNS name or IP address of the EMS server.
  • port is the port ID used by the EMS server.
TopicConnectionFactory Name of the JNDI factory that will provide a topic connection.
SecurityPrinciple Username required to connect to the EMS server. This parameter is required only if the EMS server has been configured to use a secure connection.
SecurityCredentials Password required to connect to the EMS server. This parameter is required only if the EMS server has been configured to use a secure connection.
SecurityEncryption Encryption method used for the SecurityCredentials parameter. This parameter is currently not used by TIBCO ActiveMatrix BPM.
Persistent Whether messages are (Y) or are not (N) persistent. Persistent messages are slower, but are guaranteed to be delivered once and only once to a subscriber.
Priority Priority of the JMS messages.
TimeToLive Maximum time to live for the JMS messages in milliseconds. If the value is 0 messages never expire.
TopicName Name of the JMS topic to which TIBCO ActiveMatrix BPM audit messages will be written. The default topic name is ECTopic.
SchemaVersion The version of the schema you want to use. By default, SchemaVersion is commented out, so the previous version is used. Uncomment the SchemaVersion parameter to use the latest version of the TIBCO ActiveMatrix BPM schema. You should do this if you want to use work item facades, otherwise only the default names for work item attributes display (for example, attribute1, attribute2 and so on) in the BPM audit data messages.
OutputFormat Message format in which JMS messages will be written. The only valid value is:
  • N2 - TIBCO ActiveMatrix BPM Event
See Supported JMS Message Format for more information.