WCF Adapters Property Schema and Properties
The following table contains the promoted properties in the WCF adapter property schema. The WCF adapters assign values to the properties that you can use in your application. WCF adapter also provides a mechanism to write but not promote the custom properties to the BizTalk message context, and a mechanism to promote the custom properties to the BizTalk message context. For more details, see SOAP Headers with Published WCF Services.
Namespace: http://schemas.microsoft.com/BizTalk/2006/01/Adapters/WCF-properties
| Name | Type | Description | Applicable WCF adapter | ||||||
|---|---|---|---|---|---|---|---|---|---|
|
Action |
String |
Specify the SOAPAction header field for outgoing messages. You can specify this value in two different ways: the single action format and the action mapping format. If you set this property in the single action format—for example, http://contoso.com/Svc/Op1—the SOAPAction header for outgoing messages is always set to the value specified in this property. If you set this property in the action mapping format, the outgoing SOAPAction header is determined by the BTS.Operation context property. For example, if this property is set to the following XML format and the BTS.Operation property is set to Op1, the WCF send adapter uses http://contoso.com/Svc/Op1 for the outgoing SOAPAction header. <BtsActionMapping> <Operation Name="Op1" Action="http://contoso.com/Svc/Op1" /> <Operation Name="Op2" Action="http://contoso.com/Svc/Op2" /> </BtsActionMapping> If outgoing messages come from an orchestration port, orchestration instances dynamically set the BTS.Operation property with the operation name of the port. If outgoing messages are routed with content-based routing, you can set the BTS.Operation property in pipeline components. This property is automatically promoted from incoming messages with the single action format. The default is an empty string. |
All of the WCF send adapters |
||||||
|
AffiliateApplicationName |
String |
Specify the affiliate application to use for Enterprise Single Sign-On (SSO). This property is required if the UseSSO property is set to True. The default is an empty string. |
All of the WCF send adapters except the WCF-NetNamedPipe adapter |
||||||
|
AlgorithmSuite |
String |
Specify the message encryption and key-wrap algorithms. These algorithms map to those specified in the Security Policy Language (WS-SecurityPolicy) specification. Default value: Basic256 For more information about the applicable values for the AlgorithmSuite property, see the Algorithm suite property in WCF-NetTcp Transport Properties Dialog Box, Send, Security Tab. |
WCF-BasicHttp adapter WCF-NetMsmq adapter WCF-NetTcp adapter WCF-WSHttp adapter |
||||||
|
BindingConfiguration |
String |
Specify an XML string with the <binding> element to configure different types of predefined bindings provided by Windows Communication Foundation (WCF). For more information about the system-provided binding and custom binding, see the appropriate topics in See Also. The default is an empty string. Example: <binding name="wsHttpBinding" transactionFlow="true"><security><message clientCredentialType="UserName" /></security></binding> |
WCF-Custom adapter WCF-CustomIsolated adapter |
||||||
|
BindingType |
String |
Specify the type of the binding to use for the endpoint. The default is an empty string. For more information about the applicable values for the BindingType property, see the Binding Type property in WCF-Custom Transport Properties Dialog Box, Send, Binding Tab. |
WCF-Custom adapter WCF-CustomIsolated adapter |
||||||
|
ClientCertificate |
String |
Specify the thumbprint of the X.509 certificate for authenticating this send port to services. This property is required if the ClientCredentialsType property is set to Certificate. The certificate to be used for this property must be installed into the My store in the Current User location. The default is an empty string. |
WCF-BasicHttp send adapter WCF-WSHttp send adapter WCF-NetTcp send adapter WCF-NetMsmq send adapter |
||||||
|
CloseTimeout |
String |
Specify a time span value that indicates the interval of time provided for a channel close operation to complete. Default value: 00:01:00 |
All of the WCF adapters except the WCF-Custom and the WCF-CustomIsolated adapters |
||||||
|
CustomDeadLetterQueue |
String |
Specify the fully qualified URI with the net.msmq scheme for the location of the per-application dead-letter queue, where messages that have expired or that have failed transfer or delivery are placed. For example, net.msmq://localhost/deadLetterQueueName. The dead-letter queue is a queue on the queue manager of the sending application for expired messages that have failed to be delivered. This property is required if the DeadLetterQueue property is set to Custom. The default is an empty string. |
WCF-NetMsmq send adapter |
||||||
|
DeadLetterQueue |
String |
Specify the dead-letter queue where messages that have failed to be delivered to the application will be transferred. For more information about the messages delivered to the dead-letter queue, see WCF-NetMsmq Transport Properties Dialog Box, Send, Binding Tab. Default value: System |
WCF-NetMsmq send adapter |
||||||
|
DisableLocationOnFailure |
Boolean |
Specify whether to disable the receive location that fails inbound processing due to a receive pipeline failure or a routing failure. You may want to set this property to True when receive locations can be disabled and Denial-of-Service (DoS) is not a concern. For example:
Default: False |
WCF-NetMsmq receive adapter WCF-Custom receive adapter WCF-CustomIsolated receive adapter |
||||||
|
EnableTransaction |
Boolean |
The effect of this property varies depending on the WCF adapter. For more information about this property, see how-to topics for each WCF adapter in WCF Adapters. |
WCF-WSHttp adapter WCF-NetTcp adapter WCF-NetNamedPipe adapter WCF-NetMsmq adapter |
||||||
|
EndpointBehaviorConfiguration |
String |
Specify an XML string with the <behavior> element of the <endpointBehaviors> element to configure the behavior settings of a WCF endpoint. For more information about the <endpointBehaviors> element, see the appropriate topic in See Also. The default is an empty string. Example: <behavior name="sampleBehavior"><callbackTimeouts /></behavior> |
WCF-Custom send adapter |
||||||
|
EstablishSecurityContext |
Boolean |
Specify whether the security channel establishes a secure session. A secure session establishes a Security Context Token (SCT) before exchanging the application messages. Default value: True |
WCF-WSHttp adapter |
||||||
|
FromAddress |
String |
Indicate the source endpoint address through which the incoming WCF messages are sent. The property is automatically promoted from incoming messages. |
All of the WCF adapters except the WCF-NetMsmq send adapter |
||||||
|
Headers |
String |
Specify the endpoint references used to provide additional addressing information beyond the URI. When this property is used, this property must have the <headers> element as the root element. All of the address headers must be placed inside the <headers> element. This property is automatically promoted for incoming messages. Example: <headers><Region xmlns="Uri">"String"</Region> <Member xmlns="Uri">"String"</Member> </headers> |
All of the WCF adapters |
||||||
|
Identity |
String |
Specify the identity of the service that a receive location provides or a send port expects. The values that can be specified for the Identity property differ according to the security configuration. These settings enable clients to authenticate services. In the handshake process between clients and services, the Windows Communication Foundation (WCF) infrastructure will ensure that the identity of the services matches the values of the clients. The default is an empty string. Example: <identity> <userPrincipalName value="username@contoso.com" /> </identity> |
All of the WCF adapters |
||||||
|
InboundBodyLocation |
String |
Specify the data selection for the SOAP Body element of incoming WCF messages. For more information about how to use the InboundBodyLocation property, see Specifying the Message Body for the WCF Adapters. Default value: UseBodyElement Applicable values are:
|
All of the WCF adapters except the WCF-NetMsmq send adapter |
||||||
|
InboundBodyPathExpression |
String |
Specify the body path expression to identify a specific part of an incoming message used to create the BizTalk message body part. This body path expression is evaluated against the immediate child element of the SOAP Body node of an incoming message. If this body path expression returns more than one node, only the first node is chosen for the BizTalk message body part. This property is required if the InboundBodyLocation property is set to UseBodyPath. For more information about how to use the InboundBodyPathExpression property, see WCF Adapters Property Schema and Properties. The default is an empty string. |
All of the WCF adapters except the WCF-NetMsmq send adapter |
||||||
|
InboundHeaders |
String |
Use the InboundHeaders property to access the SOAP headers of incoming WCF messages. The WCF adapters copy all the SOAP header values in inbound messages to this property, which include custom SOAP headers and standard SOAP headers that the WCF infrastructure uses for such as WS-Addressing, WS-Security, and WS-AtomicTransaction. The value contained in the context property is a string containing XML data with the <headers> root element, and the incoming SOAP headers are copied as child elements of the <headers> element. For more information about how to access SOAP headers with the WCF adapters, see the SDK sample, Using Custom SOAP Headers with the WCF Adapters, from http://go.microsoft.com/fwlink/?LinkId=79960. |
All of the WCF adapters except the WCF-NetMsmq send adapter |
||||||
|
InboundNodeEncoding |
String |
Specify the type of encoding that the WCF receive adapter uses to decode the node identified by the body path expression specified in InboundBodyPathExpression. This property is required if the InboundBodyLocation property is set to UseBodyPath. Default value: XML Applicable values are:
|
All of the WCF adapters except the WCF-NetMsmq send adapter |
||||||
|
IsFault |
Boolean |
Indicate whether SOAP fault messages are received. The property is automatically promoted from incoming messages.
|
All of the WCF adapters except the WCF-NetMsmq send adapter |
||||||
|
LeaseTimeout |
String |
Specify the maximum lifetime of an active pooled connection. After the specified time elapses, the connection closes after the current request is serviced. The WCF-NetTcp adapter leverages the NetTcpBinding class to communicate with an endpoint. When using the NetTcpBinding in load-balanced scenarios, consider reducing the default lease time-out. For more information about load balancing when using the NetTcpBinding, see the appropriate topic in See Also. Default value: 00:05:00 |
WCF-NetTcp receive adapter |
||||||
|
MaxConcurrentCalls |
Integer |
Specify the number of concurrent calls to a single service instance. Calls in excess of the limit are queued. Setting this value to 0 is equivalent to setting it to Int32.MaxValue.
Default value: 200 |
All of the WCF receive adapters except the WCF-Custom and WCF-CustomIsolated adapters |
||||||
|
MaxConnections |
Integer |
Specify the maximum number of connections that the listener can have waiting to be accepted by the application. When this quota value is exceeded, new incoming connections are dropped rather than waiting to be accepted.
The default is 10. |
WCF-NetNamedPipe adapter WCF-NetTcp adapter |
||||||
|
MaxReceivedMessageSize |
Integer |
Specify the maximum size, in bytes, for a message (including headers) that can be received on the wire. The size of the messages is bounded by the amount of memory allocated for each message. You can use this property to limit exposure to denial of service (DoS) attacks. Default value: 65536 |
WCF-BasicHttp adapter WCF-WSHttp adapter WCF-NetTcp adapter WCF-NetNamedPipe adapter WCF-NetMsmq receive adapter |
||||||
|
MessageClientCredentialType |
String |
Specify the type of credential to be used when performing client authentication using message-based security. The applicable values differ for each WCF adapter. For more information about the MessageClientCredentialType property, see how-to topics for each WCF adapter in WCF Adapters. |
WCF-BasicHttp adapter WCF-WSHttp adapter WCF-NetTcp adapter WCF-NetNamedPipe adapter |
||||||
|
MessageEncoding |
String |
Specify the encoder used to encode the SOAP message. Default value: Text Applicable values are:
|
WCF-BasicHttp adapter WCF-WSHttp adapter |
||||||
|
MsmqAuthenticationMode |
String |
Specify how the message must be authenticated by the MSMQ transport. Default value: WindowsDomain For more information about the applicable values for the MsmqAuthenticationMode property, see the MSMQ authentication mode property in WCF-NetMsmq Transport Properties Dialog Box, Send, Security Tab. |
WCF-NetMsmq adapter |
||||||
|
MsmqEncryptionAlgorithm |
String |
Specify the algorithm to be used for message encryption on the wire when transferring messages between message queue managers. This property is available only if the MsmqProtectionLevel property is set to EncryptAndSign. Default value: RC4Stream Applicable values are:
|
WCF-NetMsmq adapter |
||||||
|
MsmqProtectionLevel |
String |
Specify the way messages are secured at the level of the MSMQ transport. Default value: Sign Applicable values are:
|
WCF-NetMsmq adapter |
||||||
|
MsmqSecureHashAlgorithm |
String |
Specify the hash algorithm to be used for computing the message digest. This property is not available if the MsmqProtectionLevel property is set to None. Default value: SHA1 Applicable values are:
|
WCF-NetMsmq adapter |
||||||
|
NegotiateServiceCredential |
Boolean |
Specify whether the service credential is provisioned at the client out of band, or is obtained from the service to the client through a process of negotiation. Such a negotiation is a precursor to the usual message exchange. If the MessageClientCredentialType property equals None, Username, or Certificate, setting this property to False implies that the service certificate is available at the client out of band and that the client needs to specify the service certificate. This mode is interoperable with SOAP stacks that implement WS-Trust and WS-SecureConversation. If the MessageClientCredentialType property is set to Windows, setting this property to False specifies Kerberos-based authentication. This means that the client and service must be part of the same Kerberos domain. This mode is interoperable with SOAP stacks that implement the Kerberos token profile (as defined at OASIS WSS TC) as well as WS-Trust and WS-SecureConversation. When this property is True, it causes a .NET SOAP negotiation that tunnels SPNego exchange over SOAP messages. Default value: True |
WCF-WSHttp adapter |
||||||
|
OpenTimeout |
String |
Specify a time span value that indicates the interval of time provided for a channel open operation to complete.
Default value: 00:01:00 |
All of the WCF adapters except the WCF-Custom and WCF-CustomIsolated adapters |
||||||
|
OrderedProcessing |
String |
Specify whether to process messages serially. When this property is selected, this receive location accommodates ordered message delivery when used in conjunction with a BizTalk messaging or orchestration send port that has the Ordered Delivery option set to True. For more information about the Ordered Delivery option, see the appropriate topics in See Also. This property is applicable in the following cases:
Default value: False |
WCF-NetMsmq receive adapter WCF-Custom receive adapter WCF-CustomIsolated receive adapter |
||||||
|
OutboundBodyLocation |
String |
Specify the data selection for the SOAP Body element of outgoing WCF messages. For more information about how to use the OutboundBodyLocation property, see Specifying the Message Body for the WCF Adapters. Default value: UseBodyElement Applicable values are:
|
All of the WCF adapters except the WCF-NetMsmq receive adapter |
||||||
|
OutboundCustomHeaders |
String |
Specify the custom SOAP headers for outgoing messages. When this property is used, the property must have the <headers> element as the root element. All of the custom SOAP headers must be placed inside the <headers> element. If the custom SOAP header value is an empty string, you must assign <headers></headers> or <headers/> to this property. For more information about how to use SOAP headers with the WCF adapters, see the SDK sample, Using Custom SOAP Headers with the WCF Adapters, from http://go.microsoft.com/fwlink/?LinkId=79960 |
All of the WCF adapters except the WCF-NetMsmq receive adapter |
||||||
|
OutboundXmlTemplate |
String |
Specify the XML-formatted template for the content of the SOAP Body element of an outgoing message. This property is required if the OutboundBodyLocation property is set to UseTemplate. For more information about how to use the OutboundXMLTemplate property, see Specifying the Message Body for the WCF Adapters. The default is an empty string. |
All of the WCF adapters except the WCF-NetMsmq receive adapter |
||||||
|
Password |
String |
Specify the password to use for authentication with the destination server when the UseSSO property is set to False. The default is an empty string. |
All of the WCF send adapters except the WCF-NetNamedPipe adapter |
||||||
|
PropagateFaultMessage |
Boolean |
Specify whether to route or suspend messages that fail in outbound processing. This property is valid only for solicit-response ports.
Default value: True Applicable values are:
|
All of the WCF send adapters except the WCF-NetMsmq adapter |
||||||
|
ProxyAddress |
String |
Specify the address of the proxy server. Use the https or the http scheme depending on the security configuration. This address can be followed by a colon and the port number. The property is required if the ProxyToUse property is set to UserSpecified. For example, http://127.0.0.1:8080 The default is an empty string. |
WCF-BasicHttp send adapter WCF-WSHttp send adapter |
||||||
|
ProxyPassword |
String |
Specify the password to use for the proxy server specified in the ProxyAddress property. The default is an empty string. |
WCF-BasicHttp send adapter WCF-WSHttp send adapter |
||||||
|
ProxyToUse |
String |
Specify which proxy server to use for outgoing HTTP traffic. Default value: None Applicable values are:
|
WCF-BasicHttp send adapter WCF-WSHttp send adapter |
||||||
|
ProxyUserName |
String |
Specify the user name to use for the proxy server specified in the ProxyAddress property. The property is required if the ProxyToUse property is set to UserSpecified. For more information about this property, see How to Configure a WCF-WSHttp Send Port and How to Configure a WCF-BasicHttp Send Port. |
WCF-BasicHttp send adapter WCF-WSHttp send adapter |
||||||
|
ReplyToAddress |
String |
Indicate the reply endpoint address for the outgoing WCF messages corresponding to incoming messages received through the request-response receive locations. The property is automatically promoted from incoming messages. The default is an empty string. |
All of the WCF adapters except the WCF-NetMsmq adapter |
||||||
|
SecurityMode |
String |
Specify the type of security that is used. The applicable values differ for each WCF adapter. For more information about the SecurityMode property, see how-to topics for each WCF adapter in WCF Adapters.
|
All of the WCF adapters except the WCF-Custom and WCF-CustomIsolated adapters |
||||||
|
SendTimeout |
String |
Specify a time span value that indicates the interval of time provided for a send operation to complete. This value specifies a time span for the whole interaction to complete, even if the correspondent sends a large message. Default value: 00:01:00 |
All of the WCF adapters except the WCF-Custom and WCF-CustomIsolated adapters |
||||||
|
ServiceBehaviorConfiguration |
String |
Specify an XML string with the <behavior> element of the <serviceBehaviors> element to configure the behavior settings of a WCF service. For more information about the <serviceBehaviors> element, see the appropriate topic in See Also. The default is an empty string. Example: <behavior name="SampleServiceBehavior"><serviceAuthorization principalPermissionMode="UseAspNetRoles" /><serviceCredentials><serviceCertificate findValue="539d9ab3089bb6dc187fa7dbb382cf01f8d78f5f" storeLocation="CurrentUser" x509FindType="FindByThumbprint" /></serviceCredentials><serviceMetadata httpGetEnabled="true" /></behavior> |
WCF-Custom receive adapter WCF-CustomIsolated adapter |
||||||
|
ServiceCertificate |
String |
If this property is used for receive locations, specify the thumbprint of the X.509 certificate for the receive locations that clients use to authenticate the service. The certificate to be used for this property must be installed into the My store in the Current User location. If this property is used for send ports, specify the thumbprint of the X.509 certificate for authenticating the service to which this send port sends messages. The certificate to be used for this property must be installed into the Other People store in the Local Machine location. The default is an empty string. |
WCF-BasicHttp adapter WCF-NetMsmq adapter WCF-WSHttp adapter WCF-NetTcp receive adapter |
||||||
|
SuspendMessageOnFailure |
Boolean |
Specify whether to suspend the request message that fails inbound processing due to a receive pipeline failure or a routing failure. Default value: True |
All of the WCF receive adapters |
||||||
|
TextEncoding |
String |
Specify the character set encoding to be used for emitting messages on the binding when the MessageEncoding property is set to Text.
Default value: utf-8 Applicable values are:
|
WCF-BasicHttp adapter WCF-WSHttp adapter |
||||||
|
TimeToLive |
String |
Specify a time span for how long the messages are valid before they are expired and put into the dead-letter queue. This property is set to ensure that time-sensitive messages do not become stale before they are processed by a send port. A message in a queue that is not consumed by this send port within the time interval specified is said to be expired. Expired messages are sent to special queue called the dead-letter queue. The location of the dead-letter queue is set with the DeadLetterQueue property. Default value: 1.00:00:00 |
WCF-NetMsmq send adapter |
||||||
|
To |
String |
Specify the destination endpoint address for outgoing WCF messages that the WCF send ports send. The default is an empty string. |
All of the WCF send adapters |
||||||
|
TransactionProtocol |
String |
Specify the transaction protocol to be used with this binding. This property is required if the EnableTransaction property is set to True. Default value: OleTransaction Applicable values are:
|
WCF-NetNamedPipe adapter WCF-NetTcp adapter |
||||||
|
TransportClientCredentialType |
String |
Specify the type of credential to be used when performing the send port authentication. The applicable values differ for each WCF adapter. For more information about the TransportClientCredentialType property, see how-to topics for each WCF adapter in WCF Adapters. |
WCF-Basic adapter WCF-NetTcp adapter WCF-WSHttp adapter |
||||||
|
TransportProtectionLevel |
String |
Specify security at the level of the TCP transport. Signing messages mitigates the risk of a third party tampering with the message while it is being transferred. Encryption provides data-level privacy during transport. Default value: EncryptAndSign Applicable values are:
|
WCF-NetTcp adapter WCF-NetNamedPipe adapter |
||||||
|
UserName |
String |
Specify the user name to use for authentication with the destination server when the UseSSO property is set to False. You do not have to use the domain\user format for this property. The default is an empty string. |
All of the WCF send adapters except the WCF-NetNamedPipe adapter |
||||||
|
UseSourceJournal |
Boolean |
Specify whether copies of messages processed by this send port should be stored in the source journal queue. Default value: False |
WCF-NetMsmq send adapter |
||||||
|
UseSSO |
Boolean |
Specify whether to use Single Sign-On to retrieve client credentials for authentication with the destination server.
Default value: False |
All of the WCF send adapters except the WCF-NetNamedPipe adapter |
||||||
|
ReferencedBindings |
String |
Specify the binding configurations referenced by the bindingConfiguration attribute of the <issuer> element for the wsFederationHttpBinding and customBinding, which indicates the Security Token Service (STS) that issues security tokens. For more information about the <issuer> element, see the topic, "<issuer>" at http://go.microsoft.com/fwlink/?LinkId=83476. The binding information including the <issuer> element for the wsFederationHttpBinding and customBinding can be configured through the BindingConfiguration property of the WCF-Custom and WCF-CustomIsolated adapters. All of the referenced binding configurations for this property must be placed in the form of the <bindings> element.
The default is an empty string. Example: WCF.BindingConfiguration = @"<wsFederationHttpBinding> <binding name=""sampleBinding""> <security mode=""Message"" > <message issuedKeyType=""AsymmetricKey""> <issuer address=""http://www.contoso.com/samplests"" binding=""wsFederationHttpBinding"" bindingConfiguration=""contosoSTSBinding""/> </message> </security> </binding> </wsFederationHttpBinding>"; WCF.ReferencedBinding =@"<bindings> <wsFederationHttpBinding> <binding name=""contosoSTSBinding""> <security mode=""Message""> <message negotiateServiceCredential=""false""> <issuer address=""http://northwind.com/samplests"" bindingConfiguration=""northwindBinding"" binding=""wsHttpBinding""> </issuer> </message> </security> </binding> </wsFederationHttpBinding> <wsHttpBinding> <binding name=""northwindBinding""> <security mode=""Message""> <message clientCredentialType=""Certificate"" /> </security> </binding> </wsHttpBinding> </bindings>";
|
WCF-Custom adapter WCF-CustomIsolated adapter |
© 2010 Microsoft Corporation. All rights reserved.

Note