IMPORTANT: This document is specific to Sigma Workbooks.

Workbooks support three element types: data elements, UI elements, and control elements.

Control elements and data elements work hand-in-hand to get the data you want in front of you. Data elements display your data; whereas control elements are built and used to manipulated that displayed data.

Think data filtering and parameterization.

Summary of Content

How do controls work?
      Filter Data with Controls
      Parameters
      What does this mean for me?
Types of Controls
      Filter Types
      Parameter Types
Create a Control
Convert an Existing Element Filter to a Control
Use a Parameter in a Formula
Related Resources

How do controls work?

Control elements can be added to a workbook to manipulate that workbook's data based on user input.

Filter Data with Controls

Each filter-based control element has three primary components that define the control: type, settings and target.

Control element type: A few examples of control types include lists, date ranges, and number ranges. 

Settings: Settings are defined by workbook editors and vary depending on control type. For example, lists require source data but date ranges do not.
Together, a control's type and settings define how that control displays on the page and what user input value(s) it will accept. 

Targets: Targets are the data elements that a control element points to.  When a control's input is changed, the data in its target(s) reacts accordingly.  

Screen_Shot_2021-05-30_at_7.24.36_AM.png

Parameters

Parameters are excellent for What-If Analysis and User Input Analysis.

A parameter is a customizable field that can be added to a workbook and referenced in formulas. This allows you to dynamically replace constant values used in calculations across your workbook. 

For example, you may want to compare product sales growth by a variable 2%, 5%, and 10% percent. A parameter can be used to quickly track this variable value and inject it into formulas. 

What does this mean for me?

As a Workbook Editor

If you are authoring or editing a workbook with controls, you should have a basic understanding of how controls are constructed and how they impact targeted data elements. 

As a Viewer

If you are viewing an existing workbook, without permission or intention to edit, all you really need to know is that inputing a value into a control element will automatically update the data displayed in any elements targeted by that control.

Changing a control's input value without actively publishing the workbook only affects your current view of the workbook and its data.

Want to try it?  In the example below, click the Year list control. Then select the sales year(s) you want to include. Watch as both targeted elements respond to your changes.


Types of Controls

Filter Types

A control's type dictates the type of user input values that will be accepted by the control and the format in which those values are accepted. For example, an “include” control provides a list of data values for you to choose from, while a “range” control requests minimum and/or maximum values. 

Include

Description: Selected values will be included in your data. All other other values will be excluded.
Input Type: List of selectable values
Column Types: Text, Numbers, Dates

Screen_Shot_2021-05-30_at_7.33.15_AM.png
Note: Superficially, include and exclude filters look identical. A control element type can be identified from its vertical ••• menu, the editor panel, or from use and observation.

 

Exclude

Description: Selected values will be excluded in your data.
Input Type: List of selectable values
Column Types: Text, Numbers, Dates

Screen_Shot_2021-05-30_at_7.33.15_AM.png
Note: Superficially, include and exclude controls look identical. A control element type can be identified from its vertical ••• menu, the editor panel, or from use and observation.

 

Range (Number)

Description: Only values within the specified range will be included in your data. The range is min/max inclusive
Input Type: Min/Max numeric input boxes
Column Type: Numbers

Screen_Shot_2021-05-30_at_7.32.05_AM.png

Date Range

Description: Only values within the specified range will be included in the data. The range is min/max inclusive. Both fixed and relative date types are supported.
Input Type: A single input box with the option to select fixed and/or relative dates for both min and max values
Column Type: Dates

Screen_Shot_2021-05-30_at_7.32.15_AM.png

Text Match

Description: Allows the user to search for full and partial matches between your input text and your data’s values.
Input Types:
(1) A list of formulas to match on (ie ContainsStarts withEnds withLike), in addition to their value excluding counter parts (ie Does not contain, Does not start with, Does not end with, and Not like)
(2) A text input box for search text

Column Type: Text

Screen_Shot_2021-05-30_at_7.31.26_AM.png

Switch

Description: Allows the user to switch between True and False values.
Input Types: Switch toggle
Column Type: Boolean (true/false)

Screen_Shot_2021-05-31_at_7.59.27_PM.png

Drill Down

Description: Allows the user to view pre-defined layers of data.
Input Types: clickable text drill path
Drill Category Column Types: Text, Numbers, Dates, Boolean (true/false)

 

Parameter Types

Textbox

Description: Allows the user to enter a custom text or number value.
Input Type: A single text box. The input value will be interpreted as either text or a number depending on its pre-defined value type.

List

Description:  Allows for selection of a single value from the available list of values. The value list is defined either manually (by its creator) or from a source column in your workbook's data.
Input Type: A list with radio buttons

Date picker

Description: Allows for selection of a single date to use as a parameter value
Input Type: A calendar date picker

Switch

Description: Allows the user to switch between True and False values
Input Type: Switch toggle

Create a Control

  1. Click the + icon in the top right corner of the editor panel to open the new PAGE ELEMENTS view.
  2. Under the ELEMENTS tab, click to select your desired control element type.
    Your new element will appear on the page, and the editor panel will open up to the specific element’s configuration view.
  3. Select a Control type: Filter or Parameter
  4. Use the editor panel to configure the control. 

Convert an Existing Element Filter to a Control

The Convert to page control option creates a copy of the existing data element filter. The original element is automatically added as a target to the new control. You can customize and add additional targets to the control via the editor panel.

When a control is created from an element filter, the existing filter remain accessible. Changing the input value of the filter update the input value in the control and vice versa.  

  1. Select the data element to display the filter at the top of the page.
  2. Click to open the filter's vertical ••• menu.
  3. Select Convert to page control.
    Screen_Shot_2021-05-24_at_6.42.53_PM.png
  4. Use the editor panel to customize and add targets to your control. 

Use a Parameter in a Formula

  1. Create your parameter.Screen_Shot_2021-06-04_at_5.08.08_PM.png
  2. Create and select a new column.
  3. Click to focus the formula bar.
  4. Type in your formula, formatting the parameter id in brackets (similar to columns). Screen_Shot_2021-06-04_at_5.05.36_PM.png
  5. Click Enter to save your formula.Screen_Shot_2021-06-04_at_5.09.43_PM.png
  6. Once the formula is saved, changing the parameter value will automatically trigger the calculated column to re-calculate.Screen_Shot_2021-06-04_at_5.10.07_PM.png

Related Resources

Intro to Data Elements
Data Element Filters