Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
69 commits
Select commit Hold shift + click to select a range
7a05344
doc change
ruchI9897 Apr 23, 2025
d2a96b7
Renamed ConversationEmbed
ruchI9897 Apr 24, 2025
c4632fc
spotter rename
ruchI9897 Apr 24, 2025
a235252
renamed bodyless conversation
ruchI9897 Apr 24, 2025
dacfc0a
rename in docs
ruchI9897 Apr 24, 2025
b779d08
dummy commit
ruchI9897 Apr 24, 2025
d19976f
dummy commit
ruchI9897 Apr 24, 2025
8a7be61
added note
ruchI9897 Apr 24, 2025
c8249a3
doc change
ruchI9897 Apr 24, 2025
423fa88
Removed note
ruchI9897 Apr 24, 2025
4b59756
removed note
ruchI9897 Apr 24, 2025
00059e3
dummy comment
ruchI9897 Apr 24, 2025
72df623
Renamed conversation view config
ruchI9897 Apr 24, 2025
524737d
doc bug fix
ruchI9897 Apr 24, 2025
096dbfa
version update
ShashiSubramanya Apr 25, 2025
614da5d
SCAL-252487 fix
ShashiSubramanya Apr 30, 2025
498a18f
flutter SDK updates
ShashiSubramanya May 6, 2025
dd3e1ee
swift sdk
ShashiSubramanya May 12, 2025
42532aa
swift sdk guide
ShashiSubramanya May 15, 2025
602273f
menu update
ShashiSubramanya May 15, 2025
0916047
text edits
ShashiSubramanya May 15, 2025
9acee3c
edits
ShashiSubramanya May 15, 2025
cc754b7
menu fix
ShashiSubramanya May 15, 2025
21deb7f
mobile embed sdk docs
ShashiSubramanya May 16, 2025
d24171a
Ignore snyk error
adityamittal3107 May 14, 2025
89b889d
nav update
ShashiSubramanya May 16, 2025
1eefa0c
mobile sdk updates
ShashiSubramanya May 16, 2025
a6e1898
edits
ShashiSubramanya May 19, 2025
a878fca
Merge branch '10.9.0.cl' into mobile-sdk-new
ShashiSubramanya May 26, 2025
7f973f7
Update typedocConverter.json
ShashiSubramanya May 27, 2025
ecce13d
Update gatsby-config.js
ShashiSubramanya May 27, 2025
e47dc50
Update index.ts
ShashiSubramanya May 27, 2025
bf24e8d
Update typedocConverter.json
ShashiSubramanya May 27, 2025
f296870
Merge pull request #304 from thoughtspot/SCAL-246794
ShashiSubramanya May 27, 2025
ff4d8fc
Merge pull request #305 from thoughtspot/renameSpotter
ShashiSubramanya May 27, 2025
40c6f87
spotter and what's new update
ShashiSubramanya May 26, 2025
3d6d510
10.9-docs
ShashiSubramanya May 27, 2025
5a0fced
version update
ShashiSubramanya May 27, 2025
7bb6a4c
edits for 10.9
ShashiSubramanya May 27, 2025
3222d20
version update
ShashiSubramanya May 27, 2025
58e9cab
edits
ShashiSubramanya May 27, 2025
fb40c9e
android qsg
ShashiSubramanya May 27, 2025
b2b4de0
csp allowlist note
ShashiSubramanya May 28, 2025
147d60b
edits
ShashiSubramanya May 28, 2025
4a783e7
link update
ShashiSubramanya May 28, 2025
bda1533
edits
ShashiSubramanya May 28, 2025
461f0f3
Merge pull request #308 from thoughtspot/mobile-sdk-new
ShashiSubramanya May 28, 2025
07fb34c
formatting edits
ShashiSubramanya May 28, 2025
efa0fb1
formatting fix
ShashiSubramanya May 28, 2025
1f5d899
link update
ShashiSubramanya May 28, 2025
6e95e81
edits
ShashiSubramanya May 28, 2025
d547930
typo fixes
ShashiSubramanya May 28, 2025
43cb131
home page link fixes
ShashiSubramanya May 29, 2025
d769104
SCAL-257109
ShashiSubramanya May 29, 2025
59d67b7
react comp update and string v2 customization fix
ShashiSubramanya May 30, 2025
d647832
android sdk comments
ShashiSubramanya May 30, 2025
e26aa5a
android sdk doc updates
ShashiSubramanya Jun 2, 2025
17b0c1c
edits
ShashiSubramanya Jun 2, 2025
02a9cd0
java sdk updates
ShashiSubramanya Jun 2, 2025
faaef8f
code block fix
ShashiSubramanya Jun 2, 2025
c4b6c68
beta flag
ShashiSubramanya Jun 3, 2025
884eea0
edits
ShashiSubramanya Jun 3, 2025
1465f9d
review comments
ShashiSubramanya Jun 3, 2025
d9d7a82
edits
ShashiSubramanya Jun 3, 2025
bffd9ea
typo fixes
ShashiSubramanya Jun 3, 2025
7223508
Merge pull request #313 from thoughtspot/java-rest-api-sdk-doc
ShashiSubramanya Jun 3, 2025
b62fb8f
typo fixes
ShashiSubramanya Jun 3, 2025
6c89ea2
typo fixes
ShashiSubramanya Jun 3, 2025
e7a40c0
typo fixes
ShashiSubramanya Jun 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
10 changes: 10 additions & 0 deletions .snyk
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
version: v1.25.1
# ignores vulnerabilities until expiry date; change duration by modifying expiry date
ignore:
'snyk:lic:npm:vercel:analytics:MPL-2.0':
- '*':
reason: 'MPL-2.0 license is acceptable for our use case'
expires: 2025-07-26T20:33:41.647Z
created: 2024-03-27T20:33:41.649Z
patch: {}
1 change: 0 additions & 1 deletion modules/ROOT/pages/abac-user-parameters.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@ You must turn off indexing for any field that needs to be restricted by RLS when
ABAC rules are not supported on Liveboards with AI Highlights and Change Analysis features, and on the Answers generated from Spotter.
====


Mandatory token filters::
When setting filter rules within the token, you must place the `is_mandatory_token_filter: true` property on every column in a Worksheet or Model where a filter rule is expected. This will deny any access to data if a user has not been assigned values for the expected set of fields.

Expand Down
49 changes: 47 additions & 2 deletions modules/ROOT/pages/api-changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,51 @@

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.38.0, June 2025

[width="100%" cols="1,4"]
|====
|[tag greenBackground]#NEW FEATURE# a| *String IDs for text customization* +
Developers can now customize a specific occurrence of a visible text string in the ThoughtSpot UI using the `stringIDs` object in the customization interface.

To locate the string IDs, SDK provides the `exposeTranslationIds` attribute. By setting `exposeTranslationIds` to `true` in the Playground, you can find the string ID of the UI text and use it in your customization code.

Additionally, the SDK provides the `StringIDsUrl` attribute to allow using a JSON file with string IDs and custom strings to override the visible text in the UI.

For more information, see xref:customize-text-strings.adoc[Customize text strings].

|[tag greenBackground]#NEW FEATURE# a| *Hide columns on list pages* +

In full app embedding, you can now hide the following columns on the *Liveboards* and *Answers* listing pages using the `hiddenListColumns` array:

* *Author* +
`hiddenListColumns: [ListPageColumns.Author]`
* *Favorite* +
`hiddenListColumns: [ListPageColumns.Favourite]`
* *Last modified* +
`hiddenListColumns: [ListPageColumns.DateSort]`
* *Tags* +
`hiddenListColumns: [ListPageColumns.Tags]`
* *Share* +
`hiddenListColumns: [ListPageColumns.Share]` +

For more information, see xref:full-app-customize.adoc#_hide_columns_on_list_pages_new_experience[Customize full application embed].

|[tag greenBackground]#NEW FEATURE# a| *Spotter embed components with new names* +
The following Spotter embed components are now deprecated and replaced with new components:

* `ConversationEmbed` +
Replaced with `SpotterEmbed`
* `ConversationViewConfig` +
Replaced with `SpotterEmbedViewConfig`
* `BodylessConversation` +
Replaced with `SpotterAgentEmbed`
* `BodylessConversationViewConfig` +
Replaced with `SpotterAgentEmbedViewConfig`

The deprecated components with old names in the existing Spotter embed implementations will continue to function until further notice.
For more information, see xref:whats-new.adoc#_spotter_embed_components[What's new] and xref:embed-spotter.adoc[Spotter embed documentation].
|====

== Version 1.37.0, April 2025

Expand Down Expand Up @@ -138,9 +183,9 @@ For more information, see xref:full-app-customize.adoc#_search_components[Search
|====
|[tag greenBackground]#NEW FEATURE# a| You can now embed the following ThoughtSpot Spotter components in your app:

* `ConversationEmbed` +
* `SpotterEmbed` +
Embeds Spotter conversation interface in your app
* `BodylessConversation` +
* `SpotterAgentEmbed` +
Creates a conversation component without the body, which can be integrated into chatbots or other conversational apps.

For more information, see xref:embed-spotter.adoc[Embed Spotter] and xref:spotter-in-custom-chatbot.adoc[Integrate Spotter into your chatbot].
Expand Down
28 changes: 15 additions & 13 deletions modules/ROOT/pages/common/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -73,16 +73,20 @@
**** link:{{navprefix}}/search-embed[Embed Search]
**** link:{{navprefix}}/embed-searchbar[Embed search bar]
*** link:{{navprefix}}/react-app-embed[Embed with React components]
** Embed ThoughtSpot in a mobile app
*** link:{{navprefix}}/embed-ts-mobile-react-native[Embed using React Native SDK ^Beta^]
** link:{{navprefix}}/mobile-embed[Embed ThoughtSpot in a mobile app]
*** link:{{navprefix}}/embed-ts-mobile-react-native[React Native SDK ^Beta^]
*** link:{{navprefix}}/embed-ts-flutter[Flutter embed SDK ^Beta^]
*** link:{{navprefix}}/embed-ts-swift[Swift Embed SDK ^Beta^]
*** link:{{navprefix}}/embed-ts-android[Android Embed SDK ^Beta^]

** Customize and integrate
*** link:{{navprefix}}/style-customization[Customize UX and styles]
**** link:{{navprefix}}/customize-style[Customize basic styles]
**** link:{{navprefix}}/custom-css[CSS customization framework]
***** 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 ^Beta^]

*** link:{{navprefix}}/filters-overview[Filters overview]
**** link:{{navprefix}}/runtime-overrides[Runtime overrides]
Expand All @@ -91,23 +95,20 @@

*** link:{{navprefix}}/action-config[Customize menus]
**** link:{{navprefix}}/actions[Action IDs in the SDK]

*** Events and custom actions
**** link:{{navprefix}}/events-app-integration[Events and app interactions]
**** link:{{navprefix}}/custom-action-intro[Custom actions]
***** link:{{navprefix}}/customize-actions[Create and manage custom actions]
***** link:{{navprefix}}/edit-custom-action[Set the position of a custom action]
***** link:{{navprefix}}/add-action-viz[Add a local action to a visualization]
***** link:{{navprefix}}/add-action-worksheet[Add a local action to a worksheet]
*** link:{{navprefix}}/events-app-integration[Events and app interactions]
*** link:{{navprefix}}/custom-action-intro[Custom actions]
**** link:{{navprefix}}/customize-actions[Create and manage custom actions]
***** link:{{navprefix}}/custom-action-url[URL actions]
***** link:{{navprefix}}/custom-action-callback[Callback actions]
***** link:{{navprefix}}/custom-action-payload[Callback response payload]

*** link:{{navprefix}}/in-app-navigation[Create dynamic menus and navigation]
**** link:{{navprefix}}/edit-custom-action[Set the position of a custom action]
**** link:{{navprefix}}/add-action-viz[Add a local action to a visualization]
**** link:{{navprefix}}/add-action-worksheet[Add a local action to a worksheet]
*** link:{{navprefix}}/customize-links[Customize links]
*** link:{{navprefix}}/set-locale[Customize locale]
*** link:{{navprefix}}/custom-domain-config[Custom domain configuration]
*** link:{{navprefix}}/customize-emails[Customize onboarding settings]
*** link:{{navprefix}}/in-app-navigation[Create dynamic menus and navigation]
** link:{{navprefix}}/VisualEmbedSdk[Visual Embed SDK Reference]
include::generated/typedoc/CustomSideNav.adoc[]
*** Custom styles
Expand Down Expand Up @@ -175,6 +176,7 @@ include::generated/typedoc/CustomSideNav.adoc[]
*** link:{{navprefix}}/fetch-data-and-report-apis[Data and Report APIs]
*** link:{{navprefix}}/rest-api-sdk[REST API v2.0 SDKs]
**** link:{{navprefix}}/rest-api-sdk-typescript[TypeScript SDK]
**** link:{{navprefix}}/rest-api-sdk-java[Java SDK]

** link:{{navprefix}}/rest-apiv2-reference[REST API v2.0 Reference]
** link:{{navprefix}}/rest-api-getstarted[REST API v1]
Expand Down
7 changes: 3 additions & 4 deletions modules/ROOT/pages/custom-actions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@

ThoughtSpot provides a set of standard menu commands and buttons, controlled via xref:embed-actions.adoc[actions].

Custom actions add a new menu item to one of the following UI elements:
Custom actions add a new menu item to one of the following UI elements in an Answer or Liveboard visualization:

* the primary menu bar
* the **More** menu image:./images/icon-more-10px.png[the more options menu]
* the **More** options menu image:./images/icon-more-10px.png[the more options menu]
* the contextual menu that appears when a user right-clicks on an Answer or visualization +
+

[NOTE]
====
The link:https://developers.thoughtspot.com/docs/Enumeration_EmbedEvent#_vizpointclick[VizPointClick HostEvent] behaves in the same way as a context menu custom action, but fires immediately on a click rather than from the right-click context menu.
Expand All @@ -36,4 +36,3 @@ After a custom action has been created, there are several options for assigning
Pass data and metadata from ThoughtSpot to the embedding page as an event.
* xref:custom-actions-url.adoc[URL actions] +
POST data directly to a specific web page or API endpoint destination.

47 changes: 19 additions & 28 deletions modules/ROOT/pages/customize-actions-menu.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,30 +24,22 @@ The custom actions feature in ThoughtSpot allows users to push data to external

To view the *Custom actions* page, go to *Develop* > *Customizations* > *Custom actions*.

The *Custom actions* page displays the **Create action** button, and the *Overview* and *Actions* tabs.
The following options are available on *Custom actions* page:

* *Overview* tab +
The default view which shows the possible locations for custom actions placement in the ThoughtSpot UI.
* *Actions* tab +
Lists the custom actions and allows you to edit and delete a custom action.
* **Create action** button to add a custom action. +
Developers can create a xref:custom-actions-url.adoc[URL action] to send data from an Answer or visualization to a target URL, or a xref:custom-actions-callback.adoc[callback action] to trigger a callback event to the parent application and then pushes the Answer or visualization data in a response payload.

=== Create action

The *Create action* button allows you to create the following types of actions:

////
App actions::
An xref:app-actions.adoc[app action] connects a ThoughtSpot instance to an external app and pushes data to a user's business workspace; for example, Slack.
////

Callback actions::
A xref:custom-actions-callback.adoc[callback action] triggers a callback event to the parent application and then pushes the Answer or visualization data in a response payload.

URL actions::
A xref:custom-actions-url.adoc[URL action] sends data from an Answer or visualization to a specific URL in a `POST` request.
=== Global and local actions

Developers or administrators can set a custom action as a global or local action.

Global actions::

By default, a global action appears as a menu action in the **More** image:./images/icon-more-10px.png[the more options menu]menu on all visualizations.

+
Authorized users can edit the position of a global action on a visualization or saved Answer by using the edit icon in the *Custom actions* panel.

Expand All @@ -61,21 +53,20 @@ Any user with edit access to a visualization or worksheet can assign a local act
User access control::
For granular access control, developers can restrict a custom action's availability to a specific group. The **Show advanced availability** setting in the custom action creation page allows you to associate a custom action to one or several groups.

[NOTE]
====
In embedded ThoughtSpot instances, developers can also use the `visibleActions`, `hiddenActions`, and `disabledActions` properties to xref:embed-actions.adoc[show, hide, and disable a custom action].
====

=== Custom action placement in the UI

A custom action can be set as a primary button or as a menu item in the **More** image:./images/icon-more-10px.png[the more options menu] menu or the contextual menu on an Answer or visualization.

=== Overview
By default, the custom actions are added as menu items in the **More** options menu, unless they are explicitly set as *Primary* or *Context Menu* actions. If you want to send only a single row of data instead of the entire data set obtained from a visualization in a custom action payload, you can place the custom action in the contextual menu.

The *Overview* tab shows the possible locations for placing a custom action in the ThoughtSpot UI. You can add a custom action in the primary menu bar, or as a menu action in the **More** image:./images/icon-more-10px.png[the more options menu] menu or the contextual menu that appears when a user right-clicks on an Answer or Liveboard visualization.
[NOTE]
====
You can only assign one custom action as a primary button on a visualization or Answer.

By default, ThoughtSpot adds all custom actions to the **More** image:./images/icon-more-10px.png[the more options menu] menu. 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. To change the position of an existing custom action, click the custom action icon image:./images/custom-action-icon.png[custom action icon] on a saved Answer page, and then click the edit icon next to the custom action in the *Custom action* panel.
// Outside of the custom actions framework, the SDK provides the `primaryAction` parameter, which allows setting a specific menu action from the system-defined actions list as a primary button on Liveboard visualizations. If a `primaryAction` is already assigned to a visualization, consider whether it is necessary to add your custom action as a primary button and how it might affect user experience.
====

=== Actions
=== Disable or hide a custom action

The *Actions* tab lists the actions created on your ThoughtSpot instance.
To disable, show or hide a custom action, specify the custom action ID in the `disabledActions`, `visibleActions` or `hiddenActions` array. For more information, see xref:embed-actions.adoc[show, hide, and disable a custom action].

* To edit an action, go to **More** image:./images/icon-more-10px.png[the more options menu] menu > **Edit**.
* To delete an action, click **More** image:./images/icon-more-10px.png[the more options menu] menu > **Delete**.
Loading
Loading