Dynamic Keyword Values - Public Sector Constituency Web Access - English - Foundation 22.1 - OnBase - external

Public Sector Constituency Web Access

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

To predefine dynamic Keyword Values based on a query string, set the value of the useQueryStringKeywords key to true, and keywordList to null. For example:

"showSingleQuery": true
"selectedQueryId": 103,
"keywordList": null,
"useQueryStringKeywords": true

Then, include keyword ID and value pairs to use for the query in the query string appended to the URL. The format for a keyword query string field is as follows:

?OBKey__[ID]_[Instance]=[Value]

Where [ID] is the Keyword Type ID number, [Instance] is the iteration of the keyword (starting at 1, multiple keyword instances are only used with Operator Constraints), and [Value] is the Keyword Value to use. Note that there are two _(underscore) characters between OBKey and the keyword ID, and only one between the ID and instance number.

The following example shows a query string where the values of Transportation for the Department Keyword Type (ID #115) and Awarded for the Status Keyword Type (ID #119) are predefined:

?OBKey__115_1=Transportation&OBKey__119_1=Awarded

For more information on query strings, see Using Query Strings.

Note:

If you want to use a combination of static and dynamic predefined Keyword Values to preconfigure a query, you can add keyword and value pairs to the keywordList array and set useQueryStringKeywords to true. However, keep in mind that the Keyword Values defined in the query string override any static values for the same Keyword Type in the keywordList.