Skip to content
Closed
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
1,792 changes: 82 additions & 1,710 deletions modules/ROOT/pages/api-changelog.adoc

Large diffs are not rendered by default.

6 changes: 1 addition & 5 deletions modules/ROOT/pages/common/nav-embedding.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -173,10 +173,6 @@ include::generated/typedoc/CustomSideNav.adoc[]
[.sidebar-title]
Additional resources

* link:{{navprefix}}/embed-ts[About ThoughtSpot embedding]
* link:{{navprefix}}/get-started-tse[Embed licenses]
* link:{{navprefix}}/license-feature-matrix[Feature matrix]
* link:{{navprefix}}/faqs[FAQs]
* link:{{navprefix}}/code-samples[Code samples]
* link:https://codesandbox.io/s/big-tse-react-demo-i4g9xi[React CodeSandbox, window=_blank]
* link:https://codesandbox.io/s/graphqlcookieembed-wf4fk9?file=/src/App.js:418-426[GraphQL CodeSandbox, window=_blank]
* link:https://github.com/thoughtspot/developer-examples[Developer examples, window=_blank]
308 changes: 308 additions & 0 deletions modules/ROOT/pages/common/nav-in-product-help.adoc

Large diffs are not rendered by default.

58 changes: 13 additions & 45 deletions modules/ROOT/pages/common/nav-rest-api.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,37 +22,19 @@ REST APIs
** link:{{navprefix}}/fetch-data-and-report-apis[Data and 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]
*** link:{{navprefix}}/spotter-agent-conversation-mgmt-apis[APIs for managing saved conversations]
*** link:{{navprefix}}/spotter-apis-classic[AI APIs (Spotter Classic) ^BETA^]
*** link:{{navprefix}}/spotter-coaching-apis[Spotter coaching APIs ^BETA^]
*** link:{{navprefix}}/spotter-nl-instructions[Data model instructions APIs ^BETA^]
** link:{{navprefix}}/style-customization-apis[Style customization APIs]
** link:{{navprefix}}/audit-logs[Audit logs]
** link:{{navprefix}}/tml[TML]
** link:{{navprefix}}/collections[Collections ^BETA^]
** link:{{navprefix}}/connections[Connections]
** link:{{navprefix}}/connection-config[Connection configuration]
** link:{{navprefix}}/runtime-sort[Runtime sorting]
* link:{{navprefix}}/api-user-management[Users and group privileges]
* link:{{navprefix}}/rbac[Role-based access control]
* link:{{navprefix}}/rest-apiv2-search[Search API endpoints]
** 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}}/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]
** link:{{navprefix}}/spotter-agent-conversation-mgmt-apis[APIs for managing saved conversations]
** link:{{navprefix}}/spotter-apis-classic[AI APIs (Spotter Classic) ^BETA^]
** link:{{navprefix}}/spotter-nl-instructions[Spotter instructions APIs ^BETA^]
** link:{{navprefix}}/spotter-agent-instructions[Spotter instructions APIs ^BETA^]
* link:{{navprefix}}/audit-logs[Audit logs]
* link:{{navprefix}}/tml[TML]
* link:{{navprefix}}/collections[Collections ^BETA^]
* link:{{navprefix}}/connections[Connections]
* link:{{navprefix}}/connection-config[Connection configuration]
* link:{{navprefix}}/runtime-sort[Runtime sorting]
* link:{{navprefix}}/manual-translation-api[Manual translations]
* link:{{navprefix}}/webhooks-rest-api[Webhook APIs]
** link:{{navprefix}}/manual-translation-api[Manual translations]
** link:{{navprefix}}/webhooks-rest-api[Webhook APIs]


[.sidebar-title]
Expand All @@ -79,28 +61,14 @@ REST API v1 (DEPRECATED)
* link:{{navprefix}}/catalog-and-audit[Catalog and audit content]
* link:{{navprefix}}/rest-api-pagination[Paginate API response]
* link:{{navprefix}}/rest-api-reference[REST API v1 Reference]
** link:{{navprefix}}/orgs-api[Orgs API]
** link:{{navprefix}}/user-api[User API]
** link:{{navprefix}}/group-api[Group API]
** link:{{navprefix}}/role-api[Role API]
** link:{{navprefix}}/session-api[Session API]
** link:{{navprefix}}/connections-api[Data connection API]
** link:{{navprefix}}/metadata-api[Metadata API]
** link:{{navprefix}}/admin-api[Admin API]
** link:{{navprefix}}/tml-api[TML API]
** link:{{navprefix}}/dependent-objects-api[Dependent objects API]
** link:{{navprefix}}/search-data-api[Search data API]
** link:{{navprefix}}/liveboard-data-api[Liveboard data API]
** link:{{navprefix}}/liveboard-export-api[Liveboard export API]
** link:{{navprefix}}/security-api[Security API]
** link:{{navprefix}}/logs-api[Audit logs API]
** link:{{navprefix}}/materialization-api[Materialization API]
** link:{{navprefix}}/database-api[Database API]
** link:{{navprefix}}/rest-v1-changelog[REST API v1 changelog]
** link:{{navprefix}}/v1v2-comparison[REST v1 and v2.0 comparison]


//** link:{{navprefix}}/graphql-guide[GraphQL API ^Beta^]
* link:{{navprefix}}/rest-v1-changelog[REST API v1 changelog]
* link:{{navprefix}}/v1v2-comparison[REST v1 and v2.0 comparison]

[.sidebar-title]
Additional resources

* link:{{navprefix}}/faqs[FAQs]
* link:https://github.com/thoughtspot/developer-examples[Developer examples, window=_blank]



Expand Down
6 changes: 1 addition & 5 deletions modules/ROOT/pages/common/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -100,11 +100,7 @@ Additional resources

* link:{{navprefix}}/faqs[FAQs]
* link:https://codesandbox.io/s/big-tse-react-demo-i4g9xi[React CodeSandbox, window=_blank]
//** link:https://codesandbox.io/s/graphqlcookieembed-wf4fk9?file=/src/App.js:418-426[GraphQL CodeSandbox, window=_blank]

* link:https://community.thoughtspot.com/customers/s/[Community, window=_blank]
* link:https://training.thoughtspot.com/page/developer[Training resources, window=_blank]
* link:https://docs.thoughtspot.com[Product Documentation, window=_blank]
* link:https://developers.thoughtspot.com[ThoughtSpot Developers, window=_blank]
* Deprecated feature docs
** link:{{navprefix}}/abac-user-parameters-beta[ABAC via tokens (pre-10.4.0.cl) (Deprecated)]
* link:https://github.com/thoughtspot/developer-examples[Developer examples, window=_blank]
14 changes: 8 additions & 6 deletions modules/ROOT/pages/customize-links.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -215,10 +215,9 @@ https://www.mysite.com/{path}

== Override ThoughtSpot URLs

Link override settings allow embedded users to redirect native ThoughtSpot URLs to links within their host application. ThoughtSpot supports two Visual Embed SDK configurations for overriding links generated by ThoughtSpot. These settings work the same for multi-tenant ThoughtSpot embedded instances too.

You can set the `linkOverride` to `true` in the Visual Embed SDK to override the link format of your embedded application pages and navigation links. Once enabled, all links opened in a new tab via the right-click menu will show host application URLs.
Link override settings allow embedded users to redirect native ThoughtSpot URLs to links within their host application. ThoughtSpot supports Visual Embed SDK configurations for overriding links generated by ThoughtSpot. These settings work the same for multi-tenant ThoughtSpot embedded instances too.

Set `enableLinkOverridesV2` to `true` in the Visual Embed SDK. Once enabled, all links will display host application URLs when hovered over or opened in a new tab. ThoughtSpot recommends using this enhanced configuration for your link override settings.

[source,JavaScript]
----
Expand All @@ -229,12 +228,13 @@ const appEmbed = new AppEmbed(document.getElementById('ts-embed'), {
},
pageId: Page.Home,
showPrimaryNavbar: true,
linkOverride: true,
enableLinkOverridesV2: true,
});
appEmbed.render();
----

Set `enableLinkOverridesV2` to `true` in the Visual Embed SDK. Once enabled, all links will display host application URLs when hovered over or opened in a new tab. ThoughtSpot recommends using this enhanced configuration for you link override settings.
If your ThoughtSpot instance uses the `linkOverride` in the Visual Embed SDK to override the link format of your embedded application pages and navigation links, this flag now gets auto-upgraded to `enableLinkOverridesV2` to ensure consistent link-override behavior.


[source,JavaScript]
----
Expand All @@ -245,10 +245,12 @@ const appEmbed = new AppEmbed(document.getElementById('ts-embed'), {
},
pageId: Page.Home,
showPrimaryNavbar: true,
enableLinkOverridesV2: true,
linkOverride: true,
});
appEmbed.render();
----
[NOTE]
The `disableRedirectionLinksInNewTab` overrides these flags. When set to `true`, the link override settings will not work.

== Verify system-generated links

Expand Down
73 changes: 22 additions & 51 deletions modules/ROOT/pages/customize-style.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
:page-pageid: customize-style
:page-description: Rebrand embedded ThoughtSpot content

If you want to match the look and feel of embedded ThoughtSpot content with your core application, you can customize the ThoughtSpot application UI elements. Using style customization, you can create a uniform ThoughtSpot experience that complies with your companys branding guidelines.
If you want to match the look and feel of embedded ThoughtSpot content with your core application, you can customize the ThoughtSpot application UI elements. Using style customization, you can create a uniform ThoughtSpot experience that complies with your company's branding guidelines.

You can rebrand the ThoughtSpot interface elements such as the application logo, background color, and color scheme of visualizations.
[NOTE]
Expand Down Expand Up @@ -73,7 +73,8 @@ image::./images/style-widelogo.png[Wide application logo]
====
* The application logo (wide) appears on the login screen.

* The recommended size is 330px by 100px. This will allow the system to preserve the aspect ratio of the uploaded logo image and prevent distortion.
// SOURCE: SCAL-323307
* The recommended size for the wide logo is 250px by 50px (5:1 aspect ratio). Uploading a logo at a different aspect ratio may result in stretching or letterboxing on the login screen.

* The accepted file formats for the logo image are jpg, jpeg, and png.
====
Expand Down Expand Up @@ -181,67 +182,37 @@ To change the color palette for charts:

. To access the ThoughtSpot Developer portal, click *Develop*
. Under *Customizations*, click *Styles*.
. Click the background color box under *Chart Color Palettes*.
. Click the color you would like to change in the *primary* color palette, and use the color menu to choose your new color.
. Click *Edit* under the *Chart Color Palettes* section.
. To add a new color scheme, click *+ Add*.
. To modify an existing color, click the existing color.
+
You can also add a HEX color code.
. Click the color you would like to change in the *secondary* color palette, and use the color menu to choose your new color.
You can also add a HEX color code.
+
The colors from the secondary color palette are used after all of the primary colors from the primary palette have been exhausted.
Therefore, the secondary palette usually consists of secondary colors.

=== Configure color rotation

If the chart requires only one color, ThoughtSpot selects a primary color depending on whether you enabled color rotation. The *Color rotation* feature determines whether single-color charts use a random primary color or always use the first primary color in the palette. If you enable Color Rotation, ThoughtSpot picks colors randomly and may choose any color from Primary 1 through Primary 6 in your color palette for single-color charts. If you disable Color Rotation, ThoughtSpot always chooses Primary 1.

If you disable color rotation, ThoughtSpot generates single-color charts in the order of your color palette, left to right.
The color picker displays.
. Choose a new color or enter the HEX color code.
. Click *Save*.

[#footer-text]
== Customize footer text
You can customize the footer text in your ThoughtSpot instance to add your company-specific message.
== Add footer text
You can add footer text with hyperlinks to the ThoughtSpot application.

To customize or rebrand the footer text, follow these steps:
To add footer text:

. To access the ThoughtSpot Developer portal, click *Develop*
. Under *Customizations*, click *Styles*.
. Click the text box under *Footer text* and enter the message.
+
Your custom message will appear in the footer.
. Add your text in the *Footer Text* box.
. Click *Save changes*.

////
. Add `?customBrandingEnabled=true` to your application URL as shown in the following examples:
+
----
https://{ThoughtSpot-Host}/?customBrandingEnabled=true/#/
----
+
----
https://{ThoughtSpot-Host}/?customBrandingEnabled=true/#/pinboards
----
. Go to *Admin* > *Application settings* > *Style customization* or *Develop* > *Customizations* > *Styles*.
+
You require administrator or developer privilege to apply custom styles and footer text.
. Click the text box under *Footer text* and enter the message.
+
Your custom message will appear in the footer.
. To enable footer text customization on your cluster by default, contact ThoughtSpot Support.
////
[NOTE]
====
The footer text is displayed at the bottom of the ThoughtSpot application page. The footer text is not displayed in embedded applications.
====

////
[#page-title]
== Customize page title
You can customize the page title that appears in the browser tab.

To customize the page title displayed in the browser bar:
To customize the page title:

. To access the ThoughtSpot Developer portal, click *Develop*
. Under *Customizations*, click *Styles*.
. Click the text box under *Page title*.
. Enter your new text message.
////

== Reset styles

When you customize styles, the changes take effect after you refresh the browser.

To revert your changes, use the *Reset* button that appears when you move your cursor to the right of the style setting option.
. Enter your text in the *Page Title* box.
. Click *Save changes*.
13 changes: 5 additions & 8 deletions modules/ROOT/pages/embed-pinboard.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -209,20 +209,17 @@ image::./images/liveboard-refresh.png[Liveboard refresh]

The Visual Embed SDK also provides the following action IDs and events to customize the cache refresh visibility and workflow.

[width="100%",cols="2,1,4"]
[width="100%",cols="2,4"]
|====
|API | Description
|ID | Description

|`Action.RefreshLiveboardBrowserCache`
|xref:Action.adoc#_refreshliveboardbrowsercache[Action]
|xref:Action.adoc#_refreshliveboardbrowsercache[Action.RefreshLiveboardBrowserCache]
|Action ID to show, hide, or disable the *Refresh* button in the Liveboard header.

|`EmbedEvent.RefreshLiveboardBrowserCache`
|xref:EmbedEvent.adoc#_refreshliveboardbrowsercache[EmbedEvent]
|xref:EmbedEvent.adoc#_refreshliveboardbrowsercache[EmbedEvent.RefreshLiveboardBrowserCache]
|Emitted when a user clicks the *Refresh* button in the Liveboard header.

|`HostEvent.RefreshLiveboardBrowserCache`
|xref:HostEvent.adoc#_refreshliveboardbrowsercache[HostEvent]
|xref:HostEvent.adoc#_refreshliveboardbrowsercache[HostEvent.RefreshLiveboardBrowserCache]
|Triggers a browser cache refresh programmatically for all visualization containers on the embedded Liveboard.
|====

Expand Down
Loading
Loading