Working with the Site Map
Commerce Server 2009 includes 3 site map providers that integrate with WSS and MOSS. The behavior of these site map providers can be configured through attributes on the system.web/siteMap/providers/add element in the web.config file. The site map providers included in Commerce Server 2009 are:
WssStoreSiteMapProvider
SharePointStoreSiteMapProvider
SharePointCombinedSiteMapProvider
WssStoreSiteMapProvider
The following table lists the attributes for the WssStoreSiteMapProvider.
Attribute |
Type |
Description |
Default value |
|---|---|---|---|
StartCSNode |
String |
Gets or sets the name (not description) of the Commerce Server 2009 Catalog System category from which to start retrieval of the site map data. This node is included in the resulting site map used in Microsoft Windows SharePoint Services (WSS). |
n/a |
RecycleTime |
Int |
Gets or sets the number of minutes between “flushes” of the node cache for this site map provider. The cache is flushed on an interval specified by RecycleTime, which means that the next request for site map data performs a call to Commerce Server 2009 and a subsequent re-cache of the resulting node data. |
0 (never expires) |
DefaultCategoryPage |
String |
Gets or sets the URL of the default page to use for the display of categories. |
/Category.aspx |
DefaultProductPage |
String |
Gets or sets the URL of the default page being used for the display of product details. |
/Product.aspx |
CategoryPageProperty |
String |
Gets or sets the name of the Commerce Server 2009 custom property optionally specified on a per-category basis to allow for special category pages to be used for certain categories |
n/a |
CategoryUrlKey |
String |
Gets or sets the name of the URL key used to specify the category name on URLs emitted by the site map provider. |
category |
ProductPageProperty |
String |
Gets or sets the name of the Commerce Server 2009 custom property optionally specified on a per-category basis to allow for special product pages to be used for certain categories. |
n/a |
ProductUrlKey |
String |
Gets or sets the name of the URL key used to specify the product id on URLs emitted by the site map provider. |
id |
CatalogURLKey |
String |
Gets or sets the name of the URL key used to specify the catalog id on URLs emitted by the site map provider. |
cat |
SiteMapDepth |
Int |
Gets or sets the number of ancestors of the current node that will be displayed by the site map. For example, if the value is 2, the current node's children and grandchildren will be displayed. |
2 |
EnableUrlRewriting |
Boolean |
Gets or sets a value indicating whether URLs rendered by the site map provider should be rewritten. |
false |
RootNodeTitle |
String |
Gets or sets the title of the root node of the generated site map. |
n/a |
RootNodeDescription |
String |
Gets or sets the description of the root node of the generated site map. |
n/a |
RootNodePath |
String |
Gets or sets the URL exposed by the root node of the generated site map. |
n/a |
PathProperty |
String |
Gets or sets a value which is included after the root of the site but before the page name. |
n/a |
SharePointStoreSiteMapProvider
The following table lists the attributes for the SharePointStoreSiteMapProvider.
Attribute |
Type |
Description |
Default value |
|---|---|---|---|
StartCSNode |
String |
Gets or sets the name (not description) of the Commerce Server 2009 Catalog System category from which to start retrieval of the site map data. This node is included in the resulting site map used in Microsoft Office SharePoint Server (MOSS). |
n/a |
RecycleTime |
Int |
Gets or sets the number of minutes between “flushes” of the node cache for this site map provider. The cache is flushed on an interval specified by RecycleTime, which means that the next request for site map data performs a call to Commerce Server 2009 and a subsequent re-cache of the resulting node data. |
0 (never expires) |
DefaultCategoryPage |
String |
Gets or sets the URL of the default page to use for the display of categories. |
/Category.aspx |
DefaultProductPage |
String |
Gets or sets the URL of the default page being used for the display of product details. |
/Product.aspx |
CategoryPageProperty |
String |
Gets or sets the name of the Commerce Server 2009 custom property optionally specified on a per-category basis to allow for special category pages to be used for certain categories. |
n/a |
CategoryUrlKey |
String |
Gets or sets the name of the URL key used to specify the category name on URLs emitted by the site map provider. |
category |
ProductPageProperty |
String |
Gets or sets the name of the Commerce Server 2009 custom property optionally specified on a per-category basis to allow for special product pages to be used for certain categories. |
n/a |
ProductUrlKey |
String |
Gets or sets the name of the URL key used to specify the product id on URLs emitted by the site map provider. |
id |
CatalogURLKey |
String |
Gets or sets the name of the URL key used to specify the catalog id on URLs emitted by the site map provider. |
cat |
SiteMapDepth |
Int |
Gets or sets the number of ancestors of the current node that will be displayed by the site map. For example, if the value is 2, the current node's children and grandchildren will be displayed. |
2 |
EnableUrlRewriting |
Boolean |
Gets or sets a value indicating whether URLs rendered by the site map provider should be rewritten. |
false |
CategoryInPages |
Boolean |
Gets or sets a value indicating whether the page referenced in DefaultCategoryURL is located in the Pages document library of the site. |
true |
ProductInPages |
Boolean |
Gets or sets a value indicating whether the page referenced in DefaultProductURL is located in the Pages document library of the site. |
true |
SharePointCombinedSiteMapProvider
The following table lists the attributes for the SharePointCombinedSiteMapProvider.
Attribute |
Type |
Description |
Default value |
|---|---|---|---|
StartCSNode |
String |
Gets or sets the name (not description) of the Commerce Server 2009 Catalog System category from which to start retrieval of the site map data. This node is included in the resulting site map used in Microsoft Office SharePoint Server (MOSS). |
n/a |
RecycleTime |
Int |
Gets or sets the number of minutes between “flushes” of the node cache for this site map provider. The cache is flushed on an interval specified by RecycleTime, which means that the next request for site map data performs a call to Commerce Server 2009 and a subsequent re-cache of the resulting node data. |
0 (never expires) |
DefaultCategoryPage |
String |
Gets or sets the URL of the default page to use for the display of categories. |
/Category.aspx |
DefaultProductPage |
String |
Gets or sets the URL of the default page being used for the display of product details. |
/Product.aspx |
CategoryPageProperty |
String |
Gets or sets the name of the Commerce Server 2009 custom property optionally specified on a per-category basis to allow for special category pages to be used for certain categories. |
n/a |
CategoryUrlKey |
String |
Gets or sets the name of the URL key used to specify the category name on URLs emitted by the site map provider. |
category |
ProductPageProperty |
String |
Gets or sets the name of the Commerce Server 2009 custom property optionally specified on a per-category basis to allow for special product pages to be used for certain categories. |
n/a |
ProductUrlKey |
String |
Gets or sets the name of the URL key used to specify the product id on URLs emitted by the site map provider. |
id |
CatalogURLKey |
String |
Gets or sets the name of the URL key used to specify the catalog id on URLs emitted by the site map provider. |
cat |
SiteMapDepth |
Int |
Gets or sets the number of ancestors of the current node that will be displayed by the site map. For example, if the value is 2, the current node's children and grandchildren will be displayed. |
2 |
EnableUrlRewriting |
Boolean |
Gets or sets a value indicating whether URLs rendered by the site map provider should be rewritten. |
false |
CategoryInPages |
Boolean |
Gets or sets a value indicating whether the page referenced in DefaultCategoryURL is located in the Pages document library of the site. |
true |
ProductInPages |
Boolean |
Gets or sets a value indicating whether the page referenced in DefaultProductURL is located in the Pages document library of the site. |
true |
InjectionPoint |
Int |
Gets or sets the zero based index in the unadorned Microsoft Office SharePoint Server (MOSS) site map at which to place the Commerce Server 2009 catalog tree. If the index is greater than the number of Microsoft Office SharePoint Server (MOSS) nodes, the tree is injected at the end of the Microsoft Office SharePoint Server (MOSS) site map. |
0 |
InjectionMode |
Enum |
Gets or sets the mode. Singleton mode injects the Commerce Server 2009 catalog tree underneath the root node for the site. Variation mode performs site map injection for each sub site which does not inherit navigation from the parent. This is used to place localized copies of the Commerce Server 2009 catalog tree under Microsoft Office SharePoint Server (MOSS) Variation sites. Both mode performs injection in both Singleton and Variation mode. |
Both |