Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
22 changes: 22 additions & 0 deletions modules/ROOT/pages/deprecated-features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ As ThoughtSpot applications evolve, some existing features will be deprecated an
[options='header']
|=====
|Feature|Impacted interface and release versions|Deprecation date |End of Support / removal from the product

a|xref:deprecated-features.adoc#_worksheet_deprecation_and_removal[Worksheets] a| ThoughtSpot Cloud 10.4.0.cl and later
|November 2024 | September 2025

a|xref:deprecated-features.adoc#restApiPlayground[REST API v1 Playground] a| ThoughtSpot Cloud 10.14.0.cl and later
|November 2025 | November 2025

Expand Down Expand Up @@ -76,6 +80,24 @@ a|xref:deprecated-features.adoc#_deprecated_parameter_in_rest_api_v2_0_authentic
||||
|=====


== Worksheet deprecation and removal

Starting with 10.4.0.cl, Worksheets are deprecated and disabled by default in ThoughtSpot. In ThoughtSpot Cloud 10.12.0.cl and later versions, the ability to create new Worksheets will be removed, and all existing Worksheets will be automatically migrated to Models.

Impact on your instance::

All existing Worksheets on your instance will be migrated automatically to Models, and Worksheets will no longer be available in the ThoughtSpot UI after the 10.12.0.cl release. Note that even adding a dbt connection will result in the creation of a Model. However, if you are using Worksheets in Git workflows or CI/CD pipelines that rely on import or create, those will continue to work temporarily until 10.13.0.cl.
+
Starting with 10.13.0.cl, import of worksheet TMLs will be blocked. Any such operations will fail with an error, requiring users to convert Worksheets to Models before importing. You may want to update your CI/CD and Git workflows to use Model TMLs instead of Worksheets.

Recommended action::
* If your instance has Worksheets, verify whether they are replaced with Models after your instance is upgraded to 10.12.0.cl.
* If you are importing Worksheet TML, the import operation will fail. Therefore, ThoughtSpot recommends converting Worksheets to Models and then importing Model TMLs to ThoughtSpot.
* Update your CI/CD and Git workflows to use Model TMLs instead of Worksheets.
* In REST APIs, the subtypes of `LOGICAL_TABLE` objects may still be referred to as Worksheet. However, these subtypes imply Models. When you specify subtype `WORKSHEET`, the API will include Models in the response or operation.
* You may find the "Worksheet" terminology in the Visual Embed SDK configuration properties and feature flags; for example, the `worksheetId` property in Spotter embed. However, when configuring these settings, use the Model object and its associated properties.

[#restApiPlayground]
== REST API v1 Playground deprecation

Expand Down
3 changes: 1 addition & 2 deletions modules/ROOT/pages/embed-ts-react-app.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ If you want to use Port 8000 instead, xref:security-settings.adoc#csp-viz-embed-

=== Install SDK

* Install the Visual Embed SDK from NPM.
Install the Visual Embed SDK from NPM.
+
----
npm install @thoughtspot/visual-embed-sdk
Expand All @@ -86,7 +86,6 @@ You will require GUIDs of the following objects to embed ThoughtSpot components.

You can find the GUIDs of these objects in the UI, the developer Playground on your ThoughtSpot instance, or through the xref:metadata-api.adoc#metadata-list[metadata/list] and xref:metadata-api#object-header[metadata/listobjectheaders] REST API endpoints.


== Embed a Liveboard

To embed a ThoughtSpot Liveboard, complete the following steps:
Expand Down
24 changes: 16 additions & 8 deletions modules/ROOT/pages/open-issues.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,35 @@

This page lists the known issues that you might run into while embedding ThoughtSpot in your app, or when using the embedded interface or making REST API calls.


== Version 10.5.0.cl

[cols="3,6"]
[cols="4,6"]
[options='header']
|=====
|Issue Description| Symptoms, conditions, and workaround
|When a visualization in Liveboard embed is opened in edit mode, empty spaces appear beneath or above the visualization area.|
**Symptom**: +
When `fullHeight` is set to `true` in a Liveboard embed, the visualization pages show empty areas in edit mode.

**Conditions**: +
The `fullHeight` property dynamically sets the height of the embed container according to the height of the Liveboard. When a visualization is opened in edit mode, the same dynamic height is applied, which can result in empty space appearing on the visualization pages. This is a known limitation.

|When names are used as identifiers in path parameters, the API requests return `400 - Bad request` error. |
**Workaround**: +
None. This is a display issue and does not affect the underlying data or functionality.

|When names are used as identifiers in path parameters, the API requests return `400 - Bad request` error.
|
**Symptom**: +
If the identifier is a required attribute in the path parameter and contains a forward slash `/`, for example `N/firstname/lastname` as `user_identifier`, the API’s URI structure changes and results in a `400 - Bad Request` error. This effectively alters the API contract, making it invalid.

**Conditions**: This is a known limitation, which affects API requests to `/api/rest/2.0/users/{user_identifier}/delete`, `/api/rest/2.0/users/{user_identifier}/update` or any endpoint that accepts identifier as the path parameter.
**Conditions**: +
This is a known limitation, which affects API requests to `/api/rest/2.0/users/{user_identifier}/delete`, `/api/rest/2.0/users/{user_identifier}/update` or any endpoint that accepts identifier as the path parameter.

**Workaround**: To avoid this issue, use GUID instead of the name for object, user, Role, and group identifiers in path parameters.
**Workaround**: +
To avoid this issue, use GUID instead of the name for object, user, Role, and group identifiers in path parameters.

|The `logLevel` property does not suppress ThoughtSpot application logs.|
**Symptom**: +

The `logLevel` attribute in the Visual Embed SDK does not suppress ThoughtSpot application logs. For example, despite setting `logLevel:LogLevel.Error` or `logLevel:LogLevel.Silent`, the application logs for alerts, warnings, and debug messages are shown in the console output.

**Conditions**: +
Expand All @@ -48,7 +57,7 @@ None.
When users switch between tabs on an embedded Liveboard, the height of the Liveboard page changes and cuts the Liveboard content.

**Conditions**: +
This issue was observed on ThoughtSpot embedded instances using Visual Embed SDK versions below v1.29.0, with the `fullHeight` property set to `true`.
This issue was observed on ThoughtSpot embedded instancess using Visual Embed SDK versions below v1.29.0, with the `fullHeight` property set to `true`.

**Workaround**: +
To resolve this issue, upgrade to Visual Embed SDK v1.29.0 or later.
Expand All @@ -70,7 +79,6 @@ This issue occurs because when reimporting TML invalid characters are added to t

**Workaround**: +
See xref:tml.adoc#yamlReimport[YAML reimport in the REST API v2 Playground].
||
|=====


Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/pendo-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ To launch Pendo guides and analytics within your ThoughtSpot embed, you must int
Pendo integration with ThoughtSpot embed requires the following:

* Access to Pendo +
If you do not have a Pendo account, link:https://app.pendo.io/register[sign up for Pendo or use a trial, window=_blank] account.
If you do not have a Pendo account, you can link:https://app.pendo.io/register[sign up for Pendo, window=_blank] and create a trial account.
* Access to a ThoughtSpot instance. You need administrator privileges to enable Pendo integration.
* Approval from ThoughtSpot Support for Pendo integration.
* A publicly accessible domain to host your integration script.
Expand Down
Loading