SendToMessageQueueAction Class Reference

Sends a message to the Microsoft Message Queuing (MSMQ) service. More...

Inherits IntegrationAction.

Properties
string	Queue [get, set]
	Specifies the name of the message queue. For information about how to assign a queue name, see the MSMQ documentation. More...
QueueMessageFormat	QueueMessageFormat [get, set]
	Specifies the data format of the queue, as follows: More...
ActionTextEncoding	QueueMessageEncoding [get, set]
	Specifies the text encoding scheme of the message. Valid only when the value of QueueMessageFormat is Text. The default value is UnicodeUTF8. More...
DataTarget	Body [get, set]
	Specifies the body of the message to send. For information about how to specify the message body source, see DataTarget. Example of using an integration variable as the message body source: More...
String	Label [get, set]
	Specifies the label to attach to the message. More...
string	Priority [get, set]
	Specifies the priority to attach to the message. The default value is 3. More...
bool	Transactional [get, set]
	Specifies whether the message is transactional. The default value is false. More...
bool	Recoverable [get, set]
	Specifies whether the message is recoverable. The default value is false. More...
bool	ValidateDelivery [get, set]
	Waits for an acknowledgment message and logs an error message if a failure occurs. For more information, see http://msdn.microsoft.com/en-us/library/ms707129(VS.85).aspx. The default value is false. More...
int	ValidateDeliveryTimeout [get, set]
	Specifies the amount of time, in milliseconds, that elapses while waiting to receive an acknowledgment message before timing out. For more information, see http://msdn.microsoft.com/en-us/library/ms707129(v=vs.85).aspx. The default value is 2000. More...
CommonActionProperties
Describes the common action properties for Actions and ActionGroups.
string	Name [get, set]
	Specifies the name. This property cannot be empty and must be unique in the YAML script. More...
string	Description [get, set]
	Specifies the description. The default value is "". More...
ActionRunType	RunType [get, set]
	Runs the action by using one of the following types: More...
bool	IgnoreErrors [get, set]
	Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false. More...
int	FailureRetries [get, set]
	Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0. More...
int	RetryInterval [get, set]
	Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000. More...

Detailed Description

Sends a message to the Microsoft Message Queuing (MSMQ) service.

For common action properties, see IntegrationAction.
Example:

Actions:
- SendToMessageQueueAction:
    Queue: .\MyQueue
    Body: '%EventData%'
    Priority: 1
    Transactional: true
    Recoverable: true
    ValidateDelivery: true
    ValidateDeliveryTimeout: 3000
    Name: Send to Message Queue
    # And more common action properties
    ... 

Property Documentation

Queue

string Queue

getset

Specifies the name of the message queue. For information about how to assign a queue name, see the MSMQ documentation.

QueueMessageFormat

QueueMessageFormat QueueMessageFormat

getset

Specifies the data format of the queue, as follows:

• XML (default)
• Text

QueueMessageEncoding

ActionTextEncoding QueueMessageEncoding

getset

Specifies the text encoding scheme of the message. Valid only when the value of QueueMessageFormat is Text. The default value is UnicodeUTF8.

Body

DataTarget Body

getset

Specifies the body of the message to send. For information about how to specify the message body source, see DataTarget.
Example of using an integration variable as the message body source:

Body: %EventData%

Example of using a file as the message body source:

Body: 
  File: C:\MySecretFolder\body.txt
  Encoding: WindowsDefault

Label

String Label

getset

Specifies the label to attach to the message.

Priority

string Priority

getset

Specifies the priority to attach to the message. The default value is 3.

Transactional

bool Transactional

getset

Specifies whether the message is transactional. The default value is false.

Recoverable

bool Recoverable

getset

Specifies whether the message is recoverable. The default value is false.

ValidateDelivery

bool ValidateDelivery

getset

Waits for an acknowledgment message and logs an error message if a failure occurs. For more information, see http://msdn.microsoft.com/en-us/library/ms707129(VS.85).aspx. The default value is false.

ValidateDeliveryTimeout

int ValidateDeliveryTimeout

getset

Specifies the amount of time, in milliseconds, that elapses while waiting to receive an acknowledgment message before timing out. For more information, see http://msdn.microsoft.com/en-us/library/ms707129(v=vs.85).aspx. The default value is 2000.

Name

string Name

getsetinherited

Specifies the name. This property cannot be empty and must be unique in the YAML script.

Description

string Description

getsetinherited

Specifies the description. The default value is "".

RunType

ActionRunType RunType

getsetinherited

Runs the action by using one of the following types:

• Always (default)
• Never

IgnoreErrors

bool IgnoreErrors

getsetinherited

Specifies whether to ignore errors and continue with the next action. Valid only for Action and ActionGroup. The default value is false.

FailureRetries

int FailureRetries

getsetinherited

Specifies the number of times that the action is retried if it fails. Available only for Action. The default value is 0.

RetryInterval

int RetryInterval

getsetinherited

Specifies the interval, in milliseconds, that elapses when a failed action is retried. Valid only when the value of FailureRetries is greater than 0. Available only for Action. The default value is 10000.

---

The documentation for this class was generated from the following file:

• SendToMessageQueueAction.Properties.cs