How to Configure the Catalog 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 Catalog 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 Catalog 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 Catalog 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 Catalog 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 Catalog).

    The Commerce Server Catalog Transport Properties dialog box opens.

  4. In the Commerce Server Catalog Transport Properties dialog box, configure the operation of this Catalog 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 - Export Deleted Objects

    A required Boolean value that determines whether deleted objects will be included in export messages, with True specifying inclusion.

    The default value is False.

    Adapter Endpoint Parameters - Export Dependent Base Catalogs

    A required Boolean value that determines whether dependent catalogs for virtual catalogs will be included in export messages, with True specifying inclusion.

    The default value is False.

    Adapter Endpoint Parameters - Export Mode

    A drop-down list choice that determines whether export messages will contain a full export of catalog data, or only a partial export of catalog data based on the expression provided in the Products and Categories Clause property. The possible values are:

    • Full Export. Export messages will include all catalog objects.

    • Expression Based. Export messages will include catalog objects that match the criteria specified by the Products and Categories Clause property and that conform to the setting of the Incremental Export property.

    The default value is: Full Export

    Adapter Endpoint Parameters - Export Nulls

    A required Boolean value that determines whether null values will be included in export messages, with True specifying inclusion.

    The default value is False.

    Adapter Endpoint Parameters - Export Schema

    A drop-down list choice that determines whether schema information will be included in export messages. The possible values are:

    • All Schema. All Catalog System schemas are included in export messages.

    • No Schema. No Catalog System schemas are included in export messages.

    • Relevant Schema. Only the relevant Catalog System schemas are included in export messages.

    The default value is All Schema.

    Adapter Endpoint Parameters - Export Virtual as Virtual

    A required Boolean value that determines whether virtual catalogs will be included in export messages, with True specifying inclusion.

    The default value is False.

    Adapter Endpoint Parameters - Format Type

    A drop-down list choice that determines whether the format of export messages will be in attribute-centric format or XSD format. The possible values are:

    • Attribute Centric. Export messages will be in the attribute-centric format.

    • Xsd. Export messages will be in the XSD format and will consist of the catalog definition only. No products or catalogs will be included in the export message.

    The default value is Attribute Centric.

    Adapter Endpoint Parameters - Incremental Export

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

    This setting of this property is relevant only if the Export Mode property is set to Expression Based.

    The default value is False.

    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\Catalog

    This location, ending with the provided subkey, is used by the Commerce Server Catalog 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 - Catalog Sets to Export

    A string that specifies a comma-separated list of catalog sets to be included in the export messages. The default value is blank, which indicates that all catalog sets should be included.

    Adapter Endpoint Parameters - Export Descendants

    A drop-down list choice that determines the extent to which the descendants of catalog objects included in export messages will also be included. This property is relevant only when Expression Based is chosen for the Export Mode property. The possible values are:

    • All Descendants. Specifies that all descendants of included catalog objects should also be included in export messages.

    • Immediate Children. Specifies that the immediate child objects of included catalog objects should also be included in export messages.

    • No Descendants. Specifies that no descendants of included catalog objects should be included in export messages.

    The default value is No Descendants.

    Adapter Endpoint Parameters - Filter Descendants Clause

    A string that is relevant only if you choose Immediate Children or All Descendants for the Export Descendants property. Any filter clause specified in this property is used to further limit the inclusion of any descendants of included catalog objects in export messages.

    An example of the format expected in this property is:

    INV.quantity > 0 and CTLG.cy_list_price>9.99
    Aa545419.alert_note(en-US,CS.70).gifNote:
    If you include date/time values in the filter clause, you must specify such values in the correct time zone for the Commerce Server Catalog system to which the filter applies.

    The default value is blank, which indicates that no further filtering of any included descendants is performed.

    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 - Product Catalogs

    A string that specifies a comma-separated list of product catalogs to include in export messages. The default value is blank, which indicates that all catalogs in the Commerce Server Catalog System should be included.

    Adapter Endpoint Parameters - Products and Categories Clause

    A string that is required if you choose Expression Based for the Export Mode property. The filter clause specified in this property will be used to limit the inclusion of catalog objects in export messages.

    An example of the format expected in this property is:

    CTLG.CategoryName IN (‘Category1’) OR (INV.quantity > 0 and CTLG.cy_list_price>9.99)
    Aa545419.alert_note(en-US,CS.70).gifNote:
    If you include date/time values in the filter clause, you must specify such values in the correct time zone for the Commerce Server Catalog system to which the filter applies.
    Aa545419.alert_note(en-US,CS.70).gifNote:
    For inventory catalogs, the expression that you provide for this property will apply to product catalogs that are a part of the inventory catalog that is being exported.

    Adapter Endpoint Parameters - Properties to Export

    A string that specifies a list of comma-separated property names, which indicate the properties to be included in export messages. The default value is blank, which indicates that all properties should be included in export messages.

    Connection Information - Web Service URL

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

    The default URL of the Catalog Web Service is http://hostname/CatalogWebService/CatalogWebService.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 Catalog 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 Catalog 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 Catalog Web Service. If a name is not specified, BizTalk Server will use the running host instance credentials when logging on to the Catalog 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 Invocation Method property. This number, when combined with the corresponding numbers for hours and minutes, determines how often this Catalog receive adapter endpoint will generate export messages.

    The default value is 0.

    Aa545419.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 Invocation Method property. This number, when combined with the corresponding numbers for days and minutes, determines how often this Catalog receive adapter endpoint will generate export messages.

    The default value is 0.

    Aa545419.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 Invocation Method property. This number, when combined with the corresponding numbers for days and hours, determines how often this Catalog receive adapter endpoint will generate export messages.

    The default value is 10.

    Aa545419.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 Catalog 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 Catalog 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 Catalog 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 Invocation Method property. This number, when combined with the corresponding number for minutes, determines how often this Catalog receive adapter endpoint will generate export messages during off-peak hours.

    The default value is 0.

    Aa545419.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 Invocation Method property. This number, when combined with the corresponding number for hours, determines how often this Catalog receive adapter endpoint will generate export messages during off-peak hours.

    The default value is 0.

    Aa545419.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 Invocation Method property. This number indicates the hour of the day at which peak hours begin.

    The default value is 0.

    Aa545419.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 Invocation Method property. This number indicates the hour of the day at which peak hours end.

    The default value is 0.

    Aa545419.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 Invocation Method property. This number, when combined with the corresponding number for minutes, determines how often this Catalog receive adapter endpoint will generate export messages during peak hours.

    The default value is 0.

    Aa545419.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 Invocation Method property. This number, when combined with the corresponding number for hours, determines how often this Catalog receive adapter endpoint will generate export messages during peak hours.

    The default value is 0.

    Aa545419.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

Configuring a Catalog Adapter Endpoint