String Constraint Filter

Overview #

A String Constraint filter provides a way to filter data on the client using a set of predetermined String values. These String values are called “Constraints”, and can be generated from unique values in the underlying data. This approach allows an end user to see a pull-down of values which are known to be present in the data.

Create a String Constraint Filter #

To create a String Constraint Filter, perform the following steps:

  1. Log in to edgeSuite as an administrator.
  2. Open a Page in Edit Mode.
  3. Above the Visualization in which you want to add the filter, click the gear button to show the options drop-down menu.
  4. Select “Edit Filters”.
  5. On the “Manage Client Filters” dialog, click + to add a new filter.
  6. On the “Select Client Filter” dialog, click + Add to show the selection list.
  7. Click to select “String Constraint Filter”.

Add and Edit a String Constraint Filter #

String Constraint Filters can be reused across different datasets. The only thing required for a String Constraint Filter is a list of valid values that can be used as input. This is the same “Constraint” concept that is used with server variables. Since “Constraints” are defined globally, any constraint already defined for use with variables can be reused for client filters as well, and visa-versa. The example below shows a String Constraint that will provide a list of valid Company Names which will be presented as a pull-down. See String Constraint for more information.

An Unconstrained String Filter #

If an administrator does not want to limit input, then they can use the system provided “Unbounded String” option. This will result in an text field input instead of a pull-down, and will allow end users to type whatever they want, similar to the “Search Field” client filter.

Applying a String Constraint Client Filter #

Applying a String Constraint Filter involves selecting an attribute. It is essentially a mapping exercise. The “Attribute to Filter” property should contain values that have some relationship to the Constraints defined in the String Constraint Filter.  For Example:

  • Constraints are derived from an Attribute containing names of National Parks.
  • The String Constraint Filter would be applied to a dataset that has an attribute with National Parks.

String Constraint Properties #

Property
Description
Attribute to Filter Selects the attribute in the underlaying data to use with this filter.
Cleared Label A text string that can be selected to clear the filter, and return all records. The default value is “All”.

Example String Filter #

The default value for a String Filter is “All”, which shows all records.

Example of a String Filter (Expanded) #

The pulldown menu contains the list of constraints, which is a set of valid STRING values that can be used as input for the filter.