Skip to content
Open
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
8 changes: 4 additions & 4 deletions modules/ROOT/pages/collections.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@
ThoughtSpot now provides REST APIs that enable developers to organize different ThoughtSpot objects into an organizational container called *Collections*. These objects can be Liveboards, Answers, data models, tables, and even other Collections.
Collections provide a powerful way to manage your data assets, making discovery and collaboration easier, while ensuring the integrity of embedded workflows.

[NOTE]
====
The Collections APIs are in Beta and disabled by default on ThoughtSpot instances. To enable these APIs on your instance, contact ThoughtSpot Support.
====
#You can also embed the Collections page directly in your application using the Visual Embed SDK.
To navigate users to the Collections page in full application embedding, set `pageId` to `Page.Collections` in `AppViewConfig`.
For more information, see xref:customize-nav-full-embed.adoc#_navigate_to_the_collections_page[Navigate to the Collections page].#


== Before you begin

Expand Down
5 changes: 4 additions & 1 deletion modules/ROOT/pages/common/nav-in-product-help.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -221,7 +221,8 @@ REST APIs
*** link:{{navprefix}}/rest-apiv2-users-search[Search users]
*** link:{{navprefix}}/rest-apiv2-groups-search[Search groups]
*** link:{{navprefix}}/rest-apiv2-metadata-search[Search metadata]
** link:{{navprefix}}/fetch-data-and-report-apis[Data and Report APIs]
** link:{{navprefix}}/fetch-data-and-report-apis[Data APIs]
** link:{{navprefix}}/report-apis[Report APIs]
** link:{{navprefix}}/spotter-api[Spotter APIs]
*** link:{{navprefix}}/spotter-agent-apis[AI APIs (Spotter Agent and Spotter 3)]
*** link:{{navprefix}}/spotter-agent-instructions[Spotter AI agent instructions]
Expand All @@ -232,6 +233,8 @@ REST APIs
** link:{{navprefix}}/style-customization-apis[Style customization APIs]
** link:{{navprefix}}/audit-logs[Audit logs]
** link:{{navprefix}}/tml[TML]
*** link:{{navprefix}}/tml-import[Import TML]
*** link:{{navprefix}}/tml-export[Export TML]
** link:{{navprefix}}/collections[Collections]
** link:{{navprefix}}/connections[Connections]
** link:{{navprefix}}/connection-config[Connection configuration]
Expand Down
5 changes: 4 additions & 1 deletion modules/ROOT/pages/common/nav-rest-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ REST APIs
*** link:{{navprefix}}/rest-apiv2-users-search[Search users]
*** link:{{navprefix}}/rest-apiv2-groups-search[Search groups]
*** link:{{navprefix}}/rest-apiv2-metadata-search[Search metadata]
** link:{{navprefix}}/fetch-data-and-report-apis[Data and Report APIs]
** link:{{navprefix}}/fetch-data-and-report-apis[Data APIs]
** link:{{navprefix}}/report-apis[Report APIs]
** link:{{navprefix}}/runtime-sort[Runtime sorting]
** link:{{navprefix}}/spotter-api[Spotter APIs]
*** link:{{navprefix}}/spotter-agent-apis[AI APIs (Spotter Agent and Spotter 3)]
Expand All @@ -30,6 +31,8 @@ REST APIs
*** link:{{navprefix}}/spotter-nl-instructions[Data model instructions APIs ^BETA^]
** link:{{navprefix}}/audit-logs[Audit logs]
** link:{{navprefix}}/tml[TML]
*** link:{{navprefix}}/tml-import[Import TML]
*** link:{{navprefix}}/tml-export[Export TML]
** link:{{navprefix}}/collections[Collections]
** link:{{navprefix}}/connections[Connections]
** link:{{navprefix}}/connection-config[Connection configuration]
Expand Down
30 changes: 30 additions & 0 deletions modules/ROOT/pages/customize-nav-full-embed.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,31 @@ const embed = new AppEmbed("#embed", {
== Command palette availability in embed
In ThoughtSpot application, users can open the link:https://docs.thoughtspot.com/cloud/latest/thoughtspot-homepage#command-palette[command palette] by pressing kbd:[Cmd+K] on macOS or kbd:[Ctrl+K] on Windows to quickly navigate to objects and perform actions. However, when you embed ThoughtSpot, this feature is disabled and embedded pages include only the standard object search experience.

== #Navigate to the Collections page#

To set the Collections page as the default landing page for full application embedding, use `Page.Collections` in the `pageId` property of `AppViewConfig`.

// SOURCE: https://github.com/thoughtspot/visual-embed-sdk/blob/master/src/embed/app.ts

[source,JavaScript]
----
import { AppEmbed, Page } from '@thoughtspot/visual-embed-sdk';

const embed = new AppEmbed('#tsEmbed', {
// ... other embed view config
pageId: Page.Collections,
showPrimaryNavbar: true,
});
embed.render();
----

You can also use `navigateToPage` to route users to the Collections page programmatically after the app loads:

[source,JavaScript]
----
appEmbed.navigateToPage('collections');
----

== Customize the left navigation panel on the home page
In the V3 and V4 experience modes, the left navigation panel on the *Insights* > *Home* page includes menu items such as *Spotter*, *Answers*, *Liveboards*, *SpotIQ Analysis*, *Monitor Subscriptions*, and more. You can hide this navigation panel by setting the `hideHomepageLeftNav` property to `true` in the SDK. Note that this attribute hides the left navigation only on the home page.

Expand Down Expand Up @@ -181,6 +206,11 @@ To show or hide the *Scheduled Liveboards* section in the
| [tag greenBackground tick]#✓# Supported
| [tag greenBackground tick]#✓# Supported

| `HomeLeftNavItem.Collections` +
#To show or hide the *Collections* menu item in the *Insights* left navigation panel.#
| [tag greenBackground tick]#✓# Supported
| [tag greenBackground tick]#✓# Supported

|====


Expand Down
Loading