Message Context Properties

Message Context Properties

Microsoft BizTalk Server 2004

System properties are mostly used internally by BizTalk Messaging Engine and its components. In general, changing the values set by the engine for those properties is not recommended, because it may affect the execution logic of the engine. However, there are a large number of properties that you can change.

The following table contains a list of message context properties that the Messaging Engine can promote. You can use these properties for creation of filter expressions on send ports and orchestrations in Microsoft® BizTalk® Server 2004. A separate table lists additional properties that may be of use in some BizTalk applications that cannot be promoted.

For additional information about properties and property schemas associated with pipeline components and adapters, see the following:

Property	When and where it is promoted	Type	Description
BTS.AckFailureCategory	Promoted by the Messaging Engine before publishing an acknowledgement message into the MessageBox database.	xs:int	Identifies the ErrorCategory, which gives the place and reason for the suspension.
BTS.AckFailureCode	Promoted by the Messaging Engine before publishing an acknowledgement message into the MessageBox database.	xs:string	Identifies the ErrorCode, which gives the place and reason for the suspension.
BTS.AckID	Promoted by the Messaging Engine before publishing an acknowledgement message into the MessageBox database.	xs:string	Identifies the MessageID of the original message.
BTS.AckInboundTransportLocation	Promoted by the Messaging Engine before publishing an acknowledgement message into the MessageBox database.	xs:string	Identifies the InboundTransportLocation from the original message.
BTS.AckOutboundTransportLocation	Promoted by the Messaging Engine before publishing an acknowledgement message into the MessageBox database.	xs:string	Identifies the OutboundTransportLocation from the original message.
BTS.AckOwnerID	Promoted by the Messaging Engine before publishing an acknowledgement message into the MessageBox database.	xs:string	Identifies the instance ID from original message.
BTS.AckReceivePortID	Promoted by the Messaging Engine before publishing an acknowledgement message into the MessageBox database.	xs:string	Identifies the ReceivePortID from the original message.
BTS.AckReceivePortName	Promoted by the Messaging Engine for the acknowledgement message.	xs:string	Identifies the ReceivePortName from the original message.
BTS.AckSendPortID	Promoted by the Messaging Engine before publishing an acknowledgement message into the MessageBox database.	xs:string	Identifies the SendPortID from the original message.
BTS.AckSendPortName	Promoted by the Messaging Engine before publishing an acknowledgement message into the MessageBox database.	xs:string	Identifies the SendPortName from the original message.
BTS.AckType	Promoted by the Messaging Engine before publishing an acknowledgement message into the MessageBox database.	xs:string	Allows monitoring of acknowledgements and non-acknowledgements by an orchestration. The value will be ACK for an acknowledgment and NACK for a negative acknowledgment.
BTS.CorrelationToken	If this property is set on the message context, it is promoted by the Messaging Engine. This property is set on a context implicitly when request-response adapter or an orchestration submits a request message into the MessageBox database.	xs:string	Enables routing of response to request-response ports.
BTS.EpmRRCorrelationToken	Promoted by the Messaging Engine on request-response message execution. The property is promoted before messages are submitted into the MessageBox database.	xs:int	Used internally by the Messaging Engine. Specifies the Server Name, Process ID and a unique GUID for a request response stream of messages.
BTS.InboundTransportLocation	Promoted by the Messaging Engine after receiving a message from a receive adapter and before publishing it into the MessageBox database.	xs:string	Specifies the location (URI) on which the message was received by the handler.
BTS.InboundTransportType	Promoted by the Messaging Engine after receiving a message from a receive adapter and before publishing it into the MessageBox database.	xs:string	Specifies the type of adapter that received this message and submitted it into the server.
BTS.MessageType	Promoted by the disassembler pipeline components during message parsing.	xs:string	Specifies the type of the message. The message type is defined as a concatenation of document schema namespace and document root node.
BTS.OutboundTransportLocation	If this property is set on the message context, it is promoted by the Messaging Engine. This property is set on a message context implicitly when an orchestration sends a message to a send port. This property can be also set explicitly in an orchestration or in a pipeline.	xs:string	Specifies the destination location URI where the message is sent. The URI may contain the adapter prefix, such as http://. The adapter prefix is used by the Messaging Engine to determine the type of adapter to use when sending the message. If both the adapter prefix and the BTS.OutboundTransportType property are set, the adapter type from BTS.OutboundTransportType always takes precedence over the adapter type determined from the prefix. Valid values: BizTalk Message Queuing: DIRECT=, PRIVATE=, and PUBLIC= FILE: file:// FTP: FTP:// HTTP: http:// and https:// SMTP: mailto: SOAP: SOAP:// SQL: SQL://
BTS.OutboundTransportType	If this property is set on the message context, it is promoted by the Messaging Engine. This property is set on a context implicitly when an orchestration sends a message to a send port. This property can also be set explicitly in an orchestration or in a pipeline.	xs:string	Specifies the type of adapter used to send the message. The available adapter types are FILE, FTP, HTTP, SMTP, MSMQT (BizTalk Message Queuing), SOAP, and SQL. The values set on this property as well as adapter prefixes specified in the address are not case-sensitive.
BTS.ReceivePortID	Promoted by the Messaging Engine after receiving a message from a receive adapter and before publishing it into the MessageBox database.	xs:int	Identifies the receive port on which the message was received.
BTS.ReceivePortName	Promoted by the Messaging Engine after receiving a message from a receive adapter and before publishing it into the MessageBox database.	xs:string	User-friendly name of the receive port on which the message was received.
BTS.RouteDirectToTP	Promoted by the Messaging Engine on messages for loop back or request-response execution. The property is promoted before messages are submitted into the MessageBox database.	xs:boolean	Used internally by the Messaging Engine to enable loop back and request-response scenarios.
BTS.SPGroupID	Promoted by the Messaging Engine when the message is sent to a send port from orchestration.	xs:string	Specifies the ID of the send port group.
BTS.SPID	Promoted by the Messaging Engine when a message is sent to a send port from orchestration.	xs:string	Specifies the ID of the send port.
BTS.SPTransportBackupID	Promoted by the Messaging Engine when a message is sent to a send port from an orchestration.	xs:string	Specifies the ID of the backup adapter in the send port.
BTS.SPTransportID	Promoted by the Messaging Engine when a message is sent to a send port from an orchestration.	xs:string	Specifies the ID of the primary adapter in the send port.

There are a number of other properties in this namespace that carry information that may be useful for some BizTalk applications.

Property	When and where it is promoted	Type	Description
BTS.AckDescription	Set by the Messaging Engine before publishing an acknowledgement message into the MessageBox database.	xs:string	Identifies the ErrorDescription, which gives the place and reason for the suspension.
BTS.EncryptionCert	Not promotable.	xs:int	Identifies the thumbprint corresponding to the encryption certificate. Set this property in an orchestration or custom pipeline component placed before the MIME/SMIME Encoder pipeline component in a pipeline to perform response encryption on a request-response port that is receiving a signed and encrypted message.
BTS.InterchangeID	Set by the Messaging Engine for each message that arrives on the server.	xs:string	Defines the unique ID that is used to group the documents that resulted from the same interchange message.
BTS.Loopback	Set by an adapter when submitting the request message for loop back execution.	xs:boolean	Defines whether the message should be submitted into the server for a loop back execution. In loop back execution, the request message is published into the MessageBox database where it is routed directly to the receive adapter as a response.
BTS.SignatureCertificate	Set by some adapters when submitting a message into the server. This property is used by the Party Resolution pipeline component.	xs:string	Identifies the thumbprint of the signing certificate that was used to sign the message received by BizTalk Server.
BTS.SourcePartyID	Set by the Party Resolution pipeline component after the party has been identified for the incoming message.	xs:string	The ID of the BizTalk party.
BTS.SSOTicket	If the receive adapter supports this property, it is set when publishing the message to a server.	xs:string	A ticket contains the encrypted domain and username of the current user, as well as the ticket expiration time. The ticket is used by SSO enabled adapters to get the credentials for the user when authenticating with destination endpoints.
BTS.WindowsUser	Set by some adapters when submitting a message into the server. This property is used by the Party Resolution pipeline component.	xs:string	Specifies the account of a user on behalf of which the message is submitted into the server.

To download updated BizTalk Server 2004 Help from www.microsoft.com, go to http://go.microsoft.com/fwlink/?linkid=20616.