How to Configure the Orders Transport Properties for a Receive Endpoint

  • Article

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

Before you can configure the transport properties for a Commerce Server Orders receive adapter, you must create an appropriate receive port and receive location within the BizTalk Server Administration Console. For information about the aspects of these tasks specific to Commerce Server adapters, see How to Configure a Receive Endpoint for a BizTalk Adapter.

Almost all the configuration properties associated with Commerce Server Orders receive adapter endpoints are configured within the Transport Properties dialog box associated with the receive location you have created for this adapter. This topic explains these properties and how to set them.

To configure the Commerce Server Orders transport properties for a receive location

  1. In the BizTalk Server Administration Console, in the left pane, navigate to your Commerce Server receive location or locations.

    Note

    You may also perform these steps in Microsoft Visual Studio 2005 or Visual Studio 2008.

  2. In the right pane, right-click the appropriate Orders receive location, and then click Properties.

    The Receive Location Properties dialog box opens.

  3. Select the General tab in the left pane. In the Transport box in the right pane, click the Configure button associated with the Type selection (in which you have previously selected Commerce Server Orders).

    The Commerce Server Orders Transport Properties dialog box opens.

  4. In the Commerce Server Orders Transport Properties dialog box, configure the operation of this Orders receive adapter endpoint.

    Note

    By default, when you configure transport properties for Commerce Server adapter endpoints, no Web service calls are made to validate the parameters you specify. However, you can set a key in the registry that will instruct the adapters to perform additional parameter validation that includes several Web service calls. For more information about this registry key, see Endpoint Configuration Validation.

    Transport property

    Description

    Adapter Endpoint Parameters - Incremental Export

    A required Boolean value that determines whether export messages will include only orders objects that have changed since the last execution of this Orders receive adapter endpoint. True specifies that only changed orders objects will be included in export messages.

    The default value is False.

    Adapter Endpoint Parameters - Namespace

    A string that specifies a namespace to be added to export messages generated by this receive adapter endpoint.

    For more information about how this property is used, see Using the Namespace Transport Property.

    Adapter Endpoint Parameters - Order Settling Period

    A required number that specifies the time, in minutes, that a user can change an order before this Orders receive adapter endpoint includes it in an export message.

    The default value is 10.

    Adapter Endpoint Parameters - Orders Per Message

    A drop-down list choice that determines whether each export message will contain a single message, or multiple orders. The possible values are:

    • One Order Per Message. A separate export message will be generated for each order returned by the Commerce Server Orders System.

    • Multiple Orders Per Message. One or more multiple-order export messages will be generated for the orders returned by the Commerce Server Orders System. Each message will contain a number of orders up to the search limit configured in the Web.config file for the Orders Web Service. For example, if the search limit is configured to be 250, 520 orders will be returned in three messages: two messages that contain 250 orders each and a third message that contains the final 20 orders.

    The default value is One Order Per Message.

    Adapter Endpoint Parameters - Registry Subkey

    A required string that is used as a unique subkey within the following registry location:

    HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Commerce Server 2007 BizTalk Adapters\Orders

    This location, ending with the provided subkey, is used by the Commerce Server Orders receive adapter to store information such as the date and time this adapter endpoint was last run and the GUID it uses for tracing.

    Adapter Endpoint Parameters - Filter Clause

    A string that specifies an XML clause used to limit the orders that may be included in export messages.

    The default value is blank, which indicates that no additional filtering of profiles is performed.

    For an example of an XML filter expression that you might use as the value of this property, see Creating Filter Clauses for the Orders and Profiles Adapters.

    Adapter Endpoint Parameters - Status From

    A string that specifies a comma-separated list of order status values. These values are used to filter the orders that are included in the export messages generated by this Orders receive adapter endpoint.

    If order status values are also specified in the Status To property, the values in this property may also be used to determine how the status of these orders will be updated within the Commerce Server Orders System.

    For more information about using this property in conjunction with the Status To property, see Managing Order Status with the Orders Receive Adapter.

    Adapter Endpoint Parameters - Status To

    A string that specifies a comma-separated list of order status values. These values may be used to update the status of the orders that are included in the export message generated by this Orders receive adapter endpoint.

    For more information about using this property in conjunction with the Status From property, see Managing Order Status with the Orders Receive Adapter.

    Connection Information - Web Service URL

    A required string that specifies the URL of the Commerce Server Orders Web Service.

    The default URL of the Orders Web Service is http://hostname/OrdersWebService/OrdersWebService.asmx.

    Connection Information - Connection Timeout

    A number that specifies the Web service time-out duration, in seconds. Use "-1" to specify that there is no time-out duration.

    The default value is 100.

    Connection Information - Proxy Connection Information - Local bypass

    A Boolean value that specifies whether to bypass the proxy server when you use a local address.

    The default value is False.

    Connection Information - Proxy Connection Information - Port

    A string that specifies the port number on the proxy server through which you connect to the Orders Web Service. There is no default value.

    Connection Information - Proxy Connection Information - Proxy Password

    A string that specifies the password to use when logging on to the proxy server.

    Connection Information - Proxy Connection Information - Proxy Server

    A string that specifies the URL of the proxy server, if any. Proxy server URLs must begin with "http://" or "https://".

    Connection Information - Proxy Connection Information - Proxy Username

    A string that specifies the user name to use when logging on to the proxy server.

    Connection Information - Web Service Password

    A string that specifies the password to use when logging on to the Orders Web Service. This property is relevant only when a value is specified for the Web Service Username property.

    Connection Information - Web Service Username.

    A string that specifies the user name to use when logging on to the Orders Web Service. If a name is not specified, BizTalk Server will use the running host instance credentials when logging on to the Orders Web Service.

    For more information about host instances, see the BizTalk Server documentation.

    Fixed Query Interval - Days

    A whole number that is used when you choose Fixed for the InvocationMethod property. This number, when combined with the corresponding numbers for hours and minutes, determines how often this Orders receive adapter endpoint will generate export messages.

    The default value is 0.

    Aa545965.alert_note(en-US,CS.70).gifNote:
    The combined values of the Days, Hours, and Minutes properties must be less than 365 days.

    For more information about specifying the time interval between export operations, see Export Interval Choices for Receive Adapters.

    Fixed Query Interval - Hours

    A whole number that is used when you choose Fixed for the InvocationMethod property. This number, when combined with the corresponding numbers for days and minutes, determines how often this Orders receive adapter endpoint will generate export messages.

    The default value is 0.

    Aa545965.alert_note(en-US,CS.70).gifNote:
    The combined values of the Days, Hours, and Minutes properties must be less than 365 days.

    For more information about specifying the time interval between export operations, see Export Interval Choices for Receive Adapters.

    Fixed Query Interval - Minutes

    A whole number that is used when you choose Fixed for the InvocationMethod property. This number, when combined with the corresponding numbers for days and hours, determines how often this Orders receive adapter endpoint will generate export messages.

    The default value is 10.

    Aa545965.alert_note(en-US,CS.70).gifNote:
    The combined values of the Days, Hours, and Minutes properties must be less than 365 days.

    For more information about specifying the time interval between export operations, see Export Interval Choices for Receive Adapters.

    Invocation Style - Invocation Method

    A drop-down list choice that determines whether this Orders receive adapter endpoint will generate export messages on a fixed interval, or at different intervals based on peak and off-peak hours of the day. The possible values are:

    • Fixed. Specifies that this Orders receive adapter endpoint will generate export messages on the fixed interval specified by the Days, Hours, and Minutes properties in the Fixed Query Interval category.

    • Peak-Off peak Specifies that this Orders receive adapter endpoint will generate export messages according to the intervals specified by the properties in the Peak Hours, Off Peak Hours Query Interval, and Peak Hours Query Interval categories.

    The default value is Fixed.

    For more information about specifying the time interval between export operations, see Export Interval Choices for Receive Adapters.

    Off Peak Hours Query Interval - Off Peak Hours

    A whole number that is used when you choose Peak-Off peak for the InvocationMethod property. This number, when combined with the corresponding number for minutes, determines how often this Orders receive adapter endpoint will generate export messages during off-peak hours.

    The default value is 0.

    Aa545965.alert_note(en-US,CS.70).gifNote:
    The combined values for the Off Peak Hours and Off Peak Minutes properties must be less than the duration of off-peak hours specified by the Begin and End properties.

    For more information about specifying the time interval between export operations, see Export Interval Choices for Receive Adapters.

    Off Peak Hours Query Interval - Off Peak Minutes

    A whole number that is used when you choose Peak-Off peak for the InvocationMethod property. This number, when combined with the corresponding number for hours, determines how often this Orders receive adapter endpoint will generate export messages during off-peak hours.

    The default value is 0.

    Aa545965.alert_note(en-US,CS.70).gifNote:
    The combined values for the Off Peak Hours and Off Peak Minutes properties must be less than the duration of off-peak hours specified by the Begin and End properties.

    For more information about specifying the time interval between export operations, see Export Interval Choices for Receive Adapters.

    Peak Hours - Begin

    A whole number between 0 and 23 that is required when you choose Peak-Off peak for the InvocationMethod property. This number indicates the hour of the day at which peak hours begin.

    The default value is 0.

    Aa545965.alert_note(en-US,CS.70).gifNote:
    The values you choose for the Begin and End properties must be different.

    For more information about specifying the time interval between export operations, see Export Interval Choices for Receive Adapters.

    Peak Hours - End

    A whole number between 0 and 23 that is required when you choose Peak-Off peak for the InvocationMethod property. This number indicates the hour of the day at which peak hours end.

    The default value is 0.

    Aa545965.alert_note(en-US,CS.70).gifNote:
    The values you choose for the Begin and End properties must be different.

    For more information about specifying the time interval between export operations, see Export Interval Choices for Receive Adapters.

    Peak Hours Query Interval - Peak Hours

    A whole number that is used when you choose Peak-Off peak for the InvocationMethod property. This number, when combined with the corresponding number for minutes, determines how often this Orders receive adapter endpoint will generate export messages during peak hours.

    The default value is 0.

    Aa545965.alert_note(en-US,CS.70).gifNote:
    The combined values for the Peak Hours and Peak Minutes properties must be less than the duration of peak hours specified by the Begin and End properties.

    For more information about specifying the time interval between export operations, see Export Interval Choices for Receive Adapters.

    Peak Hours Query Interval - Peak Minutes

    A whole number that is used when you choose Peak-Off peak for the InvocationMethod property. This number, when combined with the corresponding number for hours, determines how often this Orders receive adapter endpoint will generate export messages during peak hours.

    The default value is 0.

    Aa545965.alert_note(en-US,CS.70).gifNote:
    The combined values for the Peak Hours and Peak Minutes properties must be less than the duration of peak hours specified by the Begin and End properties.

    For more information about specifying the time interval between export operations, see Export Interval Choices for Receive Adapters.

    User Defined Context Properties - Site name

    A string that specifies the name of the Web site that this receive adapter supports. There is no default value.

See Also

Other Resources

How to Add a BizTalk Adapter

How to Configure a Receive Endpoint for a BizTalk Adapter

Export Interval Choices for Receive Adapters

Managing Order Status with the Orders Receive Adapter

Creating Filter Clauses for the Orders and Profiles Adapters

Configuring an Orders Adapter Endpoint