Initializing help system before first use

Defining Tableau Global Filters

Tableau Global Filters are defined in the companion file.

These should be located under the tableau element located within the client element and must be located after the definition of any view-group elements.

A Tableau Global Filter is defined using a global-filter tag and has a mandatory name attribute. The contents of the attribute should match exactly the filter or parameter name as defined within the Tableau view. These can be obtained from the Filters and Parameters sections of the view when shown within Tableau Desktop.

A Tableau Global Filter can have zero or more include or exclude elements. By default it will apply to all views unless one or more exclude elements are defined. When an include element is added the Tableau Global Filter immediately changes so that all views are excluded except for those specifically included.

The exclude/ include elements have a mandatory workbook attribute and an optional view attribute. These should match exactly with the names of the workbook and view.
Note When a combination of include/ exclude elements are defined for a Tableau Global Filter, the include elements are processed before the exclude elements irrespective of the order in which they were defined.
The following shows several examples of the definition of Tableau Global Filters within a companion file. 
<client>
  <view-group title=”Tableau views”>
    <tableau-workbook title="workbook1" workbook="Workbook1" managed="true"/>

    <tableau-workbook title="workbook2" workbook="Workbook2" managed="true"/>
  </view-group>

  <tableau>
    <!-- Applied to all views in all workbooks -->
    <global-filter name=”MyEx1”/>

    <!-- Applied to all views except the views in Workbook2 -->
    <global-filter name=”MyEx2”>
      <exclude workbook=”Workbook2”/>
    </global-filter>

    <!-- Applied to all views except for the MyW2View view -->
    <global-filter name=”MyEx3”>
      <exclude workbook=”Workbook2” view=”MyW2View”/>
    </global-filter>

    <!-- Applied only to views in Workbook1 -->
    <global-filter name=”MyEx4”>
      <include workbook=”Workbook1”/>
    </global-filter>

    <!-- Applied only to the MyW1View view in Workbook1 -->
    <global-filter name=”MyEx5”>
      <include workbook=”Workbook1” view=”MyW1View”/>
    </global-filter>

    <!-- Applied only to the MyW1View and MyW2View views in Workbook1 and Workbook2 -->
    <global-filter name=”MyEx6”>
      <include workbook=”Workbook1” view=”MyW1View”/>
      <include workbook=”Workbook2” view=”MyW2View”/>
    </global-filter>

  </tableau>
</client>
Parent Topic Tableau Global Filters