Adding text search indices to a standard table

About this task

You can add text search indices to entities. You add text search indices to a standard application database table by adding a TSIndex element in the extension XML for that table.

To add text search indices to a standard table:

Procedure

  1. Copy the install_dir/repository/entity/extensions/Extensions.xml.sample file as install_dir/extensions/global/entities/your_filename.xml file OR modify your existing extension XML file.
  2. Edit the your_filename.xml file to add text search indices as shown in the following example for each table you want to extend. For a description of the XML attributes, see the table that follows the example.
    <!-- element exposed to create index --> 
    <DBSchema> 
      <Entities> 
        <Entity TableName="REQUIRED"> 
         . 
         . 
          <TSIndices> 
            <TSIndex Name="REQUIRED" >
             <Column Name="USERNAME" /> 
            </TSIndex> 
           . 
           . 
          </TSIndices> 
         . 
         . 
        </Entity> 
      </Entities> 
    </DBSchema>

    Attribute

    Description

    Entity

    TableName

    Required. Name of the table for which the text search indices are added. For example: YFS_USER.

    Entity/TSIndex

    Name

    Required. The name of the text search index. For example: YFS_TS_USER_Name.

    Note: This value cannot exceed 18 characters.

    Entity/TSIndex/Column

    Name

    Required. The name of the column for which the text search index is added. You cannot define multiple columns on a text index.

  3. Create a new TSIndex tag for each text search index you want to add to the column.
  4. Build and deploy your extensions.