The following table describes the category item properties in the catalog.

Property

How it is set

Description

ancestorCategories

CMS/CCS

All the categories that can be used to navigate to this category (through category.childCategories), regardless of catalog. (category.childCategories is a combination of fixedChildCategories and subCatalogsChildCategories).

ancestorCategoryIds

Implicitly set by CMS and CCS

RepositoryIDs of the ancestor categories. Read-only. Uses same database table as ancestorCategories.

auxiliaryMedia

ACC

Additional media to be displayed with this category.

catalog

Derived in development mode

Set by CMS in production mode.

The catalog that owns this category.

This property is no longer used, but remains available for backward compatibility.

catalogs

CCS

All the catalogs that include some path to this category; this property is used to determine whether an end user has permission to view this category.

categoryInfos

ACC (optional)

Map from catalogId to a categoryInfo.,

childCategories

Derived

List of all categories that are children of this category; a merge of fixedChildCategories, dynamicChildCategories, and subCatalogsChildCategories. Read-only.

childCategoryGroup

ACC

Name of the content group that contains the list of dynamicChildCategories.

childProductGroup

ACC

Name of the content group that contains the list of dynamicChildProducts.

childProducts

ACC

List of all products that are children of this category; a merge of fixedChildProducts and dynamicChildProducts. Read-only.

creationDate

Implicitly set by GSA

Date this category was created. Read-only.

defaultParentCategory

CCS

This field is no longer actively used. The parentCategory derivation uses this value if the parentCategoriesForCatalogMap does not provide a value.

description

ACC

Short descriptive text for display with this category.

displayName

ACC

Name used for the category on the site. Required.

dynamicChildCategories

Derived

List of the categories in the content group specified by the childCategoryGroup property. Read-only.

dynamicChildProducts

Derived

List of the products in the content group specified by the childProductGroup property. Read-only.

dynamicRelatedCategories

Derived

List of the categories in the content group specified by the relatedCategoryGroup property. Read-only.

endDate

ACC

Date this category will no longer be available, if a collection filter is implemented to use this property. See the ATG Personalization Programming Guide for information on filtering.

fixedChildCategories

ACC

List of child categories of this category. Used by catalog administrator to explicitly set the descendant categories of a category.

fixedChildProducts

ACC

List of child products of this category. Used by catalog administrator to explicitly set the descendant products of a category.

fixedRelatedCategories

ACC

Static list of categories related to this category.

id

ACC or GSA

RepositoryID for this category. If this property is not set through the ACC during creation, it is implicitly set by GSA.

keywords

ACC

Set of words that can be used in searching for this category.

largeImage

ACC

Large image associated with the category.

longDescription

ACC

Detailed descriptive text for display with this category.

parentCatalog

CCS

The parent catalog of this category. Only holds a value if the catalog is a rootCategory of the given catalog. This is used in the ParentCatalog derivation.

This property is no longer used, but remains available for backward compatibility.

parentCatalogs

Reference to catalog.rootCategories

The set of all catalogs that have this category as a root category.

parentCategory

Derived

The parent category of this category. Derived from parentCategoryForCatalog; if that is null, derived from defaultParentCategory.

parentCategoriesForCatalog

CMS or ACC

The parent category for each non-root category. There can be more than possible parent category, in which case the CMS selects one arbitrarily. This is used to derive the value in the parentCategory property.

parentCategoryForCatalog

Derived

The parent category in the context of the current catalog. Calculated from the parentCategoriesForCatalog map.

relatedCategories

Derived

List of all categories that are children of this category; this represents a merge of fixedRelatedCategories, dynamicRelatedCategories, and the categoryInfo property catalogsRelatedCategories. Read-only.

relatedCategoryGroup

ACC

Name of the content group that contains the list of categories that dynamicRelatedCategories is set to.

siteIds

CMS on production server; CCS on asset management server

If you are using Oracle ATG Web Commerce’s multisite feature, the IDs of those sites to which the category belongs.

smallImage

ACC

Small image associated with the category.

startDate

ACC

Date this category becomes available, if a collection filter is implemented to use this property.

subCatalogs

ACC

List of catalogs whose root categories will be considered child categories of this category. Used by catalog admin to explicitly set direct descendant catalogs of a category.

subCatalogsChildCategories

Derived

The Collective Union of the allRootCategories of each catalog in subCatalogs. Used to compile the childCategories property, which includes the complete list of all descendant categories of a category.

template

ACC

JSP used to display this category.

thumbnailImage

ACC

Thumbnail image associated with this category.

type

N/A

Provided for subclassing purposes; use to indicate if an item belongs to the superclass or a subclass. Read-only.

version

Implicitly set by GSA

Integer that is incremented automatically each time the category is updated; used to prevent version conflict.


Copyright © 1997, 2012 Oracle and/or its affiliates. All rights reserved.

Legal Notices