Keyword Search

Description

The Keyword Search allows for filtering of the table results on words occurring in either the default columns (code, name, description) or words in the column named keywords.

Info

Name

Keyword Filter Element Widget

Class

tactic.ui.filter.KeywordFilterElementWdg

TACTIC Version Support

3.8+

Required database columns

none
Options

mode

The mode for the Keyword Search: global or keyword. For example:
<mode>global</mode>
or
<mode>keyword</mode>

column

A pipe separated list of column names of the sType of the current view to perform the keyword search on. For example:
<column>code|description|title</column>
 
                            
It could also be a column from a related sType. If we are in a project/sequence view and want to search for description of the shots related:
<column>project/shot.description</column>
If no <column> is specified, then the name specified in the element name attribute is assumed to be the column name and is used to perform the search on. In the example below, the 'title' column will be used to perform the search on.
<element name='title'>

cross_db

If set to true, the column attribute can be used with an expression string with sTypes from a different database
<cross_db>true</cross_db>

relevant

If set to true, it will only return results that have already been entered in the current table. This applies to situation when you use a column of a related sType in the column option.
<relevant>true</relevant>
Usage

Once the Simple Search Keyword Search Filter is set up, input the search criteria into the search field, hit enter to submit the criteria and the matching results will appear in the table.

Modes for Keyword Search

There are 2 different modes for the Keyword Search. They are described below:

Global Search Mode: Whenever a new item is inserted or updated, the keywords (from code, name, description and keywords column are recorded to a global table. This global table is read from when the Keyword Search is in Global Search Mode.

Below is an example of the Widget Config for a Simple Search Custom Filter in Global Search Mode:

<config>
  <custom_filter> 
    <element name='title'>
        <display class='tactic.ui.filter.KeywordFilterElementWdg'>
            <mode>global</mode>
        </display>
    </element>
  </custom_filter>
</config>

Keyword Search Mode In this search mode, the user specifies the column in the current view to do the Keyword Search on. This mode allows the user to create a Simple Search Keyword Search per column.

Below is an example of the Widget Config for a Simple Search Custom Filter in Keyword Search Mode:

<config>
  <custom_filter> 
    <element name='title'>
        <display class='tactic.ui.filter.KeywordFilterElementWdg'>
            <mode>keyword</mode>
        </display>
    </element>
  </custom_filter>
</config>

In the above example, since no <column> is specified in the XML, the name specified in attribute <element name='title'> is assumed to be the column name and so it is used to run the search on the 'title' column.

Note

If no mode is specified, the mode defaults to Global Search Mode.

The XML definition will look like the following:

<element name='keywords'/>
Features and Options

Partial Word Match There is a check box next on the right of the Keywords Search field. When checked (which is the default), the search will do a partial word match.

For example, if the input the search criteria is: house, this could return results with the keyword warehouse.

Otherwise, if the partial word match is turned off, there would be no match on the keyword warehouse.

Support for Different Languages

The Keyword Search also supports searches in different languages. The search is simply doing a match on individual characters in the words.

Advanced Configuration

Specifying more than one keyword search column: Below is an example in Keyword Mode where 3 columns are specified to do the search on:

<config>
  <custom_filter> 
    <element name='description'>
        <display class='tactic.ui.filter.KeywordFilterElementWdg'>
        <mode>keyword</mode>
        <column>code|description|title</column>
        </display>
    </element>
  </custom_filter>
</config>