Skip to main content

Hyland OnBase - WorkView Filter Result

The Hyland OnBase - WorkView Filter Result Form Logic allows a WorkView Filter to be executed within a form submission, to retrieve either a column value from a single result, the object key of the single result, or the number of results that the Filter returns.

The logic makes use of WorkView Filter Configurations, an appropriate Filter Configuration will need to be set up prior to configuring this logic.

In the logic settings, select the Filter Configuration. Depending on the criteria set up in the Filter Configuration, additional settings will the become available, which will be used when executing the Filter.

For each criteria you have set up as "Prompt User - optional" or "Prompt User - mandatory", a setting will be available to map a value to. It is important that you consider the datatype of the attribute that you are mapping a value to.
The following values can be mapped to a Boolean attribute: true, yes, y, 1, false, no, n, 0 (all case-insensitive).
When mapping to a Date or DateTime attribute, for best results map to a Date component or Date based Logic.
Due to a limitation in the OnBase API, only the date portion of any DateTime value will be considered when executing the filter.

If you have any "Related Document Keyword" criteria set up, a setting will be available to map a Document ID to.

If you have any "Related Object Attribute" criteria set up, a setting will be available to map an Object key to.

For these additional settings you can map any form response, variable or logic result. Alternatively you can enter manual text by typing it into the search box for the field and pressing the return key.

Finally, select a Value to return. The options available here are:

  • Number of results - the number of results returned by executing the Filter.
  • Object key - if the Filter returns a single result, this is the key of that Object.
  • Any of the display columns configured for the Filter. The logic will only output a value for these if the Filter returns a single result.
    The output format of Date attributes is yyyy-mm-dd and the output format of DateTime attributes is yyyy-mm-dd hh:mm:ss. If you need to display these values to the user, you can convert the format to be more user-friendly.

If the Filter returns no results and either the Object key or one of the Filter's display columns are selected as the Value to return, the result of the logic will be [none].

If the Filter returns more than one result and either the Object key or one of the Filter's display columns are selected as the Value to return, the result of the logic will be [multiple].

If the Filter cannot be executed either due to an error from the API, or because invalid values were given for the criteria, the result of the logic will be [error]. Where feasible, errors are logged to the log within Integrations Hub.

Configuring a "WorkView Filter Result" Form Logic