IBM MQ

IBM MQ connector enables information exchange between IBM web Methods Integration and other systems by sending and receiving messages through the IBM® MQ messaging queue. This allows you to route documents or any piece of information from IBM web Methods Integration to systems that use IBM MQ messaging queue as their information interface.

IBM MQ connector consists of the following components -

  • Account - Facilitates the connection with IBM MQ server. Configuring an account is essential to run any operation through IBM MQ actions.
  • Actions - Facilitates to produce and consume messages from IBM MQ actions. Actions are based on templates that are provided by the IBM MQ connector.

    Each action represents a specific task that is run on a resource, such as using the Produce action to publish a message to a specified IBM MQ queue.

Creating a New Account

  1. Select your project.

  2. Click Connectors. You get a list of available connectors.

  3. Search for the Available connectors using the search bar.
    • Click Search.
    • Type IBM MQ.
    • Click IBM MQ connector.
  4. Specify the following details in the Account pane of the Add account page.
    • Name - Name of the account.
    • Description - Description of the account.
  5. Specify the following details in the Basic configuration section.
    • Host name - Required for remote connection. The name of the system on which the IBM MQ queue manager is installed. Alternatively, you can specify the IP address instead of the Host name in this field.
    • Queue manager name - Required for remote connection. The name of a Queue manager to which you want to connect. The Queue manager’s name is case-sensitive and must match the name as on the IBM MQ queue manager.
    • TCP/IP port - The port number where the IBM MQ queue manager listens for client requests.
    • Queue name(s) - The name of the queue from which you want to send and receive messages. You can specify more than one queue name in this field separated by a space.

      Specifying multiple queues allows the Put action to broadcast a message to every queue in the list. However, the list of queue names cannot contain the name of a model queue.. The Get, Peek, and Put With Acknowledgementactions use the first queue name in the list.

    • User id - The Id to connect to the secured queue manager.
    • Server connection channel - Required for remote connection. The name of the Server connection channel that is assigned to a connection to the server from the client.
      Note: The value for server connection channel is case-sensitive. Maximum characters - 20.
    • Password - The password for the user id to connect to the secured queue manager.
    • CCSID - Required. IBM’s Coded Character Set Identifiers (CCSID) is an alpha-numeric value that specifies the code page of the character-encoding scheme that the webMethods Integration Server is requesting to use. The CCSID specified for a remote connection is used only when connecting to the remote queue manager. For valid CCSID values, see IBM MQ server documentation..
    • Encoding - Required. The value that specifies the numeric-encoding scheme that webMethods Integration Server requests to use. The encoding that is specified for a remote connection is used only when connecting to the remote queue manager. The default is 00273 – Native.
    • Cache overridden connections - Specifies IBM MQ connector to enable or disable caching of overridden action connections at runtime. When you override the action's connection parameters at runtime, the IBM MQ connector creates a new connection with the updated parameters. The connection that is created is cached to enhance performance but might sporadically result in many open connections. To avoid large number of open connections, set the following parameters:
      • true - Enables internal caching of overridden connections. This is the default value.
      • false - Disables internal caching of overridden connections.
    • Transactional - The transaction type you want to enable that selects how the connector must handle the transaction before disconnecting.

      The following are the two types of Transactional mode -

      • COMMIT - Commits the transaction before disconnecting. This is the default value.
      • ROLLBACK - Rolls back the transaction before disconnecting.
  6. Specify the following details in the Advanced configuration section.
    • Truststore alias - The alias for the truststore file.
    • Keystore alias - The alias for the keystore file.
    • Cipher specifications - Cipher specifications that you can use with the IBM MQ queue manager are:
      • TLS_RSA_WITH_AES_128_CBC_SHA256. This is the default value.
      • TLS_RSA_WITH_AES_256_CBC_SHA256
      • RC4_MD5_US
      • TLS_RSA_WITH_3DES_EDE_CBC_SHA
      • TLS_RSA_WITH_AES_128_GCM_SHA256
      • TRIPLE_DES_SHA_US
      • RC2_MD5_EXPORT
      • TLS_RSA_WITH_AES_256_GCM_SHA384
      • RC4_MD5_EXPORT
      • DES_SHA_EXPORT.
      • TLS_RSA_WITH_RC4_128_SHA256
      • NULL_SHA
      • TLS_RSA_WITH_AES_256_CBC_SHA
      • TLS_RSA_WITH_DES_CBC_SHA
      • RC4_SHA_US
      • TLS_RSA_WITH_AES_128_CBC_SHA
      • TLS_RSA_WITH_NULL_SHA256
      • NULL_MD5
  7. Click Next.
  8. Specify the following details in the Advanced settings pane of the Add account page to configure connection pooling manually.
    Enable connection pooling - By default, the Enable connection pooling is False. Slide the toggle to True to enable manual configuration of connection pooling settings.
    • Minimum pool size - The minimum number of connection objects that remain in the connection pool at all times. When the connector creates the pool, it creates this number of connections. The default value is 1.
    • Maximum pool size - The maximum number of connection objects that can exist in the connection pool. When the connection pool has reached its maximum number of connections, the connector reuse any inactive connections in the pool or, if all connections are active, it waits for a connection to become available. The default value is 10.
    • Block timeout (ms) - The length of time in milliseconds, IBM MQ waits to obtain a connection with the IBM MQ server before it times out and returns an error. The default value is 1000.
    • Expire timeout (ms) - The length of time in milliseconds that an inactive connection can remain in the pool before it is closed and removed from the pool. For example, to specify 10 seconds, specify 10000. Enter 0 to specify no timeout. The default value is 1000.
      Note: IBM MQ connector does not violate the Minimum Connections parameter. These connections remain in the pool regardless of how long they are inactive.
  9. Click Next.
  10. Verify the connection details and test connection in the Test and review pane of the Add account page.
  11. Click Test connection to test if you could initialize the connection.
  12. Verify the account and the advanced settings configurations in the Overview section.
  13. Click Enable.
  14. Click Done. This redirects you to the predefined Connectors page that lists the connectors that are created.

Action Types

IBM MQ connector provides the following types of actions:

  • Put - Delivers a message to a specified queue.
  • Get - Retrieves and removes a message from a specified queue.
  • Peek - Retrieves a copy of a message without removing the original message from a specified queue.
  • Put With Acknowledgement - Delivers a message to a specified queue, and retrieves a corresponding response message.

Every action has an input and output signature. An input signature defines the parameters that are passed to the action at runtime and the output signature defines the results of the action.

Creating Put Action

The Put action delivers a message to a specified queue.

To configure a Put Action
  1. Go to Integrations > Flow services.
  2. Click the "+" (Plus) icon to create a new flow service.
  3. Type IBM MQ to select the IBM MQ connector.
  4. Click Add Custom Operation in the Type to choose action box.
  5. Specify a name and description for the Put action. The description is optional.
  6. Select the appropriate account in the Connect to account IBM MQ and click Next.
  7. Select Put in the Action pane of the Add custom action page.
  8. Click Next.

To configure fields in Put

You can configure the following message processing fields in the Put pane manually.
  1. Throw exception on failure - Toggle the slider to select whether the Put action throws an exception on failure.
    • True - Throws an exception when the connector action returns an error code. This is the default value.
    • False - Returns any error code or an error message to the Put action's output signature.
  2. Failover
    • Dead letter backout threshold - The number of times the Put action attempts to send the message before it is sent to the dead letter queue. For example, specify 2 to attempt to send the message twice. The default value is 1.
    • Dead letter queue name - The name of the queue that contains any messages that were unable to reach their intended destination. If this field is blank, the IBM MQ connector sends the message to the system dead letter queue(SYSTEM.DEAD.LETTER.QUEUE) for the queue manager that the Put action is connected.
    • Dead letter queue manager name - The name of the queue manager for the dead letter queue.
    • Headers to include in dead letter message - Selects which headers to include in the message sent to the dead letter queue.
      • None - Does not include any headers along with the original payload in the message sent to the dead letter queue.
      • DLH - Includes only the DLH header along with the original payload in the message sent to the dead letter queue.
      • MQMD - Includes only the MQMD header along with the original payload in the message sent to the dead letter queue.
      • DLH_&_MQMD - Includes both DLH and MQMD headers along with the original payload in the message sent to the dead letter queue. This is the default value.
  3. Click Next.
To configure fields in Message filter
  1. You can configure the Input field name and the constant Value the Put action uses, in the Message filter pane.
  2. The following are the input fields for selection :
    • AccountingToken - The maximum field length for the constant value is 32 alphanumeric single-byte characters.
    • AccountingTokenByteArray - The maximum field length for the constant value is 32 bytes.
    • ApplIdentityData - The maximum field length for the constant value is 32 alphanumeric single-byte characters.
    • ApplOriginData - The maximum field length for the constant value is 4 alphanumeric single-byte characters.
    • BackoutCount - The maximum field length for the constant value is 4 digits.
    • CodedCharSetId - The maximum field length for the constant value is 4 digits.
    • CorrelId - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • CorrelationIdByteArray - The maximum field length for the constant value is 24 bytes.
    • Encoding - The maximum field length for the constant value is 4 digits.
    • Expiry- The maximum field length for the constant value is 4 digits.
    • Feedback - The maximum field length for the constant value is 4 digits.
    • Format - The maximum field length for the constant value is 8 alphanumeric single-byte characters.
    • GroupId - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • GroupIdByteArray - The maximum field length for the constant value is 24 bytes.
    • MsgFlags - The maximum field length for the constant value is 4 digits.
    • MsgId - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • MsgIdByteArray - The maximum field length for the constant value is 24 bytes.
    • MsgType - The maximum field length for the constant value is 4 digits.
    • MsgSeqNumber - The maximum field length for the constant value is 4 digits.
    • Offset - The maximum field length for the constant value is 4 digits.
    • OriginalLength - The maximum field length for the constant value is 4 digits.
    • Persistence - The maximum field length for the constant value is 4 digits.
    • Priority- The maximum field length for the constant value is 4 digits.
    • PutApplName - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • PutApplType - The maximum field length for the constant value is 4 digits.
    • PutDate - The maximum field length for the constant value is 8 digits.
    • PutTime - The maximum field length for the constant value is 8 digits.
    • ReplytoQueueMgr - he maximum field length for the constant value is 48 alphanumeric single-byte characters.
    • ReplyToQ - The maximum field length for the constant value is 48 alphanumeric single-byte characters.
    • Report - The maximum field length for the constant value is 4 digits.
    • UserIdentifier - The maximum field length for the constant value is 12 alphanumeric single-byte characters.
  3. Click Next.

To configure fields in Message header

Specify the optional fields that IBM MQ connector passes, in the Message header pane.
  • Output MQMD Header
    • Click "+" (Plus) to add Output MQMD Header properties.

    • Select the properties in Output MQMD Header to specify which msgHeader property fields and constant values the Put action uses. The msgHeader property fields that you select appear in the output signature of the Put action.

      • AccountingToken
      • AccountingTokenByteArray
      • ApplIdentityData
      • ApplOriginData
      • BackoutCount
      • CodedCharSetId
      • CorrelId
      • CorrelationIdByteArray
      • Encoding
      • Expiry
      • Feedback
      • Format
      • GroupId
      • GroupIdByteArray
      • MsgFlags
      • MsgId
      • MsgIdByteArray
      • MsgType
      • MsgSeqNumber
      • Offset
      • OriginalLength
      • Persistence
      • Priority
      • PutApplName
      • PutApplType
      • PutDate
      • PutTime
      • ReplytoQueueMgr
      • ReplyToQ
      • Report
      • UserIdentifier
  • Output JMS Header
    • Click "+" (Plus) to add Output JMS Header properties.
    • Select the optional JMS properties in the Output JMS Header for the Put action. The JMS property fields appear in the input signature of the Put action.
      • JMSDestination
      • JMSExpiration
      • JMSPriority
      • JMSDeliveryMode
      • JMSCorrelationID
      • JMSCorrelationIDByteArray
      • JMSReplyTo
      • JMSType
      • JMSMessageID
      • JMSTimestamp
      • JMSRedelivered
      • JMSXGroupID
      • JMSXGroupIdByteArray
      • JMSXGroupSeq
      • JMSXUserID
      • JMSXAppID
      • JMSXDeliveryCount
      • MCDMessageDomain
      • MCDMessageSet
      • MCDMessageFormat
  • Output user defined header
    • Click "+" (Plus) to add Output user defined header properties.
    • Specify the new folder and property. For example, "jms.usr.usr1". The "jms" and "usr" are the names of the folders and "usr1" is the name of the property. All the folders and properties you add is under JMSProperties as part of the input signature of the Put action.
  • Click Next. The Summary page appears.
To verify details on Summary
  1. Verify the summary of the Put action.
  2. Click Show Input/Output to see the signatures.
  3. The following properties appear in the output signature of the Put action.
    • overrideConnection
      • queueManagerName
      • hostName
      • port
      • channel
      • CCSID
      • encoding
      • queueName
      • dynamicQueuePrefix
    • reasonCode - A String that contains the reasonCode of the MQ Series operation.
    • conditionCode - A String that contains the conditionCode of the MQ Series operation.
    • errorMsg - A String that appears in the output signature only when the connector action fails.
  4. Click Done. This redirects you to the flow service editor page.
  5. Click Save.
To run the Put Action
  1. Click Define i/o. Create an input field.
  2. Click Done.
  3. Click View/Edit pipeline. Map the fields to put the message to the queue and save the action.
  4. Click Run. Provide the input values and run the Put action.
  5. Verify the output.

Creating Get Action

The Get action checks the queue, retrieves, and removes a message from a specified queue.

To configure a Get Action
  1. Go to Integrations > Flow services.
  2. Click the "+" (Plus) icon to create a new flow service.
  3. Type IBM MQ to select the IBM MQ connector.
  4. Click Add Custom Operation in the Type to choose action box.
  5. Specify a name and description for the Get action. The description is optional.
  6. Select the appropriate connection and click Next.
  7. Select Get in the Action pane for the Add custom action page.
  8. Click Next.

To configure fields in Get

You can configure the following message processing features on the Get pane manually.
    • Wait interval (msec) - The time period in milliseconds that the Get action waits for a message to appear on the queue. The default value is 60000.
    • Throw exception on failure - Toggle the slider to select whether the Get action throws an exception on failure.
      • True - Throws an exception when the connector action returns an error code. This is the default value.
      • False - Returns any error code or an error message to the Get action's output signature.
    • Open queue in shared mode - Toggle the slider to select how the queue is opened.
      • True - In shared mode, allows simultaneous access to the queue by other applications. This is the default value.
      • False - In exclusive mode, prevents simultaneous access to the queue by other applications.
    • Convert application data - Toggle the slider to enable or disable to select whether the Get action converts the message to the local character set and encoding.
      • True - Converts the messages read using this action to the local character set and encoding. This is the default value.
      • False - Does not convert the messages read using this action to the local character set and encoding.
  2. Failover
    • Dead letter backout threshold - The number of times the Get action attempts to send the message before it is sent to the dead letter queue. For example, specify 2 to attempt to send the message twice. The default value is 1.
    • Dead letter queue name - The name of the queue that contains any messages that were unable to reach their intended destination. If this field is blank, the IBM MQ connector sends the message to the system dead letter queue(SYSTEM.DEAD.LETTER.QUEUE) for the queue manager that the action is connected.
    • Dead letter queue manager name - The name of the queue manager for the dead letter queue.
    • Headers to include in dead letter message - Selects which headers to include in the message sent to the dead letter queue.
      • None - Does not include any headers along with the original payload in the message sent to the dead letter queue.
      • DLH - Includes only the DLH header along with the original payload in the message sent to the dead letter queue.
      • MQMD - Includes only the MQMD header along with the original payload in the message sent to the dead letter queue.
      • DLH_&_MQMD - Includes both DLH and MQMD headers along with the original payload in the message sent to the dead letter queue. This is the default value.
  3. Click Next.

To configure fields in Message filter

You can configure the input field and the constant value that the Get action uses in the Message filter pane.
  1. The following are the input fields for selection:
    • CorrelId - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • CorrelationByteArray - The maximum field length for the constant value is 24 bytes.
    • GroupId - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • GroupIdByteArray - The maximum field length for the constant value is 24 bytes.
    • MsgId - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • MsgIdByteArray - The maximum field length for the constant value is 24 bytes.
    • MsgSeqNumber - The maximum field length for the constant value is 4 bytes.
    • Offset - The maximum field length for the constant value is 4 bytes.
  2. Click Next.

To configure fields in Message header

Specify the optional fields that IBM MQ connector passes, in the Message header pane.
  • Output MQMD Header
    • Click "+" (Plus) to add Output MQMD Header properties.

    • Select the properties in Output MQMD Header to specify which msgHeader property fields and constant values the Get action uses. The msgHeader property fields that you select appear in the output signature of the Get action.

      • AccountingToken
      • AccountingTokenByteArray
      • ApplIdentityData
      • ApplOriginData
      • BackoutCount
      • CodedCharSetId
      • CorrelId
      • CorrelationIdByteArray
      • Encoding
      • Expiry
      • Feedback
      • Format
      • GroupId
      • GroupIdByteArray
      • MsgFlags
      • MsgId
      • MsgIdByteArray
      • MsgType
      • MsgSeqNumber
      • Offset
      • OriginalLength
      • Persistence
      • Priority
      • PutApplName
      • PutApplType
      • PutDate
      • PutTime
      • ReplytoQueueMgr
      • ReplyToQ
      • Report
      • UserIdentifier
  • Output JMS Header
    • Click "+" (Plus) to add Output JMS Header properties.
    • Select the optional JMS properties in the Output JMS Header for the Put action. The JMS property fields appear in the output signature of the Get action.
      • JMSDestination
      • JMSExpiration
      • JMSPriority
      • JMSDeliveryMode
      • JMSCorrelationID
      • JMSCorrelationIDByteArray
      • JMSReplyTo
      • JMSType
      • JMSMessageID
      • JMSTimestamp
      • JMSRedelivered
      • JMSXGroupID
      • JMSXGroupIdByteArray
      • JMSXGroupSeq
      • JMSXUserID
      • JMSXAppID
      • JMSXDeliveryCount
      • MCDMessageDomain
      • MCDMessageSet
      • MCDMessageFormat
  • Output user defined header
    • Click "+" (Plus) to add Output user defined header properties.
    • Specify the new folder and property. For example, "jms.usr.usr1". The "jms" and "usr" are the names of the folders and "usr1" is the name of the property. All the folders and properties you add is under JMSProperties as part of the output signature of the Get action.
  • Click Next. The Summary page appears.
To verify details in Summary
  1. Verify the summary of the Get action.
  2. Click Show Input/Output to see the signatures.
  3. The following properties appear in the output signature of the Get action.
    • overrideConnection
      • queueManagerName
      • hostName
      • port
      • channel
      • CCSID
      • encoding
      • queueName
      • dynamicQueuePrefix
    • msgBody- The contents of the payload.
    • msgBodyByteArray - The contents of the payload in a byte array
    • reasonCode - A String that contains the reasonCode of the IBM MQ Series operation.
    • conditionCode- A String that contains the conditionCode of the IBM MQ Series operation.
    • errorMsg- A String that appears in the output signature only when the connector action fails.

  4. Click Done. This redirects you to the flow service editor page.

  5. Click Save.

To run a Get Action
  1. Click Run. Provide the input values and run the Get action.
  2. Verify the output.

Creating Peek Action

The Peek action retrieves a copy of a message without removing the original message from a specified queue.

To configure a Peek Action

  1. Go to Integrations > Flow services.
  2. Click the "+" (Plus) icon to create a new flow service.
  3. Type IBM MQ to select the IBM MQ connector.
  4. Click Add Custom Operation in the Type to choose action box.
  5. Specify a name and description for the Peek action. The description is optional.
  6. Select the appropriate connection and click Next.
  7. Select Peek in the Action pane for the Add custom action page.
  8. Click Next.

To configure fields in Peek

You can configure the following message processing features on the Peek pane manually.
    • Wait interval (msec) - The time period in milliseconds that the Peek action waits for a message to appear on the queue. The default value is 60000.
    • Throw exception on failure - Toggle the slider to select whether the Peek action throws an exception on failure.
      • True - Throws an exception when the connector action returns an error code. This is the default value.
      • False - Returns any error code or an error message to the Peek action's output signature.
    • Convert application data - Toggle the slider to enable or disable to select whether the Peek action converts the message to the local character set and encoding.
      • True - Converts the messages read using this action to the local character set and encoding. This is the default value.
      • False - Does not convert the messages read using this action to the local character set and encoding.
  2. Failover
    • Reset cursor before operation : When set to:
      • yes : The Peek action starts at the beginning of the queue and gets a copy of the first message. This is the default value.
      • no : The Peek action retrieves a copy of the next message in the queue relative to the last message that the Peek action retrieved.
  3. Click Next.
To configure fields in Message filter
  1. You can configure the input field and the constant value that the Peek action uses, in the Message filter pane. The following are the input fields for selection -
    • CorrelId - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • CorrelationByteArray - The maximum field length for the constant value is 24 bytes.
    • GroupId - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • GroupIdByteArray - The maximum field length for the constant value is 24 bytes.
    • MsgId - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • MsgIdByteArray - The maximum field length for the constant value is 24 bytes.
    • MsgSeqNumber - The maximum field length for the constant value is 4 bytes.
    • Offset - The maximum field length for the constant value is 4 bytes.
  2. Click Next.

To configure fields in Message header

Specify the optional fields that IBM MQ connector passes, in the Message header pane.
  • Output MQMD Header
    • Click "+" (Plus) to add Output MQMD Header properties.

    • Select the properties in Output MQMD Header to specify which msgHeader property fields and constant values the Put action uses. The msgHeader property fields that you select appear in the output signature of the Peek action.

      • AccountingToken
      • AccountingTokenByteArray
      • ApplIdentityData
      • ApplOriginData
      • BackoutCount
      • CodedCharSetId
      • CorrelId
      • CorrelationIdByteArray
      • Encoding
      • Expiry
      • Feedback
      • Format
      • GroupId
      • GroupIdByteArray
      • MsgFlags
      • MsgId
      • MsgIdByteArray
      • MsgType
      • MsgSeqNumber
      • Offset
      • OriginalLength
      • Persistence
      • Priority
      • PutApplName
      • PutApplType
      • PutDate
      • PutTime
      • ReplytoQueueMgr
      • ReplyToQ
      • Report
      • UserIdentifier
  • Output JMS Header
    • Click "+" (Plus) to add Output JMS Header properties.
    • Select the optional JMS properties in the Output JMS Header for the Put action. The JMS property fields appear in the output signature for the Peek action.
      • JMSDestination
      • JMSExpiration
      • JMSPriority
      • JMSDeliveryMode
      • JMSCorrelationID
      • JMSCorrelationIDByteArray
      • JMSReplyTo
      • JMSType
      • JMSMessageID
      • JMSTimestamp
      • JMSRedelivered
      • JMSXGroupID
      • JMSXGroupIdByteArray
      • JMSXGroupSeq
      • JMSXUserID
      • JMSXAppID
      • JMSXDeliveryCount
      • MCDMessageDomain
      • MCDMessageSet
      • MCDMessageFormat
  • Output user defined header
    • Click "+" (Plus) to add Output user defined header properties.
    • Specify the new folder and property. For example, "jms.usr.usr1". The "jms" and "usr" are the names of the folders and "usr1" is the name of the property. All the folders and properties you add is under JMSProperties as part of the output signature of the Peek action.
  • Click Next. The Summary page appears.
To verify details in Summary
  1. Verify the summary of the Peek action.
  2. Click Show Input/Output to see the signatures.
  3. The following properties appear in the output signature of the Peek action.
    • overrideConnection
      • queueManagerName
      • hostName
      • port
      • channel
      • CCSID
      • encoding
      • queueName
      • dynamicQueuePrefix
    • msgBody: The contents of the payload.
    • msgBodyByteArray: The contents of the payload in a byte array.
    • reasonCode: A String that contains the reasonCode of the MQ Series operation.
    • conditionCode: A String that contains the conditionCode of the MQ Series operation.
    • errorMsg: A String that appears in the output signature only when the connector action fails.
  4. Click Done. This redirects to the flow service editor page.
  5. Click Save.
To run a Peek Action
  1. Click Run. Provide the input values and run the Peek action.
  2. Verify the output.

Creating Put With Acknowledgement Action

The Put with acknowledgement action delivers a message to a specified queue, and retrieves a corresponding response message.

To configure a Put With Acknowledgement action

  1. Go to Integrations > Flow services.
  2. Click the "+" (Plus) icon to create a new flow service.
  3. Type IBM MQ to select the IBM MQ connector.
  4. Click Add Custom Operation in the Type to choose action box.
  5. Specify a name and description for the Put With Acknowledgement action. The description is optional.
  6. Select the appropriate connection and click Next.
  7. Select Put With Acknowledgement in the Action pane for the Add custom action page.
  8. Click Next.

To configure fields in Put With Acknowledgement

You can configure the following message processing features on the Put with acknowledgement pane manually.
    • Wait interval (msec) - The time period in milliseconds that the Put With acknowledgement action waits for a message to appear on the queue. The default value is 60000.
    • Throw exception on failure - Toggle the slider to select whether the Put With acknowledgement action throws an exception on failure.
      • True - Throws an exception when the connector action returns an error code. This is the default value.
      • False - Returns any error code or an error message to the Put With acknowledgement action's output signature.
    • Open queue in shared mode - Toggle the slider to select how the queue is opened.
      • True - In shared mode, allows simultaneous access to the queue by other applications. This is the default value.
      • False - In exclusive mode, prevents simultaneous access to the queue by other applications.
    • Convert application data - Toggle the slider to enable or disable to select whether the Put With acknowledgement action converts the message to the local character set and encoding.
      • True - Converts the messages read using this action to the local character set and encoding. This is the default value.
      • False - Does not convert the messages read using this action to the local character set and encoding.
  2. Failover
    • Dead letter backout threshold - The number of times the Put With Acknowledgement action attempts to send the message before it is sent to the dead letter queue. For example, specify 2 to attempt to send the message twice. The default value is 1.
    • Dead letter queue name - The name of the queue that contains any messages that were unable to reach their intended destination. If this field is blank, the IBM MQ connector sends the message to the system dead letter queue(SYSTEM.DEAD.LETTER.QUEUE) for the queue manager that the action is connected.
    • Dead letter queue manager name - The name of the queue manager for the dead letter queue.
    • Headers to include in dead letter message - Selects which headers to include in the message sent to the dead letter queue.
      • None - Does not include any headers along with the original payload in the message sent to the dead letter queue.
      • DLH - Includes only the DLH header along with the original payload in the message sent to the dead letter queue.
      • MQMD - Includes only the MQMD header along with the original payload in the message sent to the dead letter queue.
      • DLH_&_MQMD - Includes both DLH and MQMD headers along with the original payload in the message sent to the dead letter queue. This is the default value.
  3. Click Next.
To configure fields in Message filter
  1. You can configure the Input field name and the constant Value the Put With acknowledgement action uses, in the Message filter pane.
  2. The following are the input fields for selection :
    • AccountingToken - The maximum field length for the constant value is 32 alphanumeric single-byte characters.
    • AccountingTokenByteArray - The maximum field length for the constant value is 32 bytes.
    • ApplIdentityData - The maximum field length for the constant value is 32 alphanumeric single-byte characters.
    • ApplOriginData - The maximum field length for the constant value is 4 alphanumeric single-byte characters.
    • BackoutCount - The maximum field length for the constant value is 4 digits.
    • CodedCharSetId - The maximum field length for the constant value is 4 digits.
    • CorrelId - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • CorrelationIdByteArray - The maximum field length for the constant value is 24 bytes.
    • Encoding - The maximum field length for the constant value is 4 digits.
    • Expiry- The maximum field length for the constant value is 4 digits.
    • Feedback - The maximum field length for the constant value is 4 digits.
    • Format - The maximum field length for the constant value is 8 alphanumeric single-byte characters.
    • GroupId - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • GroupIdByteArray - The maximum field length for the constant value is 24 bytes.
    • MsgFlags - The maximum field length for the constant value is 4 digits.
    • MsgId - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • MsgIdByteArray - The maximum field length for the constant value is 24 bytes.
    • MsgType - The maximum field length for the constant value is 4 digits.
    • MsgSeqNumber - The maximum field length for the constant value is 4 digits.
    • Offset - The maximum field length for the constant value is 4 digits.
    • OriginalLength - The maximum field length for the constant value is 4 digits.
    • Persistence - The maximum field length for the constant value is 4 digits.
    • Priority- The maximum field length for the constant value is 4 digits.
    • PutApplName - The maximum field length for the constant value is 24 alphanumeric single-byte characters.
    • PutApplType - The maximum field length for the constant value is 4 digits.
    • PutDate - The maximum field length for the constant value is 8 digits.
    • PutTime - The maximum field length for the constant value is 8 digits.
    • ReplytoQueueMgr - he maximum field length for the constant value is 48 alphanumeric single-byte characters.
    • ReplyToQ - The maximum field length for the constant value is 48 alphanumeric single-byte characters.
    • Report - The maximum field length for the constant value is 4 digits.
    • UserIdentifier - The maximum field length for the constant value is 12 alphanumeric single-byte characters.
  3. Click Next.

To configure fields in Message header

Specify the optional fields that IBM MQ connector passes, in the Message header pane.
  • Output MQMD Header
    • Click "+" (Plus) to add Output MQMD Header properties.

    • Select the properties in Output MQMD Header to specify which msgHeader property fields and constant values the Put action uses. The msgHeader property fields that you select appear in the output signature of the Put With Acknowledgement action.

      • AccountingToken
      • AccountingTokenByteArray
      • ApplIdentityData
      • ApplOriginData
      • BackoutCount
      • CodedCharSetId
      • CorrelId
      • CorrelationIdByteArray
      • Encoding
      • Expiry
      • Feedback
      • Format
      • GroupId
      • GroupIdByteArray
      • MsgFlags
      • MsgId
      • MsgIdByteArray
      • MsgType
      • MsgSeqNumber
      • Offset
      • OriginalLength
      • Persistence
      • Priority
      • PutApplName
      • PutApplType
      • PutDate
      • PutTime
      • ReplytoQueueMgr
      • ReplyToQ
      • Report
      • UserIdentifier
  • Output JMS Header
    • Click "+" (Plus) to add Output JMS Header properties.
    • Select the optional JMS properties in the Output JMS Header for the Put With acknowledgement action. The JMS property fields appear in the output signature of the Put With Acknowledgement action.
      • JMSDestination
      • JMSExpiration
      • JMSPriority
      • JMSDeliveryMode
      • JMSCorrelationID
      • JMSCorrelationIDByteArray
      • JMSReplyTo
      • JMSType
      • JMSMessageID
      • JMSTimestamp
      • JMSRedelivered
      • JMSXGroupID
      • JMSXGroupIdByteArray
      • JMSXGroupSeq
      • JMSXUserID
      • JMSXAppID
      • JMSXDeliveryCount
      • MCDMessageDomain
      • MCDMessageSet
      • MCDMessageFormat
  • Output user defined header
    • Click "+" (Plus) to add Output user defined header properties.
    • Specify the new folder and property. For example, "jms.usr.usr1". The "jms" and "usr" are the names of the folders and "usr1" is the name of the property. All the folders and properties you add is under JMSProperties as part of the output signature of the Put With Acknowledgement action.
  • Click Next. The Summary page appears.
To verify details in Summary
  1. Verify the summary of the Put With Acknowledgement action.
  2. Click Show Input/Output to see the signatures.
  3. The following properties automatically appear in the output signature of the Put With Acknowledgement action.
    • overrideConnection
      • queueManagerName
      • hostName
      • port
      • channel
      • CCSID
      • encoding
      • queueName
      • dynamicQueuePrefix
    • overrideReplyToConnection
      • queueManagerName
      • hostName
      • port
      • channel
      • CCSID
      • encoding
      • queueName
      • dynamicQueuePrefix
    • msgBody: The contents of the payload.
    • msgBodyByteArray: The contents of the payload in a byte array.
    • reasonCode: A String that contains the reasonCode of the MQ Series operation.
    • conditionCode: A String that contains the conditionCode of the MQ Series operation.
    • errorMsg: A String that appears in the output signature only when the connector action fails.
  4. Click Done. This redirects to the flow service editor page.
  5. Click Save.

To run the Put With Acknowledgement Action

  1. Click Define i/o. Create an input field.
  2. Click Done.
  3. Click View/Edit pipeline. Map the input field.
  4. Click Run. Provide the queue that retrieves the corresponding message in the input value and run the action.
  5. Verify the output.
Note: In any of the actions you can override the property fields at run time using the flow editor. However, you cannot modify certain output only properties, such as PutDate and PutTime.

Limitations

IBM MQ connector is not supported in Workflows - The IBM MQ connector is not supported in workflows, even though it appears in the connector list. Currently, IBM MQ connector is supported only in flow services.

Transactional Connection not supported - The Peek and Put With Acknowledgement actions does not support Transactional connection.