From 4845efddbf875885da868ece3ed096af886b8e13 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Sat, 17 Oct 2026 10:44:33 +0530 Subject: [PATCH 1/5] SCAL-343924 --- modules/ROOT/pages/api-changelog.adoc | 11 +++ .../ROOT/pages/customize-spotter-sidebar.adoc | 83 +++++++++++++++++++ 2 files changed, 94 insertions(+) diff --git a/modules/ROOT/pages/api-changelog.adoc b/modules/ROOT/pages/api-changelog.adoc index 3435deff8..08d32656a 100644 --- a/modules/ROOT/pages/api-changelog.adoc +++ b/modules/ROOT/pages/api-changelog.adoc @@ -30,6 +30,17 @@ You can now let users pin conversations in the chat history sidebar. Use the `sp `starterPrompts`:: You can now customize the starter prompt pills in the embedded Spotter interface by using the `starterPrompts` object in `spotterChatConfig`. The object supports the `enable`, `quick`, `research`, `previewData`, and `liveboard` keys. To show or hide individual pills, use `Action.QuickSearchPill`, `Action.DeepAnalysisPill`, and `Action.DataLiteracyPill`. For more information, see xref:embed-spotter-analyst.adoc#_customizing_starter_prompt_pills[Customizing starter prompt pills]. +|[tag greenBackground]#NEW# +a| +[discrete] +===== Spotter sidebar controls + +`enableConnectorMarketplace`:: +Use this setting to show or hide the Connector Marketplace page link in the Spotter sidebar footer. For more information, see xref:customize-spotter-sidebar.adoc#connector-marketplace[Connector Marketplace and Spotter settings controls]. + +`enableSpotterInstructionAndMoreSettings`:: +Use this setting to show or hide the Spotter instructions and more settings options in the Spotter sidebar settings menu. For more information, see xref:customize-spotter-sidebar.adoc#spotter-instructions-settings[Spotter instructions and settings menu]. + |[tag greenBackground]#NEW# a| [discrete] diff --git a/modules/ROOT/pages/customize-spotter-sidebar.adoc b/modules/ROOT/pages/customize-spotter-sidebar.adoc index 63680f829..b1f9f1bb6 100644 --- a/modules/ROOT/pages/customize-spotter-sidebar.adoc +++ b/modules/ROOT/pages/customize-spotter-sidebar.adoc @@ -39,6 +39,20 @@ For more information, see xref:customize-spotter-analysts.adoc[Customizing Spott [tag greenBackground tick]#✓# Spotter 3 + [tag greenBackground tick]#✓# Spotter 2 + [tag greenBackground tick]#✓# Spotter Classic + +|Connector Marketplace link + +|Shows the link to the Connector Marketplace page in the Spotter sidebar footer. When this option is not set in the embed configuration, the cluster-level setting applies. +| +[tag greenBackground tick]#✓# Spotter 3 + +[tag redBackground tick]#x# Spotter 2 + +[tag redBackground tick]#x# Spotter Classic + +|Spotter instructions and settings + +|Shows Spotter instructions and more settings options in the Spotter sidebar settings menu. This option is disabled by default in the embedded view. To show it, set `enableSpotterInstructionAndMoreSettings` to `true` in the `spotterSidebarConfig` object. For more information, see <<_spotter_instructions_and_settings_menu,Spotter instructions and settings menu>>. +| +[tag greenBackground tick]#✓# Spotter 3 + +[tag redBackground tick]#x# Spotter 2 + +[tag redBackground tick]#x# Spotter Classic |==== == Chat history panel @@ -191,6 +205,75 @@ const embed = new SpotterEmbed('#tsEmbed', { }) ---- + +[#connector-marketplace] +== Connector Marketplace and Spotter settings controls +You can control the visibility of the Connector Marketplace link and the Spotter instructions option in the sidebar using the following properties in the `spotterSidebarConfig` object. + +=== Connector Marketplace link +To show or hide the Connector Marketplace page link in the Spotter sidebar footer, set the xref:SpotterSidebarViewConfig.adoc#_enableconnectormarketplace[`enableConnectorMarketplace`] property in the `spotterSidebarConfig` object. + +[width="100%", cols="2,5"] +|==== +|Property |Description + +|`enableConnectorMarketplace` +a|__Boolean__. Controls the visibility of the Connector Marketplace page link in the Spotter sidebar footer. + +* `true` - the Connector Marketplace link is shown. +* `false` - the Connector Marketplace link is hidden. +* `undefined` (default) - the cluster-level setting applies. +|==== + +[#spotter-instructions-settings] +=== Spotter instructions and settings menu +To show or hide the Spotter instructions and more settings options in the Spotter sidebar settings menu, set the xref:SpotterSidebarViewConfig.adoc#_enablespotterinstructionandmoresettings[`enableSpotterInstructionAndMoreSettings`] property in the `spotterSidebarConfig` object. + +[width="100%", cols="2,5"] +|==== +|Property |Description + +|`enableSpotterInstructionAndMoreSettings` +a|__Boolean__. Controls the visibility of the Spotter instructions and more settings options in the Spotter sidebar settings menu. + +* `true` - Spotter instructions and settings are shown. +* `false` (default) - Spotter instructions and settings are hidden. +* `undefined` - defaults to `false`. +|==== + +=== Example +Use this configuration for a clean, minimal Spotter experience if your application users do not need access to the Connector Marketplace or advanced settings. + +[source,JavaScript] +---- +const spotter = new SpotterEmbed('#tsEmbed', { + // ...other embed view configuration options + spotterSidebarConfig: { + spotterSidebarDefaultExpanded: true, + enablePastConversationsSidebar: true, + // Hide connector marketplace and spotter settings + enableConnectorMarketplace: false, + enableSpotterInstructionAndMoreSettings: false, + }, +}); +---- + +To explicitly show both the Connector Marketplace link and the Spotter instructions option, set both properties to `true`: + +[source,JavaScript] +---- +const spotter = new SpotterEmbed('#tsEmbed', { + // ...other embed view configuration options + spotterSidebarConfig: { + spotterSidebarDefaultExpanded: true, + enablePastConversationsSidebar: true, + // Explicitly show connector marketplace and spotter settings + enableConnectorMarketplace: true, + enableSpotterInstructionAndMoreSettings: true, + }, +}); +---- + == Additional resources * xref:customize-spotter-embed.adoc[Customizing the Spotter embed view] * xref:customize-spotter-chat-experience.adoc[Customizing the Spotter chat experience] From 892cb7604d1f0a40544d4406d70c4901e54a6e2f Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Tue, 20 Oct 2026 11:14:39 +0530 Subject: [PATCH 2/5] review edits --- modules/ROOT/pages/customize-spotter-sidebar.adoc | 15 ++++++++------- 1 file changed, 8 insertions(+), 7 deletions(-) diff --git a/modules/ROOT/pages/customize-spotter-sidebar.adoc b/modules/ROOT/pages/customize-spotter-sidebar.adoc index b1f9f1bb6..4d7d29e7a 100644 --- a/modules/ROOT/pages/customize-spotter-sidebar.adoc +++ b/modules/ROOT/pages/customize-spotter-sidebar.adoc @@ -42,13 +42,15 @@ For more information, see xref:customize-spotter-analysts.adoc[Customizing Spott |Connector Marketplace link + |Shows the link to the Connector Marketplace page in the Spotter sidebar footer. When this option is not set in the embed configuration, the cluster-level setting applies. +For more information, see xref:customize-spotter-sidebar.adoc#connector-marketplace[Connector Marketplace link]. + | [tag greenBackground tick]#✓# Spotter 3 + [tag redBackground tick]#x# Spotter 2 + [tag redBackground tick]#x# Spotter Classic |Spotter instructions and settings + -|Shows Spotter instructions and more settings options in the Spotter sidebar settings menu. This option is disabled by default in the embedded view. To show it, set `enableSpotterInstructionAndMoreSettings` to `true` in the `spotterSidebarConfig` object. For more information, see <<_spotter_instructions_and_settings_menu,Spotter instructions and settings menu>>. +|Shows Spotter instructions and more settings options in the Spotter sidebar settings menu. This option is disabled by default in the embedded view. To show it, set `enableSpotterInstructionAndMoreSettings` to `true` in the `spotterSidebarConfig` object. For more information, see xref:customize-spotter-sidebar.adoc#spotter-instructions-settings[Spotter instructions and settings menu]. | [tag greenBackground tick]#✓# Spotter 3 + [tag redBackground tick]#x# Spotter 2 + @@ -56,7 +58,7 @@ For more information, see xref:customize-spotter-analysts.adoc[Customizing Spott |==== == Chat history panel -To allow your users to access the chat history from their previous sessions, you can enable the *Chat history* in the sidebar by setting the `enablePastConversationsSidebar` parameter to `true` in the `spotterSidebarConfig` object. You can also customize the default state and the labels as shown in this example: +To allow your users to access the chat history from their previous sessions, you can enable the *Chat history* panel in the sidebar by setting the `enablePastConversationsSidebar` parameter to `true` in the `spotterSidebarConfig` object. You can also customize the default state and the labels as shown in this example: [source,JavaScript] ---- @@ -182,7 +184,7 @@ spotterEmbed.on(EmbedEvent.SpotterConversationSelected, (payload) => { For a complete list of event IDs, see xref:EmbedEvent.adoc[EmbedEvent reference]. == Customizing other settings in the sidebar panel -The other settings in the sidebar panel include a link to Best practices guide and the sidebar footer. +The other settings in the sidebar panel include a link to the best practices guide and the sidebar footer. To customize these options or to control their visibility in the sidebar, use the following options: @@ -205,11 +207,10 @@ const embed = new SpotterEmbed('#tsEmbed', { }) ---- - -[#connector-marketplace] == Connector Marketplace and Spotter settings controls You can control the visibility of the Connector Marketplace link and the Spotter instructions option in the sidebar using the following properties in the `spotterSidebarConfig` object. +[#connector-marketplace] === Connector Marketplace link To show or hide the Connector Marketplace page link in the Spotter sidebar footer, set the xref:SpotterSidebarViewConfig.adoc#_enableconnectormarketplace[`enableConnectorMarketplace`] property in the `spotterSidebarConfig` object. @@ -251,7 +252,7 @@ const spotter = new SpotterEmbed('#tsEmbed', { spotterSidebarConfig: { spotterSidebarDefaultExpanded: true, enablePastConversationsSidebar: true, - // Hide connector marketplace and spotter settings + // Hide the Connector Marketplace link and Spotter settings enableConnectorMarketplace: false, enableSpotterInstructionAndMoreSettings: false, }, @@ -267,7 +268,7 @@ const spotter = new SpotterEmbed('#tsEmbed', { spotterSidebarConfig: { spotterSidebarDefaultExpanded: true, enablePastConversationsSidebar: true, - // Explicitly show connector marketplace and spotter settings + // Explicitly show the Connector Marketplace link and Spotter settings enableConnectorMarketplace: true, enableSpotterInstructionAndMoreSettings: true, }, From 4dd3f05047d747c92189ad2ac629a91a663e68f0 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Thu, 22 Oct 2026 18:54:59 +0530 Subject: [PATCH 3/5] formatting fix --- modules/ROOT/pages/customize-spotter-embed.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/customize-spotter-embed.adoc b/modules/ROOT/pages/customize-spotter-embed.adoc index b4529fec6..1852e7181 100644 --- a/modules/ROOT/pages/customize-spotter-embed.adoc +++ b/modules/ROOT/pages/customize-spotter-embed.adoc @@ -13,9 +13,9 @@ When you xref:embed-spotter.adoc[embed Spotter] in your application, you'll noti === Default experience The default experience in embedded view is the classic Spotter interface with an initial page that includes a prompt bar for user input, a data source selector, and the UI options to preview data and reset a Spotter session. -+ + If Spotter 2 is enabled on your ThoughtSpot instance, additional controls such as Quick search and Deep analysis toggle switch, and the automatic data model selection option are available. -+ + [.widthAuto] [.bordered] image::./images/spotter-default-interface.png[Default Spotter interface] From 6974e7e988b159f23deddcde8f66ea1b12c19c3e Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Thu, 22 Oct 2026 19:14:18 +0530 Subject: [PATCH 4/5] edits --- .../ROOT/pages/customize-spotter-sidebar.adoc | 64 ++++++++----------- 1 file changed, 26 insertions(+), 38 deletions(-) diff --git a/modules/ROOT/pages/customize-spotter-sidebar.adoc b/modules/ROOT/pages/customize-spotter-sidebar.adoc index 4d7d29e7a..f08be0443 100644 --- a/modules/ROOT/pages/customize-spotter-sidebar.adoc +++ b/modules/ROOT/pages/customize-spotter-sidebar.adoc @@ -40,17 +40,17 @@ For more information, see xref:customize-spotter-analysts.adoc[Customizing Spott [tag greenBackground tick]#✓# Spotter 2 + [tag greenBackground tick]#✓# Spotter Classic -|Connector Marketplace link + -|Shows the link to the Connector Marketplace page in the Spotter sidebar footer. When this option is not set in the embed configuration, the cluster-level setting applies. -For more information, see xref:customize-spotter-sidebar.adoc#connector-marketplace[Connector Marketplace link]. - +|Spotter instructions and settings + +|Shows Spotter instructions and more settings options in the Spotter sidebar settings menu. This option is disabled by default in the embedded view. To show it, set `enableSpotterInstructionAndMoreSettings` to `true` in the `spotterSidebarConfig` object. For more information, see xref:customize-spotter-sidebar.adoc#spotter-instructions-settings[Spotter instructions and settings menu]. | [tag greenBackground tick]#✓# Spotter 3 + [tag redBackground tick]#x# Spotter 2 + [tag redBackground tick]#x# Spotter Classic -|Spotter instructions and settings + -|Shows Spotter instructions and more settings options in the Spotter sidebar settings menu. This option is disabled by default in the embedded view. To show it, set `enableSpotterInstructionAndMoreSettings` to `true` in the `spotterSidebarConfig` object. For more information, see xref:customize-spotter-sidebar.adoc#spotter-instructions-settings[Spotter instructions and settings menu]. +|Connector Marketplace link + +|Shows the link to the Connector Marketplace page in the Spotter sidebar footer. When this option is not set in the embed configuration, the cluster-level setting applies. +For more information, see xref:customize-spotter-sidebar.adoc#connector-marketplace[Connector Marketplace link]. + | [tag greenBackground tick]#✓# Spotter 3 + [tag redBackground tick]#x# Spotter 2 + @@ -210,22 +210,6 @@ const embed = new SpotterEmbed('#tsEmbed', { == Connector Marketplace and Spotter settings controls You can control the visibility of the Connector Marketplace link and the Spotter instructions option in the sidebar using the following properties in the `spotterSidebarConfig` object. -[#connector-marketplace] -=== Connector Marketplace link -To show or hide the Connector Marketplace page link in the Spotter sidebar footer, set the xref:SpotterSidebarViewConfig.adoc#_enableconnectormarketplace[`enableConnectorMarketplace`] property in the `spotterSidebarConfig` object. - -[width="100%", cols="2,5"] -|==== -|Property |Description - -|`enableConnectorMarketplace` -a|__Boolean__. Controls the visibility of the Connector Marketplace page link in the Spotter sidebar footer. - -* `true` - the Connector Marketplace link is shown. -* `false` - the Connector Marketplace link is hidden. -* `undefined` (default) - the cluster-level setting applies. -|==== - [#spotter-instructions-settings] === Spotter instructions and settings menu To show or hide the Spotter instructions and more settings options in the Spotter sidebar settings menu, set the xref:SpotterSidebarViewConfig.adoc#_enablespotterinstructionandmoresettings[`enableSpotterInstructionAndMoreSettings`] property in the `spotterSidebarConfig` object. @@ -240,26 +224,28 @@ a|__Boolean__. Controls the visibility of the Spotter instructions and more sett * `true` - Spotter instructions and settings are shown. * `false` (default) - Spotter instructions and settings are hidden. * `undefined` - defaults to `false`. +|| |==== -=== Example -Use this configuration for a clean, minimal Spotter experience if your application users do not need access to the Connector Marketplace or advanced settings. +[#connector-marketplace] +=== Connector Marketplace link +To show or hide the Connector Marketplace page link in the Spotter sidebar footer, set the xref:SpotterSidebarViewConfig.adoc#_enableconnectormarketplace[`enableConnectorMarketplace`] property in the `spotterSidebarConfig` object. -[source,JavaScript] ----- -const spotter = new SpotterEmbed('#tsEmbed', { - // ...other embed view configuration options - spotterSidebarConfig: { - spotterSidebarDefaultExpanded: true, - enablePastConversationsSidebar: true, - // Hide the Connector Marketplace link and Spotter settings - enableConnectorMarketplace: false, - enableSpotterInstructionAndMoreSettings: false, - }, -}); ----- +[width="100%", cols="2,5"] +|==== +|Property |Description -To explicitly show both the Connector Marketplace link and the Spotter instructions option, set both properties to `true`: +|`enableConnectorMarketplace` +a|__Boolean__. Controls the visibility of the Connector Marketplace page link in the Spotter sidebar footer. + +* `true` - the Connector Marketplace link is shown. +* `false` - the Connector Marketplace link is hidden. +* `undefined` (default) - the cluster-level setting applies. +|| +|==== + +=== Example +To show both the Connector Marketplace link and the Spotter instructions option in the embedded Spotter interface, set both properties to `true`: [source,JavaScript] ---- @@ -275,6 +261,8 @@ const spotter = new SpotterEmbed('#tsEmbed', { }); ---- +If your application users do not need access to the Connector Marketplace, set the `enableConnectorMarketplace` property to `false` to hide the link. + == Additional resources * xref:customize-spotter-embed.adoc[Customizing the Spotter embed view] * xref:customize-spotter-chat-experience.adoc[Customizing the Spotter chat experience] From e78939a2a350be364c96d2fe16201c7e59871299 Mon Sep 17 00:00:00 2001 From: ShashiSubramanya Date: Thu, 22 Oct 2026 19:31:46 +0530 Subject: [PATCH 5/5] content reorder --- .../ROOT/pages/customize-spotter-sidebar.adoc | 48 +++++++++---------- 1 file changed, 24 insertions(+), 24 deletions(-) diff --git a/modules/ROOT/pages/customize-spotter-sidebar.adoc b/modules/ROOT/pages/customize-spotter-sidebar.adoc index f08be0443..9730ca312 100644 --- a/modules/ROOT/pages/customize-spotter-sidebar.adoc +++ b/modules/ROOT/pages/customize-spotter-sidebar.adoc @@ -183,30 +183,6 @@ spotterEmbed.on(EmbedEvent.SpotterConversationSelected, (payload) => { For a complete list of event IDs, see xref:EmbedEvent.adoc[EmbedEvent reference]. -== Customizing other settings in the sidebar panel -The other settings in the sidebar panel include a link to the best practices guide and the sidebar footer. - -To customize these options or to control their visibility in the sidebar, use the following options: - -* `spotterDocumentationUrl` + -Allows customizing the documentation link. -* `Action.SpotterSidebarFooter` + -Action ID to show or hide the sidebar footer that contains the documentation link. -* `Action.SpotterDocs` + -Action ID to show or hide the documentation or best practices link in the sidebar footer. - -[source,JavaScript] ----- -const embed = new SpotterEmbed('#tsEmbed', { - // ...other embed view configuration options - // Configuration for the Spotter sidebar UI - spotterSidebarConfig: { - enablePastConversationsSidebar: true, // Enable the chat history sidebar - spotterDocumentationUrl: 'https://your-help-center-url', // Custom best practices link - }, -}) ----- - == Connector Marketplace and Spotter settings controls You can control the visibility of the Connector Marketplace link and the Spotter instructions option in the sidebar using the following properties in the `spotterSidebarConfig` object. @@ -263,6 +239,30 @@ const spotter = new SpotterEmbed('#tsEmbed', { If your application users do not need access to the Connector Marketplace, set the `enableConnectorMarketplace` property to `false` to hide the link. +== Customizing other options in the sidebar panel +The other options in the sidebar panel include a link to the best practices guide and the sidebar footer. + +To customize these options or to control their visibility in the sidebar, use the following options: + +* `spotterDocumentationUrl` + +Allows customizing the documentation link. +* `Action.SpotterSidebarFooter` + +Action ID to show or hide the sidebar footer that contains the documentation link. +* `Action.SpotterDocs` + +Action ID to show or hide the documentation or best practices link in the sidebar footer. + +[source,JavaScript] +---- +const embed = new SpotterEmbed('#tsEmbed', { + // ...other embed view configuration options + // Configuration for the Spotter sidebar UI + spotterSidebarConfig: { + enablePastConversationsSidebar: true, // Enable the chat history sidebar + spotterDocumentationUrl: 'https://your-help-center-url', // Custom best practices link + }, +}) +---- + == Additional resources * xref:customize-spotter-embed.adoc[Customizing the Spotter embed view] * xref:customize-spotter-chat-experience.adoc[Customizing the Spotter chat experience]