The following describes key properties of the atg.commerce.endeca.index.dimension.CategoryTreeService class and the default configuration of the /atg/commerce/endeca/index/CategoryTreeService component of this class:

catalogTools

The component of class atg.commerce.catalog.custom.CustomCatalogTools for accessing the catalog repository. By default, this property is set to:

catalogTools=/atg/commerce/catalog/CatalogTools

excludedCategoryIds

A list of the IDs of categories that dimension values should not be created for. For example, Commerce Reference Store has root categories that are not displayed on the site and therefore should not be represented by dimension values. Commerce Reference Store excludes these categories by setting excludedCategoryIds to:

excludedCategoryIds=rootCategory,homeStoreRootCategory

excludedItemsCategoryIds

A list of the IDs of the categories whose child products and skus are excluded from indexing. As with the categories specified in the excludedCategoryIds property, no dimension values are created for the categories specified in excludedItemsCategoryIds.

By default, the excludedItemsCategoryIds property of CategoryTreeService is configured to get its value from the excludedItemsAncestorIds property of the ProductCatalogOutputConfig component:

excludedItemsCategoryIds^=\
/atg/commerce/search/ProductCatalogOutputConfig.excludedItemsAncestorIds

sitesForCatalogs

To create a representation of the category hierarchy in which each category dimension value has only one parent, the CategoryTreeService class creates data structures in memory that represent all possible paths to each category in the product catalog. In order to do this, it must be provided with a list of the catalogs to use for computing paths.

The sitesForCatalogs property specifies a list of sites. If this property is set, CategoryTreeService uses the catalogs associated with the specified sites for computing paths. By default, sitesForCatalogs is set to:

sitesForCatalogs^=\
  /atg/commerce/search/ProductCatalogOutputConfig.sitesToIndex

If sitesForCatalogs is null, CategoryTreeService uses the rootCatalogsRQLString property to determine the catalogs.

rootCatalogsRQLString

An RQL query that returns a list of catalogs. If sitesForCatalogs is null, the catalogs returned from this query are used. The query is set by default to:

rootCatalogsRQLString=\
  directParentCatalogs IS NULL AND parentCategories IS NULL

If sitesForCatalogs and rootCatalogsRQLString are both null, CategoryTreeService uses the rootCatalogIds property to determine the catalogs.

rootCatalogIds

An explicit list of catalog IDs of the catalogs to use. This list is used if sitesForCatalogs and rootCatalogsRQLString are both null. By default, rootCatalogIds is set to null.