Configuring Custom Queries - Keyword Query - System Administration - On-Premises - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Premier - Essential

On-Premises System Administration

Platform
OnBase
Product
System Administration - On-Premises
Release
Foundation 22.1
License
Standard
Premier
Essential

Keyword Custom Queries limit document searches to specified Keyword Types when searching and retrieving documents across Document Types and Document Type Groups.

CAUTION:

Keyword Custom Queries should not be configured for Keyword Types associated with Document Types that use Security Keyword Types. If a Keyword Custom Query retrieves documents that use Security Keyword Types, Security Keyword Types on the documents are not respected.

In the OnBase Client, when a user runs a Keyword Custom Query without specifying any Keyword Values, the query retrieves all documents from all Document Types that have those Keyword Types assigned. If a document has multiple values for a Keyword Type, the Document Search Results list displays the document multiple times, once for each value.

Note:

Keyword Custom Queries configured to include a Display Column that exists in a Keyword Type Group generates a Document Search Results list that displays multiple instances of the same document. This is because the Keyword Type exists independently and as part of a Keyword Type Group. Use a Document Type Custom Query instead to generate the desired Document Search Results list.

In the Unity Client or Web Client, users must specify at least one Keyword Value when running a Keyword Custom Query.

To configure a Keyword Custom Query:

  1. In the Configuration module, select Queries | Custom Queries. The Custom Query dialog box is displayed.
  2. Do one of the following:
    • Create a new Keyword Custom Query. See Configuring Custom Queries.

    • Select an existing Keyword Custom Query from the Custom Query Name list.

  3. Click Keyword Query. The Custom Query Configuration dialog box is displayed.
  4. From the Available Keyword Types list, select one or more Keyword Types to limit the query and click Add. The selected Keyword Types are added to the Selected Keyword Types list.
    Tip:

    You can also double-click Keyword Types from the Available Keyword Types list to add them to the Selected Keyword Types list.

  5. If desired, select a Keyword Type from the Selected Keyword Types list and click Move Up or Move Down to adjust the order in which the Keyword Types are displayed in the Custom Query.
  6. Click Close.
  7. Click Close.