diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/CleanShot 2024-09-04 at 11.44.11.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/CleanShot 2024-09-04 at 11.44.11.png deleted file mode 100644 index ca1f5a7e..00000000 Binary files a/site/sigmaguides/src/embedding_17_link_sharing/assets/CleanShot 2024-09-04 at 11.44.11.png and /dev/null differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae10.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae10.png index c29ce456..ebff1012 100644 Binary files a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae10.png and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae10.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae3.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae3.png index 056d7273..ad6bf46f 100644 Binary files a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae3.png and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae3.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ls17.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls17.png index db7c069e..5676fe2b 100644 Binary files a/site/sigmaguides/src/embedding_17_link_sharing/assets/ls17.png and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls17.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/embedding_17_link_sharing.md b/site/sigmaguides/src/embedding_17_link_sharing/embedding_17_link_sharing.md index 2cb893fe..31dcc081 100644 --- a/site/sigmaguides/src/embedding_17_link_sharing/embedding_17_link_sharing.md +++ b/site/sigmaguides/src/embedding_17_link_sharing/embedding_17_link_sharing.md @@ -3,9 +3,9 @@ id: embedding_17_link_sharing summary: embedding_17_link_sharing categories: Embedding environments: web -status: hidden +status: published feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues -tags: +tags: default lastUpdated: 2024-08-31 # Embedding 17: Link Sharing @@ -31,7 +31,7 @@ Alternatively, customer developers can use these links to enhance their applicat **Sharing a Bookmark:** - Users can create and share bookmarks, which save the state of a workbook or exploration at a specific point in time. The shared link brings recipients directly to the bookmarked view, maintaining the exact state of the data. -**Scheduling an Export of a Workbook, Exploration, or Bookmark:** +**Scheduling an Export of a Workbook:** - Users can schedule an export of a workbook, exploration, or bookmark. The export emails include a link that directs recipients to the specific embedded content, ensuring they access the relevant data directly from the email. ### Benefits of Embedded Link Sharing @@ -41,12 +41,6 @@ Alternatively, customer developers can use these links to enhance their applicat **Consistency Across Platforms:** - Shared links bring recipients back to the same embedded content within the customer’s application, whether it’s a full workbook, an exploration, or a bookmark. -**Improved User Experience:** -- By including details like explorations and bookmarks in shared links, users can ensure that recipients see the exact analysis or data state they intended to share. - -**Streamlined Workflow:** -- The feature integrates with export scheduling, allowing recipients of scheduled reports to access the relevant embedded content—be it a workbook, exploration, or bookmark—directly from their emails. - ### How It Works Developers can trigger an iframe event in Sigma to set a `sharingLink` or `sharingExplorationLink` and include `bookmarks` when needed: @@ -61,7 +55,7 @@ Developers can trigger an iframe event in Sigma to set a `sharingLink` or `shari This event allows Sigma to generate the appropriate link, which users can share. The link ensures that recipients access the exact workbook, exploration, or bookmarked view within the embedded Sigma environment. ### Target Audience -Developers using Sigma for embedding and may want toi allow users to generate sharing links in various scenarios. +Developers using Sigma for embedding who may want to allow users to generate sharing links in various scenarios. ### Prerequisites @@ -292,8 +286,6 @@ We can now see the cloned project folder: -The project has almost everything we need, but we will need some embedded content and credentials from Sigma before we can test this out. - ![Footer](assets/sigma_footer.png) @@ -315,7 +307,7 @@ nodemon server.js Make sure the command is run in the correct directory, using the terminal command `pwd` or "present working directory". The response in terminal will look like this: @@ -336,10 +328,6 @@ It should look like this the screenshot below. Notice that there are now sharing - - Now that we have a working embed, we can test embed link sharing. ![Footer](assets/sigma_footer.png) @@ -467,10 +455,14 @@ Once the email is received and opened, the recipient can just click the link to -Clicking the link opens the bookmarked workbook with the exploration: +Clicking the link opens the original workbook since that is the link passed in sharingLink in the iframe event: + + Don't forget to delete the schedule export job: @@ -478,7 +470,7 @@ Don't forget to delete the schedule export job: ![Footer](assets/sigma_footer.png) -## What we've covered +## What We've Covered Duration: 5 In this QuickStart, we explained and demonstrated how to enable embedded link sharing in Sigma.