DTS pSearch User Guide

Version 2.2

Introduction

The DTS pSearch Module for the DTS Editor provides an alternate search panel that implements progressive (type-ahead) search for DTS Concepts and Terms.

Installation

Extract the files in pSearch-2.2.zip into your DTSInstall directory. Be sure the Use folder names box is checked. This will place all the pSearch files into the appropriate folders:

Folder Files

DTSInstall\lib\modules pluginutils.jar

psearch.jar

DTSInstall\docs psearchuserguide.pdf

DTSInstall\docs\help psearchuserguide.htm

Operation

The pSearch plug-in appears as an additional tab panel on the left side of the standard DTS Editor layout. It is also available as a floating panel by selecting Tools|New pSearch from the menu bar. pSearch also implements the DTS V4 Module Architecture and can be used in custom DTS Editor layouts.

The pSearch panel (see below) consists of an upper area for selecting the search context, a middle parameter area, and a lower area containing the search results.

Search Context

Search Parameters

Search Results

The Search Context area is similar to the corresponding area in the standard DTS Editor Search panel. The first row of radio buttons specifies whether to search on Concept names only, Concept names and synonyms, or Term names. The second row contains two dropdown boxes for selection of search methodology (Search By) and Concept/Term Status filtering (Status). The value of the Search By dropdown specifies whether search results should start with, contain, or end with the entered search phrase. (Wild-card, asterisk “*”, characters should not be used in the search phrase.) The Status dropdown selects what types of Concepts or Terms should be returned. ALL, ACTIVE, INACTIVE and DELETED options are available. If ALL is selected, the Search Results panel includes an icon in front of each result name showing the result’s status. The default Status value is ACTIVE.

Click on the Namespace or Subset radio button to specify the search target. The search target dropdown will fill with the available Namespaces, or Subsets, and when a target has been selected, the Version Select panel will show the associated versions. This is the same Version Select panel as in the DTS Editor Search panel and functions identically.

pSearch does not have a Search button. To search for a value, simply type the value into the Search For field. Matching search results will be displayed in the Search Results area, using a progressive refinement (aka “type-ahead”) search algorithm. In addition to standard cut and paste operations, the Search For field supports drop of other DTS Objects such as Concepts, Terms, Properties, etc. When drop is used, the String value of the Object, typically the Name or Value attribute, replaces the current value of the field.

The Search Parameter area gives access to the three parameters used by the search algorithm. (This area is not visible by default. It can be opened by clicking on the small up arrow in the divider below the Search Context area. It is expected that the default values will be appropriate in most cases.) The Start parameter specifies the length of the Search For string at which searching begins. Setting this parameter to a value below the default (3) will result in slower display and additional search overhead. The Delay parameter specifies the time delay (in milliseconds) following each key stroke before a new search is initiated. This parameter enables entry of a string of characters without intermediate search overhead. A longer delay allows for slower typing, but a less response search. Like the corresponding value in the standard Search panel, the Page Size parameter specifies the number of results returned in each “page” of the Search Results area. See the discussion of the Search Results panel below for details on paging through results. A large value of Page Size will increase search time and reduce the responsiveness of the panel.

Results are displayed in the Search Results area. Concepts (or Terms) can be dragged from this area to other panels of the DTS Editor. The number of returned results is shown at the top right of this area (see figure above). When a search has returned the maximum number of results, the result count is displayed in red, providing a visible cue that there are likely more results than shown. To see additional (or previous) result pages, use the Page Forward (or Page Back ) buttons.

Revision History

Version 1.0 Initial release.

Version 1.1 Bug fixes.

Version 1.2 Delay parameter added. Search For drop action changed to replace from insert.

Version 2.0 Update for DTS V4.0. Compatible with V4 Module Architecture. Additions include Status filtering (with associated result display changes), Namespace and Subset Version selection and result paging.

Version 2.1 Update for DTS 4.1.

Version 2.2 Update for DTS 4.3 Layout Manager. pSearch can be used as a Layout panel.