Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ environments: web
status: published
feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues
tags: default
lastUpdated: 2025-11-05
lastUpdated: 2026-05-10

# Plugin Use Case 01: Dashboard Builder

Expand Down Expand Up @@ -74,32 +74,48 @@ Duration: 5

We need to prepare a workbook that allows users to select from a small set of curated content (charts, KPIs, tables, etc.) to create their own custom dashboard. This workbook will be embedded into a host application later.

### Template

To make this process easier, we have created a [template](https://help.sigmacomputing.com/docs/create-and-edit-workbook-templates) that has a few KPIs preconfigured already.

Return to the Sigma homepage and click `Templates`. Click to select the `Dashboard Builder QuickStart` template:
<aside class="negative">
<strong>NOTE:</strong><br> The template is available by direct link only and not listed in the Sigma UI.

In order to use the template you must first log onto your Sigma instance and then browse to the url:

<a href="https://app.sigmacomputing.com/template?provider=7d0fc8a6-bf65-47f4-86e6-39eba581fe15&shareId=55af1852-7e92-4f3b-b817-5d87ffaf239c&namespace=production&templateId=62aeb36d-ccfc-48ad-8344-1b26d0f0502c">Dashboard Builder Template</a>
</aside>

The template will prompt to `Swap data sources`. Since it uses Sigma provided sample data, the `% Match` should be `100%`.

Click `Choose`:

<img src="assets/cdf_00.png" width="600"/>

<img src="assets/dbb_04.png" width="800"/>
Once done, the fully-built workbook is presented and we can `Accept` the swap:

This creates a new (unsaved) workbook we can use for our embed. Let's spend a few moments breaking down the structure:
<img src="assets/cdf_00a.png" width="800"/>

<img src="assets/dbb_05.png" width="800"/>
This creates a new (unsaved) workbook we can use for our embed:

There are three page tabs (#1 in the screenshot):
<img src="assets/cdf_00a.png" width="800"/>

Let's spend a few moments breaking down the structure. There are three page tabs.

**Dashboard Builder Page:**<br>
**#2:** Provides the embedded user three "containers" where elements may be placed. Elements can be selected from any of curated elements provided in the library by clicking an `Edit` button when in `Edit` mode.
**1:** Provides the embedded user three "containers" where elements may be placed. Elements can be selected from any of curated elements provided in the library by clicking an `Edit` button when in `Edit` mode.

Each container has an independent iframe element which is preconfigured for an click action to generate an iframe event when clicked:
Each container has an independent iframe element which is preconfigured for a click action to generate an iframe event when clicked:

<img src="assets/dbb_13.png" width="800"/>

The action sets the nodeID and URL value (each area has a different static value assigned) once a KPI is selected for the selected area, if the nodeID is not empty.

**3:** The controls are shown on the Dashboard Builder page only so that we can see the values change as we make changes.
**2:** The controls are shown on the Dashboard Builder page only so that we can see the values change as we make changes.

In order for the host application to know which control and "viz / container" is configured for which element, it needs to be able to construct the proper combination of URL, NodeID and most recent Explore key for each element the user has selected.

Storing the values in controls allows the dashboard to be changed by the user at any time, without effecting other users.
Storing the values in controls allows the dashboard to be changed by the user at any time, without affecting other users.

Once the user has saved a bookmark, the configuration data is written to a local JSON database.

Expand All @@ -109,14 +125,14 @@ Once the user has saved a bookmark, the configuration data is written to a local

**4:** A toggle control to allow the user to place the workbook into edit mode and select from the library.

If we click `Edit`, the modal appears, and displays the three KPI that are curated for us on the `Library` page:
If we click `Edit`, the modal appears, and displays the three KPIs that are curated for us on the `Library` page:

<img src="assets/dbb_07.png" width="800"/>

**Library Page:**<br>
Houses the curated elements that users can select from. We have pre-build three KPI for the QuickStart and included them in the template.
Houses the curated elements that users can select from. We have pre-built three KPIs for the QuickStart and included them in the template.

Looking at the actions for the `Revenue` KPI, we can see that when it is clicked, the `vizEmbedUrlControl` on the `Dashboard Builder` page is updated. This allow Sigma to know which KPI was selected by the user:
Looking at the actions for the `Revenue` KPI, we can see that when it is clicked, the `vizEmbedUrlControl` on the `Dashboard Builder` page is updated. This allows Sigma to know which KPI was selected by the user:

<img src="assets/dbb_08.png" width="800"/>

Expand All @@ -142,7 +158,7 @@ We will share with the `Embed_Users` team created in the `REST API Usage 01: Get
## Register Plugin in Sigma
Duration: 5

To keep this simple. we will use a compiled version of the Dashboard Builder plugin code in a hosted environment. This means all we have to do is configure a plugin in Sigma and provide the URL's for production and development.
To keep this simple, we will use a compiled version of the Dashboard Builder plugin code in a hosted environment. This means all we have to do is configure a plugin in Sigma and provide the URL's for production and development.

<aside class="negative">
<strong>NOTE:</strong><br> The source code for the plugin is included in a public GitHub repository, so that you can explore it at a later time.
Expand Down Expand Up @@ -341,7 +357,7 @@ Let’s run some quick validation tests to make sure everything works as expecte
3. The dropdown should stay on `1` and the `Revenue` KPI should be in `Area 1`.
4. Using the select control, switch between `Original` and `1` - Area 1 should restore correctly.

The rest of the tests are really similar so screenshots are not provided as the workflow and result is really similar to test one.
The rest of the tests are really similar so screenshots are not provided as the workflow and results are very similar to Test One.

### Test Two: Dual Area
1. Starting from the `Original Workbook`, place KPI in `Area 1`
Expand Down Expand Up @@ -489,7 +505,7 @@ git pull origin main
```

Change directory to the new folder:
```bash
```copy-code
cd plugin_dashboard_builder
```

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ environments: web
status: Published
feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues
tags: default
lastUpdated: 2025-11-26
lastUpdated: 2026-05-10

# Common Date Functions

## Overview
Duration: 5

Solve the most common date challenges in Sigma — truncation, period shifting, fiscal calendars, and date comparison — with step-by-step formula patterns you can adapt immediately.
This QuickStart presents common challenges when working with dates. Sigma can be used to manipulate dates to get the desired results, quickly and easily.

There are many ways to work with dates in Sigma. Not every solution is covered and you may even find a better method. Suggestions and feedback are always appreciated.

Expand All @@ -24,14 +24,28 @@ We will use the Sigma-provided `RETAIL`.`PLUGS_ELECTRONICS`.`PLUGS_ELECTRONICS_H
### Template
We have also made the final workbook that is created during this QuickStart available as a Sigma Template. This option allows you to read along while having the workbook built for you. The template is not required and the end result is the same if you build it yourself.

<img src="assets/cdf_01c.png" width="800"/>
<aside class="negative">
<strong>NOTE:</strong><br> The template is available by direct link only and not listed in the Sigma UI.

In order to use the template you must first log onto your Sigma instance and then browse to the url:

<a href="https://app.sigmacomputing.com/template?provider=7d0fc8a6-bf65-47f4-86e6-39eba581fe15&shareId=55af1852-7e92-4f3b-b817-5d87ffaf239c&namespace=production&templateId=a23e87ed-a961-4450-a450-6293cb1dffd2">Common Functions Template</a>
</aside>

The template will prompt to `Swap data sources`. Since it uses Sigma provided sample data, the `% Match` should be `100%`.

Click `Choose`:

<img src="assets/cdf_00.png" width="600"/>

Once done, the fully-built workbook is presented and we can `Accept` the swap and save the workbook normally:

<img src="assets/cdf_00a.png" width="800"/>

### Target Audience
Sigma builders looking for solutions to date challenges or who just want to learn new date methods.

### Prerequisites

<ul>
<li>Any modern browser is acceptable.</li>
<li>Access to your Sigma environment.</li>
Expand Down Expand Up @@ -257,15 +271,15 @@ The table should now look like this:
Add a new column next to `Customer Name` and rename it to `First_Order`.

For `First_Order` set the formula to:
```plaintext
```copy-code
Min([Date])
```

<img src="assets/CDUC12.png" width="600"/>

Now add four more columns, renaming them and applying the following formulas:

<aside class="negative">
<aside class="positive">
<strong>PRO TIP:</strong><br> Use keyboard shortcuts to save time. For example, use "Shift +" to add a new column.
</aside>

Expand Down Expand Up @@ -335,7 +349,7 @@ For more information, see [Join types](https://help.sigmacomputing.com/docs/join

<img src="assets/CDUC18.png" width="800"/>

Click Preview output. Sigma shows the tables lineage. This allows us to see how our table was constructed, which columns are selected and more. We could also join more tables from here:
Click `Preview output`. Sigma shows the table lineage. This allows us to see how our table was constructed, which columns are selected and more. We could also join more tables from here:

<img src="assets/CDUC18a.png" width="800"/>

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ environments: web
status: Published
feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues
tags: default
lastUpdated: 2025-12-05
lastUpdated: 2026-05-10

# Popular Functions

Expand All @@ -22,7 +22,25 @@ You'll learn how to categorize values, handle null data, filter and search text,
### Template
We have also made the final workbook that is created during this QuickStart available as a Sigma Template. This option allows you to read along while having the workbook built for you. The template is not required and the end result is the same if you build it yourself.

<img src="assets/cdf_01a.png" width="500"/>
<aside class="negative">
<strong>NOTE:</strong><br> The template is available by direct link only and not listed in the Sigma UI.

In order to use the template you must first log onto your Sigma instance and then browse to the url:

<a href="https://app.sigmacomputing.com/template?provider=7d0fc8a6-bf65-47f4-86e6-39eba581fe15&shareId=55af1852-7e92-4f3b-b817-5d87ffaf239c&namespace=production&templateId=49239f6d-8997-4361-9181-f2c2469f5105">Popular Functions Template</a>
</aside>

The template will prompt to `Swap data sources`. Since it uses Sigma provided sample data, the `% Match` should be `100%`.

Click `Choose`:

<img src="assets/cdf_00.png" width="600"/>

Once done, the fully-built workbook is presented and we can `Accept` the swap and save the workbook normally:

<img src="assets/cdf_00a.png" width="800"/>

Save the workbook as `Popular Functions QuickStart`.

<aside class="positive">
<strong>IMPORTANT:</strong><br> Some screens in Sigma may appear slightly different from those shown in QuickStarts. This is because Sigma continuously adds and enhances functionality. Rest assured, Sigma’s intuitive interface ensures that any differences will not prevent you from successfully completing any QuickStart.
Expand Down Expand Up @@ -59,6 +77,10 @@ The typical audience for this QuickStart includes users of Excel, common Busines
## Data Page Setup
Duration: 5

<aside class="positive">
<strong>IMPORTANT:</strong><br> If starting from the pre-built template, there is no need to create another workbook. Instead, you can review each function in its final form using the templated workbook.
</aside>

Log into Sigma, click `Create new` and select `Workbook`.

From the `Element bar`, under the `Data` group, place a new `Table` on the page.
Expand Down Expand Up @@ -122,7 +144,7 @@ Column Name: Formula:
Order_Size_Fixed BinFixed([Order_Value], 0, 5000, 10)
```

This creates 10 equal bins of $100 each: "0-100", "100-200", "200-300", etc.
This creates 10 equal bins of $500 each: "0-500", "500-1000", "1000-1500", etc.

Format the column as `Number` and remove the decimal places.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ environments: web
status: Published
feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues
tags: Default
lastUpdated: 2025-10-30
lastUpdated: 2026-05-10

# Connect Snowflake Intelligence to Sigma Workbook

Expand Down Expand Up @@ -112,13 +112,13 @@ Click the `Create agent` button.
<strong>NOTE:</strong><br> Make sure you are using the ACCOUNTADMIN role.
</aside>

Set the database and schema as shown. the `name` and `display name` to `QUICKSTARTS`:
Set the database and schema as shown, and set the `name` and `display name` to `QUICKSTARTS`:

<img src="assets/cortex_05.png" width="600"/>

Click `Create agent`.

Once the agent is created, we instruct the agent adopt a persona to help tailor the responses to our sample retail dataset.
Once the agent is created, we instruct the agent to adopt a persona to help tailor the responses to our sample retail dataset.

Use the prompt:
```copy-code
Expand Down Expand Up @@ -188,7 +188,7 @@ GRANT ROLE SIGMA_SERVICE_ROLE TO USER SIGMA_SERVICE_USER;
GRANT USAGE ON WAREHOUSE COMPUTE_WH TO ROLE SIGMA_SERVICE_ROLE;
```

After selecting `Run All` the script will run to success (at can take a minute or two to run to completion).
After selecting `Run All` the script will run to success (it can take a minute or two to run to completion).

Now would be a good time to configure the connection to Snowflake in Sigma. The connection will require key-pair authentication and write-back enabled.

Expand Down Expand Up @@ -385,15 +385,23 @@ For more information on how to create agents in Snowflake, see [Configure and in
## Sigma Template
Duration: 5

There is a Sigma template we can use to save you the time of building the Sigma workbook yourself, although that is not hard to do either.
We have made the final workbook that is created during this QuickStart available as a Sigma Template. This option allows you to read along while having the workbook built for you. The template is not required and the end result is the same if you build it yourself.

In Sigma, select `Templates`, search for `quickstarts` and select the `Snowflake Intelligence Quickstart` template:
<aside class="negative">
<strong>NOTE:</strong><br> The template is available by direct link only and not listed in the Sigma UI.

In order to use the template you must first log onto your Sigma instance and then browse to the url:

<a href="https://app.sigmacomputing.com/template?provider=7d0fc8a6-bf65-47f4-86e6-39eba581fe15&shareId=55af1852-7e92-4f3b-b817-5d87ffaf239c&namespace=production&templateId=f2bdaa07-62a5-4c8f-9c9b-95f503ab2374">Snowflake Intelligence Template</a>
</aside>

The template will prompt to `Swap data sources`. In this case, we don't need to match to any existing data so just choose the `Sigma Sample Database` and click `Choose`, ignoring the match values:

<img src="assets/cortex_25.png" width="800"/>
<img src="assets/cdf_00.png" width="600"/>

This will open a pre-configured workbook for us where we can make a few additions and adjustments. Templates can save a lot of time!
Once done, the fully-built workbook is presented and we can save the workbook normally:

<img src="assets/cortex_26.png" width="800"/>
<img src="assets/cdf_00a.png" width="800"/>

### Add an input table
We want to store all the questions/responses in the warehouse, but the template needs a place to do that. We will use an input table to make that really simple.
Expand All @@ -416,7 +424,7 @@ Now click on the `Chat Log Modal` tab and add the `Chat Log` table from `Data` >

<img src="assets/cortex_12.png" width="600"/>

Hide the `Data` page.In this way, users can see the chat log but do not have access to the input table.
Hide the `Data` page. In this way, users can see the chat log but do not have access to the input table.

### Action adjustments
We need to let the workbook actions know about our new input table and stored procedure.
Expand Down Expand Up @@ -546,7 +554,7 @@ GRANT SELECT ON TABLE SNOWFLAKE_INTELLIGENCE.AGENTS.BIG_BUYS TO ROLE SIGMA_SERVI
### Add custom tool to Agent
On the `QuickStart` agent (in `EDIT`), select the `Tools` menu and `Add custom tool`.

Configure a the tool to use the new function and click the `Generate with Cortex` button to let AI populate the `Description`:
Configure the tool to use the new function and click the `Generate with Cortex` button to let AI populate the `Description`:

<img src="assets/cortex_22.png" width="800"/>

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
\author: pballai
author: pballai
id: use_cases_fpna_report_based_on_template
summary: use_cases_fpna_report_based_on_template
categories: use-cases
environments: web
status: Use Cases
feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues
tags: default
lastUpdated: 2025-08-22
lastUpdated: 2026-05-10

# Build a Custom FP&A Report based on a Template

Expand Down Expand Up @@ -141,20 +141,32 @@ The combined dataset—ACTUALS with Hierarchy—is a standard join of the two ta
## Setting Up the Template
Duration: 5

To make this process easier, we have created a [template](https://help.sigmacomputing.com/docs/create-and-edit-workbook-templates) that is mostly configured.
We have made the final workbook that is created during this QuickStart available as a Sigma Template. This option allows you to read along while having the workbook built for you.

Return to the Sigma homepage and click `Templates`. Click to select the `Financial Reporting Template Quickstart` template:
<aside class="negative">
<strong>NOTE:</strong><br> The template is available by direct link only and not listed in the Sigma UI.

In order to use the template you must first log onto your Sigma instance and then browse to the url:

<a href="https://app.sigmacomputing.com/template?provider=7d0fc8a6-bf65-47f4-86e6-39eba581fe15&shareId=55af1852-7e92-4f3b-b817-5d87ffaf239c&namespace=production&templateId=d75e55f2-3ec3-45d2-b8f4-045cf71d76a7">Financial Reporting Template</a>
</aside>

The template will prompt to `Swap data sources`. Since it uses Sigma provided sample data, the `% Match` should be `100%`.

<img src="assets/fpna_36.png" width="800"/>
Click `Choose`:

This creates a new (unsaved) workbook for us:
<img src="assets/cdf_00.png" width="600"/>

Once done, the fully-built workbook is presented and we can `Accept` the swap and save the workbook normally:

<img src="assets/cdf_00a.png" width="800"/>

This creates a new (unsaved) workbook for us. Click `Save As` and give your new workbook a meaningful name—e.g., `FP&A QuickStart`.

<img src="assets/fpna_37.png" width="800"/>

The template is initially configured with the `Sample Sigma Database`, which should allow for a clean mapping to your own instance.

Click `Save As` and give your new workbook a meaningful name—e.g., `FP&A QuickStart`.

If we open the page tab, `Trending Report` there is `No data`:

<img src="assets/fpna_07.png" width="800"/>
Expand Down Expand Up @@ -188,7 +200,7 @@ Repeat the process for `Input Table 2`, pasting the `12 rows` into the `Manual I

<img src="assets/fpna_09.png" width="800"/>

Now return to the` Trending Report`—you should see data populated in the pivot:
Now return to the `Trending Report`—you should see data populated in the pivot:

<img src="assets/fpna_10.png" width="800"/>

Expand Down
Loading