Initializing help system before first use

Adding Tableau Global Filters to a Custom View

Gloabl filters provide view developers with the means to specify filters within a Tableau view as global and therefore should be applied to other Tableau views (with the same or other workbooks) when the view is initialized.

Global filters are declared via the global-filters attribute, and consist of a comma-separated list of filter names. When using global filters in Xpress Insight, the global filters are stored in local storage.

Adding a global filter

Global filters must first be created in the Tableau workbook. For specific guidance on creating Tableau filters, see the Tableau documentation. When adding global filters to a custom view, the defined names must match the filter names in Tableau.

To add a global filter to a Tableau component in Xpress Workbench:
  1. Select the Tableau component in View Designer.
  2. Add the global filters to the Tableau Attributes pane as a comma-separated list.
  3. Optionally, add a storage namespace for the filters. The storage namespace is used to define which filters to clear when running the vdl-action-tableau-clear-global-filters action.
In the VDL code, a Tableau component with global filters and a storage namespace defined will appear as follows: 
<vdl-tableau workbook="vdl_language"
									view="SupplyDemand"
         mirror-tables="factory_supply_demand"
         global-filters="Factory,Month,Scenario"
         height="500px"></vdl-tableau>

Storage namespace

Storage namespace is an attribute of a VDL Tableau component. You can use a storage namespace to separate filters using a specified key, for example, you can use the first scenario on the shelf as the storage namespace by defining the storage namespace as storage-namespace="=scenario.id" 

<vdl-tableau workbook="vdl_language"
         storage-namespace="=scenario.id"
									view="SupplyDemand"
         mirror-tables="factory_supply_demand"
         global-filters="Factory,Month,Scenario"
         height="500px"></vdl-tableau>

Clearing global filters

The vdl-action-tableau-clear-global-filters action is used to clear all of or a list of named global filters from a user's local storage and update any active Tableau visualizations in the view. You can clear specific filters by defining an array of filter names in the optional filter-names attribute as shown in the following example: 
<vdl-action-group name="clearSpecificGlobalFilters">
  <vdl-action-tableau-clear-global-filters filter-names="=['city', 'month']"></vdl-action-tableau-clear-global-filters>
</vdl-action-group>

When clearing global filters, a storage namespace can be provided. Only global filters within that storage namespace will be cleared, other global filters will be unaffected. If no storage namespace is specified, only global filters with no specified storage namespaces will be cleared. 

<vdl-action-group name="clearAllGlobalFiltersForNamespace">
  <vdl-action-tableau-clear-global-filters storage-namespace="=scenario.id"></vdl-action-tableau-clear-global-filters>
</vdl-action-group>
Parent Topic Embedding Tableau Views with the vdl-tableau Component

© 2001-2023 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.