Skip to content
Closed
2 changes: 1 addition & 1 deletion modules/ROOT/pages/api-changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The following enumerations are available for code based custom actions:
To define the target object for the custom action, such as on a Liveboard, visualization, Answer, or in Spotter.
* `CustomActionsPosition` +
To define the position of the custom action in the target object, such as primary menu, **More** options menu image:./images/icon-more-10px.png[the more options menu], or the contextual menu.
|[tag greenBackground]#NEW FEATURE# | *Attribute to set Parameter chip visibility during overrides*
|[tag greenBackground]#NEW FEATURE# | *Attribute to set Parameter chip visibility during overrides* +
The `HostEvent.UpdateParameters` event now supports configuring the `isVisibleToUser` attribute to show or hide the Parameter chips after an override. For more information, see xref:runtime-parameters.adoc#_show_or_hide_parameter_chips_in_embedded_sessions[Show or hide Parameter chips in embedded sessions].
|====

Expand Down
29 changes: 28 additions & 1 deletion modules/ROOT/pages/code-based-custom-actions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,9 @@ Custom Actions can be embedded through the Visual Embed SDK in the following two

=== Code based custom action for Liveboards

[NOTE]
Code based custom action for Liveboards do not return data for visualizations in their callback. To get data from a Liveboard object and its visualizations use the `POST /api/rest/2.0/metadata/liveboard/data` API endpoint.

The custom action is applied to all Liveboards.

[source,javascript]
Expand Down Expand Up @@ -206,6 +209,8 @@ const customActions = [{
}, ];
----


////
When the answerId parameter is provided, the system displays custom actions only on the visualization(s) that use the specified underlying answerId.

In this example, consider a Liveboard (lb1) with three visualizations: viz1 (based on ans1), viz2 (based on ans2), and viz3 (based on ans3).
Expand All @@ -229,6 +234,8 @@ const customActions = [{
}, ];

----
////


When `modelIds` is passed in the `dataModelIds`, then the custom action is show for all visualization which are using the columns of the specified model.

Expand Down Expand Up @@ -432,6 +439,9 @@ In this example, for a user who is part of org1 and grp1,

* The custom action will also be shown in any Liveboard where these answers have been pinned.

[NOTE]
`modelColumnNames` are not currently supported for code based custom action for Spotter.

[source,javascript]
----
const customActions = [{
Expand All @@ -445,4 +455,21 @@ const customActions = [{
groupId: ['grp1'],
orgId: ['org1']
}, ];
----
----


=== Add callback to a code based custom action

To add an event handler to listen to the callback event and trigger a data payload as a response when a user clicks on the code based custom action, use the Visual Embed SDK's .on method with EmbedEvent.CustomAction.

[source,javascript]
----
embed.on(EmbedEvent.CustomAction, (payload) => {
if (payload.data.id === 'your-custom-action-id') {
// Your callback logic
console.log("Custom Action event:", payload.data);
}
});
----

Ensure you have created the custom action and noted its id. In your callback, verify the action id in the payload.
5 changes: 3 additions & 2 deletions modules/ROOT/pages/common/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
** link:{{navprefix}}/restV2-playground?apiResourceId=http%2Fgetting-started%2Fintroduction[REST API v2 Playground]
** link:{{navprefix}}/graphql-play-ground[GraphQL Playground]
** +++<a href="{{previewPrefix}}/api/rest/playgroundV1" target="_blank">REST API v1 Playground</a>+++
** link:{{navprefix}}/theme-builder[Theme Builder ^Beta^]
** link:{{navprefix}}/theme-builder[Theme Builder]
** link:{{navprefix}}/spotdev-portal[How to use]
*** link:{{navprefix}}/dev-playground[Visual Embed Playground]
*** link:{{navprefix}}/graphql-playground[GraphQL Playground]
Expand Down Expand Up @@ -86,7 +86,7 @@
***** link:{{navprefix}}/css-variables-reference[CSS variables reference]
***** link:{{navprefix}}/customize-icons[Customize icons]
***** link:{{navprefix}}/customize-text[Customize text strings]
***** link:{{navprefix}}/theme-builder-doc[Theme builder ^Beta^]
***** link:{{navprefix}}/theme-builder-doc[Theme builder]

*** link:{{navprefix}}/filters-overview[Filters overview]
**** link:{{navprefix}}/runtime-overrides[Runtime overrides]
Expand Down Expand Up @@ -256,3 +256,4 @@ include::generated/typedoc/CustomSideNav.adoc[]
** link:https://docs.thoughtspot.com[Product Documentation, window=_blank]
** link:{{navprefix}}/rest-apiv2-beta-reference[REST API v2 ^Beta^ Reference (Deprecated)]


6 changes: 3 additions & 3 deletions modules/ROOT/pages/mcp-integration.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

ThoughtSpot’s Agentic Model Context Protocol (MCP) Server allows you to integrate ThoughtSpot analytics directly into any AI agent, custom chatbot, or LLM-based platforms that support MCP. It acts as a connector between the ThoughtSpot instance and external AI client, and provides a set of tools for interacting with ThoughtSpot’s data and its analytics capabilities programmatically.

The ThoughtSpot MCP Server is an add-on feature available with the link:https://www.thoughtspot.com/pricing[ThoughtSpot Analytics and ThoughtSpot Embedded offerings, window=_blank]. +
The ThoughtSpot MCP Server is an add-on feature available with the link:https://www.thoughtspot.com/pricing[ThoughtSpot Analytics and ThoughtSpot Embedded offerings, window=_blank]. +
To purchase the MCP Server subscription and enable the MCP Server in your environment, you must have an active subscription to one of the following ThoughtSpot license plans:

* Enterprise Edition of ThoughtSpot Analytics
Expand Down Expand Up @@ -60,10 +60,10 @@ Integration requires configuration, typically via a config file, to specify serv

Authentication and security settings::

* Access to ThoughtSpot instance: +

* Access to ThoughtSpot instance +
For MCP Server connection, users require access to a ThoughtSpot instance. For tool invocation, the MCP server must accept authenticated requests, and the LLM tool specification must carry those credentials or headers. +
ThoughtSpot administrators can use the SSO framework with SAML or OAuth token-based authentication methods to authenticate and sign in users. +

* SAML redirect settings: +
For SAML SSO users, the SAML redirect domain configuration is required to ensure that users are redirected to an allowed and trusted domain after they are authenticated. +
* To get answers to their data queries, your application users require at least view access to ThoughtSpot data sources. To generate an Answer or to create a Liveboard, users require the data download privilege.
Expand Down
17 changes: 9 additions & 8 deletions modules/ROOT/pages/publishing-overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,22 +52,23 @@ You can create the following types of variables using the xref:variables.adoc[va
[options='header']
|=====
|Variable type| Description
|`TABLE_MAPPING`| The **TABLE_MAPPING** variable allow parameterizing the following Table properties:
|`TABLE_MAPPING` a| The **TABLE_MAPPING** variable allow parameterizing the following Table properties:

* `databaseName` +
* `schemaName` +
* `tableName` +

** `databaseName`
** `schemaName`
** `tableName`
|`CONNECTION_PROPERTY` a|

The `CONNECTION_PROPERTY` variables allow parameterizing connection properties. For example, `accountName`, `warehouse`, `user`, `password`, `role` and so on.
| `CONNECTION_PROPERTY_PER_PRINCIPLE` a|

[NOTE]
This feature is disabled by default. To enable this option, contact ThoughtSpot Support.

This variable supports modifying connection properties per principal (user or user group). This means you can set different values for connection properties depending on the user or group accessing the connection. For example, `warehouse`, `role`, `user`, `password`.

The `CONNECTION_PROPERTY_PER_PRINCIPLE` variable does not allow parameterizing core connection properties such as `accountName`, `host`, or `port`. These properties must be derived from the connection configuration and cannot be set per user or user group. +
The `CONNECTION_PROPERTY_PER_PRINCIPLE` variable does not allow parameterizing core connection properties such as `accountName`, `host`, or `port`. These properties must be derived from the connection configuration and cannot be set per user or user group.

[NOTE]
This feature is disabled by default. To enable this option, contact ThoughtSpot Support.
||

//`FORMULA_VARIABLE` a| `FORMULA_VARIABLE` refers can be used to create and manage formula variables.
Expand Down
Loading
Loading