Keyword Parameters - DocPop - English - Foundation 22.1 - OnBase - Essential - Premier - Standard - external - Standard - Essential - Premier

DocPop

Platform
OnBase
Product
DocPop
Release
Foundation 22.1
License
Standard
Essential
Premier

Keyword parameters specify the Keyword Types and values used for retrieval and how the values relate to each other. The format for Keyword parameters is displayed below. The bracketed items represent variables, which are described in the table at the end of this section.

KT[Keyword Type Number]_[Instance Number]_[Comparative Operator Number]_[Logical Operator Number]=[Keyword Value]

If a Keyword value uses a specific currency format, add the following parameter for each value:

KTCF[Keyword Type Number]_[Instance Number]=[Currency Format Number]

The variables required in the Keyword parameter are described in the following table:

Variable

Description

Keyword Type Number

The Keyword Type's internal number as defined in OnBase. This is the number displayed in the upper-right corner of the Keyword Type Configuration dialog box when the Keyword Type is selected in OnBase Configuration.

Instance Number

The Keyword value's position relative to other values provided for the same Keyword Type. The number for the first instance of the Keyword Type is 0.

If there are two values for a single Keyword Type, the second value would have an instance number of 1.

Comparative Operator Number

The numeric value that specifies which comparative operator to use with the Keyword value. Possible values are listed below:

  • 0 for = (equal to)

  • 1 for < (less than)

  • 2 for > (greater than)

  • 3 for <= (less than or equal to)

  • 4 for >= (greater than or equal to)

  • 5 for <> (does not equal)

  • 6 for '' '' (exactly matches)

Logical Operator Number

The numeric value that specifies which logical (boolean) operator to use when multiple Keyword values are provided for a single Keyword Type. Possible values are listed below:

  • 0 for AND

  • 1 for OR

  • 2 for TO

Keyword Value

The Keyword value you want to use to limit your search.

Currency Format Number

The currency format ID for Keyword values that require a specific currency format. This is the number displayed in the upper-right corner of the Currency Format Configuration dialog box when the currency format is selected in OnBase Configuration.