Creating put actions
Configure and verify a Put action that is used to deliver a message to a specified queue.
About this task
The Put action delivers a message to a specified queue.
Procedure
To configure a Put action
- Go to Integrations > Flow services.
- Click the "+" (Plus) icon to create a new flow service.
- Type IBM MQ to select the IBM® MQ connector.
- Click Add Custom Operation in the Type to choose action box.
- Specify a name and description for the Put action. The description for the filed is not mandatory.
- Select the appropriate account in the Connect to account IBM MQ and click Next.
- Select Put in the Action page of the Add custom action page.
- Click Next.
- You can configure the message processing fields in the Put page
manually.
- Throw exception on failure
- Toggle the slider to select whether the Put 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 Put action's output signature.
- 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 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. This is the default value.
- Click Next.
- You can configure fields in the Header selection page.
- Header selection
- Configure the Input field name and the constant
Value the Put action uses, in the Header
selection page. 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- The 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.
- Click Next.
- 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 Put action uses. The msgHeader property fields that you select appear in the output signature of the Put action are the following.
- Output JMS Header
- Click "+" (Plus) to add Output JMS Header properties and select the MS properties in the Output JMS Header for the Put action. The JMS property fields appear in the input signature of the Put action. The following are the fields.
- 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 input signature of the Put action.
- Click Next. The Summary page is displayed.
- Verify details of the Put action on the Summary page.
- Click Done. It redirects you to the flow service editor page or click Save.
What to do next
- Click Define i/o. Create an input field.
- Click Done.
- Click View/Edit pipeline. Map the fields to put the message to the queue and save the action.
- Click Run. Provide the input values and run the Put action.
- Verify the output.