Record Filters

This section describes how to implement record filters in your Oracle Commerce application.

Related links

About record filters
Record filter syntax
Enabling properties for use in record filters
Data configuration for file-based filters
Record filter result caching
URL query parameters for record filters
Record filter performance impact

Copyright © Legal Notices

MDEX Engine Developer's Guide

Documentation Home

Contents
Search

loading table of contents...

Preface
- About this guide
- Who should use this guide
- Conventions used in this guide
- Contacting Oracle Support
About the MDEX Engine
- MDEX Engine overview
- About the Information Transformation Layer
Assembler functionality
- How the MDEX Engine Communicates with the Assembler
Working with Oracle Commerce Records
- Displaying Oracle Commerce records
  - Displaying a list of Endeca records
    - Displaying each record in the ERecList object
      - Examples of displaying records
    - Performance impact when listing records
- Displaying record properties
- Displaying dimension values for Oracle Commerce Guided Search records
- Paging through a record set
  - Using the No parameter in queries
  - Using paging control methods
Sorting Oracle Commerce Records
- About record sorting
- Configuring precomputed sort
- Changing the sort order with Dgidx flags
- URL parameters for sorting
- Sort API methods
- Troubleshooting application sort problems
- Performance impact for sorting
- Using geospatial sorting
Using Range Filters
- About range filters
- Configuring properties and dimensions for range filtering
- URL parameters for range filters
  - URL parameters for geocode filters
  - Dynamic properties created by geocode filters
- Using multiple range filters
- Examples of range filter parameters
- Rendering the range filter results
- Troubleshooting range filter problems
- Performance impact for range filters
Creating Aggregated Records
- About aggregated records
- Enabling record aggregation
- Generating and displaying aggregated records
- Aggregated record behavior
- Refinement ranking of aggregated records
Controlling Record Values with the Select Feature
- About the Select feature
- Configuring the Select feature
- URL query parameters for Select
- Selecting keys in the application
  - Java selection method
  - .NET selection property
Using the Oracle Commerce Query Language
- About the Oracle Commerce Query Language
  - Basic filtering capabilities
  - Record Relationship Navigation module
- Oracle Commerce Query Language syntax
- Making Oracle Commerce Query Language requests
  - Property value queries
    - Examples
- Record Relationship Navigation queries
- Dimension value queries
- Record search queries
  - Record search query examples
- Range filter queries
- Dimension search queries
- Oracle Commerce Query Language interaction with other features
- Oracle Commerce Query Language per-query statistics log
  - Implementing the per-query statistics log
    - Parts of the log file
  - Setting the logging threshold for queries
- Creating an Oracle Commerce Query Language pipeline
Record Filters
- About record filters
- Record filter syntax
  - Query-level syntax
    - Using the FILTER operator
    - Example of a query-level filter expression
  - XML syntax for file-based record filter expressions
    - Examples of file-based filter expressions
- Enabling properties for use in record filters
- Data configuration for file-based filters
- Record filter result caching
- URL query parameters for record filters
  - Using the Nr query parameter
- Record filter performance impact
Property Types
- Formats used for property types
- Temporal properties
  - Defining Time and DateTime properties
Working with Dimensions
- Displaying dimension groups
  - Dimension group API methods
    - Accessing the Navigation object
    - Accessing the DimGroupList object
  - Notes on displaying dimension groups
- Displaying refinements
- Displaying disabled refinements
- Implementing dynamic refinement ranking
- Displaying descriptors
- Displaying refinement statistics
- Displaying multiselect dimensions
  - Configuring multiselect dimensions
  - Handling multiselect dimensions
- Using hidden dimensions
  - Configuring hidden dimensions
  - Handling hidden dimensions in an application
    - Example of using a hidden dimension
    - Performance impact of hidden dimensions
- Using inert dimension values
  - Configuring inert dimension values
  - Handling inert dimension values in an application
- Displaying dimension value properties
- Working with external dimensions
Dimension Value Boost and Bury
- About the dimension value boost and bury feature
  - Use cases
- Nrcs parameter
  - Nrcs example
  - Nrcs setter methods
- Stratification API methods
- Retrieving the DGraph.Strata property
- Interaction with disabled refinements
Using Derived Properties
- About derived properties
  - Derived property performance impact
- Configuring derived properties
  - Troubleshooting derived properties
- Displaying derived properties
Configuring Key Properties
- About key properties
- Defining key properties
- Automatic key properties
- Key property API
Record Searches
- Keyword search overview
- Making properties or dimensions searchable
- Hierarchical record searches
- Adding search synonyms to dimension values
- Features for controlling record search
- Search query processing order
- Tips for troubleshooting record search
- Performance impact of record search
Search Interfaces
- About search interfaces
- About implementing search interfaces
- Options for enabling cross-field matches
  - How cross-field matches work in multi-assign cases
- Additional search interfaces options
- Search interfaces and URL query parameters (Ntk)
- Java examples of search interface methods
- .NET examples of search interface properties
- Tips for troubleshooting search interfaces
Dimension Searches
- About dimension search
- Default dimension search
- Compound dimension search
- Enabling dimensions for dimension search
- Ordering of dimension search results
- Advanced dimension search parameters
- Dgidx flags for dimension search
  - Dgidx flags for default dimension search
  - Dgidx flags for compound dimension search
- URL query parameters and dimension search
- Methods for accessing dimension search results
- Displaying refinement counts for dimension search
- When to use dimension and record search
- Performance impact of dimension search
Record and Dimension Search Reports
- Implementing search reports
- Methods for search reports
  - Retrieving search reports
  - Accessing information in search reports
- Troubleshooting search reports
Using Search Modes
- List of search modes
- Configuring search modes
- URL query parameters for search modes
  - Query examples with search modes
- Search mode methods
Using Boolean Search
- About Boolean search
- Example of Boolean query syntax
- Examples of using the key restrict operator
- About proximity search
  - Example of using NEAR for unordered matching
  - Example of using ONEAR for ordered matching
- Proximity operators and nested subexpressions
- Boolean query semantics
- Operator precedence
- Interaction of Boolean search with other features
- Error messages for Boolean search
- Implementing Boolean search
- URL query parameters for Boolean search
- Methods for Boolean search
- Troubleshooting Boolean search
- Performance impact of Boolean search
Using Phrase Search
- About phrase search
- About positional indexing
- How punctuation is handled in phrase search
- URL query parameters for phrase search
- Performance impact of phrase search
Using Snippeting in Record Searches
- Excerpting Record Content through Snippeting
- Snippet formatting and size
- Snippet property names
- About enabling and configuring snippeting
- URL query parameters for snippeting
- Reformatting a snippet for display in your Web application
- Performance impact of snippeting
- Tips and troubleshooting for snippeting
Using Wildcard Search
- About wildcard search
- Interaction of wildcard search with other features
- Ways to configure wildcard search
- MDEX Engine flags for wildcard search
- Presentation API development for wildcard search
- Performance impact of wildcard search
Search Characters
- Using search characters
- Query matching semantics
- Categories of characters in indexed text
- Search query processing
- Implementing search characters
- Dgidx flags for search characters
- Presentation API development for search characters
- MDEX Engine flags for search characters
Examples of Query Matching Interaction
- Record search without search characters enabled
- Record search with search characters enabled
- Record search with wildcard search enabled but without search characters
- Record search with both wildcard search and search characters enabled
Spelling Correction and Did You Mean
- About Spelling Correction and Did You Mean
- Spelling modes
  - Aspell and Espell spelling modules
  - Supported spelling modes
- Disabling spelling correction on individual queries
- Spelling dictionaries created by Dgidx
- Configuring spelling in Developer Studio
- Modifying the dictionary file
- About the admin?op=updateaspell operation
- Enabling language-specific spelling correction
- Dgidx flags for Spelling Correction
- dgraph flags for enabling Spelling Correction and DYM
  - dgraph --spellpath flag
  - Additional dgraph flags to enable spelling correction
- URL query parameters for Spelling Correction and DYM
- Spelling Correction and DYM API methods
- dgraph tuning flags for Spelling Correction and Did You Mean
- How dimension search treats number of results
- Troubleshooting Spelling Correction and Did You Mean
- Performance impact for Spelling Correction and Did You Mean
- Compiling the Aspell dictionary
  - Compiling the dictionary manually
  - Compiling the dictionary with EAC
- About word-break analysis
Stemming and Thesaurus
- Overview of Stemming and Thesaurus
- About the Stemming feature
- About the Thesaurus feature
  - Adding thesaurus entries
  - Troubleshooting the thesaurus
- Dgidx and dgraph flags for the Thesaurus
- Interactions with other search features
- Performance impact of Stemming and Thesaurus
Automatic Phrasing
- About Automatic Phrasing
  - Implementation scenarios
  - Tasks for implementation
- Using Automatic Phrasing with Spelling Correction and DYM
  - Automatic Phrasing and query expansion
- Adding phrases to a project
- Presentation API development for Automatic Phrasing
- Tips and troubleshooting for Automatic Phrasing
Stop Words
- About stop words
- Adding a sample list of stop words to an application
Relevance Ranking
- About the Relevance Ranking feature
- Relevance Ranking modules
- Relevance Ranking strategies
- Implementing relevance ranking
- Controlling relevance ranking at the query level
- Relevance Ranking sample scenarios
  - Example 1: Using a small data set
  - Example 2: UI reference implementation
- Recommended strategies
- Performance impact of Relevance Ranking
  - Making module substitutions
  - Ordering modules sensibly
Record Boost and Bury
- About the record boost and bury feature
  - Feature assumptions and limitations
- Enabling properties for filtering
- The stratify relevance ranking module
  - EQL expressions and record strata
- Record boost/bury queries
  - Using the Ntx URL parameter
  - Using the ERecSearch class
- Boost/bury sorting for Oracle Commerce records
  - Using the Ns URL parameter
  - Using API methods
Promoting Records with Dynamic Business Rules
- Using dynamic business rules to promote records
- Suggested workflow for using Oracle Commerce tools to promote records
  - Incremental implementation of business rules
- Building the supporting constructs for a business rule
  - Ensuring promoted records are always produced
  - Creating styles for dynamic business rules
- Grouping rules
  - Prioritizing rule groups
  - Interaction between rules and rule groups
- Creating rules
- Controlling rules when triggers and targets share dimension values
  - Changing the default self-pivot setting when running the Oracle Commerce HTTP service from the command line
  - Changing the default self-pivot setting when running the Oracle Commerce Tools Service as a Windows service
- Working with keyword redirects
- Presenting rule and keyword redirect results in a Web application
- Filtering dynamic business rules
  - Rule filter syntax
    - Additional Boolean usage information
  - MDEX URL query parameters for rule filters
- Performance impact of dynamic business rules
  - Rules without explicit triggers
- Applying relevance ranking to rule results
- About overloading Supplement objects
Implementing User Profiles
- About user profiles
- Profile-based trigger scenario
- User profile query parameters
- API objects and method calls
- Performance impact of user profiles
Using Why Match
- About the Why Match feature
- Enabling Why Match
- Why Match API
- Why Match property format
- Why Match performance impact
Using Word Interpretation
- About the Word Interpretation feature
- Implementing Word Interpretation
- Word Interpretation API methods
- Troubleshooting Word Interpretation
Using Why Rank
- About the Why Rank feature
- Enabling Why Rank
- Why Rank API
  - Per record match information
  - Summary match information
- Why Rank property format
- Result information for relevance ranking modules
- Why Rank performance impact
Using Why Precedence Rule Fired
- About the Why Precedence Rule Fired feature
- Enabling Why Precedence Rule Fired
- Why Precedence Rule Fired API
- Why Precedence Rule Fired property format
- Performance impact of Why Precedence Rule Fired
Presentation API Overview
- List of Guided Search APIs
- Architecture of the Presentation API
  - About Web application modules
    - Methods for transforming requests into queries
    - Techniques for passing request parameters
- One query, one page
  - The Presentation API for Java and .NET
- About query result objects returned by the MDEX Engine
Working with the Presentation API
- Core classes of the Presentation API
- Using the core objects to query the MDEX Engine
- Four basic queries
- Getting started with your own Web application
- List of query exceptions
Using the Reference Implementation
- Reference implementation overview
- The purpose of the reference implementation
  - The Java version
  - The .NET version
- Four primary modules
- Non-MDEX Engine URL parameters
- About JavaScript files
- Module maps
  - Java module maps
  - .NET module maps
- Module descriptions
- Tips on using the UI reference implementation modules
Running the Reference Implementations
- The JSP diagnostic and debugging application
- Running the ASP.NET reference implementation
Oracle Commerce URL Parameter Reference
- About the Oracle Commerce URL query syntax
  - URL parameter description format
  - About primary parameters
- N (Navigation)
- Nao (Aggregated Record Offset)
- Ndr (Disabled Refinements)
- Ne (Exposed Refinements)
- Nf (Range Filter)
- Nmpt (Merchandising Preview Time)
- Nmrf (Merchandising Rule Filter)
- No (Record Offset)
- Np (Records per Aggregated Record)
- Nr (Record Filter)
- Nrc (Dynamic Refinement Ranking)
- Nrcs (Dimension Value Stratification)
  - Example
- Nrk (Relevance Ranking Key)
- Nrm (Relevance Ranking Match Mode)
- Nrr (Relevance Ranking Strategy)
- Nrs (Oracle Commerce Query Language Filter)
- Nrt (Relevance Ranking Terms)
- Ns (Sort Key)
- Nso (Sort Order)
- Ntk (Record Search Key)
- Ntpc (Compute Phrasings)
- Ntpr (Rewrite Query with an Alternative Phrasing)
- Ntt (Record Search Terms)
- Ntx (Record Search Mode)
- Nty (Did You Mean)
- Nu (Rollup Key)
- Nx (Navigation Search Options)
- R (Record)
- A (Aggregated Record)
- Af (Aggregated Record Range Filter)
- An (Aggregated Record Descriptors)
- Ar (Aggregated Record Filter)
- Ars (Aggregated EQL Filter)
- As (Aggregated Record Sort Key)
  - Example
- Au (Aggregated Record Rollup Key)
- D (Dimension Search)
- Df (Dimension Search Range Filter)
- Di (Search Dimension)
- Dk (Dimension Search Rank)
- Dn (Dimension Search Scope)
- Do (Search Result Offset)
- Dp (Dimension Value Count)
- Dr (Dimension Search Filter)
- Drc (Refinement Configuration for Dimension Search)
- Drs (Dimension Search EQL Filter)
- Dx (Dimension Search Options)
- Du (Rollup Key for Dimension Search)
MDEX Engine Logging Variables
- About MDEX Engine logging variables
  - Logging variable operation syntax
  - Supported logging variables
Diacritical Character to ASCII Character Mapping
- Mapping table

Search Terms