catalogWebService Element

  • Article

The catalogWebService element lets you configure the behavior of the Catalog Web service. This element is required, and should be used only in the Web.config file for the Catalog Web Service (<drive>:\Inetpub\wwwroot\CatalogWebService\Web.config).

Note

The server does not apply any changes that you make to this element until you restart the Web application by using IISReset.

This element has one child element: the cache element.

The following table lists and describes the attributes of the catalogWebService element.

Attribute

Data Type

Description

authorizationPolicyPath

String

The path of the authorization policy file. This path can be a fully specified path or a relative path. If you do not specify a full path, it will be relative to the physical directory of the Catalog Web service.

This attribute is optional.

debugLevel

String

The debug level, or mode, of the site. Valid values are Checked, Debug, or Production:

  • Checked mode is a flag for intensive runtime checks. Checked mode is a superset of Debug mode. You should run a new site in Checked mode before you deploy it into production.

  • Debug mode generates debug trace messages that may help in troubleshooting a Commerce Server site when the site is live in production. This mode forgoes the more intensive checks performed in Checked mode.

  • Production mode has no special checks. It traces only operation messages.

Other components can use this attribute to determine how to handle exceptions. The default value is "Production".

This attribute is required.

disableAuthorization

String

Determines whether the Catalog system performs authorization checks. You can set the value of this attribute to enable or disable authorization for this site.

If the value of this attribute is set to true, the application will not perform authorization checks and all methods are enabled, except for GetAuthorizedTasks, which cannot function without a policy. If false, authorization is not performed.

This attribute is optional.

enableInventorySystem

String

Specifies whether to enable the Inventory System integration. This value is true if the Inventory System is enabled; otherwise false.

This attribute is required.

fileUploadDirectory

String

The fully specified local path of the target folder for uploaded files.

This attribute is optional.

maxChunkSize

String

The size, in kilobytes, of the maximum chunk size. You use this property in import and validation steps. This value must be smaller than the value of the maxRequestLength attribute, which is set within the httpRuntimeelement in your Web.config file.

The value of this attribute must represent an integer. The default value is 1024 kilobytes (1 MB).

This attribute is optional.

maxSearchResults

String

Specifies the maximum number of search results that will be displayed.

The valid range of values of this attribute is 1 to 2,147,483,647. A value of 0 specifies no maximum limit. If this attribute is not specified, no maximum limit will be set.

The value of this attribute must represent an integer.

This attribute is optional.

maxUploadFileSize

String

The maximum size, in kilobytes, of uploaded files.

If the value of this attribute is 0, there is no limit to the maximum file size. The value of this attribute must represent an integer. The default value of this attribute is 204,800.

This attribute is optional.

siteName

String

The site name.

This attribute is required.

timeOutHours

String

The maximum period of time, in hours, before the system automatically cleans up import or validation temporary files.

The value of this attribute must represent an integer.

This attribute is optional.

Note

You must specify a value for authorizationPolicyPath if disableAuthorization is set to false. If disableAuthorization is set to true, the system ignores authorizationPolicyPath.

Note

Setting the value of the disableAuthorization attribute to true grants all authenticated users full access to the server.

Note

Setting the value of the maxSearchResults attribute to 0 or not specifying the attribute may consume large amounts of server memory and severely affect performance if very many search results are returned. A typical configuration for development would be to have debugLevel set to Checked together with Debug set to True, whereas for a deployment configuration debugLevel is set to Production and Debug to False.

cache Element

The cache element describes the cache configuration parameters. The Catalog System caches the results of various methods in the Catalog System in the form of datasets. You can specify the time that a dataset remains in the cache. To do this you use the six different time-out values that are attributes of the cache element. For more information about caching in the Catalog System, see Caching in the Catalog System.

This element is optional. If it is not specified, the default value is false and caching is not enabled. The default value for all time-out values is 10 minutes. The minimum value is 0. The maximum value is the maximum integer value.

The following table lists and describes the attributes of the cache element.

Attribute

Data Type

Description

enable

String

This value is true if caching is enabled; otherwise false. The default value is false.

catalogCollectionCacheTimeout

String

Specifies how long the following datasets remain in the cache.

itemAssociationsCacheTimeout

String

Specifies the time-out for datasets that contain information about associations between objects. This time-out applies to the following methods and properties.

itemHierarchyCacheTimeout

String

Specifies the time-out for datasets that contain information about parent/child hierarchies between categories and products. This time-out applies to the following methods and properties.

itemInformationCacheTimeout

String

Specifies the time-out for datasets returned by the Information property. This time-out applies to the datasets returned by the following properties and methods.

This time-out also applies to the product information that is stored by the QueryCatalogInfo pipeline component. If inventory integration is enabled the inventory information is also cached.

itemRelationshipsCacheTimeout

String

Specifies the time-out for datasets that contain information about catalog relationships. This time-out applies to the following properties.

schemaTimeout

String

Specifies the time-out for datasets that return schema information. Setting this time-out to a high value can result in improved performance because the schema is unlikely to change after it has been defined.

This time-out applies to the datasets returned by the following properties and methods.

joinTable tablename

joinTable joins two tables together. The tables to be joined are specified in the subelements, one for each table:

<joinTable>

<joinTable> joinTable_A</joinTable>

<joinTable> joinTable_B</joinTable>

</joinTable>

Example

  <catalogWebService
    siteName="CSharpSite"
    disableAuthorization = "true"
    authorizationPolicyPath="CatalogAuthorizationStore.xml"
    debugLevel="Production"
    fileUploadDirectory="%windir%\temp"
    maxChunkSize="1024"
    maxUploadFileSize="204800"
    timeOutHours="24"
    enableInventorySystem = "true"
    <cache enable = "true"
      schemaTimeout="5" 
      itemInformationCacheTimeout="5" 
      itemHierarchyCacheTimeout="5" 
      itemRelationshipsCacheTimeout="5" 
      itemAssociationsCacheTimeout="5" 
      catalogCollectionCacheTimeout="5"/>
  />

See Also

Other Resources

Web.Config Configuration Settings