Create actions that modify input table data

🚩

This documentation describes a public beta feature and is under construction. This documentation should not be considered part of our published documentation until this notice, and the corresponding Beta flag on the feature in the Sigma service, are removed. As with any beta feature, the feature discussed below is subject to quick, iterative changes. The latest experience in the Sigma service might differ from the contents of this document.

Beta features are subject to the Beta features disclaimer.

Workbooks support actions that add, update, or delete rows in input table. These actions are designed to support form functionality but can be used in other ways to accommodate different data app use cases.

This document explains how to configure the Insert row, Update row, and Delete row actions. For more information about actions in Sigma, see Intro to actions.

User requirements

📘

The following requirements apply to users who configure actions. Users who access and interact with a workbook can typically trigger all existing actions within it. Any restrictions are noted in this document.

The ability to configure actions requires the following:

• You must be assigned an account type with the Full explore or Create, edit, and publish workbooks permission enabled.

• You must be the workbook owner or be granted Can explore¹ or Can edit workbook permission.

1 If you’re granted Can explore workbook permission, you can configure actions but cannot save changes to the workbook’s published version.

Insert row

Create an action that adds a new row in a target input table.

1. Open a workbook in Explore or Edit mode.
2. Select the trigger element (the element users must interact with to initiate the action), then click Actions in the side navigation.
3. In the Actions panel, click Add action in an existing sequence, or click Add action sequence to create a new one.
4. In the Action modal, configure the required fields to define the response:

• Field	Configuration
  Action	Select Insert row.
  Into	Select a target input table (empty only) to update with the added row.
  With values	For each column of your input table, define the value (or source of the value) that Sigma must pass to the row. The availability of value type options (described below) depend on the elements in the workbook. Static values: Passes a specified (fixed) value. Column: Passes the value of the specified table column. Control: Passes the value of the specified control element. Formula: Passes a value based on the defined formula. To leave a column blank, select Static values and leave the value unset.

5. If the trigger element is a table, pivot table, or input table, configure additional settings that determine when and how user interaction triggers the action sequence:
   • To trigger the action sequence only when a user selects a cell in a specific column, click the dropdown following the On select heading and select the column. To trigger the action sequence when a user selects a cell in any column, select Any column.
   • [optional] To control whether keyboard navigation within the element can trigger action sequences on the element, click More in the Actions panel, then select Allow keyboard to trigger actions. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn't display a checkmark (default), only pointer events can trigger them.

     💡

     Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.

     Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.

6. If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
7. [optional] To execute the action sequence only when a specific condition is met, click More in the action sequence, then select Add condition and configure the criteria. For more information about conditions, see Define an action condition.

8. Confirm that the data entry permission on the input table is set to accept edits in the published version. See Set data entry permission for more information.

Update row (Beta)

Create an action that updates values of an existing row in a target input table.

📘

The Update row action can only modify input tables created after April 23, 2023.

1. Open a workbook in Explore or Edit mode.
2. Select the trigger element (the element users must interact with to initiate the action), then click Actions in the side navigation.
3. In the Actions panel, click Add action in an existing sequence, or click Add action sequence to create a new one.
4. In the Action modal, configure the required fields to define the response:

• Field	Configuration
  Action	Select Update row.
  In	Select a target input table (empty or linked) containing rows to update.
  Which row	Define the value (or source of the value) that must match the unique identifier of the row to update. This can be the system-generated row ID for an empty input table or the primary key column value in a linked input table. If the target element is an empty input table that doesn't contain a row ID column, you can add one directly from the modal.
  Update with values	For each column that you want to update in the target input table, define the value (or source of the value) that Sigma must pass to the row. The availability of value type options (described below) depend on the elements in the workbook. Static values: Passes a specified (fixed) value. Column: Passes the value of the specified table column. Control: Passes the value of the specified control element. Formula: Passes a value based on the defined formula. To leave a column blank, select Static values and leave the value unset. If a column you want to update isn't listed, click + Add column and select it, or click + Add all columns. To remove a column that you don't want to update, click x Delete next to the corresponding value field.

5. If the trigger element is a table, pivot table, or input table, configure additional settings that determine when and how user interaction triggers the action sequence:
   • To trigger the action sequence only when a user selects a cell in a specific column, click the dropdown following the On select heading and select the column. To trigger the action sequence when a user selects a cell in any column, select Any column.
   • [optional] To control whether keyboard navigation within the element can trigger action sequences on the element, click More in the Actions panel, then select Allow keyboard to trigger actions. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn't display a checkmark (default), only pointer events can trigger them.

     💡

     Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.

     Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.

6. If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
7. [optional] To execute the action sequence only when a specific condition is met, click More in the action sequence, then select Add condition and configure the criteria. For more information about conditions, see Define an action condition.

8. Confirm that the data entry permission on the input table is set to accept edits in the published version. See Set data entry permission for more information.

Delete row (Beta)

Create an action that deletes an existing row in a target input table.

1. Open a workbook in Explore or Edit mode.
2. Select the trigger element (the element users must interact with to initiate the action), then click Actions in the side navigation.
3. In the Actions panel, click Add action in an existing sequence, or click Add action sequence to create a new one.
4. In the Action modal, configure the required fields to define the response:

• Field	Configuration
  Action	Select Delete row.
  In	Select a target input table (empty or linked) containing rows to delete.
  Which row	Define the value (or source of the value) that must match the system-generated row ID of the row to delete. If the target input table doesn't contain a row ID column, you can add one directly from the Action modal.

5. If the trigger element is a table, pivot table, or input table, configure additional settings that determine when and how user interaction triggers the action sequence:
   • To trigger the action sequence only when a user selects a cell in a specific column, click the dropdown following the On select heading and select the column. To trigger the action sequence when a user selects a cell in any column, select Any column.
   • [optional] To control whether keyboard navigation within the element can trigger action sequences on the element, click More in the Actions panel, then select Allow keyboard to trigger actions. When the option displays a checkmark, keyboard navigation and pointer events (e.g., mouse clicks) can trigger the action sequences. When the option doesn't display a checkmark (default), only pointer events can trigger them.

     💡

     Keyboard navigation as a trigger interaction can disrupt the user experience. For example, if the element's action sequences include actions that open links or other workbooks, a user can be unintentionally navigated away from their current task. This can be particularly disruptive if the action sequence can be triggered by selecting a cell in any column.

     Consider allowing keyboard navigation to trigger actions only when it facilitates the configured action sequences and is unlikely to interfere with usability.

6. If the trigger element is a plugin, select the name of the plugin configuration object under Custom plugin. In your code editor, refresh your plugin, then test the action in the workbook. For more information, see Configure plugins to use as trigger elements.
7. [optional] To execute the action sequence only when a specific condition is met, click More in the action sequence, then select Add condition and configure the criteria. For more information about conditions, see Define an action condition.

8. Confirm that the data entry permission on the input table is set to accept edits in the published version. See Set data entry permission for more information.