Create and manage workbook actions (Beta)

🚩

This is a public beta feature that’s subject to quick, iterative changes. As a result, the latest product version may differ from the contents of this document.

Workbook actions are user-defined interactivity that you can configure within and across elements in a workbook. By automating responses to specific user interactions, you can create efficient workbook workflows that produce quick and relevant data insights.

This document introduces workbook actions and explains how to configure them for streamlined data exploration and analysis. For information about using actions to create cross-element filters, see Configure cross-element filtering.

User requirements

The ability to create and manage workbook actions requires the following:

  • You must be assigned an account type with the Explore workbooks or Create, edit, and publish workbooks permission enabled.
  • You must be the workbook owner or be granted Can explore or Can edit workbook permission.

πŸ“˜

These requirements only apply to users who create and manage workbook actions. Configured workbook actions are applied to the interactions of any user who can view the workbook.

Understanding workbook actions

A workbook action consists of a trigger and a response. The trigger is the user interaction with a specific element (the trigger element), and the response is the defined reaction to the trigger.

Supported triggers:

Trigger elementInteraction
Table or pivot tableUser clicks a cell in a specific column
VisualizationUser clicks a data point on the chart
Input tableUser clicks a cell in a specific column
UI element
(button or image only)
User clicks the element
Control elementUser changes the control value

Supported responses:

ResponseDescription
NavigateShift the focus to the top of a specific page or a different element in the same workbook.
Set control valueSet the value of a specific control element in the same workbook.
Refresh element

Refresh the data of a specific element in the same workbook.

If the element is materialized, this workbook action doesn’t refresh the materialization.

Configure a workbook action

  1. Open a workbook in Explore or Edit mode.

  2. Select the trigger element on which you want to configure an action, then click Actions in the side navigation.

  3. In the Actions panel, click Add action.

  4. In the On cell click, On click, or On change modal (depending on the trigger element type), configure the workbook action to define the response:

    1. If the trigger element is a table, pivot table, or input table, select a column in the When clicking cells in field. Sigma only initiates the action when a user clicks a cell in this column.
      If the trigger element is a visualization, button, image, or control, skip this step and proceed to step 4b.

    2. Configure the remaining fields based on the type of response you want to initiate:

      Navigate to a specific page or element
      ActionSelect Navigate.
      DestinationSelect the page or element you want to shift to in the workbook view.

      Set the value of a specific control element
      ActionSelect Set control value.
      Update control valueSelect the control element you want to update.
      Set value as
      Option 1: Select Specific values to always set the control to one or more fixed values, then choose the values.
      Option 2 (available only when the trigger element is a table, pivot table, input table, or visualization): Select Values from a specific column to set the control to a value from a particular column, then choose the column. The control is dynamically set based on the column value from the same row as the clicked cell or data point.

      Refresh the data of a specific element
      ActionSelect Refresh element.
      ElementSelect the element you want to refresh.

View all workbook actions on a specific page

  1. Open a workbook in Explore or Edit mode.

  2. Without selecting an existing element, click Actions in the side navigation.

    The Actions panel lists all page elements that contain actions and the number of actions configured on each. You can click on an element to view the individual configured actions.

Edit a workbook action

  1. Open a workbook in Explore or Edit mode.

  2. Select the element containing the action you want to edit, then click Actions in the side navigation.

  3. In the Actions panel, locate the action you want to edit, then click More and select Edit.

  4. In the On cell click, On click, or On change modal, update the action configurations as needed.

Duplicate a workbook action

  1. Open a workbook in Explore or Edit mode.

  2. Select the element containing the action you want to duplicate, then click Actions in the side navigation.

  3. In the Actions panel, locate the action you want to edit, then click More and select Duplicate.

Delete a workbook action

  1. Open a workbook in Explore or Edit mode.

  2. Select the element containing the action you want to delete, then click Actions in the side navigation.

  3. In the Actions panel, locate the action you want to edit, then click More and select Delete.