Step 8: Registering the Data Enrichment plugins in the Endeca Server cluster

This topic describes how to run a command-line script that registers the Endeca Server Data Enrichment plugins, if you are installing in the cluster.

If you intend to use enrichments in your Studio application, you must register the Data Enrichment plugins in the Endeca Server cluster.

This procedure assumes that Endeca Server has been installed and that a WebLogic domain has been created for Endeca Server. It also assumes that the SSL certificates have been generated if Endeca Server was installed in secure mode.

Important: This procedure also assumes that you have already adjusted EndecaServer.properties file to point to the shared location for the /plugins and /resources directories of the Data Enrichment plugins. If you have not adjusted these locations, see Changing settings in EndecaServer.properties.

The registration script is named enrichment-metadata.bat (for Windows) or enrichment-metadata.sh (for Linux) and resides in the $ENDECA_HOME/endeca-data-enrichment/install directory.

The syntax of the script is: 
enrichment-metadata.bat|sh
<java-home>
<host>
<port>
<protocol>
<oracle-home>
<endeca-home>
<endeca-domain-home>
[<sslPassphrase>]
where:
  • java-home is the absolute path to the Java SDK.
  • host is the first portion of the Fully Qualified Domain Name for the Endeca Server machine. According to the cluster installation diagram, it is host1.
    Important: In the Endeca Server cluster, you register the Data Enrichment plugins only on host1 and not on other machines.
  • port is the port of the Managed Servers in the Endeca Server cluster installation. According to the cluster installation diagram, it is 7003 in the non-secure installation, and 7004 in the secure installation.
  • protocol is http for non-SSL mode or https for SSL-mode.
  • oracle-home is the absolute path of the Oracle Middleware directory.
  • endeca-home is the absolute path of the Endeca Server root directory.
  • endeca-domain-home is the absolute path of the Endeca Server domain directory.
  • sslPassphrase is the pass phrase for the SSL certificates. This argument is required only if the protocol argument is https.

The arguments must be provided in the order listed above.

To register the Data Enrichment plugins in the Endeca Server cluster deployment:

  1. On host1, verify that you have modified the EndecaServer.properties file and that it points to the shared location for the /plugins and /resources directories: 
    ...
endeca-data-enrichment-pluginsDir=Q:/DataEnrichment/plugins
endeca-data-enrichment-resourcesDir=Q:/DataEnrichment/resources
    For information on how to adjust these settings, see Changing settings in EndecaServer.properties.
  2. On host1, start the Admin Server for the Endeca Server domain.
  3. From a command prompt, navigate to the $ENDECA_HOME/endeca-data-enrichment/install directory.
  4. Run the registration script for your operating system, as in this Windows example: 
    enrichment-metadata.bat C:\Java\jdk1.6.0_43 host1 7004 https C:\Oracle\Middleware 
C:\Oracle\Middleware\EndecaServer7.6.1 C:\Oracle\Middleware\user_projects\domains\endeca_server_domain
The output of the above command looks similar to this example: 
INFO: Registered auditor for componentType=WebServices 
auditor=oracle.security.jps.internal.audit.DelegateAuditor$XmlAuditor@45ed957d
ECHO is off.
Registering plug-in BlacklistPlugin...
DONE!
Registering plug-in ExpressionTaggerPlugin...
DONE!
Registering plug-in LanguageDetectionPlugin...
DONE!
Registering plug-in LexicalConceptExtractorPlugin...
DONE!
Registering plug-in SalientTermExtractorPlugin...
DONE!
Registering plug-in SentimentAnalysisPlugin...
DONE!
Registering plug-in StringUtilityPlugin...
DONE!
Registering plug-in TermExtractorPlugin...
DONE!
Registering plug-in TextCleanupPlugin...
DONE!
Registering resource DefaultStoplist.yml...
DONE!
Registering resource DefaultLexicon.yml...
DONE!

The script creates a $DOMAIN_HOME/EndecaServer/DataEnrichment directory that contains resources for the plugins.

After completing this procedure and configuring JMS settings, you can use Enrichments in your Studio application. For information, see Step 9: Configuring JMS settings.