2.7.1.14.1.1.1 MessageQueueTaskType

  • Article

The MessageQueueTaskType complex type holds parameters, properties, and settings for the Message Queue Task.

The following is the XSD for the MessageQueueTaskType complex type.

   <xs:complexType name="MessageQueueTaskType">
     <xs:sequence>
     </xs:sequence>
     <xs:attribute name="CurrentPackageID" type="DTS:uuid"/>
     <xs:attribute name="TaskDescription" type="xs:string"/>
     <xs:attribute name="DataFileOverWritable">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:enumeration value="False"/>
           <xs:enumeration value="True"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="DTSMessageLineageID" type="xs:string"/>
     <xs:attribute name="DTSMessagePackageID" type="xs:string"/>
     <xs:attribute name="DTSMessageVersionID" type="xs:string"/>
     <xs:attribute name="ErrorIfMessageTimeOut">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:enumeration value="False"/>
           <xs:enumeration value="True"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="QueuePath" type="xs:string"/>
     <xs:attribute name="ReceiveMessageTimeOut" type="xs:int"/>
     <xs:attribute name="ReceiveMessageType" 
                   type="MessageQueueTask:MSMQMessageTypeEnum"/>
     <xs:attribute name="RemoveFromQueue">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:enumeration value="False"/>
           <xs:enumeration value="True"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="SaveDataFileName" type="xs:string"/>
     <xs:attribute name="StringCompareType" 
                   type="MessageQueueTask:MSMQStringCompareTypeEnum"/>
     <xs:attribute name="StringCompareValue" type="xs:string"/>
     <xs:attribute name="StringMessageToVariableName" type="xs:string"/>
     <xs:attribute name="ReceiveVariableMessage" type="xs:string"/>
     <xs:attribute name="TaskType" 
                   type="MessageQueueTask:MSMQTaskTypeEnum"/>
     <xs:attribute name="UseEncryption">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:enumeration value="False"/>
           <xs:enumeration value="True"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="EncryptionAlgorithm" 
                   type="MessageQueueTask:MSMQEncryptionAlgorithmEnum"/>
     <xs:attribute name="Use2000Format">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:enumeration value="False"/>
           <xs:enumeration value="True"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="DataFileName" type="xs:string"/>
     <xs:attribute name="StringMessage" type="xs:string"/>
     <xs:attribute name="VariableMessage" type="xs:string"/>
     <xs:attribute name="MessageType" 
                   type="MessageQueueTask:MSMQMessageTypeEnum"/>
   </xs:complexType>

The MessageQueueTaskType complex type MUST NOT contain elements.

The following table specifies additional information for the attributes of the MessageQueueTaskType complex type.

Attribute

Description

CurrentPackageID

A UUID value that specifies the DTSID attribute of the currently executing package.

TaskDescription

A string value that specifies a description for the task.

DataFileOverWritable

An enumeration value that specifies whether the message can overwrite an existing file. This enumeration value applies only if the MessageType attribute is equal to "DTSMQMessageType_DataFile".

"True" specifies that the task can overwrite a file.

"False" specifies that the task cannot overwrite a file.

DTSMessageLineageID

A string value.<87>

DTSMessagePackageID

A UUID value that specifies the DTSID property of the package that is the source of the message.

DTSMessageVersionID

A string value that specifies the version of the message.

ErrorIfMessageTimeOut

An enumeration value that specifies whether the task fails when the message times out.

"True" specifies that the task always fails when the message times out.

"False" specifies that the task does not necessarily fail when the message times out.

QueuePath

A string value that specifies the ObjectName property of a connection manager for this message queue.

ReceiveMessageTimeOut

An integer value that specifies the number of seconds that elapse before a received message times out.

ReceiveMessageType

An enumeration value that specifies the type of the received message.

RemoveFromQueue

An enumeration value that specifies whether to remove the message from the queue.

"True" specifies that the message MUST be removed from the queue.

"False" specifies that the message MUST NOT be removed from the queue.

SaveDataFileName

A string value that specifies the name of the file to which an incoming message is saved.

StringCompareType

An enumeration value that specifies the string comparison method. This enumeration value is used only when the TaskType attribute is set to the value "DTSMQType_Receiver".

StringCompareValue

A string value that specifies a string to which a string message is compared when the TaskType attribute is set to "DTSMQType_Receiver".

StringMessageToVariableName

A string value that specifies the name of the variable to which the message contents are saved.

ReceiveVariableMessage

A string value that specifies the name of the variable where a received message is saved.

TaskType

An enumeration value that specifies whether the task is sending a message or receiving a message.

UseEncryption

An enumeration value that specifies whether to encrypt the messages.

"True" specifies that the message MUST be encrypted.

"False" specifies that the message MUST NOT be encrypted.

EncryptionAlgorithm

An enumeration value that specifies the encryption algorithm to use.

Use2000Format

An enumeration value that specifies whether the message is formatted in a specific format.<88>

DataFileName

A string value that specifies the name of the file that is used if the message type uses a file.

StringMessage

A string value that contains the message text. This string value is used only if the MessageType attribute is set to the "DTSMQMessageType_String" value.

VariableMessage

A string value that contains the message text. This string value is used only if the MessageType attribute is set to the "DTSMQMessageType_Variables" value.

MessageType

An enumeration value that specifies the type of message that is sent. This enumeration value is used only when the TaskType attribute is set to "DTSMQType_Sender".