Export (0) Print
Expand All

How to Configure a WCF-BasicHttpRelay Receive Location

[Unless specifically noted, the content in this topic applies to BizTalk Server 2013 and 2013 R2.]

This section provides information on how to configure a WCF-BasicHttpRelay Receive Location using the BizTalk Server Administration Console.

noteNote
Before completing the following procedure you must have already added a one-way receive port. For more information, see How to Create a Receive Port.

To configure a WCF-BasicHttpRelay receive location

  1. In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Applications, and then expand the application under you want to create a receive location.

  2. In the left pane, click the Receive Ports node and in the right pane, right-click the receive port with which you want to associate the new receive location, and then click Properties.

  3. In the left pane of the Receive Port Properties dialog box, select Receive Locations, and in the right pane click New to create a new receive location.

  4. In the Receive Location Properties dialog box, in the Transport section, select WCF-BasicHttpRelay from the Type drop-down list, and then click Configure to configure the transport properties for the receive location.

  5. In the WCF-BasicHttpRelay Transport Properties dialog box, on the General tab, configure the endpoint address where the Service Bus relay endpoint is hosted and the service identity for the WCF-BasicHttpRelay receive location.

     

    Use this To do this

    Address (URI)

    Required. Specify the URI where the Service Bus relay endpoint is deployed.

    Endpoint Identity

    Optional. Specify the endpoint identity. These settings enable the endpoint to authenticate this receive location. In the handshake process between the endpoint and the receive location, the Windows Communication Foundation (WCF) infrastructure will ensure that the identity of the expected service matches the values of this element.

    The default is an empty string.

  6. In the WCF-BasicHttpRelay Transport Properties dialog box, on the Binding tab, configure the time-out and encoding-related properties.

     

    Use this To do this

    Open timeout (hh:mmss)

    Specify a time span value that indicates the interval of time provided for a channel open operation to complete. This value should be greater than or equal to System.TimeSpan.Zero.

    Default value: 00:01:00

    Maximum value: 23:59:59

    Send timeout (hh:mmss)

    Specify a time span value that indicates the interval of time provided for a send operation to complete. This value should be greater than or equal to System.TimeSpan.Zero. If you use a request-response receive port, this value specifies a time span for the whole interaction to complete, even if the client returns a large message.

    Default value: 00:01:00

    Maximum value: 23:59:59

    Close timeout (hh:mmss)

    Specify a time span value that indicates the interval of time provided for a channel close operation to complete. This value should be greater than or equal to System.TimeSpan.Zero.

    Default value: 00:01:00

    Maximum value: 23:59:59

    Maximum received message size (bytes)

    Specify the maximum size, in bytes, for a message including headers, which 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.

    The WCF-BasicHttpRelay adapter leverages the BasicHttpRelayBinding class in the buffered transfer mode to communicate with an endpoint. For the buffered transport mode, the BasicHttpRelayBinding.MaxBufferSize property is always equal to the value of this property.

    Default value: 65536

    Maximum value: 2147483647

    Message encoding

    Specify the encoder used to encode the SOAP message. Valid values include the following:

    • Text: Use a text message encoder.

    • Mtom: Use a Message Transmission Organization Mechanism 1.0 (MTOM) encoder.

    The default is Text.

    Text encoding

    Specify the character set encoding to be used for emitting messages on the binding when the Message encoding property is set to Text. Valid values include the following:

    • utf-16BE (unicodeFFFE): Unicode BigEndian encoding.

    • utf-16: 16-bit encoding.

    • utf-8: 8-bit encoding

    The default is utf-8.

    Max concurrent calls

    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.

    The default is 200.

  7. In the WCF-BasicHttpRelay Transport Properties dialog box, on the Security tab, define the security capabilities of the WCF-BasicHttpRelay receive location.

     

    Use this To do this

    Security mode

    Specify the type of security that is used. Valid values include the following:

    • None: Messages are not secured during transfer.

    • Transport: Security is provided using the HTTPS transport. The SOAP messages are secured using HTTPS. To use this mode, you must set up Secure Sockets Layer (SSL) in Microsoft Internet Information Services (IIS).

    • Message: Security is provided using SOAP message security over the HTTP transport. By default, the SOAP Body is encrypted and signed. The only valid Message client credential type for the WCF-Basic adapter is Certificate. This mode requires the HTTP transport. When using this security mode, the service certificate for this receive location needs to be provided through the Service certificate - Thumbprint property.

    • TransportWithMessageCredential: Integrity, confidentiality, and service authentication are provided by the HTTPS transport. To use this mode, you must set up Secure Sockets Layer (SSL) in Microsoft Internet Information Services (IIS).

    The default is Transport.

    Message client credential type

    Specify the message-level security options only if you set the Security mode above to Message or TransportWithMessageCredential. Valid values include the following:

    • UserName: Enables this receive location to require that clients be authenticated using the UserName credential. You must create the domain or local user accounts corresponding to the client credentials.

    • Certificate: Clients are authenticated to this receive location using the client certificate. The CA certificate chain for the client X.509 certificates must be installed in the Trusted Root Certification Authorities certificate store of this computer so that the clients can be authenticated to this receive location.

    The default is UserName.

    Algorithm suite

    Specify the message encryption and key-wrap algorithms only if you set the Security mode mode above to Message or TransportWithMessageCredential. This is not applicable if you set the Security mode to None or Transport.

    These algorithms map to those specified in the Security Policy Language (WS-SecurityPolicy) specification. Possible values are:

    • Basic128: Use Aes128 encryption, Sha1 for message digest, and Rsa-oaep-mgf1p for key wrap.

    • Basic128Rsa15: Use Aes128 for message encryption, Sha1 for message digest, and Rsa15 for key wrap.

    • Basic128Sha256: Use Aes256 for message encryption, Sha256 for message digest, and Rsa-oaep-mgf1p for key wrap.

    • Basic128Sha256Rsa15: Use Aes128 for message encryption, Sha256 for message digest, and Rsa15 for key wrap.

    • Basic192: Use Aes192 encryption, Sha1 for message digest, and Rsa-oaep-mgf1p for key wrap.

    • Basic192Rsa15: Use Aes192 for message encryption, Sha1 for message digest, and Rsa15 for key wrap.

    • Basic192Sha256: Use Aes192 for message encryption, Sha256 for message digest, and Rsa-oaep-mgf1p for key wrap.

    • Basic192Sha256Rsa15: Use Aes192 for message encryption, Sha256 for message digest, and Rsa15 for key wrap.

    • Basic256: Use Aes256 encryption, Sha1 for message digest, and Rsa-oaep-mgf1p for key wrap.

    • Basic256Rsa15: Use Aes256 for message encryption, Sha1 for message digest, and Rsa15 for key wrap.

    • Basic256Sha256: Use Aes256 for message encryption, Sha256 for message digest, and Rsa-oaep-mgf1p for key wrap.

    • Basic256Sha256Rsa15: Use Aes256 for message encryption, Sha256 for message digest, and Rsa15 for key wrap.

    • TripleDes: Use TripleDes encryption, Sha1 for message digest, Rsa-oaep-mgf1p for key wrap.

    • TripleDesRsa15: Use TripleDes encryption, Sha1 for message digest, and Rsa15 for key wrap.

    • TripleDesSha256: Use TripleDes for message encryption, Sha256 for message digest, and Rsa-oaep-mgf1p for key wrap.

    • TripleDesSha256Rsa15: Use TripleDes for message encryption, Sha256 for message digest, and Rsa15 for key wrap.

    The default value is Basic256.

    Service certificate -Thumbprint

    Specify the thumbprint of the X.509 certificate for this receive location that the clients use to authenticate the service. The thumbprint can be selected by navigating the My store in the Current User location with the Browse button.

    noteNote
    You must set this property only if you set the Security mode mode above to Message or TransportWithMessageCredential. This is not applicable if you set the Security mode to None or Transport.

    noteNote
    You must install the service certificate into the Current User location of the user account for the receive handler hosting this receive location.

    Minimum length: 0

    Maximum length: 40

    The default is an empty string.

    Relay client authentication type

    Specify the option to authenticate with the Service Bus relay endpoint from where the message is received. Valid values include the following:

    • None: No authentication is required.

    • RelayAccessToken: Specify this to use a security token to authorize with the Service Bus Relay endpoint.

    The default value is RelayAccessToken.

    Enable service discovery

    Select this check box to specify whether the behavior of the service is published in the Service Registry.

    Access control service

    If you set the Relay client authentication type to RelayAccessToken, click the Edit button and specify the following details:

    • Access Control Service STS Uri – Set this to https://<Namespace>-sb.accesscontrol.windows.net/, where <namespace> is your Service Bus namespace.

    • Issuer Name – Specify the issuer name. Typically this is set to owner.

    • Issuer Key – Specify the issuer key.

    noteNote
    You can get the values for the Queue URL, ACS URL, issuer name and key from the Windows Azure CTP Management Portal.

  8. In the WCF-BasicHttpRelay Transport Properties dialog box, on the Messages tab, specify the data selection for the SOAP Body element.

     

    Use this To do this

    Envelope -- entire <soap:Envelope>

    Create the BizTalk message body part from the entire SOAP Envelope of an incoming message.

    The default value is cleared.

    Body -- contents of <soap:Body> element

    Use the content of the SOAP Body element of an incoming message to create the BizTalk message body part. If the Body element has more than one child element, only the first element becomes the BizTalk message body part.

    This is the default setting.

    Path -- content located by body path

    Use the body path expression in the Body path expression text box to create the BizTalk message body part. The body path expression is evaluated against the immediate child element of the SOAP Body element of an incoming message.

    The default value is cleared.

    Body path expression

    Type 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 element 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 Path -- content located by body path option is selected.

    Type: String

    Minimum length: 0

    Maximum length: 32767

    The default is an empty string.

    Node encoding

    Specify the type of encoding that the WCF-BasicHttpRelay receive adapter uses to decode the node identified by the body path expression in the Body path expression text box.

    This property is required if the Path -- content located by body path option is selected. Valid values include the following:

    • Base64: Base64 encoding.

    • Hex: Hexadecimal encoding.

    • String: Text encoding - UTF-8

    • XML: The WCF adapters create the BizTalk message body with the outer XML of the node selected by the body path expression in the Body path expression text box.

    The default is XML.

    Body -- BizTalk response message body

    Use the BizTalk message body part to create the content of the SOAP Body element of an outgoing response message. This property is valid only for request-response receive locations.

    This is the default setting.

    Template -- content specified by template

    Use the template supplied in the XML text box to create the content of the SOAP Body element for an outgoing message. This property is valid only for request-response receive locations.

    The default value is cleared.

    XML

    Type the XML-formatted template for the content of the SOAP Body element of an outgoing message. This property is required if the Template -- BizTalk response message body option is selected. This property is valid only for request-response receive locations.

    Type: String

    Minimum length: 0

    Maximum length: 32767

    The default is <bts-msg-body xmlns="http://www.microsoft.com/schemas/bts2007" encoding="xml"/>.

    Suspend request message on failure

    Specify whether to suspend the request message that fails inbound processing due to a receive pipeline failure or a routing failure.

    The default value is cleared.

    Include exception detail in faults

    Specify whether to return SOAP faults when an error occurs to easy debugging.

    The default value is cleared.

  9. Click OK.

  10. Enter the appropriate values in the Receive Location Properties dialog box to complete the configuration of the receive location and click OK to save settings. For information about the Receive Locations Properties dialog box, see How to Create a Receive Location.

See Also

© 2014 Microsoft Corporation. All rights reserved.

Community Additions

ADD
Show:
© 2014 Microsoft