Configure the JMS Transport Connector

The JMS transport connector makes it possible to exchange message between IFS Applications and a Java Message Service (JMS) system.

The JMS Reader monitors a dedicated JMS queue for inbound messages in text format, executes them and sends an answer back to the response JMS queue.

The JMS Sender has the possibility to send files in different xml-formats or plain text to another, dedicated JMS queue.

Note: JMS Sender can only write to a JMS queue within the actual instance of Middleware Server. JMS Reader can access JMS queues instances of Middleware Server or Oracle WebLogic. If it is necessary to access third party JMS brokers, like IBM WebSphere MQ, mechanisms like JMS Bridges or Foreign JMS Servers can be used.

Note: By default the installer creates one connection factory with name IfsConnectConnectionFactory and three queues: IfsConnectInQueue, IfsConnectResponseQueue and IfsConnectOutQueue.

Contents

Setting up the JMS sender

  1. Setup the JMS sender parameters

    Parameter Description
    MAX_RETRIES Sets the maximum number of attempts to send the message before signaling a permanent error.
    RETRY_INTERVAL The time, in seconds, between each attempt to send the message.
    CONNECTION_FACTORY The JNDI name for the connection factory object used to initiate connections to the JMS system. Default value is "IfsConnectConnectionFactory".

    Note that JMS sender can only send to a queue that is defined in the actual application server.

     

  2. Setup a Route Address using the JMS sender

    Select JMS as Destination Type and select the JMS sender instance you want to use. Then enter the name of the JMS queue you want the messages to be sent to in the Destination field.

Starting up the JMS reader

  1. Setup the JMS reader parameters
    Parameter Description
    JAR_FILE The path to the JAR-file containing this connector. This value cannot be changed.
    IN_QUEUE The name of the JMS queue to read the incoming messages from. Default IfsConnectInQueue.
    RESPONSE_QUEUE The name of the JMS queue to send read receipts to. Default IfsConnectResponseQueue. (This is an optional parameter. You may unset it if you don't want to generate a read receipt.)
    CONNECTION_FACTORY The JNDI name for the connection factory object used to initiate connections to the JMS system. Default IfsConnectConnectionFactory.
    PROVIER_HOST_NAME Host name for the JMS provider to use.
    PROVIDER_PORT Port number for the JMS provider to use.
    DEFAULT_ENCODING The character encoding to use when handling the incoming messages.

     

  2. Configure the Connect Server to run the JMS reader

    Add the JMS reader instance to the CONNECTORS list in the Connect Server configuration. You can also configure another Connect Server for JMS Reader.
  3. Restart the Connect Server

    Shutdown the Connect Server and start it up again.

Defining JMS queues

By default the installer creates one connection factory with name IfsConnectConnectionFactory and three queues: IfsConnectInQueue, IfsConnectResponseQueue and IfsConnectOutQueue. If necessary it is possible to define more queues using the WLST scripting tool or by editing the <ifs_home>\wls_domain\<instance_name>\config\config.xml file.

For your convenience there is a script that can be used for this purpose. The script is located in the zip archive, jms.zip, located in <ifs_home>\instance\<instance_name> directory. See details in the JMS Bridges section below about usage instructions.

Creating JMS Bridges

The file <ifs_home>\instance\<instance_name>\jms.zip contains a python script together with two shell scripts, one for Windows and one for Linux and a properties file that configures the python script. The script make it possible to create new JMS queues or topics, but also JMS Bridges for connecting with foreign systems.

To use the script do the following:

  1. Unpack the jms.zip file to an empty directory, e.g. <ifs_home>\instance\<instance_name>\jms.
  2. Depending on your operating system open the jms.cmd or jms.sh shell script and set the correct values of variables IFS_HOME and JMS_HOME. IFS_HOME has to point out your <ifs_home> directory, while JMS_HOME the script directory from the previous step.
  3. Edit the jms.properties file:
  4. Open the command shell window and run, depending on your operating system, one of jms.cmd or jms.sh scripts.
  5. Restart the servers using <ifs_home>\instance\<instance_name>\bin\stop_all_server.cmd/sh and start_all_server.cmd/sh.