diff --git a/site/sigmaguides/src/embedding_09_events_v3/embedding_09_events_v3.md b/site/sigmaguides/src/embedding_09_events_v3/embedding_09_events_v3.md index 6909c96d..24b50852 100644 --- a/site/sigmaguides/src/embedding_09_events_v3/embedding_09_events_v3.md +++ b/site/sigmaguides/src/embedding_09_events_v3/embedding_09_events_v3.md @@ -29,7 +29,7 @@ Inbound events can be passed using either JavaScript or URL. **Outbound Events:**
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.** diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/1.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/1.png new file mode 100644 index 00000000..726cde47 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/1.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/10.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/10.png new file mode 100644 index 00000000..a88d5d8b Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/10.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/2.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/2.png new file mode 100644 index 00000000..7087109c Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/2.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/3.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/3.png new file mode 100644 index 00000000..aae562bf Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/3.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/4.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/4.png new file mode 100644 index 00000000..85d1e24d Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/4.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/5.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/5.png new file mode 100644 index 00000000..ce0d7728 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/5.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/6.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/6.png new file mode 100644 index 00000000..b7b3cd01 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/6.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/7.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/7.png new file mode 100644 index 00000000..b053ded8 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/7.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/8.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/8.png new file mode 100644 index 00000000..3cf0e617 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/8.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/9.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/9.png new file mode 100644 index 00000000..3aff50c3 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/9.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/caret.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/caret.png new file mode 100644 index 00000000..13a132ab Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/caret.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/closeview.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/closeview.png new file mode 100644 index 00000000..d0fbb0e4 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/closeview.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/crane.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/crane.png new file mode 100644 index 00000000..225ecf3f Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/crane.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/facebook.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/facebook.png new file mode 100644 index 00000000..fa3f0e02 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/facebook.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/greencheckbox.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/greencheckbox.png new file mode 100644 index 00000000..69cb876e Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/greencheckbox.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/heart_icon.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/heart_icon.png new file mode 100644 index 00000000..bff9ea90 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/heart_icon.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/horizonalline.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/horizonalline.png new file mode 100644 index 00000000..7c49d872 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/horizonalline.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/linkedin.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/linkedin.png new file mode 100644 index 00000000..d1a0636d Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/linkedin.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_1.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_1.png new file mode 100644 index 00000000..a9e06e4e Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_1.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_2.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_2.png new file mode 100644 index 00000000..28322814 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_2.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_3.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_3.png new file mode 100644 index 00000000..0826d9e9 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_3.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_4.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_4.png new file mode 100644 index 00000000..89195dd0 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_4.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_5.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_5.png new file mode 100644 index 00000000..5076699a Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/pa_5.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/sigma_footer.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/sigma_footer.png new file mode 100644 index 00000000..df51d771 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/sigma_footer.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/assets/twitter.png b/site/sigmaguides/src/embedding_15_public_access_v3/assets/twitter.png new file mode 100644 index 00000000..5a827d72 Binary files /dev/null and b/site/sigmaguides/src/embedding_15_public_access_v3/assets/twitter.png differ diff --git a/site/sigmaguides/src/embedding_15_public_access_v3/embedding_15_public_access_v3.md b/site/sigmaguides/src/embedding_15_public_access_v3/embedding_15_public_access_v3.md new file mode 100644 index 00000000..32086d6d --- /dev/null +++ b/site/sigmaguides/src/embedding_15_public_access_v3/embedding_15_public_access_v3.md @@ -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 + + + +### 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” + + + +Sigma supports embedding a workbook, individual page, or even a single element. + + + +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 + + + + + + + + + +![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: + + + +Click `Save As` and name the workbook and name the workbook `Embedding 15 - Public Access`. + + + +We can continue editing the workbook, but changes will not appear in the public embed until the workbook is republished. + + + +Open the workbook's menu and select `Share and export` > `Embedding`: + + + +Select the `Public` tab and `Profit Planning Tool` from the list. Then click `Copy` as shown, for the `Public link`: + + + +Now that we have the URL, we can use it in our sample native application. + +![Footer](assets/sigma_footer.png) + + +## 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: + + + +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: + + + +## 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) + + +## 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/)
+[Community](https://community.sigmacomputing.com/)
+[Help Center](https://help.sigmacomputing.com/hc/en-us)
+[QuickStarts](https://quickstarts.sigmacomputing.com/)
+ +Be sure to check out all the latest developments at [Sigma's First Friday Feature page!](https://quickstarts.sigmacomputing.com/firstfridayfeatures/) +
+ +[](https://twitter.com/sigmacomputing)  +[](https://www.linkedin.com/company/sigmacomputing)  +[](https://www.facebook.com/sigmacomputing) + +![Footer](assets/sigma_footer.png) + +