> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://help.sigmacomputing.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://help.sigmacomputing.com/_mcp/server. # Example representation: Workbook with a modal (Beta) > Example Sigma code representation of a workbook with a modal. 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](/docs/sigma-product-releases#beta-features). This is an example representation of a workbook, retrieved using the [Get a workbook](/reference/get-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](/reference/create-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](/docs/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](/docs/manage-workbooks-as-code). ## System and user requirements To complete the steps in this example, you must meet the user requirements listed below for creating the workbook in the UI and creating it from code. The ability to create this workbook in the Sigma UI requires the following: * You must be assigned an [account type](/docs/account-type-and-license-overview) with the **Create, edit, and publish workbooks** permission enabled. * You must have access to a connection to a data platform. The ability to create a workbook from code requires the following: * You must be assigned an [account type](/docs/account-type-and-license-overview) with the **Create, edit, and publish workbooks** permission enabled. * You must have developer credentials for the Sigma API. For more information, see [Get started with the Sigma REST API](/reference/get-started-sigma-api). This example uses a table from the [Sigma Sample Connection](/docs/sigmas-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 modal element. To create this workbook in the Sigma UI: 1. Go to the **Home** page. 2. Select ![](https://sigma-docs-screenshots.s3.us-west-2.amazonaws.com/Icons/button-add.svg) **Create new** > **Workbook**. A new workbook opens. 3. From the **Add element** bar, select **UI** > **Button**. 4. In the workbook footer, select ![](https://sigma-docs-screenshots.s3.us-west-2.amazonaws.com/Icons/caret.svg) **Add modal**. A new modal appears on the workbook canvas. 5. From the **Add element** bar, select **Data** > **Table**. 6. In the **Select source** modal, search for the table `TRIP` in the `EXAMPLES.BIKES` schema. 7. In the modal header, delete the default title, and enter `The longest trip so far lasted x minutes`. 8. Continue editing the title, replace the character `x` with a dynamic value by pressing `=` on the keyboard to open formula bar. 9. Enter the formula `Max([TRIP/Duration])`. The modal title updates with a dynamic value from the table. 10. Return to **Page 1** and select the button element. 11. In the editor panel, open the **Actions** tab. 12. Select ![](https://sigma-docs-screenshots.s3.us-west-2.amazonaws.com/Icons/button-add.svg) **Add action**. 13. Configure the action with the following settings: | Option | Setting | | :--------------- | :------------- | | **Action** | **Open modal** | | **Select modal** | *Modal 1* | 14. In the document header, select **Save as**. 15. Enter a name for the workbook, such as `modal`. 16. 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](/docs/get-the-code-representation-of-a-workbook). The code representation of this workbook appears like the following: #### YAML representation ```yaml workbookId: a9f4b027-8741-4513-a1bf-3b6ff826dd3b workbookUrlId: wi0vWO04ljWx6GkVxQCeGo createdBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o updatedBy: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o createdAt: '2026-07-27T15:23:50.337Z' updatedAt: '2026-07-27T15:23:50.337Z' name: modal url: https://aws-api.sigmacomputing.com/org-name/workbook/wi0vWO04ljWx6GkVxQCeGo path: My Documents/ latestVersion: 1 ownerId: zgzXpTRVbfX4ZE9TEm9q9fUsfXZ5o isArchived: false contents: schemaVersion: 1 elements: - id: yRTA3UuP5W kind: button text: Click Me appearance: filled actions: - id: ieRGUbtmYx trigger: on-click effects: - effect: open-overlay overlayId: 1c1PaJKuUJ - id: 1j5O99IjIf kind: table source: connectionId: b2af3691-12a0-48fa-a91d-fbe2e1b31627 kind: warehouse-table path: - EXAMPLES - BIKES - TRIP columns: - id: inode-MKXXT4nWWmGyzyQ6EUt9UH/ID formula: '[TRIP/Id]' - id: inode-MKXXT4nWWmGyzyQ6EUt9UH/DURATION formula: '[TRIP/Duration]' - id: inode-MKXXT4nWWmGyzyQ6EUt9UH/START_DATE formula: '[TRIP/Start Date]' - id: inode-MKXXT4nWWmGyzyQ6EUt9UH/0j9rfNmHBAGe3asxsM formula: '[TRIP/Start Station Name]' - id: inode-MKXXT4nWWmGyzyQ6EUt9UH/START_STATION_ID formula: '[TRIP/Start Station Id]' - id: inode-MKXXT4nWWmGyzyQ6EUt9UH/END_DATE formula: '[TRIP/End Date]' - id: inode-MKXXT4nWWmGyzyQ6EUt9UH/END_STATION_NAME formula: '[TRIP/End Station Name]' - id: inode-MKXXT4nWWmGyzyQ6EUt9UH/END_STATION_ID formula: '[TRIP/End Station Id]' - id: inode-MKXXT4nWWmGyzyQ6EUt9UH/BIKE_ID formula: '[TRIP/Bike Id]' - id: inode-MKXXT4nWWmGyzyQ6EUt9UH/SUBSCRIPTION_TYPE formula: '[TRIP/Subscription Type]' - id: inode-MKXXT4nWWmGyzyQ6EUt9UH/ZIP_CODE formula: '[TRIP/Zip Code]' order: - inode-MKXXT4nWWmGyzyQ6EUt9UH/ID - inode-MKXXT4nWWmGyzyQ6EUt9UH/DURATION - inode-MKXXT4nWWmGyzyQ6EUt9UH/START_DATE - inode-MKXXT4nWWmGyzyQ6EUt9UH/0j9rfNmHBAGe3asxsM - inode-MKXXT4nWWmGyzyQ6EUt9UH/START_STATION_ID - inode-MKXXT4nWWmGyzyQ6EUt9UH/END_DATE - inode-MKXXT4nWWmGyzyQ6EUt9UH/END_STATION_NAME - inode-MKXXT4nWWmGyzyQ6EUt9UH/END_STATION_ID - inode-MKXXT4nWWmGyzyQ6EUt9UH/BIKE_ID - inode-MKXXT4nWWmGyzyQ6EUt9UH/SUBSCRIPTION_TYPE - inode-MKXXT4nWWmGyzyQ6EUt9UH/ZIP_CODE visibleAsSource: false sort: - columnId: inode-MKXXT4nWWmGyzyQ6EUt9UH/DURATION direction: descending nulls: last pages: - id: dFEbCoEprq name: Page 1 overlays: - id: 1c1PaJKuUJ type: modal name: Modal 1 modal: header: title: "The longest trip so far lasted\_{{Max([TRIP/Duration])}} minutes" kind: workbook layout: | documentVersion: 1 ``` ## Representing modals Modals appear as entries in the `contents.overlays` array, separate from pages. The overlay entry carries the modal's `type`, `name`, and configuration. In the `layout` block, it appears as its own `` entry whose `id` matches the overlay `id`. #### Modal representation ```yaml ... - id: 1c1PaJKuUJ type: modal name: Modal 1 modal: header: title: The longest trip so far lasted {{Max([TRIP/Duration])}} minutes ... ```