Free MuleSoft CONNECT Keynote & Expo Pass Available!

Register now+
Nav

Microsoft MSMQ Connector Reference

MSMQ Receiver Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Msmq

The connection Types that can be provided to this configuration.

x

Message Count

Number

x

Polling Frequency

Number

The polling frequency in milliseconds to pull messages out of the gateway.

x

Message Formatter

Enumeration, one of:

  • None

  • ActiveXMessageFormatter

The MSMQ message formatter to use to encode or decode messages.

x

Message Delivery

Enumeration, one of:

  • NoAcknowledgement

  • AtLeastOnce

The message delivery mode when receiving messages from the Gateway.

Expiration Policy

ExpirationPolicy

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 instances as it sees fit.

MSMQ Connection Type

Parameters

Name Type Description Default Value Required

Gateway Service Address

String

x

Gateway Access Token

String

x

Queue Name (optional)

String

Queue name in UNC Path or FormatName notation, for example .\private$\myqueue

Impersonation Username (optional)

String

Impersonation Password (optional)

String

Ignore SSL Warnings

Boolean

false

Reconnection

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.

Associated Sources

  • msmq

MSMQ Sender Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

Msmq

The connection Types that can be provided to this configuration.

x

Message Formatter

Enumeration, one of:

  • None

  • ActiveXMessageFormatter

The MSMQ message formatter to use to encode or decode messages.

x

Expiration Policy

ExpirationPolicy

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 instances as it sees fit.

MSMQ Connection Type

Parameters

Name Type Description Default Value Required

Gateway Service Address

String

x

Gateway Access Token

String

x

Queue Name (optional)

String

Queue name in UNC Path or FormatName notation, for example .\private$\myqueue

Impersonation Username (optional)

String

Impersonation Password (optional)

String

Ignore SSL Warnings

Boolean

false

Reconnection

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.

Associated Operations

  • send

Send Operation

<msmq:send>

Sends the specified message to the queue.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Queue Name

String

Message Formatter

Enumeration, one of:

  • None

  • ActiveXMessageFormatter

The message formatter.

Payload

Binary

The message to be sent.

#[payload]

Impersonation Username

String

(Optional) If entered, the user name of the user to impersonate when accessing the MSMQ. The userName should be in the formats: local computer user: [username] or domain user: [DOMAIN]\[username].

Impersonation Password

String

(Optional) If entered, the password of the user to impersonate when accessing the MSMQ.

Time to be received

Number

(Optional) Message lifetime in seconds. 0 means the message does not expire.

0

Time to reach queue

Number

(Optional) Interval in seconds that represents the time a message can take to reach the destination queue from the gateway. 0 means the message does not expire.

0

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

For Configurations

  • msmq-sender-config

Throws

  • MSMQ:CONNECTIVITY

  • MSMQ:RETRY_EXHAUSTED

Sources

Msmq

<msmq:msmq>

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Redelivery Policy

RedeliveryPolicy

Defines a policy for processing the redelivery of the same message.

Streaming Strategy

  • repeatable-in-memory-stream

  • repeatable-file-store-stream

  • non-repeatable-stream

Configure to use repeatable streams and their behavior.

Reconnection Strategy

  • reconnect

  • reconnect-forever

A retry strategy in case of connectivity errors.

Output

Type

Any

Attributes Type

Any

For Configurations

  • msmq-receiver-config

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

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

  • reconnect-forever

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time to allow a dynamic configuration instance to be idle before being eligible to expire.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

Redelivery Policy

Field Type Description Default Value Required

Max Redelivery Count

Number

The maximum number of times a message can be redelivered and processed unsuccessfully before triggering process-failed-message.

Use Secure Hash

Boolean

Whether to use a secure hash algorithm to identify a redelivered message.

Message Digest Algorithm

String

The secure hashing algorithm to use. If not set, the default is SHA-256.

Id Expression

String

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

ObjectStore

The object store where the redelivery counter for each message is going to be stored.

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, which means that a STREAM_MAXIMUM_SIZE_EXCEEDED error occurs when the buffer is full.

Max Buffer Size

Number

This is the maximum amount of memory to use. If more memory is used, a STREAM_MAXIMUM_SIZE_EXCEEDED error occurs. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed.

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it starts to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.