This section describes extensions to existing item descriptors in the catalog repository.
Extensions to the Catalog Item Descriptor
Commerce Reference Store extends the catalog
item descriptor with one property called rootNavigationCategory
. The rootNavigationCategory
is of type category
and functions as the root of the navigable category/product tree. The rootNavigationCategory
is a sibling of the NonNavigableProducts
category, which provides a location for organizing products, such as gift wrapping, that are non-navigable (that is, not part of the category tree). Neither the rootNavigationCategory
nor the NonNavigableProducts
category is visible to a website visitor.
Extensions to the Category Item Descriptor
This section describes additions and modifications to the category
item descriptor.
feature and myFeature
Thefeature
andmyFeature
properties work together to ensure that a splash image for a category is always returned.myFeature
contains the splash image for a category, in the form of apromotionalContent
item.feature
is a derived property that looks at themyFeature
property of the current category to find a splash image. If the current category’smyFeature
property is null,feature
looks at thefeature
property of the category’s parent, effectively repeating the process with the parent. That is, it looks at the parent’smyFeature
property and, if the property is null, it proceeds to thefeature
property for the parent’s parent. Using this methodology, a call for a category’s splash image will move up the category tree until it finds a splash image. Note that it is thefeature
property that is used in the Commerce Reference Store JSP code.
A category’s splash image is displayed on the category and subcategory pages, via the
/browse/gadgets/categoryPromotions.jsp
gadget:
Note:
promotionalContent
is a CRS-specific item type. For detailed information, see Custom Item Descriptors in the Catalog Repository.
relatedProducts
relatedProducts
stores a list of items of typeproduct
that represent a set of products in a category. The/browse/gadgets/featuredProducts.jsp
gadget uses therelatedProducts
property to populate the list of featured products on the category page:
The
/navigation/gadgets/catalog.jsp
gadget usesrelatedProducts
to populate the list of featured products that appear in the menu bar:
titleImage
titleImage
stores a title image for the category in the form of amedia
item. This property is implemented on the/browse/gadgets/newItemList.jsp
gadget, which populates the What’s New page with a set of new products, organized by category. Commerce Reference Store sample data, however, does not include title images for categories, so thenewItemList.jsp
page defaults to using header text (Gift Ideas and Women’s Apparel in the illustrations below) instead of images when rendering the categories:
Extensions to the media-internal-text Item Descriptor
Commerce Reference Store extends the media-internal-text
item descriptor with changes that allow these items to be edited in the ATG Control Center. These changes don’t affect how items of this type function in ATG Store.
Extensions to the Product Item Descriptor
This section describes additions and modifications to the product
item descriptor.
asSeenIn
asSeenIn
stores information about the locations where a customer might see a product, such as a magazine article or television show. TheasSeenIn
property is of typeasSeenIn
. The/browse/gadgets/asSeenInElement.jsp
gadget uses this property to populate the As Seen In page in ATG Store:
The
/browse/gadgets/productAsSeenIn.jsp
gadget also uses this property to populate As Seen In information that appears above the color/size picker on the product detail page for certain products:
Note:
asSeenIn
is a CRS-specific item type. For detailed information, see Custom Item Descriptors in the Catalog Repository.
briefDescription
briefDescription
provides a brief description of the product. The/promo/gadgets/promotionalItemRenderer.jsp
gadget uses this property when rendering product information. Several other page fragments, such as/promo/gadgets/homeFeaturedProducts.jsp
, includepromotionalItemRendered.jsp
to display product information in various locations. The following example is from the ATG Store home page:
contents
contents
is a string property that contains information about product contents. The/browse/gadgets/moreDetailsDisplay.jsp
gadget uses this property to display product contents on the product detail page.
emailAFriendEnabled
emailAFriendEnabled
is a Boolean property that controls whether an Email a Friend link appears in the product detail page, under the More Actions menu:
The
/browse/gadgets/productAction.jsp
gadget uses theemailAFriendEnabled
property to determine if the Email To A Friend option should appear.
features
features
is a list property of items of typefeature
. It stores product characteristics (for example, material, color, and so on). Thefeatures.displayName
property is used as a local faceting property. See Faceted Search in the ATG Search Integration chapter for more details.
Note:
feature
is a CRS-specific item type. For detailed information, see Custom Item Descriptors in the Catalog Repository.
new
new
is a Boolean property that indicates whether an item is new or not. This property is manually defined for each product in the Commerce Reference Store sample data. The/browse/gadgets/newItemList.jsp
gadget usesnew
to determine which products to render on the What’s New page:
The best practice approach to identifying new products is to calculate which products are new based on date. Because demonstration data gets stale quickly, Commerce Reference Store can’t use this methodology, so
newItemList.jsp
uses the manually definednew
property instead. Commerce Reference Store also ships with the/browse/gadgets/newProductsList.jsp
gadget, which demonstrates the use of the/atg/store/droplet/NewProductsRQL
servlet bean component. This component is an instance ofatg.projects.store.droplet.RqlDroplet
and it calculates which products are new based on date.
preorderable, preorderEndDate, and useInventoryForPreorder
Commerce Reference Store includes three properties for managing preorderable products:
The
/browse/gadgets/pickerItemId.jsp
gadget uses the/global/gadgets/SkuAvailabilityLookup
component to determine whether a product is preorderable.SkuAvailabilityLookup
, which is an instance ofatg.projects.store.droplet.SkuAvailabilityLookup
, returns an item’s availability status—available, unavailable, backorderable, or preorderable—based on a product’s properties and the inventory levels reported by the/atg/commerce/inventory/InventoryManager
component.SkuAvailabilityLookup
will identify a product as preorderable if the following conditions are met:
Items that are preorderable appear like this on the product detail page:
promoImage
promoImage
stores the product image displayed by the/browse/gadgets/productPromoImg.jsp
gadget on the product comparisons page, in the form of amedia
item:
shippableCountries and nonShippableCountries
shippableCountries
stores a list of countries to which a product may be shipped, whilenonShippableCountries
stores a list of countries to which a product may not be shipped. Use theshippableCountries
property in those instances where it is more efficient to list a small number of countries to which a product may be shipped. By contrast, usenonShippableCountries
when it is more efficient to list a small number of countries to which a product may not be shipped.
The
/atg/store/droplet/ShippingRestrictionsDroplet
servlet component, which is used by a number of Commerce Reference Store gadgets, considers both properties when determining if a shipping address is valid for a particular item:
titleImage
titleImage
stores a title image for the product in the form of amedia
item. The/browse/gadgets/productHeader.jsp
gadget uses this property to populate the product detail page with a title image. Commerce Reference Store sample data, however, does not include title images for products, so theproductHeader.jsp
gadget defaults to using header text (“Boy cut jeans for her” in the illustration below) instead of an image when rendering the product detail page:
Extensions to the SKU Item Descriptor
This section describes additions and modifications to the SKU
item descriptor.
colorSwatch
colorSwatch
holds an image representing one of the color swatches that appears in the color/size picker, in the form of amedia
item.
giftWrapEligible
ThegiftWrapEligible
property is a Boolean that indicates whether an item is eligible for gift wrapping. The/cart/gadgets/giftWrap.jsp
gadget invokes the/atg/store/droplet/ShowGiftWrap
servlet bean component to determine if the gift wrap options should be shown on the shopping cart page. All of the hardgood items in an order (that is, any item that isn’t a gift certificate) must have agiftWrapEligible
value of true for the gift wrap options to be rendered:
taxStatus
ThetaxStatus
property tags items with different product codes that indicate whether a product should be taxed. See Designating Tax Status of Products in the ATG Commerce Programming Guide for details.