As businesses increasingly operate across both cloud and on-premise systems, they need a reliable way for these environments to communicate seamlessly in real time. The SAP Integration Suite enables this by providing a rich set of adapters that ensure secure, scalable, and effortless connectivity between systems. In this blog, I will discuss one of the recently released IBM MQ Adapter.
IBM MQ Adapter in SAP CI
IBM MQ is a secure and reliable messaging solution that enables applications, systems, services, and files to communicate by exchanging messages through queues. It simplifies and accelerates the integration of applications and the sharing of business data across diverse platforms.
The IBM MQ Adapter is available in both sender and receiver modes to streamline message-based workflows and comes in two variants — REST and JMS (Java Message Service).
Key Features
The IBM MQ Adapter (JMS variant) provides the following key features:
Sender adapter facilitates automatic message delivery via JMS Subscribe variant and Supports Persistent and Non-persistent message delivery via JMS.Supports Transactional JMS Session for data consistency and Byte and Text JMS messages.Provides multiple actions for failed transaction handling: Keep the Message and Process Again or Move to Another Queue.Receiver adapter allows reliable publishing of messages to Topics and Queues.Supports multiple authentications: Basic, Client Certificate, and None.
Practical Use Case Walkthrough:
Here we will demonstrate how to write employee data (sending it as a message) to a queue on the IBM MQ server using IBM MQ Receiver adapter and read the message from the queue with help of the IBM MQ Sender Adapter.
IBM MQ JMS Receiver Adapter: Write Employee Data to a Queue
Architecture for IBM MQ Receiver adapter
When the IBM MQ Adapter is used as a receiver adapter, SAP Integration Suite acts as the initiator of the calls.
SAP Integration Suite tenant sends the operation request to IBM MQ (this is a receiver system), IBM MQ Receiver Adapter works on the request and sends the data back using JMS protocol to the SAP Integration Suite tenant.
Prepare Details
In the Content Modifier, you can define employee details, such as names, organization, role, and salary.
EmployeeId: EMP1005
EmployeeName: Shubham
Organization: XX Industries
Role: Senior Analyst
Salary: 75000
Join Date: 2025-10-07
Configure the Connection tab for IBM MQ JMS Receiver Adapter
The Connection tab includes connection and authentication settings for IBM MQ Adapter.
For more information regarding the authentication, refer to the IBM MQ for SAP Integration Suite.
Connection Tab:
Parameter
Description
Hostname
Specify the hostname to connect to IBM MQ.
Port
Specify the port number to connect to IBM MQ.
Example as 31656
Authentication
Select the type of authentication for connecting to IBM MQ:
Basic: Provides authentication using User Credentials.Client Certificate: The server authenticates the client by receiving the client’s certificate during the SSL handshake and verifying that the certificate is valid.None: Direct connection can be made without User Credentials.
Credential Name
Specify the User Credential artifact that stores the username-password pair.
Example as IBM_MQ_54
Proxy type
Select the proxy type as Internet
SSL Cipher Suite
The specific set of cryptographic algorithms used to establish a secure, encrypted connection (SSL/TLS) between the adapter and the IBM MQ queue manager.
Example as *TLS12HIGHER
Queue Manager Name
Specify the name of the queue manager to connect for messaging.
Example as MQD
Channel Name
Specify the Channel Name in IBM MQ.
Example as CLOUD.APP.SVRCONN
Application Name
Specify the Application Name for the connection.
Example as MainApplication
Transport/Network Protocol
Select the type of protocol as TCP/IP.
Character Set ID (CCSID) for Non-ASCII Names
Specify the Character Set ID (CCSID) for Non-ASCII Names for the JMS connection.
Example: 819
Execute Write Message Using the IBM MQ JMS Receiver Adapter
Go to the Processing tab, select the Message Destination Type as Queue, and specify the Queue Name where the message will be sent on the IBM MQ server.
Select the Target Client as JMS-Compliant and enable the Transactional JMS Session to ensure data consistency.
Processing Tab:
Parameter
Description
Message Destination Type
Select the Message Destination Type as Queue
Queue Name
(only available when Message Destination Type is set to Queue)
Specify the name of the queue to write.
Example as DemoQueue1
Target Client
Select the target client type as JMS-Compliant: JMS message properties and headers will be accessible.
Transactional JMS Session
Enable the checkbox to ensure data consistency.
Advanced Message Properties
Parameter
Description
Message Type
Select the Message Type as Text.
Correlation ID
Specify the correlation ID, which is a 48-character hexadecimal encoded string, representing 24 bytes as 414d5120514d4144455620202020202067d8bf5923582e02
Note
You can also specify an application-specific value, like My Custom CorelID. This sets the correlation ID of the created message.
Delivery Mode
Select the message delivery mode as Persistent.
ReplyTo Destination
Specify the destination as QMGR2.
Expiry
Specify the message expiration time as 60000 milliseconds
Priority
Specify the priority for the message. The value can range from 0-9.
Time Stamp
Specify the message timestamp as 60000 in milliseconds.
Once the adapter is deployed successfully, we can verify it in the monitoring tab. In response, we will receive the message details in the header.
In the IBM MQ Application, here we can see that employee details have been written in the mentioned Queue (DemoQueue1).
Reading Employee Data from a Queue Using the IBM MQ (JMS Subscribe) Sender Adapter
Once the data is written on the queue, now we will see how we can use the IBM MQ JMS Sender Adapter to read a message from the same queue.
Sender Adapter (JMS Subscribe)
The IBM MQ Sender adapter is designed to function as a sender adapter. In such a scenario where the adapter is used as a sender adapter, IBM MQ (Subscribe) acts as the initiator of the calls.
The adapter subscribes to a specific queue/topic, receiving messages as they are published. A subscription enables automatic receipt of messages when you subscribe to a specific message destination type.
Configure the Connection tab for IBM MQ (JMS Subscribe) Sender Adapter
**All the Connection tab details for IBM MQ Sender are the same as JMS Receiver explained above**
Read a Message using the IBM MQ JMS (Subscribe) Sender Adapter
In the IBM MQ JMS Sender Adapter, you can read a message by selecting the Message Destination Type as Queue and specifying the Queue Name from where the message will be read on the IBM MQ server.
You can also enable Transactional JMS Session for data consistency and select Failed Transactions Handling according to your scenario. Specify the Max Delivery Count and Queue Name if failed transaction handling is selected as Move Message To Another Queue.
Once the adapter is deployed successfully, we can verify it in the monitoring tab. In response, we will receive the message body.
The IBM MQ JMS adapter is a helpful tool in the SAP Integration Suite. It makes it easier to connect IBM MQ systems running in your own data centre with cloud-based systems.
It enables reliable, event-driven messaging and supports robust integration scenarios across hybrid landscapes across both cloud and on-premise setups. As companies grow and update their IT systems, this adapter helps keep everything connected and secure.
Quick Links
For information about IBM MQ adapter configuration, see SAP Help | IBM MQ Adapter.
For detailed information about the IBM MQ adapter, see IBM MQ Adapter Guide.
Note: The IBM MQ adapter is available as part of your SAP Integration Suite license.
Labels
As businesses increasingly operate across both cloud and on-premise systems, they need a reliable way for these environments to communicate seamlessly in real time. The SAP Integration Suite enables this by providing a rich set of adapters that ensure secure, scalable, and effortless connectivity between systems. In this blog, I will discuss one of the recently released IBM MQ Adapter.IBM MQ Adapter in SAP CIIBM MQ is a secure and reliable messaging solution that enables applications, systems, services, and files to communicate by exchanging messages through queues. It simplifies and accelerates the integration of applications and the sharing of business data across diverse platforms.The IBM MQ Adapter is available in both sender and receiver modes to streamline message-based workflows and comes in two variants — REST and JMS (Java Message Service).Key FeaturesThe IBM MQ Adapter (JMS variant) provides the following key features:Sender adapter facilitates automatic message delivery via JMS Subscribe variant and Supports Persistent and Non-persistent message delivery via JMS.Supports Transactional JMS Session for data consistency and Byte and Text JMS messages.Provides multiple actions for failed transaction handling: Keep the Message and Process Again or Move to Another Queue.Receiver adapter allows reliable publishing of messages to Topics and Queues.Supports multiple authentications: Basic, Client Certificate, and None.Practical Use Case Walkthrough:Here we will demonstrate how to write employee data (sending it as a message) to a queue on the IBM MQ server using IBM MQ Receiver adapter and read the message from the queue with help of the IBM MQ Sender Adapter.IBM MQ JMS Receiver Adapter: Write Employee Data to a QueueArchitecture for IBM MQ Receiver adapterWhen the IBM MQ Adapter is used as a receiver adapter, SAP Integration Suite acts as the initiator of the calls.SAP Integration Suite tenant sends the operation request to IBM MQ (this is a receiver system), IBM MQ Receiver Adapter works on the request and sends the data back using JMS protocol to the SAP Integration Suite tenant.Prepare DetailsIn the Content Modifier, you can define employee details, such as names, organization, role, and salary.EmployeeId: EMP1005
EmployeeName: Shubham
Organization: XX Industries
Role: Senior Analyst
Salary: 75000
Join Date: 2025-10-07Configure the Connection tab for IBM MQ JMS Receiver AdapterThe Connection tab includes connection and authentication settings for IBM MQ Adapter.For more information regarding the authentication, refer to the IBM MQ for SAP Integration Suite.Connection Tab:ParameterDescriptionHostnameSpecify the hostname to connect to IBM MQ.PortSpecify the port number to connect to IBM MQ.Example as 31656AuthenticationSelect the type of authentication for connecting to IBM MQ:Basic: Provides authentication using User Credentials.Client Certificate: The server authenticates the client by receiving the client’s certificate during the SSL handshake and verifying that the certificate is valid.None: Direct connection can be made without User Credentials.Credential NameSpecify the User Credential artifact that stores the username-password pair.Example as IBM_MQ_54Proxy typeSelect the proxy type as InternetSSL Cipher SuiteThe specific set of cryptographic algorithms used to establish a secure, encrypted connection (SSL/TLS) between the adapter and the IBM MQ queue manager.Example as *TLS12HIGHERQueue Manager NameSpecify the name of the queue manager to connect for messaging.Example as MQDChannel NameSpecify the Channel Name in IBM MQ.Example as CLOUD.APP.SVRCONNApplication NameSpecify the Application Name for the connection.Example as MainApplicationTransport/Network ProtocolSelect the type of protocol as TCP/IP.Character Set ID (CCSID) for Non-ASCII NamesSpecify the Character Set ID (CCSID) for Non-ASCII Names for the JMS connection.Example: 819Execute Write Message Using the IBM MQ JMS Receiver AdapterGo to the Processing tab, select the Message Destination Type as Queue, and specify the Queue Name where the message will be sent on the IBM MQ server.Select the Target Client as JMS-Compliant and enable the Transactional JMS Session to ensure data consistency.Processing Tab:ParameterDescriptionMessage Destination TypeSelect the Message Destination Type as QueueQueue Name(only available when Message Destination Type is set to Queue)Specify the name of the queue to write.Example as DemoQueue1Target ClientSelect the target client type as JMS-Compliant: JMS message properties and headers will be accessible.Transactional JMS SessionEnable the checkbox to ensure data consistency.Advanced Message PropertiesParameterDescriptionMessage TypeSelect the Message Type as Text.Correlation IDSpecify the correlation ID, which is a 48-character hexadecimal encoded string, representing 24 bytes as 414d5120514d4144455620202020202067d8bf5923582e02NoteYou can also specify an application-specific value, like My Custom CorelID. This sets the correlation ID of the created message.Delivery ModeSelect the message delivery mode as Persistent.ReplyTo DestinationSpecify the destination as QMGR2.ExpirySpecify the message expiration time as 60000 millisecondsPrioritySpecify the priority for the message. The value can range from 0-9.Time StampSpecify the message timestamp as 60000 in milliseconds.Once the adapter is deployed successfully, we can verify it in the monitoring tab. In response, we will receive the message details in the header.In the IBM MQ Application, here we can see that employee details have been written in the mentioned Queue (DemoQueue1).Reading Employee Data from a Queue Using the IBM MQ (JMS Subscribe) Sender AdapterOnce the data is written on the queue, now we will see how we can use the IBM MQ JMS Sender Adapter to read a message from the same queue.Sender Adapter (JMS Subscribe)The IBM MQ Sender adapter is designed to function as a sender adapter. In such a scenario where the adapter is used as a sender adapter, IBM MQ (Subscribe) acts as the initiator of the calls. The adapter subscribes to a specific queue/topic, receiving messages as they are published. A subscription enables automatic receipt of messages when you subscribe to a specific message destination type.Configure the Connection tab for IBM MQ (JMS Subscribe) Sender Adapter**All the Connection tab details for IBM MQ Sender are the same as JMS Receiver explained above**Read a Message using the IBM MQ JMS (Subscribe) Sender AdapterIn the IBM MQ JMS Sender Adapter, you can read a message by selecting the Message Destination Type as Queue and specifying the Queue Name from where the message will be read on the IBM MQ server.You can also enable Transactional JMS Session for data consistency and select Failed Transactions Handling according to your scenario. Specify the Max Delivery Count and Queue Name if failed transaction handling is selected as Move Message To Another Queue.Once the adapter is deployed successfully, we can verify it in the monitoring tab. In response, we will receive the message body.The IBM MQ JMS adapter is a helpful tool in the SAP Integration Suite. It makes it easier to connect IBM MQ systems running in your own data centre with cloud-based systems. It enables reliable, event-driven messaging and supports robust integration scenarios across hybrid landscapes across both cloud and on-premise setups. As companies grow and update their IT systems, this adapter helps keep everything connected and secure.Quick LinksFor information about IBM MQ adapter configuration, see SAP Help | IBM MQ Adapter. For detailed information about the IBM MQ adapter, see IBM MQ Adapter Guide.Note: The IBM MQ adapter is available as part of your SAP Integration Suite license.LabelsTechnology UpdatesIBMMQ JMS Read More Technology Blog Posts by Members articles
#SAP
#SAPTechnologyblog
