JMS Delivery Method

The available options for the Java Message Service (JMS) delivery method are system dependent. STEP has the following standard JMS delivery options: Apache Active MQ, WebSphere MQ, and Oracle AQ. Each of these can be used to deliver messages to a JMS receiver without any further customizations. To deliver messages to other JMS providers, contact your Stibo Systems account manager for further customizations. This delivery option is only available in OIEPs.

Prerequisites

Changes to the properties file, outlined below, are implemented when the server is restarted.

Refer to the Sharedconfig.properties File Examples section below for more information.

  1. Prior to configuration, clicking the Connection Factory Name dropdown parameter displays the required property name. Provide a selection for the dropdown parameter via the sharedconfig.properties file on the STEP application server using the case-sensitive JMSConnectionFactoryName property.

  2. Prior to configuration, clicking the JMS Provider URL dropdown parameter displays the required property name. Provide a selection for the dropdown parameter via the sharedconfig.properties file on the STEP application server using the case-sensitive JMSProviderURL property. If necessary, use a comma to separate multiple URLs.

The following is an example of a complete property entry for two systems named 'qa' and 'stage,' as well as their URLs 'http://step-qa' and 'http://step-stage':

JMSProviderURL=qa=http://step-qa,stage=http://step-stage

  1. Prior to configuration, clicking the JMS Queue dropdown parameter displays the required property name. Provide a selection for the dropdown parameter via the sharedconfig.properties file on the STEP application server using the case-sensitive JMSQueue property.

Configuration

For information on a parameter, hover over the parameter field to display help text.

  1. On the Configuration tab, in the Delivery Method area, click Edit Delivery.
  2. In Select Delivery Method, choose JMS Delivery.

  1. In JMS Connection Factory Class, choose the JMS connection factory class that corresponds to the driver class from the JMS provider vendor. On a standard system, the following options are available:
  • ActiveMQInitialConnectionFactory: Connects the JMS delivery to Apache Active MQ. For information, search the web.

Note: WMQInitialContextFactory is no longer supported, use FileInitialContextFactory instead.

  • FileInitialContextFactory: Enables setting up JMS WebSphere Inbound and Outbound Integration Endpoints which reference a binding file (created from JMS WebSphere Client software). The binding file is a configuration file which includes all details of how STEP should interact with JMS WebSphere. For information about JMS WebSphere Client Software, search the web.
  1. In Connection Factory Name, select a connection factory name from the list.
  2. In JMS Provider URL, select a JMS Provider URL from the list.
  3. In JMS Queue, select the physical name of the JMS Queue to be used on Apache Active MQ or WebSphere MQ.
  4. In Binary Payload, select 'Yes' if the message contents will be in a binary format (such as Excel).
  5. In User Name, if required, enter the user name that will be used to log onto the JMS provider.
  6. In Password, if required, enter the password that will be used to log onto the JMS provider.
  7. If additional parameters are required, click Add parameter, then enter the Key and Value.
  8. On the Edit Delivery Configuration dialog, click the OK button to save the delivery method.

Sharedconfig.properties File Examples

Each of these properties has a key/value pair as a value:

JMSConnectionFactoryName=FirstFactoryName=MyFactoryName
JMSProviderURL=ProviderURL=https://myproviderurl.com/url
JMSQueue=Queue=Myqueuename

Each of the properties can contain more than one value in a comma separated list:

JMSConnectionFactoryName=FirstFactoryName=MyFactoryName1,SecondFactoryName=MyFactoryName2
JMSProviderURL=FirstProviderURL=https://myproviderurl.com/url,SecondProviderURL=https://myproviderurl2.com/url
JMSQueue=Queue1=Firstqueuename,Queue2=Secondqueuename2

Azure Message Bus

In the JNDI properties file, add properties to set the context factory and map queues, setting connectionfactory = SBCF as shown below:

connectionfactory.SBCF = failover://(amqps://khpetest.servicebus.windows.net)?jms.prefetchPolicy.all=10&failover.maxReconnectAttempts=20

Register queues in JNDI using the form:

  • queue.[jndi_name] = [physical_name]
  • topic.[jndi_name] = [physical_name]
  • queue.QUEUE = queue1

For more information on the Qpid JMS client library, refer to https://github.com/MicrosoftDocs/azure-docs/blob/master/articles/service-bus-messaging/service-bus-java-how-to-use-jms-api-amqp.md

FileInitialContextFactory JMS Delivery Configuration Example

JMS WebSphere Delivery Using SSL Configuration Example

Apache Active MQ JMS Delivery