Configure Text Search

Text Search enables users to enter keywords and search specific project fields in the Requirements, Test Plan, and Defects modules. This topic describes how to configure Text Search.

Enable Text Search on database user schema

Before enabling Text Search in ALM, enable Text Search on each database user schema on which you want to enable Text Search.

To enable text search on an Oracle database user schema:

As Admin user, run the following command:

Copy code
GRANT CTXAPP to <database user schema>

To enable text search on an SQL database user schema:

Run the following command to enable full text indexing:

Copy code
EXEC sp_fulltext_database 'enable'

Back to top

Enable Text Search in ALM

You can enable Text Search on a database server before or after you add projects. If you enable Text Search on a database server before adding a project, Text Search is enabled automatically for the project. If you enable Text Search on a database server after add a project, Text Search is disabled. You can manually enable Text Search for the project.

Caution: You cannot disable Text Search after you have enabled it.

To enable Text Search on a specific database, see Modify database server properties.

To enable Text Search on a specific project, click Enable/Rebuild Text Search in the project's Details tab. For details, see Details tab.

Back to top

Select search language for a project

For each project with Text Search enabled, you can specify a search language other than the default search language you set for the database server. For details about setting the default search language, see Modify database server properties.

To select a different search language for a project, edit the Search Language field in the project's Details tab. For details, see Details tab.

Back to top

Define searchable fields

For each project with Text Search enabled, make a system or user-defined field searchable, and then you can use Text Search to enter keywords and search the field.

Available searchable fields

The following are available as searchable fields:

  • User-defined fields with the Memo or String field type .

  • The following system fields.

    Entity Searchable System Fields
    Business Component
    • Comments

    • Component Folder

    • Component Name

    • Description

    • Original Location

    • Subtype ID

    Business Process Model Activities
    • Comments

    • Description

    • Text

    Business Process Models
    • Comments

    • Description

    Defect
    • Comments

    • Description

    • Summary

    Requirement
    • Comments

    • Description

    • Name

    • Rich Text

    Run
    • Comments

    Test
    • Comments

    • Description

    • Path

    • Protocol Type

    • Template

    • Test Name

To define a searchable field:

  1. In the ALM main window, on the masthead, click , and then select Customize. The Project Customization window opens.

  2. Click the Project Entities link. The Project Entities page opens.

  3. Expand an entity, and select a system or user-defined field that can be made searchable.

  4. Select the Searchable checkbox.

  5. Click Save to save your changes.

Back to top

See also: