Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
34 commits
Select commit Hold shift + click to select a range
c842f9b
Update react-components_lesson-01.adoc
bryanthowell-ts Jan 5, 2026
468fc23
Update react-components_intro.adoc
bryanthowell-ts Jan 5, 2026
d1f4561
Update react-components_lesson-01.adoc
bryanthowell-ts Jan 5, 2026
abc769a
Update react-components_lesson-01.adoc
bryanthowell-ts Jan 7, 2026
773b4c8
SCAL-289827
ShashiSubramanya Jan 9, 2026
ff3dbb2
SCAL-288927
ShashiSubramanya Jan 9, 2026
253f3ea
Update react-components_lesson-01.adoc
bryanthowell-ts Jan 9, 2026
1e1e7fe
Update react-components_lesson-03.adoc
bryanthowell-ts Jan 12, 2026
0ac4314
Merge pull request #392 from thoughtspot/abac-and-locale-updates
ShashiSubramanya Jan 13, 2026
ce2c7b7
SCAL-290499 Update URL handling to preserve subsection hashes in iframe
shivam-kumar-ts Jan 13, 2026
9c35ab7
Merge pull request #396 from thoughtspot/SCAL-290499
shivam-kumar-ts Jan 13, 2026
8d570e2
banner text edits
ShashiSubramanya Jan 13, 2026
789dfc2
banner text, pre-release link, and other updates
ShashiSubramanya Jan 13, 2026
4907f1a
edits
ShashiSubramanya Jan 19, 2026
44856fd
v1, v2, and v3 images for clarity
ShashiSubramanya Jan 20, 2026
4d65e9c
rls example fixes
ShashiSubramanya Jan 20, 2026
b5024c7
script changes for link handling (#394)
ShashiSubramanya Jan 20, 2026
4411bfe
SCAL-281811 documentation fix
ShashiSubramanya Jan 22, 2026
600e888
SCAL-291802
ShashiSubramanya Jan 22, 2026
99d95b0
copyright update
ShashiSubramanya Jan 22, 2026
228b93f
Update trusted-auth-sdk.adoc
bryanthowell-ts Jan 26, 2026
f3925e4
typo fixes
ShashiSubramanya Jan 29, 2026
d6fac03
edits
ShashiSubramanya Jan 29, 2026
590f312
typo fixes
ShashiSubramanya Jan 29, 2026
ee60775
Merge pull request #400 from thoughtspot/trusted-current-fixes
ShashiSubramanya Jan 30, 2026
ed590a8
Merge pull request #395 from thoughtspot/react-tutorial-refresh
ShashiSubramanya Jan 30, 2026
d10a1ef
banner text
ShashiSubramanya Feb 2, 2026
a79f5a4
banner link fix
ShashiSubramanya Feb 2, 2026
256f907
Merge pull request #403 from thoughtspot/banner-txt-test
ShashiSubramanya Feb 3, 2026
0670c0c
26.2.0.cl link update
ShashiSubramanya Feb 3, 2026
2654bf4
banner link open in new tab
ShashiSubramanya Feb 3, 2026
64fbc8f
v3 home page experience update
ShashiSubramanya Feb 3, 2026
9c294fc
banner text logic for versioned urls
ShashiSubramanya Feb 3, 2026
49be76b
link target property
ShashiSubramanya Feb 3, 2026
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions modules/ROOT/pages/abac_rls-variables.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,15 +109,15 @@ To define RLS rules with variables for a Table:

. Navigate to the Data workspace and click the Table for which to define RLS rules.
. Click *Row security* and then click *+ Add row security*.
. In the *Row Security Editor*, define the rules. To reference the formula variable in the rule, use the `ts_var` function. For example, If you want to limit user access to data of a specific region, you can create a region-specific variable, `region = ts_var('region_var')`, and assign values in the token request.
. In the *Row Security Editor*, define the rules. To reference the formula variable in the rule, use the `ts_var` function. For example, If you want to limit user access to data of a specific region, you can create a region-specific variable, `region = ts_var(region_var)`, and assign values in the token request.


=== RLS rule with a single variable reference

In this formula example, `country` refers to the "country" column in the data table, and `country_var` is the variable.

----
country = ts_var('country_var')
country = ts_var(country_var)
----

If `country_var` is assigned a single value, the user is permitted to view only rows where the `country` column matches that value.
Expand All @@ -130,20 +130,20 @@ The RLS rules support the `AND` operator, which means that you can combine multi
The following rule restricts data access to rows if the `country` column in the data table matches the value assigned to `country_var` and the `Department` column matches the value assigned to `department_var` for that user.

----
country = ts_var('country_var') AND Department = ts_var('department_var')
country = ts_var(country_var) AND Department = ts_var(department_var)
----

The rule in this example restricts data access to rows where the `region` column in the table matches the value assigned to `region_var` and the `product` column matches the value assigned to `product_var`.

----
region = ts_var('region_var') AND product = ts_var('product_var')
region = ts_var(region_var) AND product = ts_var(product_var)
----

=== Allow all rule with a TS_WILDCARD_ALL variable
In this example, `customer` represents the column `customer` in the table and `customer_var` represents variable. If the value of the customer_var variable is set to `TS_WILDCARD_ALL`, the user can access all customers in the column.

----
customer = ts_var('customer_var')
customer = ts_var(customer_var)
----

=== Group override rule with variable-based check
Expand All @@ -152,21 +152,21 @@ In any security formula you build, you may want a clause that gives access to al
In this example, users can access data if they are in the "data developers" group, or if the `Department` column matches the value assigned to their `department_var` variable.

----
'data developers' in ts_groups OR Department = ts_var('department_var')
'data developers' in ts_groups OR Department = ts_var(department_var)
----

==== Variables with numeric and Date data types

The following rule enforces a numeric threshold and restricts access to rows where the Revenue value is less than or equal to the value provided by the `revenue_cap_var` variable.

----
Revenue <= to_double(ts_var('revenue_cap_var'))
Revenue <= to_double(ts_var(revenue_cap_var))
----

The following rule restricts access to rows where the `date_column` is within the range defined by the `start_date_var` and `end_date_var` variables. Only rows with dates greater than or equal to the start date and less than or equal to the end date specified for these variables will be visible for the user.

----
(date_column >= ts_var('start_date_var')) AND (date_column <= ts_var('end_date_var'))
(date_column >= ts_var(start_date_var)) AND (date_column <= ts_var(end_date_var))
----

== Create an ABAC token request with variable attributes
Expand Down Expand Up @@ -362,8 +362,7 @@ ABAC details are sent in a JWT that can be used as a bearer token for cookieless
====

=== Verify the variable assignment

To verify the variable assignment, use the `POST /api/rest/2.0/users/search` API call and check `variable_values` in the user properties in the API response.
To retrieve user information and object properties, you can use the `POST /api/rest/2.0/users/search` API call. To include variable details in the response, set the `include_variable_values` parameter to `true` in the API request body. This allows you to fetch variable values associated with the user in the specified context.

[source,JSON]
----
Expand Down Expand Up @@ -395,7 +394,10 @@ To verify the variable assignment, use the `POST /api/rest/2.0/users/search` API
}
----

To verify the security entitlements, start a user session using the JWT and inspect the generated SQL for your query or visualization.
You can also use the `POST /api/rest/2.0/template/variables/search` API call to xref:variables.adoc#_get_variables[get the list of variables] assigned to a specific user, Org, and Model.

==== Updating variable values for a user
To update variable values for a user, you can use the `/api/rest/2.0/template/variables/update-values` endpoint, or `/api/rest/2.0/auth/token/custom` endpoint when logging in the user. Do not use the `/api/rest/2.0/users/{user_identifier}/update` endpoint, as it does not support updating variable values.

== Verify the entitlements
To verify the entitlements:
Expand Down
19 changes: 12 additions & 7 deletions modules/ROOT/pages/customize-homepage-full-embed.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,31 @@

Developers can customize the home page experience in full application embedding to show either the classic layout or the new modular home page.

In the classic (V1) experience, the home page has a static layout and does not support SDK modular customization settings.

In the V2 and V3 experience modes, you can customize the home page by specifying which modules are visible, their order, and the overall layout using configuration options available in the SDK.

[div announcementBlock]
--
[IMPORTANT]
The classic (V1) experience and V2 experience modes will be deprecated in an upcoming release in 2026. Therefore, ThoughtSpot recommends upgrading the UI experience of your full application embedding to the V3 experience.
--

== Home page layout

== Home page layout in the V3 experience
In the classic (V1) experience, the home page has a static layout and does not support SDK modular customization settings.

In the V3 experience, the SDK provides the xref:HomePage.adoc[homePage] attribute that allows you to choose the desired home page layout:
In the V3 experience, the SDK provides the xref:HomePage.adoc[homePage] attribute to set the desired home page layout:

* `homePage: HomePage.ModularWithStylingChanges` +
Enables the V3 modular home page experience with customizable components, styling options, and enhanced layout and visual elements.
Enables the V3 modular home page experience with customizable components, styling options, and enhanced layout.
* `homePage: HomePage.Modular` +
Enables the basic modular home page experience with customizable components.

After migrating from V2 to V3 experience, the home page experience shows the following changes:

* The **Watchlist** module is vertically arranged, includes menu actions to remove the KPI charts from the watchlist and create alerts, and allows drag-and-drop reordering of charts.
* The **Trending** module displays separate lists for Liveboards and Answers objects. Both these lists show the objects trending for the last 15 days, or based on the overall views, or both.
* The **Favorites** and **Learning** modules have enhanced visual styles and improved look and feel.

In both V2 and V3, the SDK allows customization to include or exclude modules, change their order, and adjust the overall layout.

== Customization settings for home page
The following customization settings are available for the modular home page in the V2 and V3 experience modes.

Expand Down
47 changes: 19 additions & 28 deletions modules/ROOT/pages/full-app-customize.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,33 +46,22 @@ A dynamic left navigation menu that adjusts its contents according to the applic

|=====
--
////
[width="100%", cols="2,8,8,8"]
[options='header']
|=====
||V1 (Legacy) |V2 experience |V3 experience

|Navigation style a|* Top navigation bar for application menu. +
* Separate left navigation panels only for specific application context, such as *Data*, *Admin* and *Develop* modules a|
* Persona-based app selector on the top navigation bar +
* A separate left navigation panel for each persona-based application context a|
* Sliding left navigation panel
* Persona-based tabs on the left panel to switch between application context.
* Separate left navigation panel for each application context.
|Home page experience| Basic | Modular and customizable home page | Modular
|Enablement| The default, legacy ThoughtSpot UI. a| Disabled by default. +
Can be enabled by setting `modularHomeExperience: true` in the Visual Embed SDK a| Disabled by default. +
Can be enabled by setting the `discoveryExperience` properties in the Visual Embed SDK.
|Migration considerations| If you want to continue using the classic experience, no migration is required.
If you plan to switch to the new navigation and modular home page experience, ThoughtSpot recommends migrating to the new v3 experience.
| The v2 navigation experience can be enabled by setting `modularHomeExperience` to `true` in the Visual Embed SDK. However, the new v3 experience with left navigation panel provides an improved experience and more customizable components for home page, therefore, we recommend using the v3 experience.
If you are already on v2 experience and want to switch to the new v3 experience, contact ThoughtSpot Support to enable this feature on your instance.
Once enabled, configure the `discoveryExperience` properties and customize your home page experience as per your embedding requirements.
|Contact ThoughtSpot Support to enable the v3 experience on your ThoughtSpot instance.
Once enabled, configure the `discoveryExperience` properties and customize your home page experience as per your embedding application requirements.
||||
|=====
////

**V3 navigation and home page experience**
[.bordered]
[.widthAuto]
image::./images/v3-experience.png[V3 UI experience]

**V2 navigation and home page experience**
[.bordered]
[.widthAuto]
image::./images/v2-experience.png[V2 UI experience]

**V1 Classic experience**
[.bordered]
[.widthAuto]
image::./images/v1-experience.png[Classic experience]


== Customize the embedded application UI for your users

Expand Down Expand Up @@ -194,13 +183,15 @@ const embed = new AppEmbed("#embed", {
After you enable the V3 experience:

* Ensure the UI shows the V3 navigation and home page.

////
+
The following figure shows the user interface with the V3 experience:
+
[.bordered]
[.widthAuto]
image::./images/new-nav3.png[New home page]

////
* Verify that all the customization settings are applied correctly.
* If you have set up custom routes for navigation within your embedded app, verify navigation workflows and check for breaking changes.

Expand Down
16 changes: 8 additions & 8 deletions modules/ROOT/pages/locale-setting.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,30 +23,30 @@ If you want to set your embedded app view to a specific locale for your applicat
[options="header"]
|====================
| Locale | Language
| `ar-EG` | Egyptian Arabic
| `da-DK` | Dansk
| `de-DE` | Deutsch
| `de-CH` | German (Switzerland)
| `de-CH` | Deutsch (Switzerland)
| `en-AU` | English (Australia)
| `en-CA` | English (Canada)
| `en-DE` | English (Germany)
| `en-IN` | English (India)
| `en-NZ` | English (New Zealand)
| `en-GB` | English (United Kingdom)
| `en-US` | English (United States)
| `en-NZ` | English (New Zealand)
| `es-ES` | Español
| `es-US` | Español (Latinoamérica)
| `es-ES` | Español (España)
| `es-MX` | Spanish (Mexico)
| `fi-FI` | Suomi
| `es-MX` | Español (Mexico)
| `fr-CA` | Français (Canada)
| `fr-FR` | Français (France)
| `ja-JP` | 日本語
| `ko-KR` | 한국어
| `it-IT` | Italiano
| `ja-JP` | Japanese (Japan)/ 日本語
| `nb-NO` | Norsk
| `nl-NL` | Nederland
| `pt-BR` | Português (Brasil)
| `pt-PT` | Português (Portugal)
| `ru-RU` | Russian (Russia)
| `ru-RU` | Pусский (ограниченный выпуск)
| `fi-FI` | Suomi
| `sv-SE` | Svenska
| `zh-CN` | 中文(简体)
| `zh-HANT`| 中文 (繁體)
Expand Down
1 change: 0 additions & 1 deletion modules/ROOT/pages/mobile-embed-android.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@ Your application developers can embed a ThoughtSpot Liveboard in your native And
Before you begin, ensure that your development environment has the following setup:

* Access to a ThoughtSpot instance with administrator and developer privileges. +
Ensure that your host app embedding ThoughtSpot is added to the xref:security-settings.adoc[CSP and CORS allowlists] in ThoughtSpot.
* Access to the Liveboard object that you want to embed.
* Android Studio is installed. +

Expand Down
1 change: 0 additions & 1 deletion modules/ROOT/pages/mobile-embed-qs-flutter.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ Before you begin, check if your setup has the following:

* A Flutter application project setup. For information about creating a Flutter app, see link:https://docs.flutter.dev/reference/create-new-app[Flutter documentation, window=_blank].
* Access to a ThoughtSpot instance with administrator and developer privileges. +
Ensure that your host app embedding ThoughtSpot is added to the xref:security-settings.adoc[CSP and CORS allowlists] in ThoughtSpot.
* Access to the Liveboard object that you want to embed.

== Get started with embedding
Expand Down
1 change: 0 additions & 1 deletion modules/ROOT/pages/mobile-embed-qs-swift.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@ Before you begin, ensure that your development setup includes the following:
* Xcode 13 or later is installed. For information about Xcode and SwiftUI, see link:https://developer.apple.com/documentation/Xcode[Xcode documentation, window=_blank].
* iOS 14.0 or later is installed on your device to test your embed.
* Access to a ThoughtSpot instance with administrator and developer privileges. +
Ensure that your host app embedding ThoughtSpot is added to the xref:security-settings.adoc[CSP and CORS allowlists] in ThoughtSpot.
* Access to the Liveboard object that you want to embed.

== Install the Swift Embed Package
Expand Down
10 changes: 1 addition & 9 deletions modules/ROOT/pages/mobile-embed.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,7 @@ Allows developers to embed ThoughtSpot content in an iOS native app.
Allows developers to embed ThoughtSpot content in an Android native app.

== Authentication and security settings
Currently, Mobile Embed SDKs support only cookieless authentication (`AuthType.TrustedAuthCookieless`) method to authenticate embed users. To handle authentication, you may have to token provider function or use your backend app to fetch a token for trusted authentication. For more information, see the Mobile Embed SDK quickstart guides.

You must also add your embedding app domain to the following allowlists on the **Develop** > **Customizations** > **Security Settings** page in the ThoughtSpot UI.

* CSP visual embed hosts
* Permitted iFrame domains
* CORS whitelisted domains

For information about how to add your domains to CSP and CORS allowlists, see xref:security-settings.adoc[Security Settings].
Currently, Mobile Embed SDKs support only cookieless authentication (`AuthType.TrustedAuthCookieless`) method to authenticate embed users. To handle authentication, you may have to token provider function or use your backend app to fetch a token for trusted authentication. For more information, see the respective Mobile Embed SDK quickstart guides.

== Mobile embed customization

Expand Down
2 changes: 0 additions & 2 deletions modules/ROOT/pages/mobilesdk-quick-start.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@ Before you begin, check the following:
* link:https://docs.npmjs.com/downloading-and-installing-node-js-and-npm[NPM and Node.js are installed, window=_blank] on your system.
* Your link:https://reactnative.dev/docs/environment-setup[React Native environment, window=_blank] is set up.
* You can access a ThoughtSpot instance with administrator and developer credentials. +
Ensure that your host app embedding ThoughtSpot is added to the xref:security-settings.adoc[CSP and CORS allowlists] in ThoughtSpot.
* You have access to the Liveboard object that you want to embed

* If you are using Expo to build your application:
Expand Down Expand Up @@ -410,7 +409,6 @@ Additionally, you can add a listener for `EmbedEvent.Error` and verify the logs.
* In case of rendering issues, adjust the frame size constraints and rerun your app.
* Check if your custom CSS specifications are applied correctly.


== Known limitations

For information about supported features and known limitations, see xref:mobile-embed.adoc#_known_limitations[Mobile embed limitations].
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/pendo-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ To validate and test Pendo integration in your embed:
image::./images/pendo-dev-console.png[Dev console verification]
--
. If your integration script includes validation checks with `pendo.validateEnvironment()`, you can verify the logs in the console to confirm if the script is executed successfully and initializes as expected. You can also enable debug logs by adding `logLevel: LogLevel.DEBUG` to your `init` code. +
For more information about `pendo.validateEnvironment()`, see the "Verify the installation" section in the link:https://support.pendo.io/hc/en-us/articles/360046272771-Developer-s-guide-to-implementing-Pendo-using-the-install-script[Pendo Documentation, window=_blank] or refer to the link:https://github.com/thoughtspot/developer-examples/blob/524ef13121fcae4756a951648e3e6dc4bb29aa26/visual-embed/pendo-integration/pendoIntegrationScript.js#L108[sample script provided by ThoughtSpot, window=_blank]. +
For more information about `pendo.validateEnvironment()`, see the "Verify the installation" section in the link:https://support.pendo.io/hc/en-us/articles/360046272771-Developer-s-guide-to-implementing-Pendo-using-the-install-script[Pendo Documentation, window=_blank] or refer to the link:https://github.com/thoughtspot/developer-examples/blob/main/visual-embed/pendo-integration/pendoIntegrationScript.js[sample script provided by ThoughtSpot, window=_blank].

. Log in to Pendo to create a sample guide for your ThoughtSpot application instance.
. In the ThoughtSpot UI, verify if the Pendo guide is published. +
Expand All @@ -203,7 +203,7 @@ If the variables are not available:

== Additional resources

* link:https://github.com/thoughtspot/developer-examples/blob/524ef13121fcae4756a951648e3e6dc4bb29aa26/visual-embed/pendo-integration/pendoIntegrationScript.js[ThoughtSpot Developer examples GitHub repository, window=_blank]
* link:https://github.com/thoughtspot/developer-examples/tree/main/visual-embed/pendo-integration[ThoughtSpot Developer examples GitHub repository, window=_blank]
* link:https://www.pendo.io/resources/getting-started-with-pendo/[Pendo Getting Started Guide]
* link:https://support.pendo.io/hc/en-us/articles/360046272771-Developer-s-guide-to-implementing-Pendo-using-the-install-script[Pendo Documentation, window=_blank]
* link:https://codesandbox.io/p/devbox/optimistic-mcclintock-lw2qq8[Code sandbox, window=_blank]
11 changes: 10 additions & 1 deletion modules/ROOT/pages/security-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,16 @@ Response code

[#shareviz]
== Share a visualization with another user or user group
If you want to share a specific visualization from a Liveboard with another user or user group, use the `/tspublic/v1/security/shareviz` API. This API lets you share the visualization with specific user IDs and provide read-only access.
If you want to share a specific visualization from a Liveboard with another user or user group, use the `/tspublic/v1/security/shareviz` API.

[IMPORTANT]
====
* Sharing a visualization implicitly shares the entire Liveboard with the recipient.
* If email notifications for object sharing are enabled, a notification with a link to the shared visualization will be sent to the recipient’s email address. Although this link opens the shared visualization, recipients can also access other visualizations in the Liveboard.
* The `/tspublic/v1/security/shareviz` API endpoint provides only read-only access to the shared visualization.
====



=== Resource URL
----
Expand Down
Loading
Loading