Hi All,

We had a requirement of replacing the File Adapter with the JMS adapter due to performance issues with large data.

There are many blogs which gives the information on how the JMS Adapter can be used, but here is a document which shows how you can configure it for sending CSV format file. Also the document contains sections where dynamic properties are used for sending Queue name to the MQHRF2 parameter of the IBM MQ Series.

Hope the document helps for providing more knowledge in using JMS adapter.


To send file data using JMS to IBM MQ series Queue with CSV format.

Reason for the requirement

The scenario deals with IDoc (IDoc AAE) to File using ICO. Files were sent from PI to third Party File Server and stored in theserver. These were picked by MFT (Managed File Transfer). From MFT jobs picks the file to Datastage and send to end system. It was reported that huge files send to the target system is causing performance issues. In order to solve this issue there was a change proposed to use JMS adapter and sending the message through MQ Queue.

Existing Design

The existing design consisted of using a File Adapter been used to send a .txt file in CSV format.  The CSV format was taken care by the File Content conversion in the File adapter. The File Name was send dynamically using ASMA (Adapter Specific Messaging Attributes) with Timestamp and a custom
FileName using an Advanced UDF.

Introducing JMS adapter:

The JMS adapter (Java Message Service) enables you to connect messaging systems to the Integration Engine or the PCK.

The adapter supports the JMS specification 1.02b and 1.1.

Before you can use the JMS adapter you must first install the relevant JMS driver. The required Java libraries are product-specific and can be obtained from either the product vendor or other providers. Following installation, you must deploy the Java libraries on the J2EE server so that the JMS adapter can access the required Java classes at runtime.

If you use MQSeries 53x.xxx, you must enter the following JAR files in aii_af_jmsproviderlib.sda.




(use the JAR file from the J2EE client directory)

JMS adapter can be used to send xml, txt files and can also receive such formats.

Requirement Build

We had a challenge here to convert the message into a file and send in a CSV format. JMS adapter do not have standard function for File Content Conversion unlike in the File adapter.  For this we had applied modules in the Module section of the adapter. Figure 1 shows the module used to achieve this:



Module Name

Module Key




To convert XML to Plain flat file

The Module Key is then used with parameters to structure the Flat File and write a CSV formatted file as shown in Figure 2 and Figure 3:



There is no other configuration required in JMS adapter to convert the xml to a flat file and sending in a CSV format.

Introducing Dynamic sending of Queue Name using JMS Adapter

The Queue name which is present in the Parameters Tab of the JMS adapter can be set in the ReplyToQueue Header of the MQHRF2 filed in the IBM MQ Series. We had achieve the same with the following solution. Figure 1 shows the Module Key RFHHEADER which we have used in the below Figure 4 to send a Queue name to the header. The hided portion is the Queue Name.


Below is the Queue Name in the JMS Queue field which we will be sending dynamically to the MQ Header. Figure 5.


We need to check the ASMA properties in theChannel to have the ReplyTOQueue attribute to be send dynamically. Figure 6.


We need to mention the below parameter in the Additional Parameters section to make possible sending of attributes in a Dynamic manner. Figure 7.


File Name Creation and getting Queue Name Dynamically

The file name was to be created based on a value from the payload appended with a constant value and timestamp. As there was no feasibility of the Timestamp to be added while sending using the JMS adapter we had to use the Java functions to get the timestamp. Below figure 8 shows the
Figure 8:


The next figure will explain how the ReplyToQueue attribute and the Filename were send dynamically using the UDF. DCJMSReplyTo is the name of the dynamic attribute we will be using to give the Queue Name.

In the figure there are other two attributes DCJMSMessageProperty1 and DCJMSMessageProperty0 which are also Dynamic attributes which are used as additional parameter inside the ASMA property.



JMS Message Correlation ID


JMS Message Expiration


JMS Message Priority


JMS Message ReplyTo Destination


JMS Message Timestamp


The technical names of the additional attributes are DCJMSMessageProperty0, DCJMSMessageProperty1, …, DCJMSMessageProperty9.

Figure 9:


In the below figure the Dynamic values are displayed in the Audir log of the Adapter Engine.Figure 10:


The Dynamic parameters and the values can also be seen in the SOAP definition in the Adapter Engine:Figure 11:


The below figure shows the IBM MQ series which shows the ReplyToQueue attribute having the Queue Name Figure 12:


All the Figures have been attached with this post. Please refer to attachment section.

Please Note:

We have covered the names of the Queue and specific other names due to compliance issues.

Also the Queue Name which is send in the ReplyToQueue Attribute is the name used in the JMS Receiver Channel and this is a Static Value. We cannot send and other Queue name in this attribute. The section hence covers possibilities where you can send a value to the MQHRF2 header of the IBM MQ series.

For Future References:

Below are the links which can be referred for any future knowledge:



To report this post you need to login first.

1 Comment

You must be Logged on to comment or reply to a post.

Leave a Reply