Oracle Commerce Guided Search - Module descriptions

Module descriptions

The table in this topic provides brief descriptions of the UI reference implementation modules.

Refer to the comments in the individual module files for more detailed information. Reference implementation module files are located in:

Java:
- $ENDECA_REFERENCE_DIR/endeca_jspref on UNIX
- %ENDECA_REFERENCE_DIR%\endeca_jspref on Windows

.NET:
ENDECA_REFERENCE_DIR\endeca_ASP.NETref

Note

In the following table, the module names do not contain file extensions. Unless otherwise noted, it is assumed that the modules are present in both Java and .NET environments, and that the file extensions are .jsp for Java and .aspx for .NET. Some modules have specific file extensions; this in indicated in the module name. Similarly, some modules are specific to Java or .NET environments only; this is indicated in the module description.

Module	Description
`controller`	Initiates the primary MDEX Engine query and determines which type of page to render (navigation, record, or aggregated record).
`constants.jsp`	In Java only: Functions as a repository for variables that do not change across requests.
`global.asax`	Functions as a repository for special event handlers that are run automatically when certain ASP events occur.
`error`	Handles error conditions.
misc_header	A general-use page header used by all page types (navigation, record, aggregated record, and error).
`misc_footer`	A general-use page footer used by all page types (navigation, record, aggregated record, and error).
`util.js`	A collection of utility routines used by various JavaScript functions to create new queries from browser request URLs.
`logging_functions`	Adds logging and reporting capability to your application. This module contains the key/value pairs required by each Oracle Commerce report element.
`misc_ene_switch` and `misc_ene_switch.js`	Render the MDEX Engine switching widget that enables you to dynamically change the MDEX Engine hostname and port.
`nav`	Creates the main navigation page, including navigation controls, navigation descriptors, and a record set.
`nav_autocorrect`	Displays autocorrection for the user’s search terms.
`nav_didyoumean`	Displays alternative suggestions for the user’s search terms.
`nav_controls`	Displays basic navigation controls. This module should be used in conjunction with `nav_breadcrumbs_stack`
`nav_range_controls` and `nav_range_controls.js`	Renders a set of controls that enable you to filter record results according to a specified range. Works with numeric properties only.
`nav_breadcrumbs_stack`	Display the navigation descriptors for the current query.
`nav_merch`	Displays merchandising-specific supplemental objects, if any exist, that accompany the results of a navigation query.
`nav_supplemental`	Displays supplemental objects, if any exist, that accompany the results of a navigation query.
`nav_records`	Renders the record set results for the current query in a non-formatted display.
`nav_records_header`	Displays a record count and other controls to handle the record set display. Also displays an aggregated record count when records have been aggregated.
`nav_records_paging`	Displays controls for paging through the record set, when applicable.
`nav_agg_records`	Renders a list of records that have been aggregated based on a rollup key.
`nav_agg_records_header`	Displays a record count and other controls to handle the record set display along with an aggregated record count.
`nav_agg_records_paging`	Displays controls for paging through a list of aggregated records, when applicable.
`misc_searchbox` and `misc_searchbox.js`	Render a basic searchbox widget.
`misc_dimsearch_results`	Displays the results of a dimension search.
`rec`	Displays a record page for an individual record.
`rec_dimvals_trees`	Displays the dimension values that have been tagged to the current record.
`rec_properties`	Displays the properties for the current record.
`agg_rec`	Displays an aggregated record page for one aggregated record.
`agg_rec_properties`	Displays the properties associated with an aggregated record’s representative record. Displays properties derived from performing calculations on the aggregated record’s constituent records.
`agg_rec_records`	Displays the constituent records associated with the current aggregated record.
`coremetrics`	Implements integration of the Coremetrics Online Analytics product.

Module

Description

controller

Initiates the primary MDEX Engine query and determines which type of page to render (navigation, record, or aggregated record).

constants.jsp

In Java only: Functions as a repository for variables that do not change across requests.

global.asax

Functions as a repository for special event handlers that are run automatically when certain ASP events occur.

error

Handles error conditions.

misc_header

A general-use page header used by all page types (navigation, record, aggregated record, and error).

misc_footer

A general-use page footer used by all page types (navigation, record, aggregated record, and error).

util.js

A collection of utility routines used by various JavaScript functions to create new queries from browser request URLs.

logging_functions

Adds logging and reporting capability to your application. This module contains the key/value pairs required by each Oracle Commerce report element.

misc_ene_switch and

misc_ene_switch.js

Render the MDEX Engine switching widget that enables you to dynamically change the MDEX Engine hostname and port.

nav

Creates the main navigation page, including navigation controls, navigation descriptors, and a record set.

nav_autocorrect

Displays autocorrection for the user’s search terms.

nav_didyoumean

Displays alternative suggestions for the user’s search terms.

nav_controls

Displays basic navigation controls. This module should be used in conjunction with nav_breadcrumbs_stack

nav_range_controls and nav_range_controls.js

Renders a set of controls that enable you to filter record results according to a specified range. Works with numeric properties only.

nav_breadcrumbs_stack

Display the navigation descriptors for the current query.

nav_merch

Displays merchandising-specific supplemental objects, if any exist, that accompany the results of a navigation query.

nav_supplemental

Displays supplemental objects, if any exist, that accompany the results of a navigation query.

nav_records

Renders the record set results for the current query in a non-formatted display.

nav_records_header

Displays a record count and other controls to handle the record set display. Also displays an aggregated record count when records have been aggregated.

nav_records_paging

Displays controls for paging through the record set, when applicable.

nav_agg_records

Renders a list of records that have been aggregated based on a rollup key.

nav_agg_records_header

Displays a record count and other controls to handle the record set display along with an aggregated record count.

nav_agg_records_paging

Displays controls for paging through a list of aggregated records, when applicable.

misc_searchbox and

misc_searchbox.js

Render a basic searchbox widget.

misc_dimsearch_results

Displays the results of a dimension search.

rec

Displays a record page for an individual record.

rec_dimvals_trees

Displays the dimension values that have been tagged to the current record.

rec_properties

Displays the properties for the current record.

agg_rec

Displays an aggregated record page for one aggregated record.

agg_rec_properties

Displays the properties associated with an aggregated record’s representative record. Displays properties derived from performing calculations on the aggregated record’s constituent records.

agg_rec_records

Displays the constituent records associated with the current aggregated record.

coremetrics

Implements integration of the Coremetrics Online Analytics product.

Module descriptions

Note

MDEX Engine Developer's Guide