Example representation: Workbook with a run Python element action (Beta)
This documentation describes one or more public beta features that are in development. Beta features are subject to quick, iterative changes; therefore the current user experience in the Sigma service can differ from the information provided in this page.
This page should not be considered official published documentation until Sigma removes this notice and the beta flag on the corresponding feature(s) in the Sigma service. For the full beta feature disclaimer, see Beta features.
This is an example representation of a workbook, retrieved using the Get a workbook endpoint with the query parameter includeContents=true. Representations like this one can be used to create a workbook from code using the Create a workbook endpoint. Each page in this example library includes the code representation of the workbook and step-by-step instructions to create it in the Sigma UI.
Consult this example and others in the Workbook representation example library to:
- Troubleshoot the formatting of a particular feature in code representation
- Relate a feature from the Sigma UI to its representation in code
- Provide context to AI tools used to create workbooks from code
This example representation cannot be used as-is. All identifying details, such as IDs, names, and URLs, have been replaced with randomized ID values or generic substitutions. The format of these contents, like the length of ID values, is preserved for demonstrative purposes. However, this representation cannot be directly used without modification to the base URL, connection details, and more. For more information, see Create and manage workbooks from code.
System and user requirements
To create this workbook in the Sigma UI, you need:
- An account type with the Create, edit, and publish workbooks and Write Python permissions.
- A Snowflake connection configured to run Python with access to the sample data and at least Can use permission.
To create a workbook from code, you need the Create, edit, and publish workbooks permission and developer credentials for the Sigma API. See Get started with the Sigma API.
This example uses a table from the Sigma Sample Connection. Your organization might have disabled access to the Sigma sample connection. If so, you can contact an admin to enable it, or use a table from another connection to follow along with this example.
Create the example workbook in the Sigma UI
This example shows a workbook with a button that runs a Python element. The Python code collects the table data into a pandas DataFrame, so the data must fit in the available memory.
To create this workbook:
-
Go to the Home page and select Create new > Workbook.
-
From the Add element bar, select Data > Table.
-
In the Select source modal, search for and select
TRIPin theEXAMPLES.BIKESschema. -
From the Add element bar, select Data > Python.
-
Select the Snowflake connection used by the
TRIPtable. -
In the code editor, enter the following code:
-
Confirm that the table element name is
TRIP. -
From the Add element bar, select UI > Button.
-
Select the button, and in the editor panel, select Actions.
-
Add an action sequence, and configure its action with Action set to Run Python element and Element set to the Python element.
-
In the document header, select Save as.
-
Enter a name for the workbook, such as
run-python-element-action. -
Select Save.
Get a code representation of this workbook
To get a representation of this workbook, follow the steps in Get the code representation of a workbook.
The connectionId values in this example are placeholders. To create a workbook from the representation, replace them with the ID of a Snowflake connection configured for Python in your organization.