Registering the Data Enrichment plugins on a single machine

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

Note: This procedure is for the single-machine installation of the Endeca Server. if you are installing and deploying Endeca Server in the cluster, see Step 8: Registering the Data Enrichment plugins in the Endeca Server cluster.

If you intend to use enrichments in your Studio application, you must register the Data Enrichment plugins. Note that the plugins are automatically registered if you installed Endeca Server via the orchestration script in the configuration mode.

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.

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 name of the machine on which WebLogic Server is running ("localhost" can be used).
  • port is the port on which WebLogic Server is running.
  • protocol is http for non-SSL mode or https for SSL-mode. Note that both http and https must be specified in lower case.
  • 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:

  1. Start the Admin Server for the Endeca Server domain.
  2. From a command prompt, navigate to the $ENDECA_HOME/endeca-data-enrichment/install directory.
  3. Run the registration script for your operating system, as in this Windows example on an SSL deployment: 
    enrichment-metadata.bat C:\Java\jdk1.6.0_43 localhost 7001 http 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 this procedure, you can use enrichments in your Studio application.