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
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Inbound events can be passed using either JavaScript or URL.
**Outbound Events:**<br>
These are variables sent from Sigma to the native application, which must have a listener coded to receive and respond to the message.

This QuickStart assumes you have already taken the QuickStart [Embedding 1: Prerequisites](https://quickstarts.sigmacomputing.com/guide/embedding_01_prerequisites/index.html?index=..%2F..index#0) so that you have a sample environment to complete the tasks in this QuickStart.
This QuickStart assumes you have already taken the QuickStart [Embedding 1: Getting Started](https://quickstarts.sigmacomputing.com/guide/embedding_01_prerequisites/index.html?index=..%2F..index#0) so that you have a sample environment to complete the tasks in this QuickStart.

**Some steps may not be shown in detail as we assume you have taken these other two QuickStarts or are familiar with Sigma workflows.**

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.
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.
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.
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.
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.
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.
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.
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.
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
@@ -0,0 +1,197 @@
author: pballai
id: embedding_1embedding_15_public_access_v35_public_v3
summary: embedding_15_public_access_v3
categories: Embedding
environments: web
status: published
feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues
tags: embedding
lastUpdated: 2024-05-19

# Embedding 15 Public Access

## Overview
Duration: 5

In this QuickStart, we demonstrate how to embed a Sigma workbook **without using JWT authentication**.

Sigma supports public access embeds, which require no login and no token — anyone with the link can view the content. This allows us to present content outside of Sigma in a controlled, public-facing format.

To support this, we will adjust the HTML and iframe setup to **use the base embed URL directly in the iframe**, without appending a `?:jwt=` parameter.

This is ideal for use cases where:
- The content is non-sensitive
- You want to embed the workbook on a public website
- You don’t need user-level filtering or row-level security

<aside class="negative">
<strong>WARNING:</strong><br>
Public embeds should only be used with content that is safe for unrestricted viewing. Anyone with the link or access to the page can see the embedded content.
</aside>

### Common use cases for public embeds

**1: Marketing Dashboards on Public Websites**
- Showcase product adoption, feature usage, customer metrics, etc.
- For example: A SaaS company shows “Live Stats: 20,000 Customers and Counting”

**2: Open Data Portals**
- Government, education, or nonprofit groups publishing public data.
- For example: “COVID-19 Cases by Region” or “Public School Enrollment Trends”

**3: Investor Relations Pages**
- Public companies showing high-level KPIs without sensitive detail.
- For example: “Quarterly Earnings Summary” or “Year-over-Year Revenue Growth”

**4: Product Documentation with Embedded Analytics**
- Help centers or support portals with embedded Sigma visualizations.
- For example: “System Uptime – Last 90 Days” or “API Usage by Endpoint”

**5: Public Event or Conference Dashboards**
- Live metrics displayed at a booth or on a projector at events.
- For example: “Live Survey Results” or “Top Booth Interactions Today”

**6: Internal Kiosks or Wallboards (Non-sensitive)**
- For use in factories, call centers, or lobbies where sign-in isn't feasible.
- For example: “Calls Answered Today” or “Production Totals by Shift”

<aside class="negative">
<strong>NOTE:</strong><br> Access to a public embed will not allow someone else access to Sigma directly.
</aside>

Sigma supports embedding a workbook, individual page, or even a single element.

<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.
</aside>

For more information on Sigma's product release strategy, see [Sigma product releases](https://help.sigmacomputing.com/docs/sigma-product-releases)

If something is not working as you expect, here's how to [contact Sigma support](https://help.sigmacomputing.com/docs/sigma-support)

### Target Audience
This QuickStart is designed for users familiar with Excel, Business Intelligence tools, or semi-technical users who want to try out or learn Sigma.

### Prerequisites

<ul>
<li>Any modern browser is acceptable.</li>
<li>Access to your Sigma environment.</li>
<li>Some familiarity with Sigma is assumed. Not all steps are shown, as we assume you’re familiar with the basics.</li>
</ul>

<aside class="positive">
<strong>IMPORTANT:</strong><br> Sigma recommends using non-production resources when completing QuickStarts.
</aside>

<button>[Sigma Free Trial](https://www.sigmacomputing.com/free-trial/)</button>

<aside class="negative">
<strong>IMPORTANT:</strong><br> Some features may be marked as “Beta” and are subject to rapid, iterative changes. As a result, the latest product version may differ from the contents of this document.
</aside>

![Footer](assets/sigma_footer.png)

## Content to Embed
Duration: 5

Since public embeds require no security, we can embed the iframe anywhere — such as on a website or internal page.

To create a public embed, we will need to complete a few steps in Sigma and in your native application.

Log into Sigma and navigate to any workbook you want to embed.

It doesn’t matter which workbook you choose. Once you complete your first embed, this step becomes very straightforward regardless of embedding an entire workbook, page or single element.

We’ll use one of the prebuilt templates included in a Sigma trial, but the steps are the same no matter what content you choose to embed.

After logging into Sigma, navigate to `Templates` and click the `Plugs Electronics Profit Planning Tool` example to open that template:

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

Click `Save As` and name the workbook and name the workbook `Embedding 15 - Public Access`.

<aside class="positive">
<strong>IMPORTANT:</strong><br> Saving a workbook also publishes it automatically. A workbook must be published before it is embedded.
</aside>

We can continue editing the workbook, but changes will not appear in the public embed until the workbook is republished.

<aside class="negative">
<strong>NOTE:</strong><br> Sigma supports embedding workbooks, pages, single elements or even the Ask Sigma interface.
</aside>

Open the workbook's menu and select `Share and export` > `Embedding`:

<img src="assets/pa_2.png" width="400"/>

Select the `Public` tab and `Profit Planning Tool` from the list. Then click `Copy` as shown, for the `Public link`:

<img src="assets/pa_3.png" width="500"/>

Now that we have the URL, we can use it in our sample native application.

![Footer](assets/sigma_footer.png)
<!-- END -->

## Native Application Configuration
Duration: 10

In VSCode, open the `embedding_qs_series_2` project and edit the `.env `file to configure the public access settings.

In the `# QS: public_access` section, set the parameters as shown, using your own base URL:

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

In the VSCode terminal, start the local web server:
```
npm start
```

In a browser, go to:
```
http://localhost:3000/public_access/?mode=public_access
```

You should see something like this:

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

## Final Thoughts
Duration: 5

Here are a few things to consider when working with public embeds.

- Public embeds are available to anyone with the embed URL.

- Public embeds reflect real-time data in your cloud data warehouse (CDW) or database (DBMS) as well as any changes published in the embedded workbook.

- Users will be able to interact with any controls you’ve made visible on the workbook.

- Access to a public embed will not grant access to any additional data in Sigma without a valid account and proper permissions.

![Footer](assets/sigma_footer.png)
<!-- END -->

## What we've covered
Duration: 5

In this QuickStart, we learned how to how to embed Sigma into a Public facing website.

**Additional Resource Links**

[Blog](https://www.sigmacomputing.com/blog/)<br>
[Community](https://community.sigmacomputing.com/)<br>
[Help Center](https://help.sigmacomputing.com/hc/en-us)<br>
[QuickStarts](https://quickstarts.sigmacomputing.com/)<br>

Be sure to check out all the latest developments at [Sigma's First Friday Feature page!](https://quickstarts.sigmacomputing.com/firstfridayfeatures/)
<br>

[<img src="./assets/twitter.png" width="75"/>](https://twitter.com/sigmacomputing)&emsp;
[<img src="./assets/linkedin.png" width="75"/>](https://www.linkedin.com/company/sigmacomputing)&emsp;
[<img src="./assets/facebook.png" width="75"/>](https://www.facebook.com/sigmacomputing)

![Footer](assets/sigma_footer.png)
<!-- END OF WHAT WE COVERED -->
<!-- END OF QUICKSTART -->