Oracle Commerce Guided Search - Navigation cartridge request event attributes

Navigation cartridge request event attributes

The following describes the schema for an Assembler navigation cartridge request event. These fields are in addition to those described for the base request.

The NavigationEventWrapper class includes getter and setter methods for each of these attributes.

Attribute	Type	Description
`endeca:autocorrectTo`	`String`	The suggested auto-correct term, if it triggers for the request.
`endeca:contentPath`	`String`	The content path of the page corresponding to the request.
`endeca:didYouMeanTo`	`List <String>`	The suggested "Did You Mean" term, if it triggers for the request.
`endeca:dimensions`	`List <String>`	The dimension names selected for navigation.
`endeca:dimensionValues`	`List <String>`	The dimension value names selected for navigation.
`endeca:eneTime`	`Long`	The time, in milliseconds, that it takes the MDEX Engine to run the query.
`endeca:numRecords`	`Long`	The number of records returned for the request.
`endeca:numRefinements`	`Integer`	The number of selected refinements.
`endeca:recordNames`	`List <String>`	The names of the records returned by the request. To populate this attribute, the `recordDisplayFieldName` property on the `ResultsListConfig` object must be set to the name of the field that contains record names.
`endeca:recordSpec`	`String`	The record specifier for a selected record.
`endeca:requestType`	`RequestType`	The type of request. Possible values are: T - Root navigation N - Navigation only S - Search only SN - Search, then navigation R - Record detail UNKNOWN - Unknown
`endeca:searchKey`	`String`	The search key for the current navigation state.
`endeca:searchMode`	`String`	The search mode for the request.
`endeca:searchTerms`	`String`	The search terms for the request.
`endeca:siteRootPath`	`String`	The site root path of the page corresponding to the request.
`endeca:sortKey`	`List <String>`	The sort keys for the request. Each key is a `String` with the format `fieldName\|<Descending\|Ascending>`.
`endeca:spotlights`	`List <String>`	The list of spotlights triggered for the request.

Copyright © Legal Notices