Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Whats new 10.5 #231

Merged
merged 31 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
31 commits
Select commit Hold shift + click to select a range
067a6d0
image updates and note for spotter in full app
ShashiSubramanya Dec 3, 2024
cf87705
image edits
ShashiSubramanya Dec 3, 2024
11e19be
whats new 10.5
rani2655 Dec 5, 2024
04571a1
sharing context for Orgs
rani2655 Dec 5, 2024
4be074a
whats new 10.5
rani2655 Dec 5, 2024
2d12699
whats new 10.5
rani2655 Dec 10, 2024
75a7d5a
sharing context for Orgs
rani2655 Dec 10, 2024
b131ed9
sharing context for Orgs
rani2655 Dec 11, 2024
9f1a0d9
sharing context for Orgs
rani2655 Dec 11, 2024
4604fc2
perOrgcustomembedurl
rani2655 Dec 11, 2024
0b3d02e
perOrgcustomembedurl
rani2655 Dec 11, 2024
4065c9b
perOrgcustomembedurl
rani2655 Dec 11, 2024
65afd73
orgcustom-embed
rani2655 Dec 12, 2024
b800371
orgcustom-embed
rani2655 Dec 12, 2024
30395de
orgcustom-embed
rani2655 Dec 12, 2024
d186741
orgcustom-embed
rani2655 Dec 12, 2024
0a0f60d
orgcustom-embed
rani2655 Dec 12, 2024
2633a1d
orgcustom-embed
rani2655 Dec 12, 2024
a676e2d
orgcustom-embed
rani2655 Dec 12, 2024
db02e85
orgcustom-embed
rani2655 Dec 12, 2024
5ad5258
editorial corrections
rani2655 Dec 13, 2024
ba1dfda
perOrg feedback
rani2655 Dec 17, 2024
6420449
perOrg feedback
rani2655 Dec 17, 2024
15b60d1
perOrg feedback
rani2655 Dec 17, 2024
7caa606
perOrg feedback
rani2655 Dec 17, 2024
882491b
URl restructuring
rani2655 Dec 17, 2024
174b285
perOrg feedback
rani2655 Dec 17, 2024
f9b950c
URl restructuring
rani2655 Dec 17, 2024
1eb39f4
Merge branch '10-5-0' into whats-new-10.5
ShashiSubramanya Dec 18, 2024
ffc1e87
Update whats-new.adoc
ShashiSubramanya Dec 18, 2024
5406dfe
Update orgs.adoc
ShashiSubramanya Dec 18, 2024
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
21 changes: 21 additions & 0 deletions modules/ROOT/pages/customize-links.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ An Answer link is generated when a user shares an Answer with another user and i
SpotIQ analyses links::
ThoughtSpot generates this link when a user runs the SpotIQ analysis on the data generated from a search query, saved Answer, or a visualization pinned to a Liveboard. This link points users to the *SpotIQ Analyses* page and is also sent in email notifications.


Links to unsubscribe from notifications::
+
The *Unsubscribe* link is included in system-generated emails to allow users to turn off email notifications.
Expand Down Expand Up @@ -80,6 +81,8 @@ For example, when a user subscribes to receive threshold-based alerts for a KPI
====
* Make sure the {object-id} and {sub-object-id} variables are used only for ThoughtSpot objects. If the link format has two {object-id} variables, your application users may not receive the correct links. For example, if the link format is `\https://www.mysite.com/?myobject-id={object-id}/liveboard-id={object-id}`, ThoughtSpot may replace both these variables with the Liveboard GUID when it generates the Liveboard link. +
* ThoughtSpot query parameters that substitute the `{ts-query-params}` variable are prefixed with `ts-`.
* If xref:orgs.adoc[per Org custom embed URL feature] is enabled on your ThoughtSpot instance, the Org ID is also passed as a query parameter in the `{ts-query-params}`.
* The developers are advised to update their implementation to accommodate the Org ID in the `{ts-query-params}` while setting up the custom links for their application users, and avoid any workflow disruption.
====

== Customize link format
Expand Down Expand Up @@ -175,6 +178,8 @@ https://www.mysite.com/insight/{object-id}
----
https://www.mysite.com/?insights={object-id}
----


Unsubscribe link::

This URL provides a link to the *Profile* settings page in ThoughtSpot.
Expand Down Expand Up @@ -238,7 +243,20 @@ To verify if the links are generated in the format you configured, share a Liveb
For example, if you customized the hostname in the URL as `www.mysite.com`, ThoughtSpot generates links with the `www.mysite.com` hostname.

* If you are using a non-embedded ThoughtSpot instance and the Liveboard or Answer sharing URL format is customized, ThoughtSpot displays the *Embedded link format* checkbox. To copy the URL in the customized format, click *Embedded link format*.
+
[NOTE]
====
If the per Org custom embed URL feature is enabled on your ThoughtSpot instance, this URL in the *Embedded link format* will also show the Org ID.
For example if you have defined the custom link as,

`\https://www.mysite.com/liveboard/{object-id}/?{ts-query-params}`

The *Embedded link format* will be,

`\https://www.mysite.com/liveboard/22946f4b-b4ce-4643-be50-66afcd5177/orgId=0`

The Org ID will passed in the URL depending on the placement of `{ts-query-params}` in the custom link settings.
====
+
[.bordered]
[.widthAuto]
Expand All @@ -253,7 +271,10 @@ image::./images/embed-link-liveboardSchedule.png[Embed link format]

* Verify the `Unsubscribe` links in email notifications.



////
== Limitations

Currently, ThoughtSpot does not support customizing the **View Liveboard** URL in Liveboard schedule notifications.
////
7 changes: 6 additions & 1 deletion modules/ROOT/pages/embed-spotter.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Embedding applications can avail the benefits of Spotter by using the following

* Embed Spotter capabilities using xref:embed-spotter.adoc#_embed_spotter_using_visual_embed_sdk[Visual Embed SDK] +
* Use xref:spotter-apis.adoc[REST APIs to create a conversation session, ask follow-up questions, and generate Answers]
* Integrate xref:spotter-in-custom-chatbot.adoc[Spotter capabilities into your chatbot].
* Integrate xref:spotter-in-custom-chatbot.adoc[Spotter capabilities into your chatbot]

[NOTE]
====
Expand All @@ -24,6 +24,11 @@ The Spotter feature is in beta and disabled by default on ThoughtSpot Embedded i
Visual Embed SDK offers several options to seamlessly embed conversational analytics within your applications and customize the interface and experience as per your organization's branding guidelines.
If you want to embed only the conversation interface, you can use the `ConversationEmbed` package and add it to your application.

[NOTE]
====
If you are embedding full ThoughtSpot experience in your app using `AppEmbed`, you must enable new home page experience and set the home page search bar mode to `aiAnswer`. For more information, see xref:full-app-customize.adoc#_include_spotter_interface[Customize full application embedding].
====

=== Spotter components

The Spotter embedding adds the following components to your embedding application:
Expand Down
38 changes: 33 additions & 5 deletions modules/ROOT/pages/embed-without-sdk.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,7 @@ Note the URL format to embed a Liveboard in an iFrame:

`\https://{ThoughtSpot-Host}/?embedApp=true#/embed/viz/{Liveboard_id}`


You can also add xref:embed-without-sdk.adoc#_additional_flags_to_customize_the_embedded_view[additional flags] and xref:embed-without-sdk.adoc#rtOverridesIframe[runtime filters and parameter overrides] as query parameters in the embed URL.

== Embed a visualization in an iFrame
Expand Down Expand Up @@ -203,13 +204,18 @@ For example, to filter `michigan` in the `State` columns, pass these values as f
**Liveboard embed**
+
`\https://{ThoughtSpot-host}/?embedApp=true&p&col1=State&op1=EQ&val1=michigan#/embed/viz/{Liveboard_id}`


+
If the per Org URL feature is enabled on your ThoughtSpot instance, the URL format will be:
+
`\https://{ThoughtSpot-host}/?embedApp=true&p&col1=State&op1=EQ&val1=michigan&OrgID=1#/embed/viz/{Liveboard_id}`
+
**Visualization embed**
+
`\http://{ThoughtspotHost}/?embedApp=true&col1=State&op1=EQ&val1=michigan#/embed/viz/{Liveboard_id}/{visualization_id}`

+
If the per Org URL feature is enabled on your ThoughtSpot instance, the URL format will be:
+
`\http://{ThoughtspotHost}/?embedApp=true&col1=State&op1=EQ&val1=michigan&OrgID=1#/embed/viz/{Liveboard_id}/{visualization_id}`
+
**Search embed**
+
Expand All @@ -224,13 +230,20 @@ To apply xref:runtime-parameters.adoc[Parameter overrides], add the Parameter na
**Liveboard embed**
+
`\https://{ThoughtSpot-host}/?embedApp=true&param1=Discount&paramVal1=0.25#/embed/viz/{Liveboard_id}`

+
If the per Org URL feature is enabled on your ThoughtSpot instance, the URL format will be:
+
`\https://{ThoughtSpot-host}/?embedApp=true&param1=Discount&paramVal1=0.25&OrgID=1#/embed/viz/{Liveboard_id}`
+
**Visualization URL embed**
+
`\https://{ThoughtSpot-host}/?embedApp=true&param1=Discount&paramVal1=0.25#/
embed/viz/{Liveboard_id}/{visualization_id}`

+
If the per Org URL feature is enabled on your ThoughtSpot instance, the URL format will be:
+
`\https://{ThoughtSpot-host}/?embedApp=true&param1=Discount&paramVal1=0.25&OrgID=1#/
embed/viz/{Liveboard_id}/{visualization_id}`

+
**Search embed**
Expand All @@ -244,6 +257,21 @@ embed/viz/{Liveboard_id}/{visualization_id}`
The Natural Language Search component does not support runtime overrides.
====

== URL format with the per Org feature
If the per Org URL feature is enabled on your ThoughtSpot instance, a sample URL format will be:

*Liveboard embed*

`\https://{ThoughtSpot-Host}/?embedApp=true&OrgID=1#/embed/viz/{Liveboard_id}`

*Visualization embed*

`\https://{ThoughtSpot-Host}/?embedApp=true&OrgID=1#/embed/viz/{Liveboard_id}/{visualization_id}`

*Search Embed*

`\https://{ThoughtSpot-Host}/?embedApp=true&dataSources=["cd252e5c-b552-49a8-821d-3eadaa049cca"]&OrgID=1#/answer`

== Feature flags and query parameters to customize the embedded view

To customize ThoughtSpot components embedded in an iFrame, ThoughtSpot provides additional flags that you can pass as query parameters in the iFrame embedding URL.
Expand Down
50 changes: 49 additions & 1 deletion modules/ROOT/pages/orgs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -89,8 +89,56 @@ If a cluster administrator wants to perform a Create, Read, Update, or Delete (C
* The `Primary Org (Org 0)` is the default Org and cannot be deleted.
* Each Org is identified by a unique name and ID, and can have its own users and groups.
* Groups are unique to an Org and can be created only within the context of an Org.

////
* A user can belong to multiple Orgs and can switch between the Org context. At any given time, a user can only access objects and data in the Org they have logged into.
* A user from one Org cannot share an object with the users of another Org.
* A user not having access to multiple Orgs cannot share an object with the users of another Org.
////

====

=== Orgs context for sharing links
A user belonging to multiple Orgs can share ThoughtSpot objects such as Liveboards and Answers, with users of another Org. This will require the object to have share permissions, and both users to be part of the parent Org of the shared object.

==== Per Org URL

[earlyAccess eaBackground]#Early Access#

If the per Org URL feature is enabled on your ThoughtSpot instance, you can access shared objects such as Liveboards and Answers from multiple Orgs in different browser tabs.
For example, you can access a Liveboard from Org1 in one tab and open a shared object from Org2 in another browser tab.

To enable this feature on your instance, contact link:https://community.thoughtspot.com/customers/s/contactsupport[ThoughSpot Support, window=_blank]. When this feature is enabled, the Org ID will be shown in the ThoughtSpot object URL as a query parameter, as shown in the following example:

`\https://{ThoughtSpot-Host}/orgId=0/pinboard/22946f4b-b4ce-4643-be50-66afcd5177`

//If you are embedding content from multiple Orgs, you can set the `overrideOrgId` property in the SDK, if the per Org URL feature is enabled on your instance.
For more information, see link:https://docs.thoughtspot.com/cloud/latest/orgs-overview#_all_org_scope[ThoughtSpot product documentation, window=_blank].


==== Per Org custom embed URL (for custom link settings)

[earlyAccess eaBackground]#Early Access#

//With the current implementation, users belonging to multiple Orgs had to select the parent Org of a shared object from a list while trying to access it from a different Org.
Starting with ThoughtSpot Cloud 10.5.0.cl release, developers embedding ThoughtSpot in their application will be able to edit their custom link settings for their application users to allow seamless access to content from another different Org. For example, a user has
access to Org1, Org2 and Org3. While the user is logged in to Org1, they can access a Liveboard shared by another user in Org3 without using the Org switcher.

This feature is turned off by default. To enable this feature on your instance, contact link:https://community.thoughtspot.com/customers/s/contactsupport[ThoughSpot Support, window=_blank]. When this feature is enabled, the Org ID will be passed as an additional query parameter in the `{ts-query-param}` in the URL.
For example, if you have set the custom link as:

`\https://www.mysite.com/liveboard/{object-id}/?{ts-query-params}`

The resulting URL will be:

`\https://www.mysite.com/liveboard/22946f4b-b4ce-4643-be50-66afcd5177/orgId=0`

The Org ID will passed in the URL depending on the placement of `{ts-query-params}` in the custom URL.

//Customers can use this Org ID to access content between different Orgs by setting up the `overrideOrgId` in the SDK.

[NOTE]
====
The developers are advised to update their implementation to accommodate the Org ID in the `{ts-query-params}` while setting up the xref:https://developers.thoughtspot.com/docs/customize-links[custom links] for their application users. This will enable the users to seamlessly access ThoughtSpot objects across Orgs in a multi-Org setup, without causing any disruption to the current workflow.
====

== Feature availability on a multi-tenant instance
Expand Down
13 changes: 13 additions & 0 deletions modules/ROOT/pages/whats-new.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,19 @@ This page lists new features, enhancements, and deprecated functionality in Thou

== Version 10.5.0.cl

=== Migration to IAMv2
All new ThoughtSpot application instances are enabled with enhanced Identity and Access Management (IAMv2). The existing ThoughtSpot embedded instances will be migrated to IAMv2 during the maintenance windows.

* To ensure a seamless migration, review and follow the link:https://docs.thoughtspot.com/cloud/latest/okta-iam#_before_migrating_to_iam_v2[steps in the ThoughtSpot product documentation, window=_blank].
* To understand changes to the API endpoints with this upgrade, see xref:https://developers.thoughtspot.com/docs/api-user-management#_user_migration_to_iamv2[User migration to IAMv2]
* For more information, see link:https://docs.thoughtspot.com/cloud/latest/okta-iam[Identity and Access Management V2, window=_blank].

=== Orgs context for custom links
Starting with ThoughtSpot Cloud 10.5.0.cl release, developers embedding ThoughtSpot in their application can include the Org context in ThoughtSpot URLs using custom link settings.
//For instance, being able to seamlessly access content from a different Org, while being logged in another Org.

This feature is turned off by default. To enable this feature on your ThoughtSinstance, contact link:https://community.thoughtspot.com/customers/s/contactsupport[ThoughSpot Support, window=_blank]. For more information, see xref:orgs.adoc[Orgs context for sharing links].

=== Default search experience on embedded ThoughtSpot Home page
If your ThoughtSpot instance is being upgraded from 10.1.0.cl to 10.5.0.cl, note that the Natural Language Search is set as the default search experience on embedded ThoughtSpot Home page. The split search experience, which was introduced in 10.3.0.cl, will be turned off by default. For applications embedding full ThoughtSpot experience, the `isUnifiedSearchExperienceEnabled` property set to `true` in the Visual Embed SDK. Your application users can continue to use the unified experience until it is deprecated. Developers can choose to disable unified search experience and customize the home page search experience for their users.

Expand Down
Binary file modified static/doc-images/images/converseEmbed_default.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/doc-images/images/spotter-customization.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified static/doc-images/images/spotter-customization2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.