Exporting a UIMA pipeline to a Watson Explorer Content Analytics server

If you have connectivity to a Watson Explorer Content Analytics server, you can automatically deploy the pipeline to the server and associate the pipeline with one or more collections.

Before you begin

Before you can export a UIMA pipeline to Watson Explorer Content Analytics, you must configure a Watson Explorer Content Analytics server connection file.

For enterprise search collections: Before you export a text analysis engine to a Watson Explorer Content Analytics enterprise search collection, enable the document cache to avoid recrawling content. If the document cache is not enabled, you must run a full recrawl after you export the text analysis engine to Watson Explorer Content Analytics.

About this task

After you configure and test your UIMA pipeline in Content Analytics Studio, you can export the pipeline as a PEAR file and deploy it on a Watson Explorer Content Analytics server. By default, the UIMA pipeline is deployed as the custom annotator stage of the document processing pipeline for the specified collections.

Alternatively, you can manually configure the collection associations and facet mappings by using the administration console. For example, you might have separate collections for your development and production environments and want to use the same PEAR file for both collections. After you deploy the PEAR file by using Content Analytics Studio, you manually configure the collection for the development environment and perform some tests. When the testing is complete, you can apply the same configuration settings to the collection for the production environment.

Procedure

To export a UIMA pipeline to a Watson Explorer Content Analytics server:

  1. From the Configuration/Annotators directory of your project, right-click your ANNOCONFIG pipeline configuration file, click Export, and click Content Analytics Studio > UIMA Pipeline to Watson Explorer Content Analytics Server.
  2. Specify a name and temporary location for the PEAR file that is created on the file system before it is uploaded onto the Watson Explorer Content Analytics server.
    By default, the PEAR file is exported to the Content Analytics Studio workspace directory.
  3. Select the Watson Explorer Content Analytics server connection file that defines the server to which you want to export the pipeline and select one or more collections with which to associate the PEAR file.
    If you export the pipeline to multiple collections, all collections must be of the same type (that is, either content analytics collections or enterprise search collections).
    Tip: If not all collections are listed, open the connection configuration file, click Refresh, and then save the file.
  4. Specify mappings between the UIMA types and features that are created by the pipeline and the index fields and facets that Watson Explorer Content Analytics populates for each document that is analyzed.
  5. Specify how to deploy the UIMA pipeline in Watson Explorer Content Analytics.
    For example, clear the Install in the custom stage of the Watson Explorer Content Analytics collection check box if you plan to manually configure the collection associations by using the administration console.

What to do next

After the PEAR file is installed in Watson Explorer Content Analytics, you can view the new annotation values as facets in the content analytics miner.

If you want to update the facet mappings without changing the linguistic resources, clear the Upload PEAR file to the Watson Explorer Content Analytics Server check box when you export the pipeline. Ensure that the Define required Fields and Facets on the Watson Explorer Content Analytics collection check box is selected when you want to update facet mappings.

If you want to reinstall the pipeline after you modify the linguistic resources in Content Analytics Studio, you must specify a different name in the Text Analysis Engine Name field when you install the updated pipeline. If you want to use the same name when you install the updated pipeline, you must first manually disassociate the existing version of the text analysis engine from the Watson Explorer Content Analytics collections and delete that version of the text analysis engine from Watson Explorer Content Analytics.