Adding text search indexes to a default table

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

Procedure

  1. Copy the <runtime_sandbox>/repository/entity/extensions/Extensions.xml.sample file as <runtime_sandbox>/extensions/global/entities/your_custom_filename.xml file OR modify your existing extension XML file.
  2. Edit the your_custom_filename.xml file to add text search indexes 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"> 
         . 
         . 
          <TSIndexes> 
            <TSIndex Name="REQUIRED" >
             <Column Name="USERNAME" /> 
            </TSIndex> 
           . 
           . 
          </TSIndexes> 
         . 
         . 
        </Entity> 
      </Entities> 
    </DBSchema>

    Attribute

    Description

    Entity

    TableName

    Name of the table for which the text search indexes are added. For example, YFS_USER.

    Entity/TSIndex

    Name

    The name of the text search index. For example, YFS_TS_USER_Name.

    Note: This value cannot exceed 18 characters.

    Entity/TSIndex/Column

    Name

    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 TSIndex tag for each text search index that you want to add to the column.
  4. Build and deploy your extensions.