MDEX Developer's Guide

The MDEX engine consist of

• • dGraph - the process that performs the search

  • dgidx - indexer

  • dgwordlist - utility to compile worddat dictionary for spelldat that enables the spell check

  • enecerts - for SSL

Assembler process

1. client perform request via Endeca application page

2. Endeca page/application invoke assembler method with

3. ContentItem result = assembler.assemble(contentItem);

4. Assembler pass the request to navigation cartridge handler.

5. navigation cartridge handler invoke presentation API to pass the request to MDEX

6. MDEX engine performs the search, filter, sort and return the result to navigation cartridge handler

   1. navigation cartridge handler return the content item that contains the search result to Assembler

   2. the Assembler combines the content item that contains the search result and other content items from some other search queries

   3. the Assembler returns the combined result to the Endeca application

   4. In the Endeca application, the rendering code for each of the cartridge will get the information it needs and display them

   5. The Endeca application returns the rendered information back to the application page

Assembler API can be invoke directly by java - see Assembler API help javadoc

DImension group

• • enables user to select values from each of the dimensions contained. If dimensions are created via hierarchy, once a value has been selected from one of the branch, the remaining dimension values would no longer be valid for refinement.

  • But with dimension group, it allows user to select other values from the same branch.

  • e.g. mutual fund, dimension group for performance that contains YTD return, 1 year return, 3 years return etc... with hierarchy, once user select one of the metric, other will be hidden. But with dimension group, user can select 1, 2 or all 3 dimensions.

Presentation API

• • ENEQueryResults->Top-level objects -> member objects

  • The parameters in the MDEX Engine query determine the type of top-level object that is returned in response to the query

• Top level objects can be

  • Navigation - user's current location in the dimension hierarchy, records associated with that location

    • • using N or DimValIdList dimvalIdList = new DimValIdList("4294967055 18832"); query.setNavDescriptors(dimvalIdList);

  • Endeca Record - single Endeca record

• • • using R, recordSpec

• • Aggregated Endeca record

  • DimensionSearchResult

• • • using D with dimension search term