Skip to content

Commit c3e1ddd

Browse files
authored
Merge pull request #395 from sigmacomputing/Getting-Started-embed-v3-draft-edits
gs-v3-draft-edits
2 parents 55b0b13 + 0fa18de commit c3e1ddd

File tree

2 files changed

+43
-43
lines changed

2 files changed

+43
-43
lines changed
118 KB
Loading

site/sigmaguides/src/embedding_01_getting_started_v3/embedding_01_getting_started_v3.md

Lines changed: 43 additions & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -373,6 +373,15 @@ The .env file provides fallback logic for each JWT:
373373

374374
This allows you to maintain a consistent test user by default, and easily override it per QuickStart as needed for different workflows.
375375

376+
Open the `.env` file. We will copy / paste key values as we progress through sections of this QuickStart:
377+
378+
<img src="assets/gs_13a.png" width="600"/>
379+
380+
<aside class="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+
376385
![Footer](assets/sigma_footer.png)
377386
<!-- END OF SECTION-->
378387

@@ -446,17 +455,6 @@ Create another team called `Sales_Managers`, set the team to `Private` and check
446455

447456
<img src="assets/gs_2a.png" width="800"/>
448457

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-
460458
Exit `Administration` by clicking the Sigma <img src="assets/crane.png" width="50"/> icon.
461459

462460
![Footer](assets/sigma_footer.png)
@@ -535,7 +533,7 @@ If you lose the embed secret, or it becomes compromised, you can revoke it and g
535533

536534
<img src="assets/gs_15.png" width="550"/>
537535

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.
539537

540538
![Footer](assets/sigma_footer.png)
541539
<!-- END -->
@@ -623,49 +621,25 @@ Select the `Plugs_Sales_Transactions` table, then copy the URL:
623621

624622
<img src="assets/gs_12.png" width="800"/>
625623

626-
Paste the `Base URL` into the text file.
624+
Paste the `Base URL` into the `.env` file in the `# QS: getting_started` group.
627625

628626
![Footer](assets/sigma_footer.png)
629627
<!-- END OF SECTION-->
630628

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-
<img src="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-
<img src="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-
<img src="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-
![Footer](assets/sigma_footer.png)
655-
<!-- END -->
656-
657629
## Edit Environment File and Test
658630
Duration: 5
659631

660632
Let’s make the embed work in the Git project set up earlier.
661633

662-
Return to VS Code and open the `.env` file.
634+
Return to VS Code and open the `.env` file (if not still open).
663635

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.
665637

666-
<img src="assets/gs_17.png" width="800"/>
638+
For `ACCOUNT_TYPE` use `View`.
667639

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`.
669643

670644
For example:
671645
<img src="assets/gs_20.png" width="800"/>
@@ -719,6 +693,32 @@ Once the local Express server is running, logging output appears in the console
719693
![Footer](assets/sigma_footer.png)
720694
<!-- END -->
721695

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+
<img src="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+
<img src="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+
<img src="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)
718+
719+
![Footer](assets/sigma_footer.png)
720+
<!-- END -->
721+
722722
## Tracking User Activity
723723
Duration: 5
724724

0 commit comments

Comments
 (0)