Creating get actions

Configure and verify a Get action that 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 not a mandatory field.
6. Select the appropriate connection and click Next.
7. Select Get in the Action page for the Add custom action page.
8. Click Next.
9. You can configure the following message processing fields in the Get page 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 returns an exception on failure.

   • True - Returns an exception when the connector action returns an error code. True 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. True 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. True is the default value.
   • False - Does not convert the messages read using this action to the local character set and encoding.

   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 Get 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 that is sent to the dead letter queue.
     • None - Does not include any headers along with the original payload in the message that is 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. DLH_&_MQMD is the default value.
   • Click Next.

10. You can configure fields in the Header selection page.

    Header selection

    Configure the Selection Criteria and the constant Value the Get action use. 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.
    • Click Next.

11. Specify the fields that the IBM MQ connector passes in the Message header page.

    Output MQMD Header

    Click "+" (Plus) to add Output MQMD Header properties and 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.

    Output JMS Header

    Click "+" (Plus) to add Output JMS Header properties and select the MS properties in the Output JMS Header for the Get action. The JMS property fields appear in the output signature of the Get action.

    Output user defined header

    Click "+" (Plus) to add Output user defined header properties and 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.

12. Click Next. The Summary page appears.
13. Verify details of the Get action on the Summary page.
14. Click Done. This redirects you to the flow service editor page or click Save.