You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: site/sigmaguides/src/embedding_01_getting_started_v3/embedding_01_getting_started_v3.md
+43-43Lines changed: 43 additions & 43 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -373,6 +373,15 @@ The .env file provides fallback logic for each JWT:
373
373
374
374
This allows you to maintain a consistent test user by default, and easily override it per QuickStart as needed for different workflows.
375
375
376
+
Open the `.env` file. We will copy / paste key values as we progress through sections of this QuickStart:
377
+
378
+
<imgsrc="assets/gs_13a.png"width="600"/>
379
+
380
+
<asideclass="positive">
381
+
<strong>IMPORTANT:</strong><br> Parameters in the "Default Embed User" group of .env will be overridden by parameters in the other groups. It is there for convenience as often the parameters are common, so having a default group is merely a time saver. Nothing more.
382
+
</aside>
383
+
384
+
376
385

377
386
<!-- END OF SECTION-->
378
387
@@ -446,17 +455,6 @@ Create another team called `Sales_Managers`, set the team to `Private` and check
446
455
447
456
<imgsrc="assets/gs_2a.png"width="800"/>
448
457
449
-
### Text file for temp storage of values
450
-
It’s helpful to store a few values in a text file as we create them. Once comfortable, these can just be added directly to the .env file.
451
-
452
-
Here are the values we will capture as we progress:
453
-
```code
454
-
Client ID:
455
-
Secret:
456
-
Team(s): Sales_People, Sales_Managers
457
-
Base_URL:
458
-
```
459
-
460
458
Exit `Administration` by clicking the Sigma <imgsrc="assets/crane.png"width="50"/> icon.
461
459
462
460

@@ -535,7 +533,7 @@ If you lose the embed secret, or it becomes compromised, you can revoke it and g
535
533
536
534
<imgsrc="assets/gs_15.png"width="550"/>
537
535
538
-
Copy and paste the `Client ID` and `Secret` into the text file.
536
+
Copy and paste the `Client ID` and `Secret` into the respective locations in the `.env`file, in the `# Shared by all QuickStarts` grouping.
539
537
540
538

541
539
<!-- END -->
@@ -623,49 +621,25 @@ Select the `Plugs_Sales_Transactions` table, then copy the URL:
623
621
624
622
<imgsrc="assets/gs_12.png"width="800"/>
625
623
626
-
Paste the `Base URL` into the text file.
624
+
Paste the `Base URL` into the `.env` file in the `# QS: getting_started` group.
627
625
628
626

629
627
<!-- END OF SECTION-->
630
628
631
-
## Embed Sandbox
632
-
Duration: 5
633
-
634
-
Sigma’s embed sandbox allows you to test your embed before integrating it into the native application. This allows you to view the content from the embed user’s perspective to verify security settings and other configurations.
635
-
636
-
Open the workbook’s menu and select `Share and export`, then `Embedding...`:
637
-
638
-
<imgsrc="assets/gs_16a.png"width="400"/>
639
-
640
-
Select `JWT`, choose `Page 1 - Plugs Sales Transactions` from the list control, and click `Test`:
641
-
642
-
<imgsrc="assets/gs_16b.png"width="600"/>
643
-
644
-
This opens the embedding sandbox with the selected element pre-configured.
645
-
646
-
Select your `Client credentials` and click `Load embed` to see the result:
647
-
648
-
<imgsrc="assets/gs_16.png"width="800"/>
649
-
650
-
You can adjust a variety of options to test different scenarios, which can help save time during initial testing.
651
-
652
-
For more information, see [Test an embed URL in the embed sandbox](https://help.sigmacomputing.com/docs/test-an-embed-url-in-the-embed-sandbox)
653
-
654
-

655
-
<!-- END -->
656
-
657
629
## Edit Environment File and Test
658
630
Duration: 5
659
631
660
632
Let’s make the embed work in the Git project set up earlier.
661
633
662
-
Return to VS Code and open the `.env` file.
634
+
Return to VS Code and open the `.env` file (if not still open).
663
635
664
-
It will have placeholders for the values we need to provide and also includes some important notes.
636
+
We have a few more parameters to configure.
665
637
666
-
<imgsrc="assets/gs_17.png"width="800"/>
638
+
For `ACCOUNT_TYPE` use `View`.
667
639
668
-
Replace the placeholders with the values you saved earlier, using `View` for the `Account Type` and any email address (a made-up one is fine):
640
+
For `EMAIL` any email address (a made-up one is fine).
641
+
642
+
For `TEAMS` use `Sales_People`.
669
643
670
644
For example:
671
645
<imgsrc="assets/gs_20.png"width="800"/>
@@ -719,6 +693,32 @@ Once the local Express server is running, logging output appears in the console
719
693

720
694
<!-- END -->
721
695
696
+
## Embed Sandbox
697
+
Duration: 5
698
+
699
+
Sigma also provides an "in-product" embed sandbox that allows you to test your embed before integrating it into the native application. This allows you to view the content from the embed user’s perspective to verify security settings and other configurations.
700
+
701
+
Open the workbook’s menu and select `Share and export`, then `Embedding...`:
702
+
703
+
<imgsrc="assets/gs_16a.png"width="400"/>
704
+
705
+
Select `JWT`, choose `Page 1 - Plugs Sales Transactions` from the list control, and click `Test`:
706
+
707
+
<imgsrc="assets/gs_16b.png"width="600"/>
708
+
709
+
This opens the embedding sandbox with the selected element pre-configured.
710
+
711
+
Select your `Client credentials` and click `Load embed` to see the result:
712
+
713
+
<imgsrc="assets/gs_16.png"width="800"/>
714
+
715
+
You can adjust a variety of options to test different scenarios, which can help save time during initial testing.
716
+
717
+
For more information, see [Test an embed URL in the embed sandbox](https://help.sigmacomputing.com/docs/test-an-embed-url-in-the-embed-sandbox)
0 commit comments