Setting up a text indexing preprocessor

You can quickly set up your first text indexing preprocessor by completing this procedure. The text indexing preprocessor processes document content before it is indexed by Elasticsearch or Content Search Services.

About this task

By completing the steps described in this procedure, you create the items identified in the following table.

Item Name Description
Document subclass TP Test Document The class where you assign the text indexing preprocessor definition. The text indexing preprocessor action is run on all documents with CBR enabled that are created with this class definition before they are indexed.
Text preprocessor definition TP Test Definition Associates a text indexing preprocessor action with the TP Test Document class.
Text preprocessor action TP Test Action References the Java™ code module that performs the text preprocessing action.
Code module TP Test Module Contains the custom Java class that implements the text preprocessing logic.
Object store folder TP Test Folder The folder where you can add documents when you test the text indexing preprocessor.

Procedure

To set up a text indexing preprocessor:

  1. Create a custom Java text indexing preprocessor class.

    Create a Java class that implements your text preprocessing logic. The class processes document content before it enters the indexing queue for Elasticsearch or Content Search Services.

    Compile your class and package it as a JAR file. This JAR file will be uploaded as a code module in a later step.

  2. Create a subclass of Document.
    1. In the administration console, navigate to Object Stores > object store name > Document Class.
    2. Right-click Document Class and click New Class.
    3. Complete the Create a Class wizard by using the following values:
      • Name: TP Test Document
      • Symbolic Name: TPTestDocument
      • Description: Document subclass for testing text indexing preprocessors.

      You can use the default values for the remaining items.

  3. Create a code module for your text indexing preprocessor.
    1. Navigate to Object Stores > object store name > Events, Actions, Processes > Code Modules.
    2. Right-click Code Modules and click New Code Module.
    3. Complete the Create a Code Module wizard:
      • Name: TP Test Module
      • Description: Code module for text preprocessing test.
      • Upload your JAR file containing the custom text indexing preprocessor class.
  4. Create a text indexing preprocessor action.
    1. Navigate to Object Stores > object store name > Events, Actions, Processes > Text Preprocessor Actions.
    2. Right-click Text Preprocessor Actions and click New Text Preprocessor Action.
    3. Complete the Create a Text Preprocessor Action wizard by using the following values:
      • Name: TP Test Action
      • Description: This action preprocesses document content before indexing.
      • Class: Select Class and enter the fully qualified name of your custom text indexing preprocessor class (including package name).
      • Code Module: Select Configure Code Module and browse to select the TP Test Module you created.
  5. Create a text indexing preprocessor definition.
    1. Double-click the TP Test Document class that you created and click the Text Preprocessor Definitions tab.
    2. Select Show Inherited to show inherited text indexing preprocessor definitions.
    3. Click New and enter the following values:
      • Display Name: TP Test Definition
      • Status: Select to enable the text indexing preprocessor definition.
      • Action: Select TP Test Action from the list.
    4. Click OK to save the definition.
  6. Prepare to test the text indexing preprocessor.
    1. Navigate to Object Stores > object store name > Root Folder.
    2. Right-click Root Folder and click New Sub Folder.
    3. Enter TP Test Folder and click Create.
  7. Test your text indexing preprocessor.
    1. Right-click TP Test Folder and click New Document.
    2. Complete the New Document wizard by using the following values. If a field or selection is not specified, use the default value.
      • Document Title: TP Test 1
      • Add content to the document (required for text indexing).
      • Class: Choose TP Test Document from the list.
      • Ensure content-based retrieval (CBR) is enabled for the document.
    3. After you have specified the document class, click Create.
    4. Verify that the text indexing preprocessor executed by checking the document properties or the indexing queue to confirm the preprocessing occurred before indexing.
  8. Optional: Do one or more of the following tasks: