Custom Item Descriptors in the Catalog Repository

Commerce Reference Store adds the following item descriptors to the catalog repository:

asSeenIn

clothing-sku

features

furniture-sku

promotionalContent

This section describes the Commerce Reference Store-specific item types and their key properties. For a complete list of item type properties, use the Component Browser in the Dynamo Server Admin.

asSeenIn Item Descriptor

The asSeenIn item type stores information about the location where a product may have been seen by a customer, such as a magazine article or a television show. The asSeenin product property is of type asSeenIn and it has the properties described in the table below.

Property

Description

date

The date the product appeared in a publication, on a television show, etc.

description

A description of the product’s appearance.

displayName

A name for the asSeenIn item. This name appears in the Business Control Center and may also be used on a Web site to identify the item.

id

A unique ID for the asSeenIn item.

source

A string that stores the source of the product appearance, for example, a publication, a television show, etc.

clothing-sku Item Descriptor

The clothing-sku item type is a sub-type of the sku item type and it adds properties that are appropriate for clothing items, as described in the table below.

Property

Description

color

color is a string property that represents an item’s color. It is used in several ways:

- By the store.war/global/util/displaySkuProperties.jsp gadget to render the wood finish of an item on the shopping cart page.

feature Item Descriptor

The feature item type stores information about a specific product feature, such as type of fabric or material. The features product property is list of items of type feature and it has the properties described in the table below.

Property

Description

description

A short description of the feature item.

displayName

A name for the feature item that appears in the Business Control Center.

featureName

A string that identifies the feature item and may be used on a Web site to identify the item.

id

A unique ID for the feature item.

largeImagesmallImage

Properties of type media that allow you to associate various images with the feature item.

longDescription

A long description of the feature item.

promotionalContent Item Descriptor

The promotionalContent item type provides information about a pricing promotion or marketing campaign on ATG Store. It allows a merchant to consolidate any number of possible marketing tools into a single item: image, text, a link to a product or category, and a pricing promotion. This gives the merchant flexibility for the type of content that can be populated in a slot on a page, or be referenced from a category or product. Note that promotionalContent items are informational only. The actual granting of pricing promotions is handled by other mechanisms.

For the purposes of Commerce Reference Store, a promotionalContent item is essentially an image, sometimes with supporting text. This illustration shows two examples of promotionalContent items:

The table below describes the promotionalContent properties:

Property

Description

associatedCategory

An associated category for the promotionalContent item. The store.war/WEB-INF/tags/store/promotionalContentWrapper.tag uses this property to render a link that takes a customer to a category page that is appropriate for the promotion.

associatedProduct

An associated product for the promotionalContent item. The store.war/WEB-INF/tags/store/promotionalContentWrapper.tag uses this property to render a link that the customer can click to view a product detail page that is appropriate for the promotion.

associatedSite

An associated site for the promotionalContent item. The store.war/WEB-INF/tags/store/promotionalContentWrapper.tag uses this property to render a link that the customer can click to go from the promotion to the home page for the associated site.

creationDate

A timestamp for the date and time that the promotionalContent item was created. Defaults to the current date and time at the time of creation.

description

A short description of the promotionalContent item.

displayName

A name for the promotionalContent item.

id

A unique ID for the promotionalContent item.

image, derivedImage

The image and derivedImage properties work together to derive a URL for an image that represents the promotionalContent item.

The image property contains a URL to an image. Commerce Reference Store uses URLs that contain {site} and {language} variables that provide the foundation for deriving a site-specific URL for the image. For example:

A JSP reference to the derivedImage property calls the atg.projects.store.dp.StoreContextDerivation class and passes it the value of the image property. StoreContextDerivation derives the URL by replacing the {site} and {language} variables in the image property value with the current site’s site ID and language. For example, the image property value above could result in a URL similar to the following: