Create a One-Click Action Button
A button is a UI element that allows you to create a one-click action in a workbook. You can customize how a button is displayed and configure it to open an external link, open a Sigma document (workbook, dataset, connection table, etc.), redirect to a specific destination in the current workbook, or initiate a PDF download.
Summary of Content
Create a One-Click Action Button
User Requirements
The ability to create elements in a workbook requires the following:
- You must be assigned an account type with the Explore Workbook or Edit Workbook permission enabled.
- You must be the workbook owner or be granted Can Explore or Can Edit workbook permission.
Create a One-Click Action Button
- In the navigation menu, click
Add element to open the Add New panel. - In the Elements tab, go to the UI Elements section and select Button.
- Configure the display-related fields:
- Label - Enter a label or call to action (CTA) text.
- Appearance - Select a button style.
- Horizontal align - Align the button relative to the total element width.
- Select an Action option to determine the one-click action:
- Open an external link - opens a webpage external to Sigma
- Open a Sigma document - opens a Sigma workbook, dataset, connection table, etc.
- Go to target on this workbook - redirects to a specific page or element in the current workbook
- Download as PDF - initiates a PDF download containing the current page or entire workbook
- Refer to the following sections and configure the relevant action-related fields.
Open an External Link
Configure the following fields to create a button that opens a webpage external to Sigma:
- Link URL - Enter the external webpage URL.
- Open in - Determine how the linked page opens in the browser.
The Same window and Parent window options both open the linked page in the current browser window; however, Same window applies to workbooks accessed directly in Sigma, while Parent window applies to embedded workbooks only. When selecting an Open in option, consider how report consumers will access the workbook.
Open a Sigma Document
Configure the following fields to create a button that opens a Sigma workbook, dataset, connection table, etc.:
- Page - Enter the target document's URL slug.
The slug is the part of the target document URL that follows your organization name, beginning with a forward slash (/).
- Open in - Determine how the linked document opens in the browser.
The Same window and Parent window options both open the linked document in the current browser window; however, Same window applies to workbooks accessed directly in Sigma, while Parent window applies to embedded workbooks only. When selecting an Open in option, consider how report consumers will access the workbook.
Go to Target on This Workbook
Configure the following field to create a button that redirects to a specific page or element in the current workbook:
- Target - Select the target page or element.
Download as PDF
Configure the following field to create a button that initiates a PDF download containing the current page or entire workbook:
- Orientation - Select the downloadable content and PDF output orientation.
Permissible users can initiate a PDF download when accessing the workbook directly in Sigma. To enable PDF download in a private or application embed, append :allow_export=true to the embed URL. Users cannot download a PDF when viewing the workbook in a public embed.