Required Keywords - Public Sector Constituency Web Access - Foundation 24.1 - Foundation 24.1 - Ready - OnBase - external

Public Sector Constituency Web Access

Platform
OnBase
Product
Public Sector Constituency Web Access
Release
Foundation 24.1
License

The RequiredKeywords element of the web.config file can be used to designate Keyword Types as required for specific Custom Queries. This means that public users cannot execute the query without filling out that keyword's search field.

Note:

The configuration of required keywords using WAMCon is not supported.

Within the RequiredKeywords element, create a child Query element with an ID attribute for the Custom Query you want to configure required keywords for. Set the value of the ID attribute to the ID number of the Custom Query you want to configure. Under this child element, add a grandchild Keyword element containing an ID attribute with a value set to the ID number for the Keyword Type you want to be required.

Tip:

Custom Queries and Keyword Types are represented by ID numbers. You can view the ID number for a Custom Query in the Configuration module by selecting it in the Custom Queries dialog box. Likewise, you can select a keyword in the Keyword Type Configuration dialog box to see its ID number.

In the following example, the Applicant Information Custom Query (ID #106) is configured to require the Name Keyword Type (ID #120) to execute a search:

<RequiredKeywords>
    <Query ID="106">
        <Keyword ID="120"/>
    </Query>
</RequiredKeywords>

You can also configure queries to require multiple keywords by using additional Keyword elements, or use the wildcard character "*" as the query ID to make the Keyword Types specified in that Query element required for all applicable Custom Queries.

In the following example, the Location Keyword Type (ID #118) is required for all queries, and the Applicant Information Custom Query (ID #106) is configured to additionally require the Name(ID #120) and Position Applied(ID #117) keywords.

<RequiredKeywords>
    <Query ID="*">
        <Keyword ID="118"/>
    </Query>
    <Query ID="106">
        <Keyword ID="120"/>
        <Keyword ID="117"/>
    </Query>
</RequiredKeywords>