IBM MQ Connector Reference | MuleSoft Documentation
# IBM MQ Connector Reference
IBM MQ Connector v1.7
Provides the main class of this connector, which is the entry point where configurations, connection providers, operations, and sources are declared.
Release Notes: IBM MQ Connector Release Notes
## Configurations
### Config
Default configuration.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The name for this configuration. Connectors reference the configuration with this name.  
Connection | The connection types to provide to this configuration.  
Encoding | The default encoding of the message body if the message doesn’t communicate it.  
Content Type | The default content type of the message body is the message doesn’t communicate it.  
Send Correlation Id |  Enumeration, one of:
  * ALWAYS
  * NEVER

|  Whether to specify a `correlationId` when publishing messages. This applies both for custom correlation IDs specified at the operation level and for default correlation IDs taken from the current event.  
Expiration Policy |  Expiration Policy | Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers it eligible for expiration. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. The runtime purges the instances when it sees fit.  
Ack Mode |  Enumeration, one of:
  * IMMEDIATE
  * MANUAL
  * DUPS_OK

| The Session ACK mode to use when consuming a message.  
Consumer Type |  One of:
  *   * queue-consumer

  
Selector | Default JMS selector to use for filtering incoming messages.  
Persistent Delivery |  If true, the message is sent using the PERSISTENT `JMSDeliveryMode`.  
Priority |  The default `JMSPriority` value to use when sending the message.  
Time To Live | Defines the default time the message is in the broker before it expires and is discarded.  
Time To Live Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the timeToLive configurations. | `MILLISECONDS`  
Disable Message Id | If true, the Message is flagged to avoid generating its MessageID.  
Disable Message Timestamp | If true, the Message is flagged to avoid generating its sent Timestamp.  
Delivery Delay | Only used by JMS 2.0: Sets the delivery delay to be applied to postpone the Message delivery.  
Delivery Delay Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Only used by JMS 2.0: Time unit to use in the deliveryDelay configurations. | `MILLISECONDS`  
Jms Type | The message type identifier to be set in the JMSType Header when a message is sent.  
#### Connection Types
##### Connection
###### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Connection Mode |  One of:

  
Username | Username to use to connect to the IBM MQ Server.  
Password | Password of the used username.  
Client ID | ID of the JMS Client used to identify the current client.  
Number to use when connecting to the queue manager. The default value (819) is suitable in most situations.  
Additional Properties | Additional properties to configure the IBM MQ client.  
Caching Strategy |  One of:
  * Default Caching
  * no-caching

| The strategy to use for caching of sessions and connections.  
Enable XA Transactions | Supports creating and joining XA transactions which enables the connector to participate in a transaction with multiple resources. Note that IBM MQ Connector does not support nested XA transactions due to IBM MQ driver limitations.  
Specification |  Enumeration, one of:
  * JMS_2_0
  * JMS_1_1

| Version of the JMS specification for the JMS Client.  
Target Client |  Enumeration, one of:
  * JMS_COMPLIANT
  * NO_JMS_COMPLIANT

|  Describes the way to create the IBM MQ JMS Client. When using `JMS_COMPLIANT`, indicates that the RFH2 format is used to send information. The RFH2 header carries JMS-specific data that is associated with the message content. When not using `JMS_COMPLIANT`, features like User Properties and Media Type propagation stop working. | `JMS_COMPLIANT`  
Application Name | Application name to be registered in the connection factory. By default this is the application name. Max 27 characters are allowed.  
Read Message Descriptor (MD) |  Enumeration, one of:
  * ENABLED
  * DISABLED

| Indicates if this is enabled to read the message descriptor properties.  
Write Message Descriptor (MD) |  Enumeration, one of:
  * ENABLED
  * DISABLED

| Indicates if this is enabled to write the message descriptor properties.  
Message Context |  Enumeration, one of:
  * DEFAULT
  * SET_ALL_CONTEXT
  * SET_IDENTITY_CONTEXT

|  Indicates the message context to configure message options.
  * DEFAULT: No options can be set.
  * SET_ALL_CONTEXT: All options can be set.
  * SET_IDENTITY_CONTEXT: Only Identity options can be set.

  
Temporary Model | The name of the IBM MQ model queue that refers to a model queue that can be used to create a permanent dynamic queue.  
Temporal Queue Prefix | The prefix to use when creating temporary queue names. The last non-blank character must be an asterisk (`*`).  
Temporal Topic Prefix | The prefix to use when creating temporary topic names. The last non-blank character must be an asterisk (`*`).  
Receive Exit Handler | The receive exit handler class. When writing exits for use with IBM MQ Java, each object must also have a constructor that takes a single string argument. When IBM MQ creates an instance of the exit, it passes any initialization data into the exit using this constructor.  
Receive Exit Handler Init | Initialization string for the receive exit.  
Send Exit Handler | The send exit handler class. When writing exits for use with IBM MQ Java, each object must also have a constructor that takes a single string argument. When IBM MQ creates an instance of the exit, it passes any initialization data into the exit using this constructor.  
Send Exit Handler Init | Initialization string for the send exit.  
Security Exit Handler | The security exit handler class. When writing exits for use with IBM MQ Java, each object must also have a constructor that takes a single string argument. When IBM MQ creates an instance of the exit, it passes any initialization data into the exit using this constructor.  
Security Exit Handler Init | Initialization string for the security exit.  
Min Pool Size | The minimum size of the XA connection pool.  
Max Pool Size | The maximum size of the XA connection pool.  
Max Idle Seconds | The number of seconds an XA transaction can remain idle before it’s eligible for eviction.  
IBM MQ CipherSpec Mapping |  Enumeration, one of:
  * ORACLE_CIPHER_SUITES
  * IBM_CIPHER_SUITES

| Defines which CipherSuite mapping to use: Oracle JDK or IBM JDK. Configure this parameter depending on the host JDK. For more information, see SSL/TLS CipherSpecs and CipherSuites. | `ORACLE_CIPHER_SUITES`  
IBM Cipher Suite | CipherSuite to use to connect to the IBM MQ Server.  
Reset Count | This property represents the total number of bytes sent and received by a connection before the secret key that is used for encryption is renegotiated. Integer value between 0 (disabled) and 999999999.  
Peer Name | Specifies a distinguished name pattern, to ensure that your JMS application connects to the correct queue manager.  
FIPS Required | Enable it if is required a connection to use a CipherSuite that is supported by the IBM Java JSSE FIPS provider (IBMJSSEFIPS).  
Cert Stores | Specifies a list of LDAP servers to use for certificate revocation list (CRL) checking.  
Reconnection |  | When the application is deployed, a connectivity test is performed on all connectors. If set to `true`, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
You can also configure Client Channel Definition Tables (CCDT) connection by going to the **Advanced** tab and adding the `XMSC_WMQ_CCDTURL` and `XMSC_WMQ_QUEUE_MANAGER` properties in the **Additional properties** section. If you use the `XMSC_WMQ_CCDTURL` property, ensure **Connection mode** is set to `Client` in the **General** tab.   
---  
## Operations
  * Publish Consume


## Sources
  * On New Message


### Consume
`<ibm-mq:consume>`
Allows a user to consume a single message from a given destination.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Destination | The name of the destination from where the message should be consumed.  
Consumer Type |  One of:
  *   * queue-consumer

| The type of the MessageConsumer that is required for the given destination, along with any extra configurations that are required based on the destination type.  
Ack Mode |  Enumeration, one of:
  * IMMEDIATE
  * MANUAL
## Sources
  * On New Message


### Consume
`<ibm-mq:consume>`
Allows a user to consume a single message from a given destination.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Destination | The name of the destination from where the message should be consumed.  
Consumer Type |  One of:
  *   * queue-consumer

| The type of the MessageConsumer that is required for the given destination, along with any extra configurations that are required based on the destination type.  
Ack Mode |  Enumeration, one of:
  * IMMEDIATE
  * MANUAL

| The ConsumerAckMode to configure over the message and session.  
Selector | A custom JMS selector for filtering the messages.  
Maximum Wait | Maximum time to wait for a message before timing out.  
Maximum Wait Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the maximumWaitTime configurations. | MILLISECONDS  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| The type of joining action that operations can take regarding transactions. | JOIN_IF_POSSIBLE  
Content Type | Sets the ContentType of the received message. If the message already have one, this one is overridden.  
Encoding | Sets the Encoding of the received message. If the message already have one, this one is overridden.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  IBM MQ Attributes  
---|---  
### For Configurations
#### Throws
  * IBM-MQ:ACK
  * IBM-MQ:CONNECTIVITY
  * IBM-MQ:CONSUMING
  * IBM-MQ:DESTINATION_NOT_FOUND
  * IBM-MQ:RETRY_EXHAUSTED
  * IBM-MQ:SECURITY
  * IBM-MQ:TIMEOUT


### Publish
`<ibm-mq:publish>`
Allows a user to send a Message to a JMS destination.
When using multiple MUnit test suites with the **Publish** operation, set the `avoid.dispose.mq.threads` system property to `true`. This property prevents the connector from cleaning up IBM MQ threads that are needed for the next test suite to run.   
---  
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Destination | The name of the Destination where the Message should be sent  
Destination Type |  Enumeration, one of:
  * QUEUE
  * TOPIC

| The MQDestinationType of the destination.  
Transactional Action |  Enumeration, one of:
  * ALWAYS_JOIN
  * JOIN_IF_POSSIBLE
  * NOT_SUPPORTED

| Transactional Action for the operation. Indicates if the publish must be executed or not in a transaction. | JOIN_IF_POSSIBLE  
Send Correlation Id |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Options on whether to include an outbound correlation ID or not.  
The body of the Message | `#[payload]`  
JMS Type | The JMSType identifier header of the Message.  
Correlation ID | The JMSCorrelationID header of the Message.  
Send Content Type | Whether or not the body content type should be sent as a property  
Content Type | The content type of the message’s body.  
Send Encoding | Whether or not the body outboundEncoding should be sent as a Message property.  
Encoding | The encoding of the message’s body.  
Reply To |  MQ JMS Destination | The destination where a reply to this Message should be sent  
User Properties | The custom user properties that should be set to this Message.  
JMSX Properties |  MQ JMSX Properties | The JMSX properties that should be set to this Message.  
Persistent Delivery | If true, the Message is sent using the PERSISTENT JMSDeliveryMode.  
Priority | The default JMSPriority value to use when sending the message.  
Time To Live | Defines the default time the message is in the broker before it expires and is discarded.  
Time To Live Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the timeToLive configurations  
Disable Message Id | If true, the Message is flagged to avoid generating its MessageID.  
Disable Message Timestamp | If true, the Message is flagged to avoid generating its sent Timestamp.  
Delivery Delay | Only used by JMS 2.0. Sets the delivery delay to be applied to postpone the Message delivery.  
Delivery Delay Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the deliveryDelay configurations.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
### For Configurations
#### Throws
  * IBM-MQ:CONNECTIVITY
  * IBM-MQ:DESTINATION_NOT_FOUND
  * IBM-MQ:ILLEGAL_BODY
  * IBM-MQ:PUBLISHING
  * IBM-MQ:RETRY_EXHAUSTED
  * IBM-MQ:SECURITY


### Publish Consume
`<ibm-mq:publish-consume>`
Allows a user to send a message to a JMS destination and wait for a response either to the provided ReplyTo destination or to a temporary destination created dynamically.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Destination | The name of the Destination where the Message should be sent  
Request-Reply Pattern |  Enumeration, one of:
  * CORRELATION_ID
  * MESSAGE_ID

| Indicates how requests and reply messages are correlated, which ensures that the incoming message is the proper reply to the outgoing message. * The `CORRELATION_ID` pattern value is used with the **Publish Consume** operation. After the operation publishes a request message to the destination queue, it expects a message with the same correlation ID as the request message. It then consumes that correlated response message. * The `MESSAGE_ID` pattern value is used with the **Publish Consume** operation. After the operation publishes a request message to the destination queue, it expects a message with a correlation ID of the same value as the message ID of the request message. It then consumes that correlated response message. | CORRELATION_ID  
Send Correlation ID |  Enumeration, one of: **AUTO** ALWAYS ** NEVER | Options on whether to include an outbound correlation ID or not.  
The body of the Message. | `#[payload]`  
JMS Type | The JMSType identifier header of the Message.  
Correlation ID | The JMSCorrelationID header of the Message.  
Send Content Type | Whether or not the body content type should be sent as a property.  
Content Type | The content type of the message’s body.  
Send Encoding | Whether or not the body outboundEncoding should be sent as a Message property.  
Encoding | The encoding of the message’s body  
Reply To |  MQ JMS Destination | The destination where a reply to this Message should be sent.  
User Properties | The custom user properties that should be set to this Message  
JMSX Properties |  MQ JMSX Properties | The JMSX properties that should be set to this Message  
Persistent Delivery | If true, the Message is sent using the PERSISTENT JMSDeliveryMode.  
Priority | The default JMSPriority value to use when sending the message.  
Time To Live | Defines the default time the message is in the broker before it expires and is discarded  
Time To Live Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the timeToLive configurations  
Disable Message Id | If true, the Message is flagged to avoid generating its MessageID.  
Disable Message Timestamp | If true, the Message is flagged to avoid generating its sent Timestamp  
Delivery Delay | Only used by JMS 2.0. Sets the delivery delay to be applied to postpone the Message delivery  
Delivery Delay Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the deliveryDelay configurations  
Ack Mode |  Enumeration, one of:
  * IMMEDIATE
  * MANUAL

| The Session ACK mode to use when consuming the message | IMMEDIATE  
Maximum Wait | Maximum time to wait for a message to arrive before timeout  
Maximum Wait Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS
| Time unit to use in the timeToLive configurations  
Disable Message Id | If true, the Message is flagged to avoid generating its MessageID.  
Disable Message Timestamp | If true, the Message is flagged to avoid generating its sent Timestamp  
Delivery Delay | Only used by JMS 2.0. Sets the delivery delay to be applied to postpone the Message delivery  
Delivery Delay Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the deliveryDelay configurations  
Ack Mode |  Enumeration, one of:
  * IMMEDIATE
  * MANUAL

| The Session ACK mode to use when consuming the message | IMMEDIATE  
Maximum Wait | Maximum time to wait for a message to arrive before timeout  
Maximum Wait Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the maximumWaitTime configuration | MILLISECONDS  
Content Type | The content type of the message body to be consumed.  
Encoding | The encoding of the message body to be consumed.  
Target Variable | The name of a variable to store the operation’s output.  
Target Value | An expression to evaluate against the operation’s output and store the expression outcome in the target variable. | `#[payload]`  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
#### Output
Attributes Type |  IBM MQ Attributes  
---|---  
### For Configurations
#### Throws
  * IBM-MQ:ACK
  * IBM-MQ:CONNECTIVITY
  * IBM-MQ:CONSUMING
  * IBM-MQ:DESTINATION_NOT_FOUND
  * IBM-MQ:ILLEGAL_BODY
  * IBM-MQ:PUBLISHING
  * IBM-MQ:RETRY_EXHAUSTED
  * IBM-MQ:SECURITY
  * IBM-MQ:TIMEOUT


`<ibm-mq:ack>`
Allows the user to perform an ACK when the AckMode#MANUAL mode is elected while consuming the Message. As per JMS Spec, performing an ACK over a single Message automatically works as an ACK for all the Messages produced in the same JmsSession.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The AckId of the Message to ACK.  
#### Throws
  * IBM-MQ:ACK


### Recover Session
`<ibm-mq:recover-session>`
Allows a user to perform a session recover when the AckMode#MANUAL mode is elected while consuming the Message. As per JMS Spec, performing a session recover automatically redelivers all the consumed messages that had not being acknowledged before this recover.
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
The AckId of the Message Session to recover.  
#### Throws
  * IBM-MQ:SESSION_RECOVER


## Sources
### On New Message
`<ibm-mq:listener>`
#### Parameters
Name | Type | Description | Default Value | Required  
---|---|---|---|---  
Configuration | The name of the configuration to use.  
Destination | The name of the Destination from where the Message should be consumed.  
Consumer Type |  One of:
  *   * queue-consumer

| The Type of the Consumer that should be used for the provided destination.  
Ack Mode |  Enumeration, one of:
  * IMMEDIATE
  * MANUAL
  * DUPS_OK

| The Session ACK mode to use when consuming a message.  
Selector | JMS selector to use for filtering incoming messages.  
Number Of Consumers | The number of concurrent consumers to use to receive JMS Messages  
Transactional Action |  Enumeration, one of:
  * ALWAYS_BEGIN

| The type of beginning action that sources can take regarding transactions.  
Transaction Type |  Enumeration, one of: | The type of transaction to create. Availability depends on the runtime version.  
Primary Node Only | Whether this source should only be executed on the primary node when running in a cluster.  
Redelivery Policy |  Redelivery Policy | Defines a policy for processing the redelivery of the same message.  
Content Type | Sets the content type of the received message. If the message already has a content type, it is overridden.  
Encoding | Sets the encoding of the received message. If the message already has one, it is overridden.  
Reconnection Strategy | 
  *   * Reconnect Forever

| A retry strategy in case of connectivity errors.  
Ignore JMS replyTo header | True if no automatic response is needed for messages with destination header  
The body of the Message | `#[payload]`  
JMS Type | The JMSType identifier header of the message.  
Correlation ID | The JMSCorrelationID header of the message.  
Send Content Type | Whether or not to send the body content type as a property.  
Content Type | The content type of the message’s body.  
Send Encoding | Whether or not the body outboundEncoding should be sent as a Message property.  
Encoding | The encoding of the message’s body  
Reply To |  MQ JMS Destination | The destination where a reply to this Message should be sent  
User Properties | The custom user properties that should be set to this Message  
JMSX Properties |  MQ JMSX Properties | The JMSX properties that should be set to this Message.  
Persistent Delivery | Whether or not the delivery should be done with a persistent configuration.  
Priority | The default JMSPriority value to use when sending the message.  
Time To Live | Defines the default time the message is in the broker before it expires and is discarded.  
Time To Live Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the timeToLive configurations,  
Disable Message Id | If true, the Message is flagged to avoid generating its MessageID.  
Disable Message Timestamp | If true, the Message is flagged to avoid generating its sent Timestamp.  
Delivery Delay | Only used by JMS 2.0. Sets the delivery delay to be applied to postpone the Message delivery.  
Delivery Delay Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| Time unit to use in the deliveryDelay configurations.  
Send Correlation ID |  Enumeration, one of:
  * ALWAYS
  * NEVER

| Options on whether to include an outbound correlation ID or not.  
Request Reply Pattern |  Enumeration, one of:
  * CORRELATION_ID
  * MESSAGE_ID

| Indicates how requests and reply messages are correlated, which ensures that the incoming message is the proper reply to the outgoing message. * The `CORRELATION_ID` pattern value is used with the **Publish Consume** operation. After the operation publishes a request message to the destination queue, it expects a message with the same correlation ID as the request message. It then consumes that correlated response message. * The `MESSAGE_ID` pattern value is used with the **Publish Consume** operation. After the operation publishes a request message to the destination queue, it expects a message with a correlation ID of the same value as the message ID of the request message. It then consumes that correlated response message. | CORRELATION_ID  
#### Output
Attributes Type |  IBM MQ Attributes  
---|---  
### For Configurations
## Types
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enabled Protocols | A comma-separated list of protocols enabled for this context.  
Enabled Cipher Suites | A comma-separated list of CipherSuites enabled for this context.  
Trust Store  
Key Store  
Revocation Check | 
  * Standard Revocation Check
  * Custom OCSP Responder
| Options on whether to include an outbound correlation ID or not.  
Request Reply Pattern |  Enumeration, one of:
  * CORRELATION_ID
  * MESSAGE_ID

| Indicates how requests and reply messages are correlated, which ensures that the incoming message is the proper reply to the outgoing message. * The `CORRELATION_ID` pattern value is used with the **Publish Consume** operation. After the operation publishes a request message to the destination queue, it expects a message with the same correlation ID as the request message. It then consumes that correlated response message. * The `MESSAGE_ID` pattern value is used with the **Publish Consume** operation. After the operation publishes a request message to the destination queue, it expects a message with a correlation ID of the same value as the message ID of the request message. It then consumes that correlated response message. | CORRELATION_ID  
#### Output
Attributes Type |  IBM MQ Attributes  
---|---  
### For Configurations
## Types
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Enabled Protocols | A comma-separated list of protocols enabled for this context.  
Enabled Cipher Suites | A comma-separated list of CipherSuites enabled for this context.  
Trust Store  
Key Store  
Revocation Check | 
  * Standard Revocation Check
  * Custom OCSP Responder

  
### Trust Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location of the trust store which resolves relative to the current classpath and file system, if possible.  
Password | The password used to protect the trust store.  
The type of store used.  
Algorithm | The algorithm used by the trust store.  
Insecure | If true, no certificate validations are performed, rendering connections vulnerable to attacks. Use at your own risk.  
### Key Store
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The location of the key store which resolves relative to the current classpath and file system, if possible.  
The type of store used.  
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file is used by default.  
Key Password | The password used to protect the private key.  
Password | The password used to protect the key store.  
Algorithm | The algorithm used by the key store.  
### Standard Revocation Check
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Only End Entities | Only verify the last element of the certificate chain.  
Prefer Crls | Try CRL instead of OCSP first.  
No Fallback | Do not use the secondary checking method (the one not selected before).  
Soft Fail | Avoid verification failure when the revocation server cannot be reached or is busy.  
### Custom OCSP Responder
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The URL of the OCSP responder.  
Cert Alias | Alias of the signing certificate for the OCSP response (must be in the trust store), if present.  
### CRL File
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
The path to the CRL file.  
### Reconnection
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Fails Deployment | When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.  
Reconnection Strategy | 
  *   * Reconnect Forever

| The reconnection strategy to use.  
### Reconnect
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often in milliseconds to reconnect.  
How many reconnection attempts to make.  
blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Reconnect Forever
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Frequency | How often in milliseconds to reconnect.  
blocking | If false, the reconnection strategy runs in a separate, non-blocking thread.  
### Expiration Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Idle Time | A scalar time value for the maximum amount of time a dynamic configuration instance can be idle before it’s considered eligible for expiration.  
Time Unit |  Enumeration, one of:
  * NANOSECONDS
  * MICROSECONDS
  * MILLISECONDS
  * SECONDS
  * MINUTES
  * HOURS

| A time unit that qualifies the maxIdleTime attribute.  
### IBM MQ Attributes
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Properties |  JMS Message Properties  
### JMS Message Properties
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
User Properties  
Jms Properties  
Jmsx Properties |  JMSX Properties  
### JMSX Properties
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Jmsx User ID  
Jmsx App ID  
Jmsx Delivery Count  
Jmsx Group ID  
Jmsx Group Seq  
Jmsx Producer TXID  
Jmsx Consumer TXID  
Jmsx Rcv Timestamp  
### Redelivery Policy
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Max Redelivery Count | The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message  
Use Secure Hash | Whether to use a secure hash algorithm to identify a redelivered message.  
Message Digest Algorithm | The secure hashing algorithm to use.  
Id Expression | Defines one or more expressions to use to determine when a message has been redelivered. This property may only be set if useSecureHash is false.  
Object Store |  Object Store | The object store where the redelivery counter for each message is going to be stored.  
### MQ JMS Destination
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Destination | The name that identifies the destination where a message should be sent.  
Destination Type |  Enumeration, one of:
  * QUEUE
  * TOPIC

| The type of this destination.  
### MQ JMSX Properties
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Jmsx User ID  
Jmsx App ID  
Jmsx Delivery Count  
Jmsx Group ID  
Jmsx Group Seq  
Jmsx Producer TXID  
Jmsx Consumer TXID  
Jmsx Rcv Timestamp  
### Topic Consumer
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
No Local  
Subscription Name  
### Binding
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Queue Manager | The queue manager name.  
### Client
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Host where the IBM MQ Broker is.  
Queue Manager listener port.  
Queue Manager | The queue manager which is used when selecting a channel definition.  
Name of the channel to connect to.  
Connection Name List | Hosts to which the client attempts to reconnect to after its connection is broken. The connection name list is a comma-separated list of host and IP port pairs.  
### Default Caching
Field | Type | Description | Default Value | Required  
---|---|---|---|---  
Session Cache Size | Size of the session cache.  
Cache Producers | Indicates whether or not to cache the producer.  
Cache Consumers | Indicates whether or not to cache the consumer.  
## See Also
MuleSoft Help Center