Merge pull request #236 from thoughtspot/10-5-0

10.5.0.cl docs

modules/ROOT/pages/api-changelog.adoc

@@ -8,6 +8,21 @@
 
 This changelog lists only the changes introduced in the Visual Embed SDK. For information about new features and enhancements available for embedded analytics, see xref:whats-new.adoc[What's New].
 
+== Version 1.35.0, December 2024
+
+[width="100%" cols="1,4"]
+|====
+|[tag greenBackground]#NEW FEATURE#  a|
+The SDK now provides the `isUnifiedSearchExperienceEnabled` setting to customize the Search experience on ThoughtSpot Home page for embedding application users:
+
+* When set to `true`, the split search experience is disabled and the Search bar on the Home page functions as Natural Language Search interface
+* When set to `false`, the split search experience is enabled and object Search is set as the default Home page search experience.
+
+For more information, see xref:full-app-customize.adoc#_search_components[Search interface on the Home page in full application embedding].
+
+|[tag greenBackground]#NEW FEATURE#  a| The `overrideOrgId` parameter in the SDK provides the ability to override Org context for embedding application users. This parameter allows users authenticated to an Org to temporarily view content from another Org. Before specifying the Org ID for override, make sure the Per Org URL feature is enabled on your ThoughtSpot instance. To enable Per Org URL on your instance, contact ThoughtSpot Support.
+|====
+
 == Version 1.34.0, November 2024
 
 [width="100%" cols="1,4"]

modules/ROOT/pages/authentication.adoc

@@ -551,14 +551,12 @@ __Optional__|__Integer__. If the Orgs feature is enabled on your instance, speci
 * `APPEND` +
 Adds the attributes defined in the API request to the user’s user properties. These properties will be applied to user sessions and for scheduled jobs if any.
 
-
 * `NONE` +
 The security entitlements assigned via attributes will be used only for the user session initiated with the token generated from this API call.
 
 * `REPLACE` +
 Available from 10.5.0.cl. Replaces existing user properties of the user with the attributes defined in this API request.
 
-
 * `RESET` +
 Resets the user properties assigned to a user upon token generation.
 

modules/ROOT/pages/customize-links.adoc

@@ -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.
@@ -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
@@ -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.
@@ -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]
@@ -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.
+////

modules/ROOT/pages/data-report-v2-api.adoc

@@ -198,6 +198,11 @@ In the `POST` request body, specify the GUID or name of the Liveboard as `metada
 The default `file_format` is CSV. For PDF and PNG file format, you can specify additional parameters to customize the page orientation and include or exclude the cover page, logo, footer text, and page numbers.
 For PNG file format, you can include cover page and filters.
 
+[NOTE]
+====
+The downloadable file returned in API response file is extensionless. You need to rename the downloaded file by typing in the relevant extension.
+====
+
 .**Example**
 [source,cURL]
 ----
@@ -276,6 +281,12 @@ curl -X POST \
 }'
 ----
 
+[NOTE]
+====
+* The downloadable file returned in API response file is extensionless. You need to rename the downloaded file by typing in the relevant extension.
+* HTML rendering is not supported for PDF exports of Answers with tables.
+====
+
 == Pagination settings for Data and Report APIs
 
 When you make REST API calls to some v2 Data endpoints to query data, the API may return many rows of data in response. By default, the following parameters are set in API requests to the v2 Data API endpoints:

modules/ROOT/pages/embed-authentication.adoc

@@ -14,41 +14,43 @@ This section describes the authentication methods supported in the SDK and when
 
 The following figure shows the authentication methods best suited for production use cases:
 
-image:./images/auth-type-embed.svg[Embed authentication types]
+[.widthAuto]
+image:./images/auth-type-embed.png[Embed authentication types]
 
 The following table lists the general recommendations for choosing an authentication method to authenticate embedded application users.
 
 [width="100%" cols="4,4,6,6"]
 [options='header']
 |=====
-|Authentication type|AuthType in SDK|When to use|Not recommended
-|xref:embed-authentication.adoc#embedSSO[Embedded SSO authentication] (Recommended) |`AuthType.EmbeddedSSO` a| Use this method: +
+|Authentication type|AuthType in SDK|When to use|Not recommended scenarios
 
-* If your application is already using a SAML IdP or OpenID provider that allows iframe redirects.
-* If your ThoughtSpot instance has SAML or OIDC authentication support configured.
-* To seamlessly redirect your users to their IdP within the embedded iframe for authentication.
-
-a|ThoughtSpot does not recommend using Embedded SSO authentication in the following scenarios: +
+.2+|xref:embed-authentication.adoc#trusted-auth-embed[Trusted authentication]
 
-* If you are using multiple IdPs for user authentication. +
-* If you cannot configure your IdP to allow iframe redirect. +
+|`AuthType.TrustedAuthTokenCookieless`
+(Recommended) a|  Use this authentication type to implement cookieless authentication if your Web browsers block third-party cookies.
 
+a|Do not use this method if you don’t have an app backend component to host the authentication server needed for trusted authentication.
 
-.2+|xref:embed-authentication.adoc#trusted-auth-embed[Trusted authentication]|`AuthType.TrustedAuthToken` a|Use this method: +
+|`AuthType.TrustedAuthToken` a|Use this method: +
 
 * If your IdP setup does not support Embedded SSO authentication.
 * If you want your users that do not exist in your IdP to authenticate to ThoughtSpot.
 * If you are using multiple IdPs, and you do not have IdP federation.
 
 a|ThoughtSpot does not recommend using trusted authentication in the following scenarios: +
 
-* If you want to and can implement a simple solution with Embedded SSO authentication.
-* If you don’t have an app backend component to host the authentication server needed for trusted authentication.
+If you don’t have an app backend component to host the authentication server needed for trusted authentication.
 
+|xref:embed-authentication.adoc#embedSSO[Embedded SSO authentication] |`AuthType.EmbeddedSSO` a| Use this method: +
 
-|`AuthType.TrustedAuthTokenCookieless` a| Use this authentication type to implement cookieless authentication if your Web browsers block third-party cookies.
+* If your application is already using a SAML IdP or OpenID provider that allows iframe redirects.
+* If your ThoughtSpot instance has SAML or OIDC authentication support configured.
+* To seamlessly redirect your users to their IdP within the embedded iframe for authentication.
 
-a|Do not use this method if you don’t have an app backend component to host the authentication server needed for trusted authentication.
+a|ThoughtSpot does not recommend using Embedded SSO authentication in the following scenarios: +
+
+* If you are using multiple IdPs for user authentication. +
+* If you cannot configure your IdP to allow iframe redirect. +
 
 |xref:embed-authentication.adoc#saml-sso-embed[SAMLRedirect authentication]|`AuthType.SAMLRedirect` a|Use this method if your application uses a SAML IdP that does not natively support embedding.
 a|Do not use this method if you don't want the SDK to redirect your entire app to the IdP for user authentication when the embedded content loads. For example, you may want to seamlessly authenticate users without multiple redirects to the IdP.
@@ -74,6 +76,13 @@ For some situations, shared *customer-level* or *role-level* accounts may be mor
 
 *Public access* can be achieved by creating a dedicated *public user account* with tightly defined access control. Any of the authentication methods can be used for the public user account.
 
+[#trusted-auth-embed]
+== Trusted authentication
+
+In the trusted authentication method, a security token is required to authenticate users who request access to the embedded ThoughtSpot content. For trusted authentication, you will require a token request service, which can securely authenticate your application users.
+
+For more information, see xref:trusted-authentication.adoc[Trusted authentication].
+
 [#embedSSO]
 == Embedded SSO authentication
 
@@ -87,14 +96,6 @@ init({
 });
 ----
 
-[#trusted-auth-embed]
-== Trusted authentication
-
-In the trusted authentication method, a security token is required to authenticate users who request access to the embedded ThoughtSpot content. For trusted authentication, you will require a token request service, which can securely authenticate your application users.
-
-For more information, see xref:trusted-authentication.adoc[Trusted authentication].
-
-
 [#saml-sso-embed]
 == SAMLRedirect authentication
 If your IdP supports SAML SSO to authenticate and does not support iFrame redirects, you can configure the `SAMLRedirect` auth type to authenticate your embedded application users. If this authentication method is enabled, the SDK redirects your app to the IdP login page for user authentication when the embedded content loads.
@@ -162,10 +163,9 @@ Optionally, you can configure a `redirectPath` string to redirect embed users to
 redirectPath: "/dashboard"
 ----
 
-
 [#none]
 == No authentication (pass-through) method
-If your application already uses an IdP to authenticate users and allows iframe embedding, and your ThoughtSpot instance has SAML or OIDC configured, you can set the `authType` attribute to `None`. The `None` authentication method can leverage user authentication taking place outside of the embedded application context. The SDK won't do additional authentication and acts as a pass-through.
+If your application already uses an IdP to authenticate users and allows iframe embedding, and your ThoughtSpot instance has SAML or OIDC configured, you can set the `authType` attribute to `None`. The `None` authentication method can leverage user authentication taking place outside  the embedded application context. The SDK won't do additional authentication and acts as a pass-through.
 
 [source,javascript]
 ----
@@ -175,6 +175,12 @@ init({
 });
 ----
 
+[NOTE]
+====
+* This `AuthType.None` authentication method is not recommended for Production use cases.
+* Many web browsers do not support third-party cookies. Due to this, cookies will no longer be shared across the embed and the host application, or other tabs in the browser. Developers using this authentication method in development or test environments must xref:security-settings.adoc#_enable_partitioned_cookies[enable partitioned cookies] on the *Develop* > *Security settings* page. On browsers supporting partitioned cookies, the login cookie will persist in the app after a successful login. Therefore, the `AuthType.None` authentication method requires logging into the embedded application through Basic Authentication.
+====
+
 [#basic-auth-embed]
 == Basic authentication
 
@@ -202,7 +208,6 @@ init({
 ThoughtSpot does not recommend this authentication method for production environments.
 ====
 
-
 == Authentication errors and event handling
 
 The user authentication may fail due to an incomplete SSO login process, expired user session, SDK initialization error, or if the browser has blocked third-party cookies.

modules/ROOT/pages/embed-spotter.adoc

@@ -156,7 +156,7 @@ When customizing icons, ensure that the hosting server is added to to the *CSP c
 
 ==== Customize menu elements
 
-You can show or hide menu elements such as the *Pin*, *Save* buttons on the Spotter page using xref:embed-actions.adoc[`disabledActions`, `visibleActions`, or `hiddenActions`] array as shown in this example:
+You can show or hide menu elements such as the *Pin*, *Save*, and *Download* buttons, and chart switcher icon on the Spotter page using xref:embed-actions.adoc[`disabledActions`, `visibleActions`, or `hiddenActions`] array as shown in this example:
 
 [source,JavaScript]
 ----
@@ -166,7 +166,7 @@ You can show or hide menu elements such as the *Pin*, *Save* buttons on the Spot
 
 [NOTE]
 ====
-In ThoughtSpot 10.4.0.cl release, you can hide or disable only *Pin* and *Save* menu actions on the Spotter page.
+Action enumerators to show, disable, or hide menu elements such as *Preview data*, *Reset*, feedback widget, and the edit and delete icons on the Spotter page are not available in Visual Embed SDK for ThoughtSpot 10.5.0.cl release.
 ====
 
 === Register, handle, and trigger events