Catalog: CatalogNavigationView Noun

Catalog: CatalogNavigationView Noun

The CatalogNavigationView noun was created to represent all of the information required to make use of faceted navigation (from a search engine) when a shopper is browsing catalog pages for a store model (Aurora, Madisons, Elite) that is provided by default.

The noun defines the categories and catalog entries for display in the store and defines the prices, attachments, merchandising associations, and other properties that are relevant to display for the catalog entries.

The noun also defines the properties that are relevant to searching, such as facets, the breadcrumb trail, and some debugging information.

BOD Summary
Access Profile and Expression Builder columns are for Get BOD only.

BOD Action Code / Access Profile Action Expression Service Provided Sample XML Message Client Library / Expression Builder
GetCatalogNavigationView All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogNavigationView Returns the catalog navigation view for a page in the store. Request
Response

getCatalogNavigationView getCatalogNavigationViewByCategory getCatalogNavigationAttachmentView getWebContentView
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogNavigationView[CatalogEntryView[(UniqueID=$uniqueId$)]] Get catalog navigation view for a catalog entry by unique id(s).
Returns the catalog navigation view for the given unique id(s). Request
Response

getCatalogEntryViewSummaryByID getCatalogEntryViewDetailsByID getCatalogEntryViewAttachmentsByID getCatalogEntryViewDetailsWithAttachmentsByID getCatalogEntryViewDetailsWithComponentsAndAttachmentsByID getCatalogEntryViewDetailsWithMerchandisingAssociationsByID getCatalogEntryViewAllByID getCatalogEntryViewPriceByID getCatalogEntryViewPriceWithAttributesByID
All access profiles listed in the 'Access Profile' section can be applied to this expression. /CatalogNavigationView[CatalogEntryView[(PartNumber=$partNumber$)]] Get catalog navigation view for a catalog entry by part number(s).
Returns the catalog navigation view for the given part number(s). Request
Response

getCatalogEntryViewSummaryByPartnumber getCatalogEntryViewDetailsByPartnumber getCatalogEntryViewAttachmentsByPartnumber getCatalogEntryViewDetailsWithAttachmentsByPartnumber getCatalogEntryViewDetailsWithComponentsAndAttachmentsByPartnumber getCatalogEntryViewDetailsWithMerchandisingAssociationsByPartnumber getCatalogEntryViewAllByPartnumber getCatalogEntryViewPriceByPartnumber getCatalogEntryViewPriceWithAttributesByPartnumber
IBM_Store_All profile that is listed in the 'Access Profile' section can be applied to this expression. /CatalogNavigationView[CatalogEntryView[(UniqueID=)]/MerchandisingAssociations[(AssociationType=)]] Gets the catalog navigation view for a catalog entry by the catalog entry unique ID and returns the merchandising associations for the catalog entry that match specific merchandising association types. Request
Response

getCatalogEntryViewWithSpecifiedAssociationsByID
IBM_Store_Summary and IBM_Store_Details listed in the 'Access Profile' section can be applied to this expression. /CatalogNavigationView[CatalogGroupView[(UniqueID=$uniqueId$)]] Get catalog navigation view for a catalog group by unique id(s).
Returns the catalog navigation view for the given unique id(s). Request
Response

getCatalogNavigationCatalogGroupView
IBM_Store_Summary and IBM_Store_Details listed in the 'Access Profile' section can be applied to this expression. /CatalogNavigationView[CatalogGroupView[(Identifier=$identifier$)]] Get catalog navigation view for a catalog group by identifier.
Returns the catalog navigation view for the given identifier. Request
Response

getCatalogNavigationCatalogGroupViewByIdentifier
IBM_Store_Summary and IBM_Store_Details listed in the 'Access Profile' section can be applied to this expression. /CatalogNavigationView/CatalogGroupView Get catalog navigation view for the top catalog groups of the current catalog.
Returns the catalog navigation view for the current catalog. Request
Response

getCatalogNavigationCatalogGroupViewByCatalogId
IBM_Store_Summary and IBM_Store_Details listed in the 'Access Profile' section can be applied to this expression. /CatalogNavigationView[CatalogGroupView[(ParentCatalogGroupID=$parentCatalogGroupId$)]] Get catalog navigation view for catalog groups by parent catalog group unique id.
Returns the catalog navigation view for the given parent catalog group unique id. Request
Response

getCatalogNavigationCatalogGroupViewByParentCatalogGroup

Access Profile

Some sample XML request and response web service messages are provided for each noun. These sample messages might not include all properties or attributes. To view a sample message that includes other properties or attributes, enable logging and tracing for the appropriate component and then call the web service to set or change the properties or attributes. Review the corresponding log file to see the request or response information.

Access Profile Data Returned
IBM_Store_CatalogEntrySearch

See the request and response section for a demonstration of the data returned for each search profile.

This access profile is designed for use on the store front. Everyone has access to execute this web service using this access profile. There is a difference between the web service which makes use of the JDBC mediator and the one that uses the search engine.

In the case of this web service that uses the search engine, the access profile is only used to determine the access control. (Who is allowed to execute this web service.)

The amount of data returned back from the search engine is controlled through a new concept of a search profile. These search profiles are defined in WC.ear/xml/config/COMPONENT/wc-search.xml

The configuration for search profiles used by this web service is in: WC.ear/xml/config/com.ibm.commerce.catalog-fep/wc-search.xml

Search profiles:

IBM_findCatalogEntryByName
IBM_findCatalogEntryByNameAndShortDescription
IBM_findCatalogEntryByID
IBM_findCatalogEntryByUnstructureField
IBM_Global_WebContent
IBM_findCatalogGroupSummary
IBM_findCatalogEntrySummary
IBM_findCatalogEntryDetails
IBM_findCatalogEntryAttachments
IBM_findCatalogEntryDetailsWithAttachments
IBM_Store_CatalogEntryDetailsWithComponentsAndAttachments
IBM_findCatalogEntryDetailsWithMerchandisingAssocDetails
IBM_findCatalogEntryAll
IBM_findCatalogEntryPrice
IBM_findCatalogEntryPriceWithAttributes

IBM_Store_Summary For catalog entries:

catalogEntryTypeCode
buyable
UniqueID
PartNumber
Name
ThumbNail
FullImage
ManufacturerName
ShortDescription
LongDescription
StoreID
Keyword
Title
MetaDesc
MetaKeyword
FullImageAltDescription
MetaData
UserData
For catalog groups:

UniqueID
Identifier
Name
ThumbNail
ShortDescription
MetaData
UserData

This access profile is designed for the store front. The related search profile is IBM_findCatalogEntrySummary for catalog entries and IBM_findCatalogGroupSummary for catalog groups. It returns the summary information for a catalog entry or a catalog group.
IBM_Store_Details For catalog entries:

IBM_Store_Summary+

disallowRecurringOrder
SubscriptionTypeCode
Price
ParentCatalogGroupID
ParentCatalogEntryID
hasSingleSku
SingleSKUCatalogEntryID
NumberOfSKUs
SKUs
Attributes
For catalog groups:

IBM_Store_Summary+

LongDescription
FullImage
Title
MetaDescription
MetaKeyword
FullImageAltDescription

This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryDetails for catalog entries and IBM_findCatalogGroupDetails for catalog groups. It returns detailed information for a catalog entry or a catalog group.
IBM_Store_CatalogEntryAttachments IBM_Store_Details+

UniqueID
Attachments

This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryAttachments. It returns attachments for a catalog entry.
IBM_Store_CatalogEntryDetailsWithAttachments IBM_Store_Details+

Attachments

This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryDetailsWithAttachments. It returns detailed information and attachments for a catalog entry.
IBM_Store_CatalogEntryDetailsWithComponentsAndAttachments IBM_Store_CatalogEntryDetailsWithAttachments+

Components
DynamicKitURL
DynamicKitDefaultConfiguration
dynamicKitDefaultConfigurationComplete

This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryDetailsWithComponentsAndAttachments. It returns detailed information, components and attachments for a catalog entry.
IBM_Store_CatalogEntryDetailsWithMerchandisingAssociations IBM_Store_Details+

MerchandisingAssociations

This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryDetailsWithMerchandisingAssocDetails. It returns detailed information and merchandising associations for a catalog entry.
IBM_Store_All IBM_Store_CatalogEntryDetailsWithComponentsAndAttachments+

MerchandisingAssociations

This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryAll. It returns the all the information for a catalog entry.
IBM_Store_CatalogEntryPrice

catalogEntryTypeCode
UniqueID
Price

This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryPrice. It returns the price for a catalog entry.
IBM_Store_CatalogEntryPriceWithAttributes IBM_Store_CatalogEntryPrice+

buyable
StoreID
PartNumber
Name
ThumbNail
ManufacturerName
ShortDescription
Attributes

This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryPriceWithAttributes. It returns the price and attributes for a catalog entry.

XSD files

CatalogNavigationView.xsd
CatalogEntryView.xsd
CatalogGroupView.xsd
CatalogCommon.xsd
CommonTypes.xsd

BOD	Action Code / Access Profile	Action Expression	Service Provided	Sample XML Message	Client Library / Expression Builder
GetCatalogNavigationView	All access profiles listed in the 'Access Profile' section can be applied to this expression.	/CatalogNavigationView	Returns the catalog navigation view for a page in the store.	Request Response	getCatalogNavigationView getCatalogNavigationViewByCategory getCatalogNavigationAttachmentView getWebContentView
	All access profiles listed in the 'Access Profile' section can be applied to this expression.	/CatalogNavigationView[CatalogEntryView[(UniqueID=$uniqueId$)]]	Get catalog navigation view for a catalog entry by unique id(s). Returns the catalog navigation view for the given unique id(s).	Request Response	getCatalogEntryViewSummaryByID getCatalogEntryViewDetailsByID getCatalogEntryViewAttachmentsByID getCatalogEntryViewDetailsWithAttachmentsByID getCatalogEntryViewDetailsWithComponentsAndAttachmentsByID getCatalogEntryViewDetailsWithMerchandisingAssociationsByID getCatalogEntryViewAllByID getCatalogEntryViewPriceByID getCatalogEntryViewPriceWithAttributesByID
	All access profiles listed in the 'Access Profile' section can be applied to this expression.	/CatalogNavigationView[CatalogEntryView[(PartNumber=$partNumber$)]]	Get catalog navigation view for a catalog entry by part number(s). Returns the catalog navigation view for the given part number(s).	Request Response	getCatalogEntryViewSummaryByPartnumber getCatalogEntryViewDetailsByPartnumber getCatalogEntryViewAttachmentsByPartnumber getCatalogEntryViewDetailsWithAttachmentsByPartnumber getCatalogEntryViewDetailsWithComponentsAndAttachmentsByPartnumber getCatalogEntryViewDetailsWithMerchandisingAssociationsByPartnumber getCatalogEntryViewAllByPartnumber getCatalogEntryViewPriceByPartnumber getCatalogEntryViewPriceWithAttributesByPartnumber
	IBM_Store_All profile that is listed in the 'Access Profile' section can be applied to this expression.	/CatalogNavigationView[CatalogEntryView[(UniqueID=)]/MerchandisingAssociations[(AssociationType=)]]	Gets the catalog navigation view for a catalog entry by the catalog entry unique ID and returns the merchandising associations for the catalog entry that match specific merchandising association types.	Request Response	getCatalogEntryViewWithSpecifiedAssociationsByID
	IBM_Store_Summary and IBM_Store_Details listed in the 'Access Profile' section can be applied to this expression.	/CatalogNavigationView[CatalogGroupView[(UniqueID=$uniqueId$)]]	Get catalog navigation view for a catalog group by unique id(s). Returns the catalog navigation view for the given unique id(s).	Request Response	getCatalogNavigationCatalogGroupView
	IBM_Store_Summary and IBM_Store_Details listed in the 'Access Profile' section can be applied to this expression.	/CatalogNavigationView[CatalogGroupView[(Identifier=$identifier$)]]	Get catalog navigation view for a catalog group by identifier. Returns the catalog navigation view for the given identifier.	Request Response	getCatalogNavigationCatalogGroupViewByIdentifier
	IBM_Store_Summary and IBM_Store_Details listed in the 'Access Profile' section can be applied to this expression.	/CatalogNavigationView/CatalogGroupView	Get catalog navigation view for the top catalog groups of the current catalog. Returns the catalog navigation view for the current catalog.	Request Response	getCatalogNavigationCatalogGroupViewByCatalogId
	IBM_Store_Summary and IBM_Store_Details listed in the 'Access Profile' section can be applied to this expression.	/CatalogNavigationView[CatalogGroupView[(ParentCatalogGroupID=$parentCatalogGroupId$)]]	Get catalog navigation view for catalog groups by parent catalog group unique id. Returns the catalog navigation view for the given parent catalog group unique id.	Request Response	getCatalogNavigationCatalogGroupViewByParentCatalogGroup

Access Profile	Data Returned
IBM_Store_CatalogEntrySearch	See the request and response section for a demonstration of the data returned for each search profile.	This access profile is designed for use on the store front. Everyone has access to execute this web service using this access profile. There is a difference between the web service which makes use of the JDBC mediator and the one that uses the search engine. In the case of this web service that uses the search engine, the access profile is only used to determine the access control. (Who is allowed to execute this web service.) The amount of data returned back from the search engine is controlled through a new concept of a search profile. These search profiles are defined in WC.ear/xml/config/COMPONENT/wc-search.xml The configuration for search profiles used by this web service is in: WC.ear/xml/config/com.ibm.commerce.catalog-fep/wc-search.xml Search profiles: IBM_findCatalogEntryByName IBM_findCatalogEntryByNameAndShortDescription IBM_findCatalogEntryByID IBM_findCatalogEntryByUnstructureField IBM_Global_WebContent IBM_findCatalogGroupSummary IBM_findCatalogEntrySummary IBM_findCatalogEntryDetails IBM_findCatalogEntryAttachments IBM_findCatalogEntryDetailsWithAttachments IBM_Store_CatalogEntryDetailsWithComponentsAndAttachments IBM_findCatalogEntryDetailsWithMerchandisingAssocDetails IBM_findCatalogEntryAll IBM_findCatalogEntryPrice IBM_findCatalogEntryPriceWithAttributes
IBM_Store_Summary	For catalog entries: catalogEntryTypeCode buyable UniqueID PartNumber Name ThumbNail FullImage ManufacturerName ShortDescription LongDescription StoreID Keyword Title MetaDesc MetaKeyword FullImageAltDescription MetaData UserData For catalog groups: UniqueID Identifier Name ThumbNail ShortDescription MetaData UserData	This access profile is designed for the store front. The related search profile is IBM_findCatalogEntrySummary for catalog entries and IBM_findCatalogGroupSummary for catalog groups. It returns the summary information for a catalog entry or a catalog group.
IBM_Store_Details	For catalog entries: IBM_Store_Summary+ disallowRecurringOrder SubscriptionTypeCode Price ParentCatalogGroupID ParentCatalogEntryID hasSingleSku SingleSKUCatalogEntryID NumberOfSKUs SKUs Attributes For catalog groups: IBM_Store_Summary+ LongDescription FullImage Title MetaDescription MetaKeyword FullImageAltDescription	This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryDetails for catalog entries and IBM_findCatalogGroupDetails for catalog groups. It returns detailed information for a catalog entry or a catalog group.
IBM_Store_CatalogEntryAttachments	IBM_Store_Details+ UniqueID Attachments	This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryAttachments. It returns attachments for a catalog entry.
IBM_Store_CatalogEntryDetailsWithAttachments	IBM_Store_Details+ Attachments	This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryDetailsWithAttachments. It returns detailed information and attachments for a catalog entry.
IBM_Store_CatalogEntryDetailsWithComponentsAndAttachments	IBM_Store_CatalogEntryDetailsWithAttachments+ Components DynamicKitURL DynamicKitDefaultConfiguration dynamicKitDefaultConfigurationComplete	This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryDetailsWithComponentsAndAttachments. It returns detailed information, components and attachments for a catalog entry.
IBM_Store_CatalogEntryDetailsWithMerchandisingAssociations	IBM_Store_Details+ MerchandisingAssociations	This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryDetailsWithMerchandisingAssocDetails. It returns detailed information and merchandising associations for a catalog entry.
IBM_Store_All	IBM_Store_CatalogEntryDetailsWithComponentsAndAttachments+ MerchandisingAssociations	This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryAll. It returns the all the information for a catalog entry.
IBM_Store_CatalogEntryPrice	catalogEntryTypeCode UniqueID Price	This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryPrice. It returns the price for a catalog entry.
IBM_Store_CatalogEntryPriceWithAttributes	IBM_Store_CatalogEntryPrice+ buyable StoreID PartNumber Name ThumbNail ManufacturerName ShortDescription Attributes	This access profile is designed for the store front. The related search profile is IBM_findCatalogEntryPriceWithAttributes. It returns the price and attributes for a catalog entry.