Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
3977ac2
link fixes
ShashiSubramanya Sep 10, 2025
7d1fd5c
typo fix
ShashiSubramanya Sep 10, 2025
1b7027a
org feature matrix update SCAL-272951
ShashiSubramanya Sep 15, 2025
7f71849
formatting fixes
ShashiSubramanya Sep 15, 2025
f5a7e43
SCAL-272976 fix
ShashiSubramanya Sep 16, 2025
f45aeba
SCAL-273014
ShashiSubramanya Sep 16, 2025
8469c1e
beta label to lb styling
rani2655 Sep 26, 2025
76aa11d
edits
ShashiSubramanya Sep 23, 2025
981be8f
spotter apis
ShashiSubramanya Sep 27, 2025
c9d4fd1
edits
ShashiSubramanya Sep 29, 2025
8c38564
edits
ShashiSubramanya Sep 29, 2025
8faef82
Merge branch 'main' into 10.13.0.cl
ShashiSubramanya Sep 29, 2025
31e9d72
added new api fields
rani2655 Sep 30, 2025
9ca7d36
changes to label
rani2655 Oct 1, 2025
2d1a5d5
edits
ShashiSubramanya Oct 2, 2025
ddad1a6
image edits
ShashiSubramanya Oct 2, 2025
64f41bd
version and nav update
ShashiSubramanya Oct 2, 2025
37d14d3
link fixes
ShashiSubramanya Oct 2, 2025
3d3804c
edits
ShashiSubramanya Oct 2, 2025
f3c06c3
image and link updates
ShashiSubramanya Oct 2, 2025
db60e9d
title fix
ShashiSubramanya Oct 2, 2025
3e6cb78
review comments
ShashiSubramanya Oct 3, 2025
c3ade32
terminology update = Worksheet to Model
ShashiSubramanya Oct 3, 2025
bc30f38
email-custom
rani2655 Oct 3, 2025
e30a1a1
email-custom1
rani2655 Oct 3, 2025
1345e87
email-custom2
rani2655 Oct 3, 2025
0cbc3c1
Merge pull request #360 from thoughtspot/worksheet-model-conversion
ShashiSubramanya Oct 3, 2025
485cbb3
SCAL-274483
ShashiSubramanya Oct 3, 2025
73631a0
rt-filters
ShashiSubramanya Oct 3, 2025
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
2 changes: 1 addition & 1 deletion modules/ROOT/pages/access-control-sharing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ image::./images/shareability_access.png[Shareability with groups and users]
Users *do not see the group* that provides them access to a given piece of content (the same content could be shared to multiple groups they belong to, or to them directly as well), nor do they see who shared content to them individually, although they can see the *author* of any content.

=== Sharing content
ThoughtSpot users can share objects such as Liveboards, Answers, Tables, Models, Worksheets, and Table columns.
ThoughtSpot users can share objects such as Liveboards, Answers, Tables, Models, and Table columns.

Sharing provides either `read-only` or `edit` permissions on an object

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/admin-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -1151,7 +1151,7 @@ On successful deletion of the action, the API returns a response body indicating
[#custom-action-assoc]
== Associate a custom action to ThoughtSpot objects

ThoughtSpot supports associating custom actions to Liveboards, answers, and worksheets, To programmatically associate a custom action to a ThoughtSpot object, send a `POST` request to the `/tspublic/v1/admin/embed/actions/{actionid}/associations` API endpoint.
ThoughtSpot supports associating custom actions to Liveboards, Answers, and Models, To programmatically associate a custom action to a ThoughtSpot object, send a `POST` request to the `/tspublic/v1/admin/embed/actions/{actionid}/associations` API endpoint.

=== Resource URL
----
Expand Down
32 changes: 32 additions & 0 deletions modules/ROOT/pages/api-changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,38 @@

This changelog lists only the changes introduced in the Visual Embed SDK. For information about new features and enhancements available for embedded analytics, see xref:whats-new.adoc[What's New].

== Version 1.42.0, October 2025

[width="100%" cols="1,4"]
|====
|[tag greenBackground]#NEW FEATURE# a|*Runtime overrides in Spotter embed*
The Visual Embed SDK now supports runtime overrides in Spotter embed.

* To apply runtime filters, use the `runtimeFilters` object
* To apply runtime Parameters, use the `runtimeParameters` object.

|[tag greenBackground]#NEW FEATURE# a|*PNG images in Liveboard schedule notifications*
To enable embedding PNG images of Liveboards in scheduled job notifications sent to subscribers, the SDK provides the `isPNGInScheduledEmailsEnabled` boolean parameter. When set to true, scheduled emails will include a PNG image of the Liveboard.

The SDK also provides the following action IDs:

* `Action.PngScreenshotInEmail` +
Adds the option to include a PNG screenshot in the notification email body when scheduling emails in ThoughtSpot.
* `Action.RemoveAttachment`
Allows the user to remove an attachment from the email configuration in the schedule email dialog.
|[tag greenBackground]#NEW FEATURE# a|*Spotter embed*

Action IDs::
The following action IDs are available for Spotter embedding and are currently supported only in the `hiddenActions` array:

* `Action.SpotterWarningsBanner` +
Action ID to control the visibility of the Spotter warnings banner in the UI. This banner displays general warnings or informational messages related to Spotter results or queries.
* `Action.SpotterWarningsOnTokens` +
Action ID to control the visibility of warning indicators on individual Spotter tokens parsed from a Spotter query.
* `Action.SpotterTokenQuickEdit` +
Action ID to enable or disable the link:https://docs.thoughtspot.com/cloud/latest/spotter-getting-started#quick-edits[quick edit functionality^] for Spotter tokens.
|====

== Version 1.41.0, September 2025

[width="100%" cols="1,4"]
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,7 @@ Resets the existing user properties upon token generation and adds the new attri
|`filter_rules` a|__Array of filter rules__. An array of runtime filter conditions to pass via token. Each rule in the array must include the following information:

* `column_name` +
Name of the column in the data source object (Worksheet or Model).
Name of the column in the data source object (Model).
* `operator` +
Filter operator to use. For a complete list of supported operators, see xref:runtime-filters.adoc#rtOperator[filter operators].
* `values` +
Expand Down Expand Up @@ -625,7 +625,7 @@ The values to filter on. To get all records, use `TS_WILDCARD_ALL` .
|`parameter_values` a| __Array of Parameter values__. Parameter rules to apply. Each rule in the array must include the following attributes:

* `name` +
Name of the column in the data source object (Worksheet or Model)
Name of the column in the data source object (Model)
* `value` +
The values to use.

Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/catalog-and-audit.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,6 @@ To see a user's privilege set, use the xref:user-api.adoc#get-user-details[user
There are also `assignedGroups` and `inheritedGroups` arrays within the response, which contain the GUIDs of the groups the user belongs to. To see the privileges assigned to the groups, use the xref:group-api.adoc#get-ug-details[group API endpoint]. Using `GET /user` and `GET /group` endpoints together allows tracing what group membership gives the user their privileges.

== Dependency tracking
The xref:dependency-apis.adoc[dependency REST APIs] allow you to see which content objects rely on a data object. You can request the dependencies of a *table* object, which will return *worksheets*, *answers*, *Liveboards* and other objects that use the *table*.
The xref:dependency-apis.adoc[dependency REST APIs] allow you to see which content objects rely on a data object. You can request the dependencies of a *table* object, which will return *models*, *answers*, *Liveboards* and other objects that use the *table*.

To go up the chain, from an object to what it depends upon, you need to either export and process the object's TML or use the `/metadata/details` API endpoint, which returns a very large and complex data structure. For example, the `tables` property of the TML of an Answer or Liveboard provides the name of the table, Worksheet, or view that the data comes from. Worksheet TML responses similarly have a property referencing the tables or views they connect to.
To go up the chain, from an object to what it depends upon, you need to either export and process the object's TML or use the `/metadata/details` API endpoint, which returns a very large and complex data structure. For example, the `tables` property of the TML of an Answer or Liveboard provides the name of the Table, Model, or view that the data comes from. Model TML responses similarly have a property referencing the tables or views they connect to.
15 changes: 9 additions & 6 deletions modules/ROOT/pages/common/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -134,8 +134,6 @@
*** link:{{navprefix}}/prerender[Prerender components]
*** link:{{navprefix}}/lazy-load-fullHeight[Full height and lazy loading options]
*** link:{{navprefix}}/prefetch[Prefetch static resources]
** link:{{navprefix}}/external-tool-script-integration[External tools and scripts]
*** link:{{navprefix}}/pendo-integration[Pendo integration with embed]
** link:{{navprefix}}/VisualEmbedSdk[Visual Embed SDK Reference]
include::generated/typedoc/CustomSideNav.adoc[]
*** Custom styles
Expand All @@ -154,15 +152,17 @@ include::generated/typedoc/CustomSideNav.adoc[]
**** [.typedoc-Enumeration]#link:{{navprefix}}/Enumeration_PrefetchFeatures[PrefetchFeatures]#
**** [.typedoc-Function]#link:{{navprefix}}/Function_executeTML[executeTML]#
**** [.typedoc-Function]#link:{{navprefix}}/Function_exportTML[exportTML]#

** Other embedding methods
*** link:{{navprefix}}/embed-without-sdk[Embed without SDK]
*** link:{{navprefix}}/custom-viz-rest-api[Create a custom visualization]
** link:{{navprefix}}/sf-integration[Integration with Salesforce]
** link:{{navprefix}}/troubleshoot-errors[Troubleshoot errors]

* link:{{navprefix}}/rest-apis[REST API]
** link:{{navprefix}}/rest-apis[Overview]
** link:{{navprefix}}/api-user-management[Users and group privileges]
** link:{{navprefix}}/rbac[Role-based access control]
** link:{{navprefix}}/spotter-api[Spotter APIs ^BETA^]
** link:{{navprefix}}/audit-logs[Audit logs]
** link:{{navprefix}}/tml[TML]
** link:{{navprefix}}/connections[Connections]
Expand All @@ -171,7 +171,6 @@ include::generated/typedoc/CustomSideNav.adoc[]
*** link:{{navprefix}}/rest-apiv2-getstarted[Get started]
*** link:{{navprefix}}/api-authv2[REST API v2.0 authentication]
*** link:{{navprefix}}/rest-apiv2-js[REST API v2.0 in JavaScript]
*** link:{{navprefix}}/spotter-api[Spotter AI APIs ^BETA^]
*** link:{{navprefix}}/rest-apiv2-search[REST API v2.0 Search endpoints]
**** link:{{navprefix}}/rest-apiv2-users-search[Search users]
**** link:{{navprefix}}/rest-apiv2-groups-search[Search groups]
Expand Down Expand Up @@ -229,9 +228,13 @@ include::generated/typedoc/CustomSideNav.adoc[]
*** link:{{navprefix}}/multitenancy-within-an-org[Multi-tenancy within an Org]
*** link:{{navprefix}}/single-tenant-data-models[Single-tenant data models with Orgs]
*** link:{{navprefix}}/orgs-api-op[Org administration]
** link:{{navprefix}}/vercel-integration[Vercel integration]
** link:{{navprefix}}/tse-cluster[Cluster maintenance and upgrade]

* Integration with external tools
** link:{{navprefix}}/external-tool-script-integration[External tools and scripts]
** link:{{navprefix}}/pendo-integration[Pendo integration with embed]
** link:{{navprefix}}/mcp-integration[MCP server integration]
** link:{{navprefix}}/sf-integration[Integration with Salesforce]
** link:{{navprefix}}/vercel-integration[Vercel integration]
* Additional references
** link:{{navprefix}}/embed-ts[About ThoughtSpot embedding]
** link:{{navprefix}}/get-started-tse[Embed licenses]
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/custom-actions-callback.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Callback custom actions allow you to get data payloads from an embedded ThoughtS
* Users with developer or admin privileges can create a callback custom action in the Developer portal.
* Developers can set a callback action as a global or local action.
* To access callback actions, users must have the **New Answer Experience** enabled on their application instance.
* Users with edit permissions to a Worksheet or visualization can add a local callback action to a visualization or Answer of their choice.
* Users with edit permissions to a Model or visualization can add a local callback action to a visualization or Answer of their choice.
* Developers must register the callback in the Visual Embed SDK and define data classes and functions to parse and process the JSON data payload retrieved from the callback event.
--

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/custom-actions-edit.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
:page-pageid: edit-custom-action
:page-description: You can set a custom action as a primary button or as a menu action in the More options or the contextual menu.

ThoughtSpot lets you add custom actions globally to all your visualizations. When creating a custom action, developers can set the action as *Global* or *Local*. By default, the global custom actions are placed in the **More** menu image:./images/icon-more-10px.png[the more options menu]. The local custom actions are not placed anywhere in the UI until they are assigned to a Worksheet, Liveboard visualization, or saved Answer.
ThoughtSpot lets you add custom actions globally to all your visualizations. When creating a custom action, developers can set the action as *Global* or *Local*. By default, the global custom actions are placed in the **More** menu image:./images/icon-more-10px.png[the more options menu]. The local custom actions are not placed anywhere in the UI until they are assigned to a Model, Liveboard visualization, or saved Answer.

You can place a custom action as a primary button, in the **More** image:./images/icon-more-10px.png[the more options menu] menu, or the context menu that appears when a user right-clicks on an Answer or Liveboard visualization. For example, if you want to send only a single row of data instead of the entire data set obtained from a visualization, you can place the custom action in the contextual menu.

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/custom-actions-url.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ ThoughtSpot allows you to add a custom action to trigger a data payload to a spe
* Developers can limit custom action access to a specific user group.
* To access a URL action, users must have the **New Answer Experience** enabled.
* For URL actions to work in the embedded mode, you must add the URL domain to the CORS and CSP connect-src allowlist.
* Only ThoughtSpot users with edit permissions to a Worksheet or visualization can add a URL action to a Worksheet, visualization, or saved Answer.
* Only ThoughtSpot users with edit permissions to a Model or visualization can add a URL action to a Model, visualization, or saved Answer.
--

[#creUrlAction]
Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/custom-actions-viz.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
:page-pageid: add-action-viz
:page-description: Add custom actions

ThoughtSpot lets you add custom actions globally to all your visualizations or locally to a specific visualization or Worksheet. By default, the actions created in the Developer portal are set as *Global* actions. Developers or administrators can choose to set an action as **Local** and allow their application users to assign it to a visualization or saved Answer of their choice.
ThoughtSpot lets you add custom actions globally to all your visualizations or locally to a specific visualization or Model. By default, the actions created in the Developer portal are set as *Global* actions. Developers or administrators can choose to set an action as **Local** and allow their application users to assign it to a visualization or saved Answer of their choice.

If custom actions are enabled on your instance, the UI displays these actions in the *Custom actions* panel on a saved Answer or visualization page. By default, local custom actions are not assigned to any visualization. Any ThoughtSpot user with edit access to a visualization, saved Answer, or Worksheet can add a local action to the objects of their choice. For example, if you want to send data from a specific visualization to the pre-configured URL or web page, you can assign a URL action to that visualization.
If custom actions are enabled on your instance, the UI displays these actions in the *Custom actions* panel on a saved Answer or visualization page. By default, local custom actions are not assigned to any visualization. Any ThoughtSpot user with edit access to a visualization, saved Answer, or Model can add a local action to the objects of their choice. For example, if you want to send data from a specific visualization to the pre-configured URL or web page, you can assign a URL action to that visualization.

If you have access to a custom action, ThoughtSpot lets you perform the following tasks:

Expand Down Expand Up @@ -103,4 +103,4 @@ To delete a custom action association:
. Click the *Custom actions* icon image:./images/custom-action-icon.png[the Custom actions menu].
. In the **Custom actions **panel, click the delete icon next to that action that you want to remove.

For information about deleting a custom action assigned at the Worksheet level, see xref:custom-actions-worksheet.adoc[Add custom actions to a Worksheet].
For information about deleting a custom action assigned at the Model level, see xref:custom-actions-worksheet.adoc[Add custom actions to a Model].
36 changes: 18 additions & 18 deletions modules/ROOT/pages/custom-actions-worksheet.adoc
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
= Add custom actions to a Worksheet
= Add custom actions to a Model
:toc: true

:page-title: Actions customization
:page-pageid: add-action-worksheet
:page-description: Add custom actions to worksheets
:page-description: Add custom actions to Models

ThoughtSpot supports adding custom actions to the visualizations generated from a specific worksheet. The local custom actions created in the Developer portal appear on the worksheet page, so that you can assign these actions to the new visualizations built from that worksheet.
ThoughtSpot supports adding custom actions to the visualizations generated from a specific Model. The local custom actions created in the Developer portal appear on the Model page, so that you can assign these actions to the new visualizations built from that Model.

[NOTE]
====
When you assign a custom action to a worksheet, ThoughtSpot adds it to the Answers generated from that worksheet.
When you assign a custom action to a Model, ThoughtSpot adds it to the Answers generated from that Model.
====

== Before you begin

* Make sure the custom actions are set as *Local*.
* Make sure you have edit permissions to modify the worksheet.
* Make sure you have edit permissions to modify the Model.
* Make sure the link:https://docs.thoughtspot.com/cloud/latest/answer-experience-new[new Answer experience, window=_blank] is enabled on your cluster.

== Assign a custom action to a worksheet
== Assign a custom action to a Model

To add a custom action to a worksheet:
To add a custom action to a Model:

. Go to *Data* > *Data Objects* > *Worksheets*.
. Click the worksheet that you want to modify.
. Go to *Data* > *Data Objects* > *Models*.
. Click the Model that you want to modify.
. Click the *Custom actions* tab.
+
A list of custom actions available on your instance is displayed.

. Note that the page shows the global custom actions that appear on all visualizations by default. These actions will be available on all answers generated from the worksheet.
. Note that the page shows the global custom actions that appear on all visualizations by default. These actions will be available on all answers generated from the Model.

. To assign a local custom action to a worksheet:
. To assign a local custom action to a Model:
.. Click *Add action*.
.. Select the custom action that you want to add.
.. To specify the position of the action, select one of the following options:
Expand All @@ -40,9 +40,9 @@ Sets the custom action as a primary menu action.
+
[NOTE]
====
ThoughtSpot allows only one primary action on a visualization page. If visualizations generated from the worksheet already have a primary action, the new configuration overrides this setting.
ThoughtSpot allows only one primary action on a visualization page. If visualizations generated from the Model already have a primary action, the new configuration overrides this setting.

If a visualization built from this worksheet already has a primary action added locally at the visualization level, ThoughtSpot will retain this configuration and does not apply the primary action added at the worksheet level.
If a visualization built from this Model already has a primary action added locally at the visualization level, ThoughtSpot will retain this configuration and does not apply the primary action added at the Model level.
====

* *Menu*
Expand All @@ -58,12 +58,12 @@ Adds the custom action as a menu item in the contextual menu. If you want to sen

. Click *Save*.
+
The custom action will be added to all Answers generated from this worksheet.
The custom action will be added to all Answers generated from this Model.

== Verify the custom action placement

. To view the action you just added, click *Home*.
. Set your worksheet as the data source, specify search tokens, and click **Go**.
. Set your Model as the data source, specify search tokens, and click **Go**.
+
. Verify if the action is added to the visualization page.

Expand All @@ -72,9 +72,9 @@ The custom action will be added to all Answers generated from this worksheet.

== Edit the position of a local action

To edit the position of a local custom action associated with a worksheet:
To edit the position of a local custom action associated with a Model:

. Navigate to the worksheet page.
. Navigate to the Model page.
. Click *Custom actions*.
. Click on the action that you want to edit, and then click the edit icon.
. Modify the position and click **Save**.
Expand All @@ -83,6 +83,6 @@ To edit the position of a local custom action associated with a worksheet:

To delete a custom action association:

. Navigate to the worksheet page.
. Navigate to the Model page.
. Click *Custom actions*.
. Click on the action that you want to delete, and then click the delete icon.
2 changes: 1 addition & 1 deletion modules/ROOT/pages/custom-actions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ You must xref:customize-actions-menu.adoc[create custom actions] in the **Develo
After a custom action has been created, there are several options for assigning how and where the custom action will appear:

* xref:custom-actions-viz.adoc[Assign custom actions to an answer or a visualization on a Liveboard]
* xref:custom-actions-worksheet.adoc[Assign custom actions to a worksheet]
* xref:custom-actions-worksheet.adoc[Assign custom actions to a Model]
* xref:custom-actions-edit.adoc[Set the menu position of a custom action]

== Ways for embedding apps to receive custom actions
Expand Down
Loading
Loading