Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions modules/ROOT/pages/api-changelog.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/customize-spotter-embed.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
78 changes: 75 additions & 3 deletions modules/ROOT/pages/customize-spotter-sidebar.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,26 @@ 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

|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

|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
|====

== 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]
----
Expand Down Expand Up @@ -167,8 +183,64 @@ 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.
== 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.

[#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`.
||
|====

[#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.
||
|====

=== 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]
----
const spotter = new SpotterEmbed('#tsEmbed', {
// ...other embed view configuration options
spotterSidebarConfig: {
spotterSidebarDefaultExpanded: true,
enablePastConversationsSidebar: true,
// Explicitly show the Connector Marketplace link and Spotter settings
enableConnectorMarketplace: true,
enableSpotterInstructionAndMoreSettings: true,
},
});
----

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:

Expand Down
Loading