Using Operators for Custom Queries - E-Forms - English - Foundation 22.1 - OnBase - Premier - external - Standard - Premier - Standard

E-Forms

Platform
OnBase
Product
E-Forms
Release
Foundation 22.1
License
Premier
Standard

Some instances call to mapping fields in such a way that Keyword Values are evaluated and results are returned.

The following table defines operators used for custom queries:

CAUTION:

These tags are supported only for E-Forms and HTML Form custom queries. Using these tags in standard HTML documents stored in OnBase is not supported, and will yield unexpected results.

<SELECT name=OBOperKey__keyword_keywordoccurrence>

This tag specifies that a Keyword Value will be evaluated using an operator for the custom query. The Keyword Type Number or the Keyword Type Name must be placed in the tag where keyword is specified, along with the occurrence of the Keyword Type within the form. If the Keyword Type Name is used, the Keyword Type Name must match the Keyword Type Name configured in the system. Examples:

<Select name=OBOperKey__318_1>

<Select name=OBOperKey_Patient_Name_1>

Note:

OBOperKey is followed by one underscore character (_) when using a Keyword Type name and two underscores (__) when using a Keyword Number.

<OPTION>

This tag specifies what operators are available for each OBOperKey instance. The following operators and their corresponding codes are available for use:

  • =(equals)

  • &lt;(less than)

  • &lt;=(less than or equal to)

  • &gt;(greater than)

  • &gt;=(greater than or equal to)

  • &lt;&gt;(Not equal to)

    There is no space between the codes.

  • &quot; &quot;(Literal)

    There is a space between each &quot;

  • IsNull(null values)

Examples:

<OPTION>&lt;</OPTION>

<OPTION>&lt;=</OPTION>

<OPTION>&gt;</OPTION>

Note:

There must be an <OPTION> tag for each operator to be made available.

<INPUT name=OBKey__keyword_keywordoccurrence>

This tag specifies the Keyword Type to which the input field is linked. The Keyword Type Number or the Keyword Type Name must be placed in the tag where keyword is specified, along with the occurrence of the Keyword Type within the form. If the Keyword Type name is used, the Keyword Type name must match the Keyword Type name configured in the system. Example: <INPUT name=OBOperKey__318_1>

<SELECT name=OBOperator__keyword_keywordoccurrence> <OPTION selected>AND</OPTION> <OPTION>OR</OPTION></SELECT>

The OBOperator tag allows the inclusion of the AND and OR operators after the input field, in order to create more complex search options.

The Keyword Type number or the Keyword Type name must be placed in the tag where keyword is specified, along with the occurrence of the Keyword Type within the form. If the Keyword Type Name is used, it must match the Keyword Type Name configured in the system.

The following limitations apply when working with this operator:

  • The Use OR for duplicates option applies to duplicate Keyword Type fields on an HTML form. If this option is selected, each value in duplicate Keyword Type fields will be searched for separately, as if the values were joined by the OR logical operator.

  • The Use OR for duplicates option overrides the OBOperator tag. Even if a user selects AND to join the two Keyword values, the OR operator is used. If this option is not selected, the OBOperator tag is respected, and users can refine their searches using the AND or OR operator.

The following limitations apply to operators used for custom queries:

  • Any codes used to map Keywords, including the Keyword name itself, are not case sensitive.

  • The selected value can be specified by default for an operator. To do so, the following tag must be used for the option selected by default: <OPTION selected></OPTION>.

Example code:

<TBODY>
    <TR>
        <TD>Num #1:</TD>
        <TD><SELECT name=OBOperKey__315_1> <OPTION selected>=</OPTION> <OPTION>&lt;</OPTION> <OPTION>&lt;=</OPTION> <OPTION>&gt;</OPTION> <OPTION>&gt;=</OPTION> <OPTION>&lt;&gt;</OPTION> <OPTION>""</OPTION></SELECT></TD>
        <TD><INPUT name=OBKey__315_1></TD>
        <TD><SELECT name=OBOperator__315_1> <OPTION selected>AND</OPTION><OPTION>OR</OPTION></SELECT></TD>
    </TR>
    <TR>
        <TD>Num #2:</TD>
        <TD><SELECT name=OBOperKey__315_2> <OPTION selected>=</OPTION><OPTION>&lt;</OPTION> <OPTION>&lt;=</OPTION> <OPTION>&gt;</OPTION><OPTION>&gt;=</OPTION> <OPTION>&lt;&gt;</OPTION> <OPTION>""</OPTION></SELECT></TD>
        <TD><INPUT name=OBKey__315_2></TD>
    </TR>
    <TR>
        <TD align=middle colSpan=4><INPUT type=submit value=Query name=OBBtn_Yes>&nbsp; <INPUT type=submit value=Cancel name=OBBtn_Cancel><BR></TD>
    </TR>
</TBODY>