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: modules/ROOT/pages/sf-integration.adoc
+64-22Lines changed: 64 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,41 +6,53 @@
6
6
:page-pageid: sf-integration
7
7
:page-description: Methods for embedding ThoughtSpot into Salesforce Cloud products
8
8
9
-
Integrating ThoughtSpot with Salesforce enables users to access analytics directly within their Salesforce environment. By embedding ThoughtSpot content, organizations can deliver data-driven insights where your end users work, enhancing decision-making and efficiency. This guide explores the various embedding options, including the Visual Embed SDK and non-SDK approaches, and discusses key recommendations for authentication, customization/branding, and embedding in mobile apps.
9
+
Integrating ThoughtSpot with Salesforce enables users to access analytics directly within their Salesforce environment. By embedding ThoughtSpot content, organizations can deliver data-driven insights where their end users work, enhancing decision-making and efficiency.
10
10
11
-
== Embeddable objects
11
+
This guide explores the various embedding options, including the ThoughtSpot Lightning Web Component (LWC) plugin for Salesforce, Visual Embed SDK, and non-SDK approaches, and provides key recommendations for authentication, customization/branding, and embedding in mobile apps.
12
12
13
-
ThoughtSpot allows users to create several types of objects. Before we get into the details, it's important to understand that any of the following objects can be easily embed into Salesforce:
13
+
== Embeddable objects
14
+
ThoughtSpot allows users to create several types of objects. You can easily embed any of the following objects into Salesforce:
14
15
15
-
* *Search* - A self-service interface that allows users to perform searches on data and build visualizations
16
-
* *Answers* - Individual visualizations generated and saved from user search queries
17
-
* *Liveboards* - Interactive dashboards that contain one or more visualizations (Answers)
18
-
* *Spotter* - AI-powered assistant that helps users analyze data using natural language
19
-
* *Full Application* - Allows you to embed the full ThoughtSpot application or the individual application pages
16
+
* *Search* - A self-service interface that allows users to perform searches on data and build visualizations.
17
+
* *Answers* - Individual visualizations generated and saved from user search queries.
18
+
* *Liveboards* - Interactive dashboards that contain one or more visualizations (Answers).
19
+
* *Spotter* - An AI-powered assistant that helps users analyze data using natural language.
20
+
* *Full Application* - Allows embedding the full ThoughtSpot application or the individual application pages.
20
21
21
22
== Embedding methods
22
-
There are two development options for this integration:
23
+
The following development options are available for this integration:
24
+
25
+
[width="100%" cols="5,8"]
26
+
[options='header']
27
+
|=====
28
+
|Embedding method | Description
29
+
|Embedding using the LWC plugin a| ThoughtSpot's LWC plugin for Salesforce enables seamless embedding of Liveboards and Spotter inside your Salesforce environment. You can configure your experience by choosing which Liveboards to display, and update URLs dynamically.
30
+
31
+
*Key considerations*
23
32
24
-
* Embedding with Visual Embed SDK
25
-
* iFrame embedding without the SDK
33
+
* Easy to install with no custom code required.
34
+
* Simplified integration of Liveboards and Spotter components using the Salesforce Lightning App Builder.
35
+
* Support for authentication mechanisms such as SAML and Trusted Authentication.
26
36
27
-
=== Visual Embed SDK
28
-
If you are using the `Salesforce Lightning platform`, we highly recommend using ThoughtSpot's Visual Embed SDK as it provides maximum flexibility and allows you to create highly customized solutions across all Salesforce Cloud products.
37
+
If you are using the `Salesforce Lightning platform` and want to embed a Liveboard or the Spotter functionality, we highly recommend using the LWC plugin.
29
38
30
-
==== Key considerations
39
+
|Using Visual Embed SDK a| If you are using the `Salesforce Lightning platform` and do not want to use the LWC plugin, we recommend using ThoughtSpot's Visual Embed SDK as it provides maximum flexibility and allows you to create highly customized solutions across all Salesforce Cloud products.
31
40
32
-
* Simplified integration using Lightning Web Components (LWC)
41
+
*Key considerations*
42
+
43
+
* Simplified integration with LWC
33
44
* Enhanced customization and interactivity
34
45
* Support for authentication mechanisms like SAML and Trusted Authentication
35
46
36
-
=== iFrame embedding
37
-
For organizations using the `Salesforce Classic platform`, or that prefer not to use the SDK, embedding ThoughtSpot can be achieved via iframes. This method is simpler, but considered a legacy approach for embedding.
47
+
|iFrame embedding without the SDK a|For organizations using the `Salesforce Classic platform` or those that prefer not to use the SDK or the LWC plugin, embedding ThoughtSpot can be achieved via iframes. This method is simpler, but considered a legacy approach for embedding.
38
48
39
-
==== Key considerations
49
+
*Key considerations*
40
50
41
51
* Fewer customization options
42
52
* Potential styling limitations
43
53
* SAML authentication only
54
+
||
55
+
|=====
44
56
45
57
=== Mobile considerations
46
58
If you require ThoughtSpot content to be available in the Salesforce mobile app, we recommend leveraging the Visual Embed SDK with Single Sign-On (SSO) using Cookieless Trusted Authentication (AuthType.TrustedAuthTokenCookieless). This combination will provide a seamless embedding experience.
@@ -51,8 +63,38 @@ Now that we understand our options, let's walk through the implementation steps
51
63
52
64
To embed ThoughtSpot content, complete the steps described in the following sections:
53
65
54
-
* Embed with Visual Embed SDK
55
-
* Use iFrame to embed
66
+
* xref:sf-integration.adoc#_embed_spotter_or_a_liveboard_using_lwc_plugin[Embed Spotter or a Liveboard using the LWC plugin]
67
+
* xref:sf-integration.adoc#_embed_with_visual_embed_sdk[Embed with Visual Embed SDK]
68
+
* xref:sf-integration.adoc#_use_iframe_to_embed[Use iFrame to embed]
69
+
70
+
=== Embed Spotter or a Liveboard using the LWC plugin
71
+
The LWC plugin allows embedding ThoughtSpot Spotter and Liveboards. The embedding method with the LWC plugin involves the following steps:
72
+
73
+
. *Installing the LWC plugin*
74
+
+
75
+
.. Create a link:https://developer.salesforce.com/developer-legacy/signup[Salesforce Developer account, window=_blank]. If you already have an account, log in to Salesforce with your credentials.
76
+
.. Install the link:https://login.salesforce.com/packaging/installPackage.apexp?p0=04tWU000000A2LVYA0[ThoughtSpot LWC package, window=_blank].
77
+
.. Select the appropriate access level for your users, then click *Install*.
.. Add your ThoughtSpot instance URL in Salesforce as a trusted host for CSP and Cross-Origin Resource Sharing (CORS).
82
+
.. Configure access control for your users.
83
+
.. Configure the ThoughtSpot allowlists to enable seamless integration and communication between your host application and ThoughtSpot.
84
+
.. Set up authentication and enable Single Sign-On (SSO).
85
+
86
+
+
87
+
For more information and detailed instructions, see link:https://docs.thoughtspot.com/cloud/latest/salesforce-plugin-setup[Plugin setup and integration guide, window=_blank].
88
+
89
+
. *Embedding ThoughtSpot component* +
90
+
91
+
.. In your Salesforce app, click the gear icon and select *Edit Page* to open the Lightning App Builder.
92
+
.. Drag and drop the ThoughtSpot component into the page layout.
93
+
.. Configure the ThoughtSpot application URL, object ID, and other such relevant object properties.
94
+
.. Save and load the embedded page.
95
+
96
+
+
97
+
For more information and detailed instructions, see link:https://docs.thoughtspot.com/cloud/latest/salesforce-plugin[Salesforce integration documentation, window=_blank].
56
98
57
99
=== Embed with Visual Embed SDK
58
100
The Salesforce lightning platform moved developers away from Visualforce to *Lightning Web Components (LWC)*. If you are considering using the SDK, we will assume your Salesforce instance is running on Lightning.
@@ -69,7 +111,7 @@ NOTE: This guide does not cover LWC development. We will assume you have experie
69
111
Any LWC you develop in Salesforce will contain an html, js, and meta.xml file. Let's walk through a simple Liveboard embed component.
70
112
71
113
*meta.xml* +
72
-
Defines the metadata values for the component. Specifically, where you want to embed in Salesforce (Record Pages, Experience Cloud, Homepage, etc.), and any configurable parameters for your ThoughtSpot objects (type of object to embed, Cluster URL, Org, etc.).
114
+
Defines the metadata values for the component. Specifically, where you want to embed in Salesforce (Record Pages, Experience Cloud, Homepage, and more), and any configurable parameters for your ThoughtSpot objects (type of object to embed, Cluster URL, Org, and more).
73
115
74
116
[source, xml]
75
117
----
@@ -362,5 +404,5 @@ The Visual Embed SDK allows extensive customization, including the following:
362
404
* Controlling user experience via ThoughtSpot’s developer-friendly APIs.
363
405
364
406
== Conclusion
365
-
Embedding ThoughtSpot into Salesforce enhances analytics accessibility, enabling users to gain insights without leaving their CRM. Whether using the ThoughtSpot SDK or iframe-based approaches, choosing the right authentication and embedding method is essential. By leveraging LWC and customizing ThoughtSpot’s appearance, organizations can create a seamless and powerful analytics experience within Salesforce.
407
+
Embedding ThoughtSpot into Salesforce enhances analytics accessibility, enabling users to gain insights without leaving their CRM. Whether using the ThoughtSpot LWC plugin, Visual Embed SDK or iframe-based approaches, choosing the right authentication and embedding method is essential. By leveraging LWC and customizing ThoughtSpot’s appearance, organizations can create a seamless and powerful analytics experience within Salesforce.
0 commit comments