IBM Cloud for SAP

Cloud for SAP Community

Join us to learn more about deploying SAP landscape on IBM Cloud from this community of collaborative experts and IBM Cloud product users.

 View Only

IBM MQ JMS Adapter for SAP Integration Suite

  • 1.  IBM MQ JMS Adapter for SAP Integration Suite

    Posted Thu May 08, 2025 09:50 AM

    What is IBM MQ ?

    IBM MQ allows you to manage and optimize enterprise architecture. Enterprise architecture management is the practice of aligning IT infrastructure and systems with business strategy and goals. It involves documenting the organization's IT landscape, planning, designing, and overseeing the implementation of architectural changes to meet changing business requirements.

    Key Features

    The IBM MQ Adapter (JMS variant)  provides the following key features:

    • Sender adapter supports synchronous message read via JMS Poll Variant.
    • Supports Transactional JMS Session for data consistency.
    • 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 Persistent and Non Persistent message delivery via JMS.
    • Supports Byte and Text JMS messages.

    Using IBM MQ JMS Receiver Adapter to Write Employee Data to a Queue

    In IBM MQ JMS Receiver Adapter, we can write employee data ( send as a message) to a queue in the IBM MQ server. The adapter ensures secure and reliable communication.

    Prepare Details in Content Modifier

    In SAP Cloud Integration, you can populate necessary details or message in Message Body of Content modifier.

    Configure Connection tab for IBM MQ JMS Receiver Adapter ?

    In IBM MQ JMS Receiver Adapter, you must configure fields like Hostname and Port for specifying the IBM MQ server's address and the communication port. You can also select Authentication as Basic from the dropdown, enter the Credential Name for identifier associated with the user credentials (Username and Password) and specify Channel Name that facilitates the connection between the client application and the queue manager.

    Specify the Queue Manager Name used to manage and coordinate queues in the IBM MQ server. Enter Cipher Suite Name for secure data transmission. The Application Name helps track the specific application during message transactions.

    You can also select Transport/Network Protocol as TCP/IP and specify the Character Set ID (CCSID) for defining how character data is encoded.

    Parameter

    Description

    Hostname

    Specify as mqd-b57b.qm.eu-de.mq.appdomain.cloud

    Port

    Specify the port number as 31636

    Authentication

    Select Authentication as Basic.

    Credential Name

    Specify as IBM_MQ_54

    Channel Name

    Specify as CLOUD.ADMIN.SVRCOS

    Queue Manager Name

    Specify as QMGR

    Cipher Suite Name

    Specify as *TLS12LOWER

    Application Name

    Specify as MainApplication

    Transport/Network Protocol

    Select as TCP/IP

    Character Set ID (CCSID) for Non-ASCII Names

    Specify as 819

    Execute Write 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 and enable the Transactional JMS Session.

                

    Parameter

    Values

    Message Destination Type

    Select as Queue.

    Queue Name

    Specify as EmployeeData

    Target Client

    Select as JMS-Compliant

    Transactional JMS Session

    Enable the transactional JMS session.

     

    Set Advanced for JMS Message Properties

    In the Advanced tab, you have the option the Message Type as Text or Byte, we will select Text here. Specify a Correlation ID to uniquely identify and link related messages within the messaging system. You can also set the Delivery Mode to Persistent to ensure message reliability.

    Next, define the ReplyTo Destination to specify where responses should be routed, set the Expiry time (in milliseconds) to control message validity, assign a Priority level to influence processing order, and include a Timestamp (in milliseconds).

    Additionally, you can also define custom JMS Message Properties to the message.

     

    Reading Messages from a Queue Using the IBM MQ JMS Sender Adapter

    Our example illustrates how the IBM MQ JMS Sender Adapter allows querying to read a message.

    Configure the Connection tab for IBM MQ JMS Sender Adapter

    The connection details for this configuration are the same as those used in the IBM MQ JMS Receiver adapter.

    Additionally, here you need to specify the Polling Interval (in milliseconds) which determines how frequently the system polls messages from IBM MQ server. You should also set the Message Receive Wait Time which defines how long the system waits to receive messages. To ensure visibility of failed error messages in the messages processing logs, enable the Process Errors as an Event option.

    Parameter

    Description

    Hostname

    Specify as mqd-b57b.qm.eu-de.mq.appdomain.cloud

    Port

    Specify the port number as 31849

    Authentication

    Select Authentication as Basic.

    Credential Name

    Specify as IBM_MQ_54

    Channel Name

    Specify as CLOUD.ADMIN.SVRCOS

    Queue Manager Name

    Specify as QMGR

    Cipher Suite Name

    Specify as *TLS12LOWER

    Application Name

    Specify as MainApplication

    Transport/Network Protocol

    Select as TCP/IP

    Character Set ID (CCSID) for Non-ASCII Names

    Specify as 819

    Polling Interval

    Specify as 60000

    Message Receive Wait Time

    Specify as 100

    Process Errors as an Event

    Enable to utilize Process Errors as an Event

    Read a Message using IBM MQ JMS 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.

    Select Target Client as JMS-Complaint and enable Transactional JMS Handling to ensure data consistency and reliability. Set Failed Transaction Handling to Move Message To Another Queue to forward undeliverable messages to a designated queue.

    You can set the Max Delivery Count to specify the number of attempts  to be made before marking a message as failed. Provide the Queue Name, such as QueueData, where failed messages will be stored. Additionally, configure the Message Selector to filter messages based on specific criteria.

    Quick Links

    For detailed information about IBM MQ adapter configuration, see IBM MQ Adapter Guide

    For detailed information about IBM MQ adapter, see IBM MQ Adapter for SAP Integration Suite.

    Note: The IBM MQ adapter is available as part of your SAP Integration Suite license.



    ------------------------------
    Max van Dam
    ------------------------------