WorkView Filter Results component
The WorkView Filter Results Form Component allows a WorkView Filter to be executed within a form submission, and the results presented to the submitting user as options to select from in a dropdown list.
The component makes use of WorkView Filter Configurations, an appropriate Filter Configuration will need to be set up prior to configuring this logic.
Settings
When adding the component to a page template, the following settings will need to be configured:
| Name | Description |
|---|---|
| Filter Configuration | The Filter Configuration which will determine the WorkView Filter and the criteria used for fetching the results |
| Filter display column to user for option labels | Which value from the results should be presented to the user to select from |
When adding the page into the form, you may be prompted to configure additional settings. These settings are mappings for any values required by criteria defined in the Filter Configuration.
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.
Return values
Under usual circumstances, the component will return the Object Key, and values for each of the display columns defined within the Filter, for the option selected by the user, however there are scenarios where the user would not be presented with options from Filter results, to choose from:
- if the Filter returns no results, the component will present a single option to the user: "My answer is not listed" with a value of
[none] - if there is an error executing the Filter (for example, if the values provided for the criteria are not valid), the component will present a single option to the user: "My answer is not listed" with a value of
[error]
It is important that you use branching and/or logic to handle these scenarios appropriately.
For column values, 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.