A list of Filter Set Configurations is displayed. A Filter Set defines a set of filters and their options. Canto provides preconfigured Filter Sets to be used e.g. with Cumulus Portals and Cumulus Mobile App.
You can adjust the sequence of the Filter Set Configurations with the buttons on the right side.
You can edit existing Filter Set Configurations or add new ones. Clicking the according buttons opens the Filter Set Configuration window.
Filter Set Configuration
This window is for editing existing filter sets, or specifying new ones.
• Filter Set Name – Name of the filter set to be edited (existing or new one).
• Configured Filters – List of filters that are contained in the current filter set. You can edit or remove existing filters or ad new ones according buttons below the list. And you can change the sequence of the filters with the according buttons on the right side of the list.
NOTE: Employing filters influences the performance. The more filters are employed, the more load for the Cumulus Server.
There are different types of filters:
• Standard – filters based on the values of record fields,
• Input – field-based filters which can be further controlled via input by the user.
• Range Input – field-based filters which can be further controlled via input by the user. The user can enter a range of desired field values.
• Query-based – filters based on queries, which are usually more complex than simple field-based filters
• Type-ahead – filters based on the values of string lists.
You can adjust the sequence of the filters with the buttons on the right side.
You can add more filter or edit existing ones via the appropriate buttons.
Adding Standard Field-based Filters
To add a field based filter:
1. Click Add. The Select Filter Type window is displayed.
2. Click Standard. The Select the field for filtering window is displayed.
3. Select the field you want to use for filtering. Click OK. The Configure Filter window is displayed.
4. You can
• enter a name for the filter (default: the name of the selected field)
• enter a description
• define whether this filter is displayed collapsed or expanded at startup
Depending on the selected field you can
• define whether this filter is displayed hierarchically (default: a flat list of options)
• define whether the flat list is ordered by frequency (default: alphabetically), and the number of initially shown entries
• define, whether the user can select multiple options from the list (default: no) and the logical operator used to combine these options (default: OR)
5. Click OK.
Adding Input Filters
To add an input filter:
1. Click Add. The Select Filter Type window is displayed.
2. Select Input. The Select the field for filtering window is displayed.
3. Select the field you want to use for filtering. The Configure Filter window is displayed.
4. Enter a name for the filter (default: the name of the selected field).
5. Enter a description (optional).
6. Define whether this filter is displayed collapsed or expanded at startup.
For most field types, filtering is performed according to the user’s input. If you have selected a string field in step 2), you must
7. define how filtering is processed: either
• according to the users input (Filter by entered value), OR
• according to values suggested by Cumulus (Filter by suggested values). Initially, Cumulus suggests the values most frequently contained in the selected field. When the user starts typing, the initial suggestions are replaced with suggestions matching the user’s input.
8. If Filter by entered value is selected, you must additionally specify the search operator to be used with the user’s input (Starts with / Does not start with / Equal to / Not equal to).
If Filter by suggested values is selected, you must additionally specify the initial number of suggestions for the most frequently contained values, and the number of suggestions matching the user’s input.
9. Click OK.
Adding Range Filters
To add an range input filter:
1. Click Add. The Select Filter Type window is displayed.
2. Select Range input. The Select the field for filtering window is displayed.
3. Select the field you want to use for filtering. The Configure Filter window is displayed.
4. Enter a name for the filter (default: the name of the selected field).
5. Enter a description.
6. Define whether this filter is displayed collapsed or expanded at startup.
7. Click OK.
NOTE: Field-based filters are only available to Portals users if the respective field is contained in each catalog the user can access. A filter based on a field that is not part of all accessible catalogs is not displayed to the user!
Adding Query-based Filters
To add a query based filter:
1. Click Add. The Select Filter Type window is displayed.
2. Select Query-based. The Configure Filter window is displayed.
3. Enter a name for the new filter. Additionally, you can
• enter a description
• define whether this filter is displayed collapsed or expanded at startup
4. Define the options for this filter. An option is a query with a name (and an optional description):
• Click Add. The Configure Filter Option window is displayed
• Enter a name and the desired query. Note that queries for filters must be created individually. It is not possible to use previously saved queries! The most convenient way to create a query is to compose it in the Cumulus Client’s Find window in Advanced Mode, then copy it into the Query field of the Configure Filter Option window.
5. Click OK.
6. Add (or edit) more filter options, if necessary.
7. Define which logical operator you want to use to combine the defined options: AND or OR.
8. Click OK.
Names and descriptions of filters and filter options can be easily adapted to a multitude of languages via the button in the respective windows. Clicking this button opens a window for entering translations of the name and description.
Known Issue: Filters and Localization
After installing Cumulus Web Solutions going to the CIP Configurator, then, Settings and Filters, you may not be able to add a filter because the Standard button is deactivated and other options return an error. This probably means you have not installed your Cumulus Products in the English language.
The sample below shows the CIP Configurator issue after installing Cumulus in French (The Standard button is disabled and clicking on another button will return an error):
To build the fields list needed for filter settings, the CIP Configurator is checking the catalogs configured in the Catalog Aliases (under Catalog Access) and try to find such catalog name in your catalogs folder. When installing Cumulus in another language than English, the Sample Catalog name is localized but the default cip-config.xml file still has the English catalog name.
For instance, in a French installation, the Sample Catalog will be named "Catalogue d'exemple" (which is it's ccf file name as well). CIP Configurator finds "Sample Catalog" for all catalog aliases and no file is matching that name, so no field can be loaded to configure filters.
What to do? Just go the Catalog Access and for at least one Catalog Alias, remove the Sample Catalog and add an existing catalog. Then, everything works as expected.
button in the respective windows. Clicking this button opens a window for entering translations of the name and description.