Skip to main content

Form search widget

A form search widget allows you to provide filter options so that users can control the cases that are displayed in a tile widget. You use a form to specify the fields that users can use to search for cases. Only the cases that match the search criteria are displayed in the associated tile widget.

A form search widget filtering the F1 drivers displayed in the associated tile widget

Form configuration​

Before you can add a form search widget to a view, you need to add a search form to the casetype using the Add Search Form option. When creating the form, you must select the dataset that you will use to populate the tile widget, as this determines the fields that you can add to the form.

Once you have created the form, use the form designer to add the dataset columns that you want users to be able to search by. For example, for a dataset containing details of Product cases, you might want to allow users to search by name, manufacturer, price, and whether the item is in stock. Each column is added as a field to the form.

Select each field to display the properties pane and configure the options:

  • Set the Column type to Default to allow users to enter a search term. This is useful for columns that contain names, case IDs, or descriptions. For columns that contain boolean values, a checkbox is displayed.
  • Set the Column type to Picklist with counter to generate a picklist of the values found in that dataset column. The number of times each value occurs in the dataset is displayed in parentheses. This is useful for values that are repeated multiple times, such as categories, departments, and other groupings.
  • By default, the search term entered or selected by the user is compared against the rows in the dataset. Any rows with a value in the selected column that matches the search term exactly are displayed as individual tiles in the associated tile widget. You can change this behavior by selecting a different option from the Dataset operator list. For example, you might want to allow users to search for all items with dates earlier than or the same as the date that they enter. To return any items that contain a partial match, select Contains from the Dataset operator field. This is useful for text fields containing names or descriptions.

You can also use the form designer to adjust the layout, change field labels, and apply conditional logic. For more information, see Configure forms.

Widget configuration​

When you add a form search widget to a view, you must select the relevant form based on a dataset.

In order to display the search results, add a tile widget that uses the same dataset and select the form search widget from the Master widget list.

To limit the number of tiles that are displayed, use the Items per page option in the form search widget settings. If the number of matching items exceeds this limit, the results in the tile widget are paginated.

Note:

This widget is designed as a drop-in replacement for the Search options you can use in templates. To enable the total count and/or sort options available in the Search template, prefix the relevant search class with grexxsearchclass-- and add it to the CSS classes for the form search widget. For example, if your search class was mysearchclass, you would need to add grexxsearchclass--mysearchclass to the form search widget.