diff --git a/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/1.png b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/1.png new file mode 100644 index 00000000..726cde47 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/1.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/10.png b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/10.png new file mode 100644 index 00000000..a88d5d8b Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/10.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/2.png b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/2.png new file mode 100644 index 00000000..7087109c Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/2.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/3.png b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/3.png new file mode 100644 index 00000000..aae562bf Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/3.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/4.png b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/4.png new file mode 100644 index 00000000..85d1e24d Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/4.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/5.png b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/5.png new file mode 100644 index 00000000..ce0d7728 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/5.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/6.png b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/6.png new file mode 100644 index 00000000..b7b3cd01 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/6.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/7.png b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/7.png new file mode 100644 index 00000000..b053ded8 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/7.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/8.png b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/8.png new file mode 100644 index 00000000..3cf0e617 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/8.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/9.png b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/9.png new file mode 100644 index 00000000..3aff50c3 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/9.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/Sigma_Footer.png b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/Sigma_Footer.png new file mode 100644 index 00000000..df51d771 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/_shared_assets/Sigma_Footer.png differ 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 new file mode 100644 index 00000000..ca1f5a7e Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/CleanShot 2024-09-04 at 11.44.11.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes10.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes10.png new file mode 100644 index 00000000..1698ad80 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes10.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes11.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes11.png new file mode 100644 index 00000000..0ee0da05 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes11.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes11a.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes11a.png new file mode 100644 index 00000000..f2a418a8 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes11a.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes15.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes15.png new file mode 100644 index 00000000..46116775 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes15.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes16.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes16.png new file mode 100644 index 00000000..aef03cce Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes16.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes8.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes8.png new file mode 100644 index 00000000..79225a7c Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes8.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes9.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes9.png new file mode 100644 index 00000000..83a44410 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes9.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes9a.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes9a.png new file mode 100644 index 00000000..a537b299 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/accounttypes9a.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae1.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae1.png new file mode 100644 index 00000000..0ffda7e2 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae1.png 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 new file mode 100644 index 00000000..c29ce456 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae10.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae11.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae11.png new file mode 100644 index 00000000..ab48eaba Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae11.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae12.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae12.png new file mode 100644 index 00000000..a321ab91 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae12.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae13.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae13.png new file mode 100644 index 00000000..8843f097 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae13.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae14.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae14.png new file mode 100644 index 00000000..e2ed5c4a Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae14.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae15.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae15.png new file mode 100644 index 00000000..212a0ab4 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae15.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae16.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae16.png new file mode 100644 index 00000000..d7f3324d Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae16.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae17.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae17.png new file mode 100644 index 00000000..ca1f5a7e Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae17.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae18.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae18.png new file mode 100644 index 00000000..f7b6aecf Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae18.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae19.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae19.png new file mode 100644 index 00000000..978fcd20 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae19.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae1a.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae1a.png new file mode 100644 index 00000000..a8b3f923 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae1a.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae2.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae2.png new file mode 100644 index 00000000..e56e9abd Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae2.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae20.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae20.png new file mode 100644 index 00000000..7ce5d550 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae20.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae21.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae21.png new file mode 100644 index 00000000..466e44ff Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae21.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae22.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae22.png new file mode 100644 index 00000000..697f269d Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae22.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae23.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae23.png new file mode 100644 index 00000000..fc650d30 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae23.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae24.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae24.png new file mode 100644 index 00000000..a97d9d28 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae24.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 new file mode 100644 index 00000000..056d7273 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae3.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae4.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae4.png new file mode 100644 index 00000000..d5745ce9 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae4.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae5.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae5.png new file mode 100644 index 00000000..7405e17f Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae5.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae6.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae6.png new file mode 100644 index 00000000..3c12dd07 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae6.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae7.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae7.png new file mode 100644 index 00000000..c95ace93 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae7.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae8.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae8.png new file mode 100644 index 00000000..d1973a72 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae8.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ae9.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae9.png new file mode 100644 index 00000000..0559d60b Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ae9.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/facebook.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/facebook.png new file mode 100644 index 00000000..fa3f0e02 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/facebook.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/greencheckbox.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/greencheckbox.png new file mode 100644 index 00000000..69cb876e Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/greencheckbox.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/horizonalline.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/horizonalline.png new file mode 100644 index 00000000..7c49d872 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/horizonalline.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/linkedin.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/linkedin.png new file mode 100644 index 00000000..d1a0636d Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/linkedin.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ls1.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls1.png new file mode 100644 index 00000000..ee558425 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls1.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ls16.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls16.png new file mode 100644 index 00000000..4d4e8452 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls16.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 new file mode 100644 index 00000000..db7c069e Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls17.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ls2.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls2.png new file mode 100644 index 00000000..d7539f8c Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls2.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ls3.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls3.png new file mode 100644 index 00000000..23111107 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls3.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ls4.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls4.png new file mode 100644 index 00000000..4c7f58b9 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls4.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ls5.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls5.png new file mode 100644 index 00000000..8965de22 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls5.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/ls6.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls6.png new file mode 100644 index 00000000..2424cd4c Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/ls6.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/sigma_footer.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/sigma_footer.png new file mode 100644 index 00000000..df51d771 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/sigma_footer.png differ diff --git a/site/sigmaguides/src/embedding_17_link_sharing/assets/twitter.png b/site/sigmaguides/src/embedding_17_link_sharing/assets/twitter.png new file mode 100644 index 00000000..5a827d72 Binary files /dev/null and b/site/sigmaguides/src/embedding_17_link_sharing/assets/twitter.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 new file mode 100644 index 00000000..3de36c57 --- /dev/null +++ b/site/sigmaguides/src/embedding_17_link_sharing/embedding_17_link_sharing.md @@ -0,0 +1,503 @@ +author: pballai +id: embedding_17_link_sharing +summary: embedding_17_link_sharing +categories: Embedding +environments: web +status: published +feedback link: https://github.com/sigmacomputing/sigmaquickstarts/issues +tags: Default +lastUpdated: 2024-08-31 + +# Embedding 17: Link Sharing + +## Overview +Duration: 5 + +Embedded Link Sharing, when enabled, allows users to share specific workbooks, explorations, or bookmarks through URLs generated within an embed as they work in Sigma. + +These links can be copied and pasted into user-created emails (or other systems), allowing recipients to access the relevant content directly from their emails without needing to navigate back to Sigma. + +These links will also be included in any scheduled exports created by the user, allowing recipients to click a link to access the shared content. + +Alternatively, customer developers can use these links to enhance their application's functionality. + +### Use Cases +**Sharing the Entire Embedded Workbook:** +- Users can share a link that brings other users directly to the full embedded workbook within the customer’s application. + +**Sharing an Exploration Created from an Embedded Workbook:** +- Users can share a specific exploration they’ve created within a workbook. The shared link opens the exact exploration view, preserving the context of the analysis. + +**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:** +- 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 +**Enhanced Collaboration:** +- Users can share specific views, explorations, or bookmarks with their teams, ensuring that the exact context and state of the data are maintained. + +**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: + +```code +{ + type: 'workbook:sharinglink:update', + sharingLink: string | null, + sharingExplorationLink?: string | null +} +``` + +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. + +### Prerequisites + + + + + + + +![Footer](assets/sigma_footer.png) + +## Create Something to Embed +Duration: 5 + +Sigma is very flexible and has different workflows for creating content, based on source data. + +For example, we could first create a [data model](https://help.sigmacomputing.com/docs/intro-to-data-models), set permission on it, and then save it off for later use in a workbook(s). We would then create a workbook with a table, that shows data from the data model we saved earlier. + + + +To minimize the steps, we will leverage a different workflow. + + + +### Create a Team +To demonstrate our embed, we need to create a [Team](https://help.sigmacomputing.com/docs/manage-teams) to share our new workbook with. + +Navigate to `Administration` > `Teams` and click `Create Team`. + +Name the new team `Sales_People`, and click `Create`. + + + +### Create a Workbook with Sample Data + +From Sigma / `Home` click the `+` Create New button and click `Workbook`: + + + +We will use `Table` from the options: + + + +Next we need to select our source data. We will use the typical sample data, as in other QuickStarts. + +Sigma allows users to search for tables by name; type `Hands` in the search bar and select the `PLUGS_ELECTRONICS_HANDS_ON_LAB_DATA` table: + + + +This opens the selected table in a new (unpublished) workbook that carries the temporary name `Exploration`: + + + +The first thing we want to do is click the `Save As` button, choose where to store the workbook and give it the name `My Plugs Sales Table - Link Sharing` and save it. + + + +You may have noticed that Sigma provides `folders`, a `My Documents` folder and also [workspaces](https://help.sigmacomputing.com/docs/manage-workspaces). This enables a variety of use-cases to be possible with regards to how documents are stored, managed and shared with others. + +### Share the Workbook + +In order to fully demonstration this functionality, we will need another user. This user will be automatically added to Sigma's `People` page upon first use of the parent application containing a Sigma embed. + +We will refer to this user as our `test-user` going forward, and use a valid email address so that can check the emails that Sigma sends to the `test-user`. + + + +The Embed-API will assign our `test-user` to the `Sales_People` team, which will grant the permission to them. + +Click the caret to the right of the workbook's name and select `Share` + + + +Search for the `Sales_People` team and provision `Can explore` permission, click `Share`. + + + +### Create Embed Path + +Open the workbook's menu and and this time select `Embedding`: + + + +Create a `secure` embed for the `Entire Workbook` and copy the `Embed URL` off to a text file for later use: + + + +We are now ready to configure our secure embed for our workbook and team. + +![Footer](assets/sigma_footer.png) + + +## Create Embed Credentials +Duration: 5 + +Next, we will create the required information to provide to the developer of the Parent application (in this case the developer is us). They will need to update the Embed-API with this information. + +### Sigma Embed Client credentials + +Embed `Client credentials` ("credentials") are a crucial component for creating a Sigma embed. These credentials are encoded within your embed URL, providing an additional layer of validation to ensure the embed's authenticity and security. + +The credentials are made up of the `Client ID` and `Client Secret`, and are generated using the Sigma UI. + +The credentials will be used in the embed API, to ensure your embed URLs are valid at run-time. + +**Here are some important points to note about the credentials:** + +**Irretrievable**: Once created, you cannot retrieve the original credentials. Ensure to store them securely. + +**Regeneration**: If the credentials are lost, they can be regenerated, but with different values. This will invalidate all existing embeds until the new values are in place in the embed API. + +**Update Requirement**: After regenerating new credentials, you must update all existing embeds, using the Embed API for that change. + +Remember to keep your credentials in a secure location, as losing them requires action to maintain your embedded analytics functionality. + + + +### Client Credentials Creation + +We will now create credentials that are specific to our workbook embed. + +**1:** Navigate to `Administration` > `Developer Access`: + + + +**2:** Click `Create New`, located in the page's top right corner. This will open the `Create Client Credentials` modal. + +**3:** Under `Access Credential Type?` select `Embedding`. + +**4:** Enter a `Name` and `Description` as you see fit. + +**5:** Under `Owner`, select an organization member with the account type you would like to associate with the embed secret. For now, just select yourself or an `Administrator`. + + + + + +**6:** Click Create: + +**7:** Copy the provided `ClientID` and `Secret` and store them. + + + +**8:** Click Close. + +Paste the credentials into a text file for now, we will use them later. + + + +![Footer](assets/sigma_footer.png) + + + +## Clone the Git Repository Project Folder +Duration: 5 + +We have made the source code available for this QuickStart's demonstration in a [public GitHub repository.](https://github.com/sigmacomputing/quickstarts-public). + +While you may clone the entire repository (it is not that large), we want to avoid cloning sections of the repository that are not of immediate interest. + +Instead, we will use VSCode and terminal to perform a git `sparse-checkout` of the specific project folder we are interested in. A few extra steps, but cleaner local project folder. + +Open `VSCode` and a new `terminal` session. + +In terminal, navigate to the desired directory where we want to clone the repo folder into. + +For example: +```code +cd {/path/to/your/directory} +``` + +Execute the terminal command: +```code +git init +``` + +Add the remote repository as the origin: +```code +git remote add -f origin https://github.com/sigmacomputing/quickstarts-public.git +``` + +Enable sparse checkout: +```code +git config core.sparseCheckout true +``` + +Specify the folder you want to clone by adding it to the sparse-checkout configuration: +```code +echo "embedding/sigma_embed_link_sharing/" > .git/info/sparse-checkout +``` + +At this point, we have run each command and not seen any errors: + + + +Finally, pull the specified folder from the repository: +```code +git pull origin main +``` + +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) + + +## Parent Application +Duration: 5 + +Open the cloned project folder in VSCode and click to open the `.env` file. This file contains variables that we will configure manually. In production environments, these values would be generated by the parent application at runtime. + +Replace the placeholder values for `EMBED_PATH`, `CLIENT_ID`, `EMBED_SECRET` and `EMAIL` to match your values created earlier: + + + +### Launch Node Express Web-server +In `VS-Code`, open a new terminal session and run the command: +```code +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: + + + +The specific code block that informs Sigma to enable embed link sharing is in the file index.html: + + + +### Test that the embed works +In your default browser, browse to: +```code +http://localhost:3000 +``` + +It should look like this the screenshot below. Notice that there are now sharing options shown (#2/3 and #4): + + + + + +Now that we have a working embed, we can test embed link sharing. + +![Footer](assets/sigma_footer.png) + + +## Embed Link Sharing Workflow +Duration: 5 + +With our embed working, we can start sharing links. + +Note that our sample code includes some logging, which can be seen in the browser's inspection console: + + + +Both options (#4 and 5 in the image above) open a `Share with others` modal where the sharing link can be easily copied: + + + +Go ahead and copy the link and paste it into another browser (to simulate a different user). The report will render as expected. For example, we tried it using Safari: + + + + + +### Create an exploration +It is very common for users to want to share an exploration they have created, especially when it contains interesting insights. + +To support this important feature, exploration link sharing is enabled. + +To demonstrate, we can create a simple filter on the embed, as shown in the screenshot below: + + + +Lets say we want to show just `Mobiles`: + + + +Now when we select either of the sharing options, the modal gives us the option (enabled by default) to `Link to current exploration`: + + + +If we copy this link and open it again in Safari, the embed will be filtered to show only `Mobiles`: + + + +In looking at the link that Sigma generates, we can see there is a value for `exploreKey`. This is the reference to the shared exploration: +```code +http://localhost:3000?workbookId=3vgLIaDPizJG2LmoThUPYu&exploreKey=286b0a60-7586-494d-851c-77ebb3066bff +``` + +The exploration sharing link is also shown the the browsers inspection console: + + + +![Footer](assets/sigma_footer.png) + + +## Bookmark Sharing +Duration: 5 + +The embed link sharing workflow with bookmarks is very similar. Since not all customers use bookmarks, you can skip this section if your organization does not utilize them. + + + +To learn more about personal bookmarks, [see here.](https://help.sigmacomputing.com/docs/create-and-manage-bookmarks) + +Lets create a bookmark for the filtered workbook we left off at. + +Click the `bookmark` icon and select `Save as new bookmark`: + + + +Give the new workbook a name and click `Save`: + + + +In the inspection console, we can see the new workbookID and also a new sharing link: + + + +We can share this new workbook (remember, this is a workbook and not yet an exploration!) by clicking the share icon and clicking `Copy Link`: + + + +Paste this into the browser and verify that we only have access to the filtered rows with a bookmarkID in the sharing exploration link: + + + +If we continue the workflow, using the bookmarked workbook, we can add another filter to create a new exploration: + + + +If we copy the exploration sharing link now, it also includes reference to the bookmark: +```code +http://localhost:3000/?exploreKey=3a976df5-2a22-4a97-ac37-cb94f1b374ef&bookmarkId=353b632f-e230-4919-9101-5512847e4075 +``` + +![Footer](assets/sigma_footer.png) + + +## Scheduled Exports +Duration: 5 + +Continuing from the last section, lets schedule a report for our bookmarked exploration. + +This time, open the embed's footer menu and click `Schedule export`: + + + +Click the `Add schedule` button. + +Provide a value email address and set the `Frequency` to `Monthly` and click `Create`: + + + +Open the `Actions` menu and click `Send now` to test: + + + +Once the email is received and opened, the recipient can just click the link to access the shared workbook (assuming they have permissions to do so from the parent application): + + + +Clicking the link opens the bookmarked workbook with the exploration: + + + +Don't forget to delete the schedule export job: + + + +![Footer](assets/sigma_footer.png) + + +## What we've covered +Duration: 5 + +In this QuickStart, we explained and demonstrated how to enable embedded link sharing in Sigma. + +**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) + + \ No newline at end of file