Auto-Correction / Spell Correction - Endeca Best Practices

1) Applications should present feedback and clarification to users about spelling corrections

 

2) The MDEX Engine flag --spell-glom should be used to enable cross-field spell correction. This will enlarge the dynamic spelling dictionary created by the engine by including entries across different properties or dimensions.

How to find the list of all published projects status on the Authoring Instance? - Endeca Experience manager

This will help to find the list of projects saved on Authoring Dgraph using Endeca Experience manager and also who made those changes.

http://localhost:8006/ifcr/system/endeca/publishStatus?environment=Authoring&group=rules&site=ENDECA-APP-NAME

[{"status":"success","env":"Authoring","message":"Publish succeeded: 

AuthoringDgraph","id":"[PUBSERV4]",

"tool":["content"],"app":"CRS","time":"Tue Jan 19 2016 16:28:39 GMT-0600",

"timestamp":1453242519554,"user":["rhonakamble"]},

{"status":"success","env":"Authoring","message":"Publish succeeded: 

AuthoringDgraph","id":"[PUBSERV3]",

"tool":["content"],"app":"CRS","time":"Tue Jan 19 2016 16:27:11 GMT-0600",

"timestamp":1453242431229,"user":["admin"]}]

How to find Endeca component versions Ex: Dgraphs, Deployment template, Forge, CAS and Tools & Framework? - Endeca component versions

MDEX: 

Use below command
C:\Endeca\MDEX\6.5.1\bin>dgraph.exe --version
Endeca dgraph version 6.5.1.829811
Supports opti-XML version : 2.00
Supports binary IR version: 640
Interface specification :
  READS:dgidx=6.3.0a WRITES:dgraph=IR640
ICU version 51.2
OLT version OLT 1.4 140319
OpenSSL 1.0.0k 5 Feb 2013 

Deployment Template:

Use below command
C:\Endeca\apps\Discover\control>runcommand.bat --version
Deployment Template: 11.1.0

Platform Services: 

Use below command
C:\Endeca\PlatformServices\11.1.0\bin>forge.exe --version
INFO    01/19/16 03:14:25.991 UTC (1453173265991)       FORGE   {config}: forge 4.1-Internal-foo@bar-baz-beetle ("i86pc-MINGW32_NT-6.1")
INFO    01/19/16 03:14:25.996 UTC (1453173265995)       FORGE   {config}: Copyright 2001-2012 Oracle Endeca Technologies, Inc.
INFO    01/19/16 03:14:26.000 UTC (1453173265999)       FORGE   {config}: Command Line: forge.exe --version
forge 4.1-Internal-foo@bar-baz-beetle ("i86pc-MINGW32_NT-6.1")
Copyright 2001-2012 Oracle Endeca Technologies, Inc.
INFO    01/19/16 03:14:26.041 UTC (1453173266040)       FORGE   {config}: Initialized cURL, version: libcurl/7.16.4 OpenSSL/0.9.8 zlib/1.2.3
INFO    01/19/16 03:14:26.045 UTC (1453173266044)       FORGE   {config}: Forge completed successfully.

CAS:

Use below jar to find the version: 
C:\Endeca\CAS\11.1.0\lib\cas-cmd>cas-cmd-11.1.0.jar

Tools and Framework: 

Version is displayed on the login screen

Stemming and Thesaurus - Endeca Features

Stemming  - The stemming dictionary is based on the common English dictionary, and doesn’t pluralize proper nouns, brand names, etc.  In order to ‘Stem’ a plural of a word that doesn’t occur commonly, a two way thesaurus entry should be made in the Workbench or update the stemming dictionary.

      Stemming  dictionary found at MDEX level /opt/app/endeca//MDEX/6.5.1/conf/stemming

    Thesaurus  -  The thesaurus is intended for specifying concept-level mappings between words and phrases.

There are two options available when configuring thesaurus entries:

1)      One-Way - This mapping technique specifies only one direction of equivalence. 

                 Ex: Assume you define a one-way mapping from the phrase “red wine” to the phrases “merlot” and “cabernet sauvignon”.  This one-way mapping ensures that a search for “red wine” also returns any matches containing the more specific terms “merlot” or “cabernet sauvignon.”

2)      Two-Way - This technique means that the direction of a word mapping is equivalent between the words.

                  Ex: a Two-way mapping between “laptop,” “desktop,” and “notebook” means that a search for one of these words will always return all results matching any of these words

Note: Only one global thesaurus is supported for an Endeca data domain. In other words, language-specific thesauruses are not supported (for example, one thesaurus for English, a second for French, and so on).  

How to check the Endeca Dgraph version?

/opt/app/endeca/MDEX/6.4.0/bin]

$ ./dgraph --version

Endeca dgraph version 6.4.0.743933

Supports opti-XML version : 2.00

Supports binary IR version: 640

Interface specification :

  READS:dgidx=6.3.0a WRITES:dgraph=IR640

ICU version 4.2.1

OLT version OLT 1.3 121107

Endeca Dgidx and Dgraph Flags - Endeca Flags

Dgidx Flags: 

http://docs.oracle.com/cd/E29584_01/webhelp/IAPAdmin/toc.htm#Dgidx%20flags 

Dgraph Flags:

http://docs.oracle.com/cd/E29584_01/webhelp/IAPAdmin/toc.htm#Dgraph%20flags

Endeca ENEConnectionException - How to Enable backwards compatibility, so that the Dgraph can communicate with previous versions of the Presentation API

ERROR MESSAGE in Endeca JSP reference application: ENEConnectionException com.endeca.navigation.ENEConnectionException: Error establishing connection to retrieve Navigation Engine request

Enable backwards compatibility, so that the Dgraph can communicate with previous versions of the Presentation API. In addition to the currently supported version of the Presentation API, the following previous full versions are supported: 6.0.x, 5.1.x, 5.0.x and 4.8.x. Therefore, the value for <api-version> must be one of the following:

• 601 for all 6.0.x versions of the API.
• 510 or 500 for all corresponding versions of the API, 5.1.x and 5.0.x.
• 480 for the 4.8.x versions of the API, including the Perl API. 

<dgraph-defaults>
    <properties>
     ...
    <directories>
     ...
    </directories>
    <args>
       <arg>--back_compat</arg> 
       <arg>601</arg> 
       ...
        </args>
    <startup-timeout>120</startup-timeout>
  </dgraph-defaults>

Note: Starting with version 6, the Endeca Presentation API is part of the Platform Services package. For the version of the Platform Services that is compatible with the current version of the MDEX Engine.

How to add Endeca Record Sort options in ATG 11.1? - Core Endeca

1) Go to /opt/app/endeca/apps/CRS/config/mdex/record_sort_config.xml and add the desired properties that can sort the result set.

Example:
<RECORD_SORT_CONFIG>
  <RECORD_SORT NAME="product.displayName"/>
  <RECORD_SORT NAME="product.salePrice"/>
  <RECORD_SORT NAME="product.bvRatings"/>
</RECORD_SORT_CONFIG>

2) Run a baseline index to create the sorts in the MDEX.

Endeca - Stop words

Endeca Stop words
Stop words are words that are ignored by the MDEX Engine when the words are part of a keyword search.

Where I can find OOTB Stop words?
Endeca 3.1.X
/opt/apps/endeca/apps/CRS/config/CRS.stop_words.xml
Endeca 11.X
/opt/app/endeca/apps/CRS/config/mdex/CRS.stop_words.xml

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<!DOCTYPE STOP_WORDS SYSTEM "stop_words.dtd">
<STOP_WORDS>
  <STOP_WORD>a</STOP_WORD>
  <STOP_WORD>do</STOP_WORD>
  <STOP_WORD>me</STOP_WORD>
  <STOP_WORD>when</STOP_WORD>
  <STOP_WORD>about</STOP_WORD>
  <STOP_WORD>find</STOP_WORD> 
 <STOP_WORD>not</STOP_WORD>
  <STOP_WORD>where</STOP_WORD>
  <STOP_WORD>above</STOP_WORD>
  <STOP_WORD>for</STOP_WORD>
  <STOP_WORD>or</STOP_WORD>
  <STOP_WORD>why</STOP_WORD>
  <STOP_WORD>an</STOP_WORD>
  <STOP_WORD>from</STOP_WORD>
  <STOP_WORD>over</STOP_WORD>
  <STOP_WORD>with</STOP_WORD>
  <STOP_WORD>and</STOP_WORD>
  <STOP_WORD>have</STOP_WORD>
  <STOP_WORD>show</STOP_WORD>
  <STOP_WORD>you</STOP_WORD>
  <STOP_WORD>any</STOP_WORD>
  <STOP_WORD>how</STOP_WORD>
  <STOP_WORD>the</STOP_WORD>
  <STOP_WORD>your</STOP_WORD>
  <STOP_WORD>are</STOP_WORD>
  <STOP_WORD>I</STOP_WORD>
  <STOP_WORD>under</STOP_WORD>
  <STOP_WORD>can</STOP_WORD>
  <STOP_WORD>is</STOP_WORD>
  <STOP_WORD>what</STOP_WORD>
</STOP_WORDS>

 You can add application specific stop words in above mentioned file and run Endeca baseline update.

Endeca Dimension search Performance Tuning - Best Practices

Performance of dimension search directly depends on number of dimension values and size of the resulting set of matching dimension values. If Dimension values returned are more than 1000 then it will cause big performance hit.
Compound dimension search is more expensive than non-compound request. if you are not using compound dimension feature then disable it. Here is the link on how to disable it:
http://ravihonakamble.blogspot.com/2015/07/endeca-few-items-on-dgrpah-side-to.html
 
In both the cases, You can limit the results by using advanced dimension search parameters.
Ex: Di parameter to specify the specific dimension or list of Dimension value Id's. 

D=avengers&Di=11378
D= Dimension Query Search Term
Di= One or more ID's of dimensions to search against

Viewing the Endeca MDEX Engine Auditing page - Endeca JSP Reference application

To view the MDEX Engine Auditing page:
Access the following URL:
http://DgraphServerNameOrIP:DgraphPort/admin?op=audit
For example, if your Dgraph is running on your local machine and listening on port 15000, specify this:
http://localhost:15000/admin?op=audit


FYI:
The information on the MDEX Engine Auditing page is persistent and is valid across the MDEX Engine restarts.