Skip to main content
Mitratech Success Center

Search Results Tab

 

Search Plug-ins

image

There are three types of plug-ins: Results Viewer, Result Item Selector and Document Routing. A Search Template can be configured with one Results Viewer, one Result Item Selector or one

Document Routing plug-in. When a plug-in has been selected from one of these categories, the remaining items in that category will be unavailable.

Results Viewer

Standard DataStoreDSX Compound Display Document Plug-in

The Compound Display plug-in is used to display associated documents which have been indexed using a different Data Definition. The Data Definition associated with the Search Template using the Compounds display and the Data Definition used to index the associated document must have a Custom Field Type in common.

image

Example Use of Compound Display Document Plug-in

For example, a Data Definition named Signatures is used to index signatures. A signature card is scanned-in and it is stored with a Signature Reference. The Signature Reference is based on a Custom Field Type and is used to link the signature with an account. The Signature Reference is used to identify the valid signatures for cheques from each account.

A second Data Definition is used to index cheques. This Data Definition contains the index fields which are required to store all the MICR data. In this example, this Data Definition also contains an index field based on a Custom Field Type called Signature Reference. When a cheque is indexed, the Signature Reference is entered which identifies the signatures which can be used on the cheque.

The cheques Data Definition is used to create a Search Template which contains a Document Route which defines when a cheque can be approved. The cheques Search Template is also configured with a Compound Display plug-in which defines the association between the Search Template and the Custom Field Type.

The cheque Search Template is then used to search for cheques which have not yet been approved. When a cheque is returned in the search results, a signature card is also returned so the Searching Client user can verify the signature on the cheque.

The Standard DataStoreDSX Compound Display Document Plug-in properties are described in Table 108.

{Insert text here}

Table 108. Terminology: Standard DataStoreDSX Compound Display Document Plug-in Properties

Term

Meaning

Compound, comma separated list of Document State Ids or All

Enter the list of Document State numbers returned in the search for which the search results from the second Search Template are displayed.

For example, in the above example, to display the signatures for states 0, 33 and 34 enter: 0, 33, 34.

To display the signatures for all document states, enter: All

Note: If you leave this field blank, or if you enter a state number that is not used in the Document Route, the search results from the

second Search Template are never displayed.

Compound, display compound search toolbar under compound display page

True – the toolbar is displayed under the compound search results

image

False – the toolbar is not displayed under the compound search results.

image

Compound, display the thumbnails for the compound search display

True – thumbnails are displayed below the compound search results.

False – thumbnails are not displayed below the compound search results.

Note: Thumbnails are displayed for text, PDF and TIFF files only.

Compound, the compound search title displayed above the compound search results

Enter the text you would like to be displayed as the title above the compound search results.

Compound, the percentage of the screen width used to display the compound search

Enter a value for the percentage of the width of the row to be used to display the compound search results.

Linkage, compound search template name

Enter the name of the Search Template which also contains the Custom Field Type (specified below). The search results from this Search Template is also displayed when the Document State requirements are also met.

Linkage, the Custom Field Type Id used as the linking field in the compound search

Enter the Custom Field Type Id for the field which is used in both the main Search Template and the compound Search Template.

To copy the Id, select the Custom Field Type in the Management Studio tree. The Custom Field Type summary is displayed on the Template Management tab. Select the Id and press Ctrl+C. Click on the Search Template Editor click in the text box beside The Custom Field Type Id used as the linking field in the compound search and press Ctrl+V. Delete Id and the space before the Custom Field Type Id.

Main, display main search toolbar under main page display

True – the toolbar is displayed under the main search results.

image

False – the toolbar is not displayed under the main search results.

image

Main, horizontal thumbnails

True – the main search result thumbnails are displayed horizontally below the main search results.

False – the main search result thumbnails are displayed vertically to the right of the main search results.

Note: This setting takes effect when Show Thumbnails is set to True (see below).

Main, show thumbnails

True – thumbnails are displayed for the main search results.

False – thumbnails are not displayed for the main search results.

Note: The position of the thumbnails is set with Horizontal thumbnails (see above).

Note: Thumbnails are displayed for text, PDF and TIFF files only.

Main, the main search title displayed above the search results

Enter the text you would like to be displayed as the title above the main search results.

Main, thumbnails collapsed by default

True – by default, when the Search Template is first loaded, thumbnails are not displayed for the main search results.

False – by default, when the Search Template is first loaded, thumbnails are displayed for the man search results.

Note: When Main, show thumbnails is set to True, the thumbnails can be displayed or hidden by clicking the Document Thumbnails button. See “Document Thumbnails”.

Standard DataStoreDSX Display Document Plug-in

When the Standard Display Document Plug-in is selected and a result is selected in the results grid, the Document is displayed in the selected position. The Show Thumbnails option enables the user to decide whether or not to display thumbnails.

image

image

The Standard DataStoreDSX Display Document Plug-in properties are described in Table 109.

Table 109. Terminology: Standard DataStoreDSX Display Document Plug-in Properties

Term

Meaning

Horizontal Thumbnails

True – (and when Show Thumbnails is also set to True), thumbnails are displayed horizontally below the document.

False – (and when Show Thumbnails is also set to True), thumbnails are displayed vertically to the right of the document.

Note: Thumbnails are displayed for text, PDF and TIFF files only.

Show Thumbnails

True – thumbnails are displayed either horizontally or vertically according to the setting of Horizontal Thumbnails.

False – thumbnails are not displayed.

Also see “Search Results Tab” for more information about changing the way search results are displayed.

DataStoreDSX Scrollable Display Plug-in

The Scrollable Display Plug-in is an alternative display view to the standard document view control and allows users to scroll through the pages of a multi-page document without the user needing to use a thumbnail view plug-in.

The DataStoreDSX Scrollable Display Plug-in properties are described in Table 110.

Table 110. Terminology: DataStoreDSX Scrollable Display Plug-in Properties

Term

Meaning

Horizontal Orientation

True – pages are displayed side by side. (Scrolled horizontally.)

False – pages are displayed end to end. (Scrolled vertically.)

Scroll pages horizontally:

image

Scroll pages vertically:

image

image

Result Item Selector

Standard DataStoreDSX Thumbnail Plug-in

The Thumbnail plug-in can be used to provide thumbnail displays of the retrieved documents. It cannot be used with other plug-ins which include thumbnails.

Standard DataStoreDSX Results Grid Plug-in

The Standard DataStoreDSX Results Grid Plug-in properties are described in Table 111.

Table 111. Terminology: Standard DataStoreDSX Results Grid Plug-in Properties

Term

Meaning

Show Grid

This must be set to True.

Show multiple field values

Expanded Grid Row – when a field contains multiple values, allows the Searching Client user to click the arrow to expand the grid row to display all the values.

image

Popup Window – when a field contains multiple values, allows the Searching Client user to click the arrow to display a popup window showing all the values.

image

Document Routing

Document Routing Panel

The Document Routing panel is used to display the Document Routing transitions, reasons and notes that have been assigned to search results.

See “Configure for this Search Template” for information on setting up a Document Route.

  • Was this article helpful?