Object set filter variables

An object set filter variable is used to track the filter state of an object set, often output by widgets such as the Filter List, XY Chart, Vega Chart or Pivot Table widgets. Object set filters can then be applied to object set variables, or used to filter object sets in widget configurations.

Create an object set filter variable

Because an object set filter variable is often meant to capture the output of a widget's selections, it can be created as an empty variable and then used in widget configurations.

A default state for the filter can also be specified by selecting object types, property types, and values for those property types. The values can be specified inline, or as variables.

If you select multiple object types, it is recommended that you filter on properties that are shared by all object types. Failure to do so may result in unexpected behavior, especially if deploying the module from Marketplace.

You can also remove the specified object types once your properties are specified if you want to make your filter object type agnostic. Note that you cannot add additional property filters, or select variables for property values, unless at least a single object type is specified.

Filter value extraction

For some workflows, it may be helpful to extract specific filtered values from an object set filter to use them elsewhere in your module. Here are some sample use cases where this may be valuable:

1. You want to extract and translate a user's filtered values from an initial object type to a secondary object type with a different data model. For example, if a user is initially filtering on the Email Date property on an Email object, and you want to translate that filter to also work on the Call Date property of a Phone Call object.
2. A user filters to a given alert type in the Filter List widget, and you want to extract their chosen alert type into a string variable to then use it to pre-fill a Create New Alert Action.
3. A user has filtered down to certain properties in the Exploration Search Bar widget, and you want to extract and save their filter state using module interface variables as dynamic URL parameters so that the module can be re-loaded with those same selections.

To accomplish this, you can specify a default filter variable state using variables for property values, and turn on Update used variables on filter value changes.

When the filter value is updated to a filter that matches the shape of the default filter, the value for each variable in the configured default will be updated to the extracted value from the filter.

Using the filter above, if I select a range of points-per-game in my filter list, the numeric inputs that are backed by these extraction variables will be updated.

Only the following value types can be extracted:

• Numeric ranges
• Date/Time ranges
• String terms
  • An array variable should be configured to extract multiple values. If a non-array variable is configured, only the first filtered value will be extracted.