Skip to content

Commit 650aea6

Browse files
Merge pull request #311 from thoughtspot/10.9.0.cl
10.9.0.cl docs
2 parents d76b99d + e7a40c0 commit 650aea6

34 files changed

Lines changed: 2845 additions & 378 deletions

modules/ROOT/pages/abac-user-parameters.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ You must turn off indexing for any field that needs to be restricted by RLS when
3636
ABAC rules are not supported on Liveboards with AI Highlights and Change Analysis features, and on the Answers generated from Spotter.
3737
====
3838

39-
4039
Mandatory token filters::
4140
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.
4241

modules/ROOT/pages/api-changelog.adoc

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,51 @@
88

99
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].
1010

11+
== Version 1.38.0, June 2025
12+
13+
[width="100%" cols="1,4"]
14+
|====
15+
|[tag greenBackground]#NEW FEATURE# a| *String IDs for text customization* +
16+
Developers can now customize a specific occurrence of a visible text string in the ThoughtSpot UI using the `stringIDs` object in the customization interface.
17+
18+
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.
19+
20+
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.
21+
22+
For more information, see xref:customize-text-strings.adoc[Customize text strings].
23+
24+
|[tag greenBackground]#NEW FEATURE# a| *Hide columns on list pages* +
25+
26+
In full app embedding, you can now hide the following columns on the *Liveboards* and *Answers* listing pages using the `hiddenListColumns` array:
27+
28+
* *Author* +
29+
`hiddenListColumns: [ListPageColumns.Author]`
30+
* *Favorite* +
31+
`hiddenListColumns: [ListPageColumns.Favourite]`
32+
* *Last modified* +
33+
`hiddenListColumns: [ListPageColumns.DateSort]`
34+
* *Tags* +
35+
`hiddenListColumns: [ListPageColumns.Tags]`
36+
* *Share* +
37+
`hiddenListColumns: [ListPageColumns.Share]` +
38+
39+
For more information, see xref:full-app-customize.adoc#_hide_columns_on_list_pages_new_experience[Customize full application embed].
40+
41+
|[tag greenBackground]#NEW FEATURE# a| *Spotter embed components with new names* +
42+
The following Spotter embed components are now deprecated and replaced with new components:
43+
44+
* `ConversationEmbed` +
45+
Replaced with `SpotterEmbed`
46+
* `ConversationViewConfig` +
47+
Replaced with `SpotterEmbedViewConfig`
48+
* `BodylessConversation` +
49+
Replaced with `SpotterAgentEmbed`
50+
* `BodylessConversationViewConfig` +
51+
Replaced with `SpotterAgentEmbedViewConfig`
52+
53+
The deprecated components with old names in the existing Spotter embed implementations will continue to function until further notice.
54+
For more information, see xref:whats-new.adoc#_spotter_embed_components[What's new] and xref:embed-spotter.adoc[Spotter embed documentation].
55+
|====
1156

1257
== Version 1.37.0, April 2025
1358

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

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

146191
For more information, see xref:embed-spotter.adoc[Embed Spotter] and xref:spotter-in-custom-chatbot.adoc[Integrate Spotter into your chatbot].

modules/ROOT/pages/common/nav.adoc

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -73,16 +73,20 @@
7373
**** link:{{navprefix}}/search-embed[Embed Search]
7474
**** link:{{navprefix}}/embed-searchbar[Embed search bar]
7575
*** link:{{navprefix}}/react-app-embed[Embed with React components]
76-
** Embed ThoughtSpot in a mobile app
77-
*** link:{{navprefix}}/embed-ts-mobile-react-native[Embed using React Native SDK ^Beta^]
76+
** link:{{navprefix}}/mobile-embed[Embed ThoughtSpot in a mobile app]
77+
*** link:{{navprefix}}/embed-ts-mobile-react-native[React Native SDK ^Beta^]
78+
*** link:{{navprefix}}/embed-ts-flutter[Flutter embed SDK ^Beta^]
79+
*** link:{{navprefix}}/embed-ts-swift[Swift Embed SDK ^Beta^]
80+
*** link:{{navprefix}}/embed-ts-android[Android Embed SDK ^Beta^]
81+
7882
** Customize and integrate
7983
*** link:{{navprefix}}/style-customization[Customize UX and styles]
8084
**** link:{{navprefix}}/customize-style[Customize basic styles]
8185
**** link:{{navprefix}}/custom-css[CSS customization framework]
8286
***** link:{{navprefix}}/css-variables-reference[CSS variables reference]
8387
***** link:{{navprefix}}/customize-icons[Customize icons]
8488
***** link:{{navprefix}}/customize-text[Customize text strings]
85-
**** link:{{navprefix}}/theme-builder-doc[Theme builder ^Beta^]
89+
***** link:{{navprefix}}/theme-builder-doc[Theme builder ^Beta^]
8690
8791
*** link:{{navprefix}}/filters-overview[Filters overview]
8892
**** link:{{navprefix}}/runtime-overrides[Runtime overrides]
@@ -91,23 +95,20 @@
9195

9296
*** link:{{navprefix}}/action-config[Customize menus]
9397
**** link:{{navprefix}}/actions[Action IDs in the SDK]
94-
95-
*** Events and custom actions
96-
**** link:{{navprefix}}/events-app-integration[Events and app interactions]
97-
**** link:{{navprefix}}/custom-action-intro[Custom actions]
98-
***** link:{{navprefix}}/customize-actions[Create and manage custom actions]
99-
***** link:{{navprefix}}/edit-custom-action[Set the position of a custom action]
100-
***** link:{{navprefix}}/add-action-viz[Add a local action to a visualization]
101-
***** link:{{navprefix}}/add-action-worksheet[Add a local action to a worksheet]
98+
*** link:{{navprefix}}/events-app-integration[Events and app interactions]
99+
*** link:{{navprefix}}/custom-action-intro[Custom actions]
100+
**** link:{{navprefix}}/customize-actions[Create and manage custom actions]
102101
***** link:{{navprefix}}/custom-action-url[URL actions]
103102
***** link:{{navprefix}}/custom-action-callback[Callback actions]
104103
***** link:{{navprefix}}/custom-action-payload[Callback response payload]
105-
106-
*** link:{{navprefix}}/in-app-navigation[Create dynamic menus and navigation]
104+
**** link:{{navprefix}}/edit-custom-action[Set the position of a custom action]
105+
**** link:{{navprefix}}/add-action-viz[Add a local action to a visualization]
106+
**** link:{{navprefix}}/add-action-worksheet[Add a local action to a worksheet]
107107
*** link:{{navprefix}}/customize-links[Customize links]
108108
*** link:{{navprefix}}/set-locale[Customize locale]
109109
*** link:{{navprefix}}/custom-domain-config[Custom domain configuration]
110110
*** link:{{navprefix}}/customize-emails[Customize onboarding settings]
111+
*** link:{{navprefix}}/in-app-navigation[Create dynamic menus and navigation]
111112
** link:{{navprefix}}/VisualEmbedSdk[Visual Embed SDK Reference]
112113
include::generated/typedoc/CustomSideNav.adoc[]
113114
*** Custom styles
@@ -175,6 +176,7 @@ include::generated/typedoc/CustomSideNav.adoc[]
175176
*** link:{{navprefix}}/fetch-data-and-report-apis[Data and Report APIs]
176177
*** link:{{navprefix}}/rest-api-sdk[REST API v2.0 SDKs]
177178
**** link:{{navprefix}}/rest-api-sdk-typescript[TypeScript SDK]
179+
**** link:{{navprefix}}/rest-api-sdk-java[Java SDK]
178180

179181
** link:{{navprefix}}/rest-apiv2-reference[REST API v2.0 Reference]
180182
** link:{{navprefix}}/rest-api-getstarted[REST API v1]

modules/ROOT/pages/custom-actions.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@
66

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

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

1111
* the primary menu bar
12-
* the **More** menu image:./images/icon-more-10px.png[the more options menu]
12+
* the **More** options menu image:./images/icon-more-10px.png[the more options menu]
1313
* the contextual menu that appears when a user right-clicks on an Answer or visualization +
14-
+
14+
1515
[NOTE]
1616
====
1717
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.
@@ -36,4 +36,3 @@ After a custom action has been created, there are several options for assigning
3636
Pass data and metadata from ThoughtSpot to the embedding page as an event.
3737
* xref:custom-actions-url.adoc[URL actions] +
3838
POST data directly to a specific web page or API endpoint destination.
39-

modules/ROOT/pages/customize-actions-menu.adoc

Lines changed: 19 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -24,30 +24,22 @@ The custom actions feature in ThoughtSpot allows users to push data to external
2424

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

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

29+
* *Overview* tab +
30+
The default view which shows the possible locations for custom actions placement in the ThoughtSpot UI.
31+
* *Actions* tab +
32+
Lists the custom actions and allows you to edit and delete a custom action.
33+
* **Create action** button to add a custom action. +
34+
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.
2935

30-
=== Create action
31-
32-
The *Create action* button allows you to create the following types of actions:
33-
34-
////
35-
App actions::
36-
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.
37-
////
38-
39-
Callback actions::
40-
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.
41-
42-
URL actions::
43-
A xref:custom-actions-url.adoc[URL action] sends data from an Answer or visualization to a specific URL in a `POST` request.
36+
=== Global and local actions
4437

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

4740
Global actions::
4841

4942
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.
50-
5143
+
5244
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.
5345

@@ -61,21 +53,20 @@ Any user with edit access to a visualization or worksheet can assign a local act
6153
User access control::
6254
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.
6355

64-
[NOTE]
65-
====
66-
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].
67-
====
68-
56+
=== Custom action placement in the UI
57+
58+
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.
6959

70-
=== Overview
60+
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.
7161

72-
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.
62+
[NOTE]
63+
====
64+
You can only assign one custom action as a primary button on a visualization or Answer.
7365
74-
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.
66+
// 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.
67+
====
7568

76-
=== Actions
69+
=== Disable or hide a custom action
7770

78-
The *Actions* tab lists the actions created on your ThoughtSpot instance.
71+
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].
7972

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

0 commit comments

Comments
 (0)