diff --git a/modules/ROOT/pages/access-control-sharing.adoc b/modules/ROOT/pages/access-control-sharing.adoc index 50723154b..783c7ebbe 100644 --- a/modules/ROOT/pages/access-control-sharing.adoc +++ b/modules/ROOT/pages/access-control-sharing.adoc @@ -31,11 +31,11 @@ image::./images/shareability_access.png[Shareability with groups and users] Users *do not see the group* that provides them access to a given piece of content (the same content could be shared to multiple groups they belong to, or to them directly as well), nor do they see who shared content to them individually, although they can see the *author* of any content. === Sharing content -ThoughtSpot users can share objects such as Liveboards, answers, tables, worksheets, and table columns. +ThoughtSpot users can share objects such as Liveboards, Answers, Tables, Models, Worksheets, and Table columns. Sharing provides either `read-only` or `edit` permissions on an object -When an object is shared, users can view all the data regardless of the permissions set at the parent object level. For example, a user can view a shared Liveboard without having access to its underlying worksheet or table from which the visualizations in the Liveboard are built. However, there are some features of a Liveboard, which do require at least `read-only` permissions to the underlying worksheet. +When an object is shared, users can view all the data regardless of the permissions set at the parent object level. For example, a user can view a shared Liveboard without having access to its underlying data source from which the visualizations in the Liveboard are built. However, there are some features of a Liveboard, which do require at least `read-only` permissions to the underlying data model. === Sharing visibility @@ -49,8 +49,7 @@ A user with *administrator* privileges can share any content to any user or grou image::./images/shareability_can_share_to.png[Shareability and group membership controls visibility] == Sharing via UI -Within the ThoughtSpot UI, there are buttons or menu items to trigger the sharing workflow for every type of object (link:https://docs.thoughtspot.com/cloud/latest/share-liveboards#share-liveboardpage[Liveboards, target=_blank] or link:https://docs.thoughtspot.com/cloud/latest/share-worksheets[worksheets, target=_blank] for example). - +Within the ThoughtSpot UI, there are buttons or menu items to trigger the sharing workflow for every type of object (link:https://docs.thoughtspot.com/cloud/latest/share-liveboards#share-liveboardpage[Liveboards, target=_blank] or link:https://docs.thoughtspot.com/cloud/latest/share-models[Models, target=_blank] for example). == Sharing via REST API The REST API v2 link:https://developers.thoughtspot.com/docs/restV2-playground?apiResourceId=http%2Fapi-endpoints%2Fsecurity%2Fassign-change-author[/security/metadata/share endpoint, target=_blank] is used to programmatically share content, or to remove any access. diff --git a/modules/ROOT/pages/code-samples.adoc b/modules/ROOT/pages/code-samples.adoc index a0d957f3a..620d3a4c0 100644 --- a/modules/ROOT/pages/code-samples.adoc +++ b/modules/ROOT/pages/code-samples.adoc @@ -372,8 +372,8 @@ See the following pages: == Additional resources * link:https://github.com/thoughtspot/visual-embed-sdk/blob/main/README.md[Visual Embed SDK GitHub respository, window=_blank] + -* link:https://github.com/thoughtspot/ts_rest_api_and_tml_tools[REST API and TML Python library and examples, window=_blank] + +* link:https://github.com/thoughtspot/thoughtspot_tml[TML Python library and examples, window=_blank] + * link:https://github.com/thoughtspot/ts_everywhere_resources[Visual Embed SDK examples, window=_blank] + -* xref:rest-api-reference.adoc[REST API Reference Guide] + +* xref:rest-api-v2-reference.adoc[REST API Reference] + * link:https://developers.thoughtspot.com/guides[Tutorials, window=_blank] + * xref:VisualEmbedSdk.adoc[Visual Embed SDK Reference Guide] + \ No newline at end of file diff --git a/modules/ROOT/pages/customize-css-styles.adoc b/modules/ROOT/pages/customize-css-styles.adoc index 12bfe2a78..c939592cf 100644 --- a/modules/ROOT/pages/customize-css-styles.adoc +++ b/modules/ROOT/pages/customize-css-styles.adoc @@ -19,11 +19,12 @@ The following example shows the supported variables: |Variable| Description |`--ts-var-root-background`| Background color of the Liveboard, visualization, Search, and Answer pages. -|`--ts-var-root-color`| Color of the text on application pages. +|`--ts-var-root-color`| Color of the text on application pages. + +This variable definition does not affect the object description text that appears on list pages such as *Liveboards* and *Answers*. |`--ts-var-root-secondary-color`| Color of the text on application pages. |`--ts-var-root-font-family`| Font type for the text on application pages. |`--ts-var-root-text-transform`|Text transformation specification for UI elements in the app. + -|`--ts-var-application-color`| Font color of the text on toggle buttons such as All, Answers, and Liveboards on the homepage, chart and table titles on the AI Answer page. +|`--ts-var-application-color`| Font color of the text on toggle buttons such as All, Answers, and Liveboards on the homepage, chart and table titles on the Answer page, and object titles on list pages such as *Liveboards* and *Answers*. |`--ts-var-segment-control-hover-background`| Background color of the toggle buttons to switch between All, Answers, and Liveboards on the homepage. |====== diff --git a/modules/ROOT/pages/customize-text-strings.adoc b/modules/ROOT/pages/customize-text-strings.adoc index d9b70bc88..007a8fba3 100644 --- a/modules/ROOT/pages/customize-text-strings.adoc +++ b/modules/ROOT/pages/customize-text-strings.adoc @@ -177,9 +177,11 @@ init({ }); ---- +//// For testing purposes, you can use the following URL: -`https://cdn.jsdelivr.net/gh/thoughtspot/custom-content-demo/string-ids.json` +`\https://cdn.jsdelivr.net/gh/thoughtspot/custom-content-demo/string-ids.json` +//// == Override common keywords and substrings diff --git a/modules/ROOT/pages/deploy-with-tml-apis.adoc b/modules/ROOT/pages/deploy-with-tml-apis.adoc index 064686dd4..dbbf47f18 100644 --- a/modules/ROOT/pages/deploy-with-tml-apis.adoc +++ b/modules/ROOT/pages/deploy-with-tml-apis.adoc @@ -81,7 +81,7 @@ The process for exporting TML files into source control is: . Use `/metadata/tml/export` endpoint in REST API v1 or v2.0 with `export_fqns=true` argument and `formmattype=YAML` to retrieve the TML of the object . Save the TML response strings to disk in a Git-enabled directory using a consistent name format -You can use the link:https://thoughtspot.github.io/cs_tools/tools/scriptability/[CS Tool Scriptibility, window=_blank] package for a pre-built tool for programmatic exporting or build your own equivalent using the link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python[thoughtspot_rest_api_v1 Python library, window=_blank]. +You can use the link:https://thoughtspot.github.io/cs_tools/scriptability/[CS Tools, window=_blank] package for a pre-built tool for programmatic exporting or build your own equivalent using the link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python[thoughtspot_rest_api_v1 Python library, window=_blank]. === Best practices with TML export API The `formattype` argument can be set to `YAML` or `JSON`. diff --git a/modules/ROOT/pages/embed-actions.adoc b/modules/ROOT/pages/embed-actions.adoc index b7587e859..915ab4485 100644 --- a/modules/ROOT/pages/embed-actions.adoc +++ b/modules/ROOT/pages/embed-actions.adoc @@ -252,5 +252,5 @@ embed.render(); == Additional resources [#standard-actions] -* xref:Action.doc[Action ID] +* xref:Action.adoc[Action ID] * xref:embed-action-ref.adoc[Action ID reference] diff --git a/modules/ROOT/pages/filters_overview.adoc b/modules/ROOT/pages/filters_overview.adoc index 6747e30b7..5dad232b0 100644 --- a/modules/ROOT/pages/filters_overview.adoc +++ b/modules/ROOT/pages/filters_overview.adoc @@ -29,7 +29,7 @@ All types of filters result in some form of `WHERE` clause being applied to the == RLS Rules -xref:rls-rulesl.adoc[RLS rules] are defined at the ThoughtSpot Table object level. +xref:rls-rules.adoc[RLS rules] are defined at the ThoughtSpot Table object level. Once in place, they always apply within the query generation layer. diff --git a/modules/ROOT/pages/git-rest-api-guide.adoc b/modules/ROOT/pages/git-rest-api-guide.adoc index 540971059..6cd46cd2c 100644 --- a/modules/ROOT/pages/git-rest-api-guide.adoc +++ b/modules/ROOT/pages/git-rest-api-guide.adoc @@ -16,7 +16,7 @@ The xref:version_control.adoc#moving-tml-changes-between-environments[basic proc The following sections describe how to use the version control REST APIs after completing xref:git-configuration.adoc[Git configuration] for a ThoughtSpot instance. -There is a complete implementation of all Git REST APIs available in the link:https://thoughtspot.github.io/cs_tools/tools/git/[CS Tools package, target=_blank] as well as link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python/blob/main/examples_v2/[example workflow scripts available in Python, target=_blank]. +There is a complete implementation of all Git REST APIs available in the link:https://thoughtspot.github.io/cs_tools/[CS Tools package, target=_blank] as well as link:https://github.com/thoughtspot/thoughtspot_rest_api_v1_python/blob/main/examples_v2/[example workflow scripts available in Python, target=_blank]. == Commit files The `/api/rest/2.0/vcs/git/branches/commit` API call exports the TML files for the requested ThoughtSpot objects directly to a Git branch and commits the changes. diff --git a/modules/ROOT/pages/intro-thoughtspot-objects.adoc b/modules/ROOT/pages/intro-thoughtspot-objects.adoc index 74dd78306..fed1bf2a8 100644 --- a/modules/ROOT/pages/intro-thoughtspot-objects.adoc +++ b/modules/ROOT/pages/intro-thoughtspot-objects.adoc @@ -18,7 +18,7 @@ image::./images/object_model_hierarchy.png[Object Model Hierarchy] == Data modeling You must create a data model comprising at least one link:https://docs.thoughtspot.com/cloud/latest/connections[connection, window=_blank] with one link:https://docs.thoughtspot.com/cloud/latest/connect-data[Table, window=_blank] to begin using link:https://docs.thoughtspot.com/cloud/latest/search-data[Search data, window=_blank] to create content. -Most often, there will be multiple *Tables*, with a variety of link:https://docs.thoughtspot.com/cloud/latest/tables-join[joins, window=_blank] defined in ThoughtSpot, with a link:https://docs.thoughtspot.com/cloud/latest/worksheet-create[Worksheet, window=_blank] or link:https://docs.thoughtspot.com/cloud/latest/models[Model, window=_blank] bringing those tables together into a presentable analytic data model for the end-users. +Most often, there will be multiple *Tables*, with a variety of link:https://docs.thoughtspot.com/cloud/latest/tables-join[joins, window=_blank] defined in ThoughtSpot, with a link:https://docs.thoughtspot.com/cloud/latest/models[Model, window=_blank] bringing those tables together into a presentable analytic data model for the end-users. Data engineers with *Can manage data* privilege can add connections either link:https://docs.thoughtspot.com/cloud/latest/connections[in the UI, window=_blank] or via xref:connections.adoc[REST API]. Connections are owned and accessible only to their creator, who then imports *Tables* from the connection. Once imported, tables can be shared with other Thoughtspot groups and users. @@ -26,7 +26,7 @@ Data engineers with *Can manage data* privilege can add connections either link: [NOTE] ==== -Models in ThoughtSpot application refer to an advanced version of Worksheets and is an Early Access feature. Like Worksheets, Models can be created in Data Workspace and used as a data object for content creation and data analytics. +Models in ThoughtSpot application refer to an advanced version of Worksheets and serve as data source objects for content creation and data analytics. In ThoughtSpot 10.12.0.cl and later release versions, Worksheets are deprecated and replaced with Models. ==== === Data modeling workflow @@ -128,5 +128,5 @@ Column and join objects with their own GUIDs do exist within the ThoughtSpot sys == Related resources * link:https://docs.thoughtspot.com/home/[ThoughtSpot product documentation, window=_blank] -* link:https://training.thoughtspot.com/path/data-expert-cloud[Data expert learning path, window=_blank] + diff --git a/modules/ROOT/pages/lazy-loading-fullheight.adoc b/modules/ROOT/pages/lazy-loading-fullheight.adoc index 514753ab3..c25954828 100644 --- a/modules/ROOT/pages/lazy-loading-fullheight.adoc +++ b/modules/ROOT/pages/lazy-loading-fullheight.adoc @@ -32,7 +32,7 @@ const embed = new LiveboardEmbed('#embed', { == Lazy loading with full height enabled -The `lazyLoadingForFullHeight` boolean parameter enables lazy loading of visualizations when `fullHeight` is `true`. When set to `true`, visualizations in the embedded Liveboard are loaded incrementally as the user scrolls, rather than all at once. This improves performance for large Liveboards by reducing initial load time and resource usage. +If `fullHeight` is enabled, you can use the `lazyLoadingForFullHeight` boolean parameter to enable lazy loading of visualizations. When both `fullHeight` and `lazyLoadingForFullHeight` are set to `true`, visualizations in the embedded Liveboard are loaded incrementally as the user scrolls, rather than all at once. This reduces initial load time and resource usage, and improves performance for large Liveboards. [source,JavaScript] ---- diff --git a/modules/ROOT/pages/mobilesdk-quick-start.adoc b/modules/ROOT/pages/mobilesdk-quick-start.adoc index ae9d896ed..668d5aee1 100644 --- a/modules/ROOT/pages/mobilesdk-quick-start.adoc +++ b/modules/ROOT/pages/mobilesdk-quick-start.adoc @@ -17,7 +17,7 @@ Before you begin, check the following: * link:https://docs.npmjs.com/downloading-and-installing-node-js-and-npm[NPM and Node.js are installed, window=_blank] on your system. * Your link:https://reactnative.dev/docs/environment-setup[React Native environment, window=_blank] is set up. * You can access a ThoughtSpot instance with administrator and developer credentials. + -Ensure that your host app embedding ThoughtSpot is added to the nxref:security-settings.adoc[CSP and CORS allowlists] in ThoughtSpot. +Ensure that your host app embedding ThoughtSpot is added to the xref:security-settings.adoc[CSP and CORS allowlists] in ThoughtSpot. * You have access to the Liveboard object that you want to embed * If you are using Expo to build your application: diff --git a/modules/ROOT/pages/orgs.adoc b/modules/ROOT/pages/orgs.adoc index 661b98b1c..ad659fbad 100644 --- a/modules/ROOT/pages/orgs.adoc +++ b/modules/ROOT/pages/orgs.adoc @@ -168,7 +168,8 @@ On an Orgs-enabled cluster, certain UI and API operations are allowed only at th a| [tag greenBackground tick]#✓# User creation and management + [tag greenBackground tick]#✓# User association to groups -|Groups and privileges| [tag greyBackground tick]#–# |__Groups and privilege configuration and management are restricted to Org context only.__ +|Group provisioning, Roles and privileges| [tag redBackground tick]#–# |[tag greenBackground tick]#✓# + +__Groups and privilege configuration and management are restricted to Org context only.__ |Authentication a| [tag greenBackground tick]#✓# Local authentication configuration + [tag greenBackground tick]#✓# Trusted authentication + @@ -186,52 +187,47 @@ __OIDC authentication is supported only if users are already created and mapped //// a| [tag greenBackground tick]#✓# Trusted authentication -|Access to `Develop` tab| [tag greenBackground tick]#✓# | [tag greenBackground tick]#✓# +|Access to `Develop` page| [tag greenBackground tick]#✓# | [tag greenBackground tick]#✓# + -__Access to the *Develop* tab at the Org level is disabled by default. To enable *Develop* tab and its features at the Org level, contact ThoughtSpot Support.__ |Security settings (CORS settings)| [tag greenBackground tick]#✓# | [tag greenBackground tick]#✓# -|Security settings (CSP settings)| [tag greenBackground tick]#✓# | [tag greyBackground tick]#–# -|Data connections and objects a| [tag greyBackground tick]#–# a|[tag greenBackground tick]#✓# Object creation and management + +|Security settings (CSP settings)| [tag greenBackground tick]#✓# | [tag redBackground tick]#–# +|Data connections and objects a| [tag redBackground tick]#–# a|[tag greenBackground tick]#✓# Object creation and management + [tag greenBackground tick]#✓# Data connection creation and management * __Cluster administrators can create and edit connections in any Org__. + * __Org administrators can create and edit their connections in their respective Orgs__. + -* __Starting from 9.0.0.cl, cluster administrators can share connections with Org administrators and also with users who have data management privileges. Org administrators cannot view or edit the connections created by the Cluster administrators if the connection object is not shared with them__. +* __Cluster administrators can share connections with Org administrators and also with users who have data management privileges. Org administrators cannot view or edit the connections created by the Cluster administrators if the connection object is not shared with them__. | Access control a| [tag greenBackground tick]#✓# Org creation for data isolation + [tag greenBackground tick]#✓# User mapping to Orgs + -a| [tag greenBackground tick]#✓# Groups and privilege assignment to users + +a| [tag greenBackground tick]#✓# Groups and privilege assignment to users + [tag greenBackground tick]#✓# Object sharing with other users and groups in the Org |Customization| [tag greenBackground tick]#✓# Custom domain configuration + [tag greenBackground tick]#✓# From ID customization for system notifications + -[tag greenBackground tick]#✓# Onboarding settings and welcome message customization |[tag greyBackground tick]#–#| +[tag greenBackground tick]#✓# Onboarding settings and welcome message customization |[tag redBackground tick]#–#| Style customization and CSS overrides | [tag greenBackground tick]#✓#| [tag greenBackground tick]#✓# + -__Style customization settings can be applied through the *Develop* > *Customizations* > *Style customizations* page. Alternatively, you can access Style customization from the Admin tab. +//Style customization settings can be applied through the *Develop* > *Customizations* > *Style customizations* page. Alternatively, you can access Style customization from the Admin tab. -Per-Org CSS overrides can be applied using the Visual Embed SDK. To enable this feature on your instance, contact ThoughtSpot Support. __ +__Per-Org CSS overrides can be applied using the CSS customization framework available with the Visual Embed SDK. __ -|Custom actions| [tag greyBackground tick]#–# | [tag greenBackground tick]#✓# + +|Custom actions| [tag redBackground tick]#–# | [tag greenBackground tick]#✓# + __Custom action creation and group association are supported by default at the Primary Org (Org 0) level. To enable action customization at the Org level, contact ThoughtSpot Support__ -|Link customization for embedded instances| [tag greyBackground tick]#–# | [tag greenBackground tick]#✓# + -__The Link customization feature is supported by default at the Primary Org (Org 0) level. To enable link customization at the Org level, contact ThoughtSpot Support.__ -|Developer Playground| [tag greyBackground tick]#–# |[tag greenBackground tick]#✓# + -__The Visual Embed and REST API Playgrounds are available by default at the Primary Org (Org 0) level. To enable Playground access at the Org level, contact ThoughtSpot Support.__ - +|Link customization for embedded instances| [tag greenBackground tick]#✓#| [tag greenBackground tick]#✓# +//The Link customization feature is supported by default at the Primary Org (Org 0) level. To enable link customization at the Org level, contact ThoughtSpot Support. +|REST API and Visual Embed Playgrounds|[tag redBackground tick]#–# |[tag greenBackground tick]#✓# +|REST API v2.0 endpoints | [tag greenBackground tick]#✓# Org endpoints for CRUD operations| [tag greenBackground tick]#✓# |REST API v1 operations a| [tag greenBackground tick]#✓# Org endpoints for CRUD operations + - -__Group provisioning and custom action group association API operations are not supported__. -a|__All API operations are supported except for the CRUD operations of Orgs__. -|REST API v2.0 endpoints | [tag greyBackground tick]#–#| [tag greenBackground tick]#✓# + -__For production use cases, ThoughtSpot recommends using REST API v1 endpoints__. +a|[tag greenBackground tick]#✓# |===== diff --git a/modules/ROOT/pages/rest-api-java-sdk.adoc b/modules/ROOT/pages/rest-api-java-sdk.adoc index 37012ddc2..3d435b50d 100644 --- a/modules/ROOT/pages/rest-api-java-sdk.adoc +++ b/modules/ROOT/pages/rest-api-java-sdk.adoc @@ -28,7 +28,7 @@ If you are using Maven, add the REST API Java SDK as a dependency to the POM.xml com.thoughtspot rest-api-sdk - 2.16.0 + 2.17.0 compile ---- @@ -42,7 +42,7 @@ If you are using Gradle, add the REST API Java SDK as a dependency to your build } dependencies { - implementation "com.thoughtspot:rest-api-sdk:2.16.0" + implementation "com.thoughtspot:rest-api-sdk:2.17.0" // Use the latest version of the SDK } ---- diff --git a/modules/ROOT/pages/rest-api-v2-metadata-search.adoc b/modules/ROOT/pages/rest-api-v2-metadata-search.adoc index 7d937ea49..ec205b935 100644 --- a/modules/ROOT/pages/rest-api-v2-metadata-search.adoc +++ b/modules/ROOT/pages/rest-api-v2-metadata-search.adoc @@ -3779,7 +3779,12 @@ Common use cases for the dependent objects include tagging, auditing proper shar The `include_stats` boolean option causes the `stats` key of the response to be filled with an object with statistics about user access to the object. === include_worksheet_search_assist_data -The `include_worksheet_search_assist_data` boolean parameter includes details about the link:https://docs.thoughtspot.com/cloud/latest/search-assist[Search Assist, target=_blank] feature within the response. +The `include_worksheet_search_assist_data` boolean parameter includes details about the Search Assist feature within the response. + +[NOTE] +==== +The Search Assist feature is a deprecated feature and is not available on ThoughtSpot instances from 10.4.0.cl onwards. +==== === Other include attributes The `metadata/search` response typically excludes objects that are `auto-created`, `hidden`, or `incomplete`, as these objects represent internal use cases typically not seen or modified by any end user. diff --git a/modules/ROOT/pages/rest-apiv2-changelog.adoc b/modules/ROOT/pages/rest-apiv2-changelog.adoc index f5a79eb85..73d678200 100644 --- a/modules/ROOT/pages/rest-apiv2-changelog.adoc +++ b/modules/ROOT/pages/rest-apiv2-changelog.adoc @@ -14,6 +14,7 @@ This changelog lists the features and enhancements introduced in REST API v2.0. The following API endpoints are now available: +//// Column security rules:: * `POST /api/rest/2.0/security/column/rules/update` + @@ -21,6 +22,7 @@ Updates column security rules for a given Table. * `POST /api/rest/2.0/security/column/rules/fetch` + Gets details of column security rules for the tables specified in the API request. +//// Custom calendar:: * `POST /api/rest/2.0/calendars/create` + diff --git a/modules/ROOT/pages/search-assist-tse.adoc b/modules/ROOT/pages/search-assist-tse.adoc index 9a535d785..2374f060a 100644 --- a/modules/ROOT/pages/search-assist-tse.adoc +++ b/modules/ROOT/pages/search-assist-tse.adoc @@ -6,6 +6,11 @@ :page-description: Search Assist on embedded instances :description: Enable Search Assist to demonstrate how to get construct your search query and view answers. +[IMPORTANT] +==== +Search Assist feature is deprecated and is not available in ThoughtSpot 10.4.0.cl and later versions. +==== + The Search Assist feature provides sample scenarios of searching data from a Worksheet. Your application users can use this feature to familiarize themselves with the search experience and get the answers they need. To enable the Search Assist walkthrough on an embedded instance, the following steps are required: @@ -59,6 +64,7 @@ Similarly, you can add keywords, such as *_product_* and *_this year_* to your s * Search Assist lessons can be configured only on worksheets. * To configure a Search Assist lesson on a Worksheet, make sure you have embedded the ThoughtSpot *Data* tab in your host app. +//// == Related resources * link:https://docs.thoughtspot.com/cloud/latest/search-assist-coach[Search Assist Coach, window=_blank] diff --git a/modules/ROOT/pages/tml.adoc b/modules/ROOT/pages/tml.adoc index f94b39392..8b7658b6e 100644 --- a/modules/ROOT/pages/tml.adoc +++ b/modules/ROOT/pages/tml.adoc @@ -25,11 +25,15 @@ See the following pages for the detailed syntax of TML files for each object typ * link:https://docs.thoughtspot.com/cloud/latest/tml-sql-views[TML for SQL Views, window=_blank] + * link:https://docs.thoughtspot.com/cloud/latest/tml-tables[TML for Tables, window=_blank] + * link:https://docs.thoughtspot.com/cloud/latest/tml-views[TML for Views, window=_blank] + -* link:https://docs.thoughtspot.com/cloud/latest/tml-worksheets[TML for Worksheets, window=_blank] + * link:https://docs.thoughtspot.com/cloud/latest/tml-models[TML for Models, window=_blank] + +* link:https://docs.thoughtspot.com/cloud/10.11.0.cl/tml-worksheets[TML for Worksheets, window=_blank] + For TML modification tips and recommendations, see xref:modify-tml.adoc[TML modification]. +[NOTE] +==== +Worksheets are deprecated in ThoughtSpot and replaced by Models from 10.12.0.cl onwards. +==== == TML import and export via REST API diff --git a/modules/ROOT/pages/user-api.adoc b/modules/ROOT/pages/user-api.adoc index 36e5bd19f..b2a284104 100644 --- a/modules/ROOT/pages/user-api.adoc +++ b/modules/ROOT/pages/user-api.adoc @@ -742,7 +742,7 @@ POST /tspublic/v1/user/activate |`userid`|__String__. The GUID of the user account to activate. |`auth_token`|__String__. The authentication token to reactivate the user account. |`password` |__String__. The password string for the user account. -|`properties`|__String__. User property string on the Base64 Encoded format. For example, if the user's email address is `UserA@thoughspot.com`, specify `VXNlckFAdGhvdWdoc3BvdC5jb20=` in the request body. +|`properties`|__String__. User property string on the Base64 Encoded format. For example, if the user's email address is `\UserA@thoughspot.com`, specify `VXNlckFAdGhvdWdoc3BvdC5jb20=` in the request body. |=== === Example request diff --git a/modules/ROOT/pages/vercel-int.adoc b/modules/ROOT/pages/vercel-int.adoc index b0ec58d84..1eb3ddaab 100644 --- a/modules/ROOT/pages/vercel-int.adoc +++ b/modules/ROOT/pages/vercel-int.adoc @@ -79,9 +79,9 @@ To continue with integration, check if your Vercel project is integrated with Po * If Postgres is integrated, ThoughtSpot will automatically create a connection to the existing Postgres databases in your project. + -With Postgres, you can either use an existing Worksheet available on your instance or create a Worksheet instantaneously. +With Postgres, you can either use an existing Worksheet available on your instance or create a Model instantaneously. + -Worksheets in ThoughtSpot refer to logical representation of data and are used to model complex datasets. To know more about Worksheets, see link:https://docs.thoughtspot.com/cloud/latest/worksheets[ThoughtSpot Product Documentation, window=_blank]. + +Models in ThoughtSpot refer to logical representation of data and are used to model complex datasets. For more information, see link:https://docs.thoughtspot.com/cloud/latest/models[ThoughtSpot Product Documentation, window=_blank]. + ** To analyze data from an existing Worksheet, click **Connect to existing Worksheets**. ** To create a connection and Worksheet, click **Create a new connection**. diff --git a/modules/ROOT/pages/webhooks.adoc b/modules/ROOT/pages/webhooks.adoc index 62c5c0dd1..7b751e19d 100644 --- a/modules/ROOT/pages/webhooks.adoc +++ b/modules/ROOT/pages/webhooks.adoc @@ -305,6 +305,5 @@ image::./images/failureAlert.png[Webhook failure notification] == Additional references * link:https://docs.thoughtspot.com/cloud/latest/monitor[Monitor alerts documentation, window=_blank] -* link:https://training.thoughtspot.com/kpi-monitor-alerts[KPI alerts training, window=_blank] diff --git a/modules/ROOT/pages/whats-new.adoc b/modules/ROOT/pages/whats-new.adoc index bf3a58a69..884ce8810 100644 --- a/modules/ROOT/pages/whats-new.adoc +++ b/modules/ROOT/pages/whats-new.adoc @@ -30,7 +30,7 @@ For more information, see xref:customize-css-styles.adoc#grp-style[CSS variables === Lazy loading of visualizations on a Liveboard -You can now enable lazy loading of Liveboard visualizations when the `fullHeight` property is enabled. When set to `true`, the visualizations in the embedded Liveboard are loaded incrementally as the user scrolls the Liveboard page. +To optimize initial load time, you can now enable lazy loading of Liveboard visualizations using the `lazyLoadingForFullHeight` parameter. When both `fullHeight` and `lazyLoadingForFullHeight` attributes are set to `true`, visualizations in the embedded Liveboard are loaded incrementally as the user scrolls, rather than all at once on initial load. For more information, see xref:lazy-loading-fullheight.adoc[Lazy loading of Liveboard visualizations]. diff --git a/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-intro.adoc b/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-intro.adoc index ed132aa5a..c2526f551 100644 --- a/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-intro.adoc +++ b/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-intro.adoc @@ -30,7 +30,7 @@ The examples in this tutorial use link:https://code.visualstudio.com/[Visual Stu * A web server that will host static web content (.html, .css, .js files). The examples in this tutorial use the Live Server plug-in for Visual Studio Code. * A basic understanding of ThoughtSpot. + -This can be obtained by taking introductory courses. For information about the courses you can take to learn the basics, see the link:https://training.thoughtspot.com[ThoughtSpot Training site, window=_blank] for courses. +This can be obtained by taking introductory courses. For information about the courses you can take to learn the basics, see the link:https://training.thoughtspot.com/[ThoughtSpot Training site, window=_blank] for courses. Ideally, you will have some experience with HTML and Javascript, but it's not required. diff --git a/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-lesson-02.adoc b/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-lesson-02.adoc index e69cd4ebd..82c2cefbf 100644 --- a/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-lesson-02.adoc +++ b/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-lesson-02.adoc @@ -63,9 +63,9 @@ The image above has three main sections: == Download the code -Before beginning, you should download the code from link:https://github.com/thoughtspot/tse-step-by-step/[GitHub, window=_blank]. The recommended approach is to use the link:https://github.com/git-guides/git-clone[`git clone`, window=_blank] command to make a local copy, perhaps after link:https://docs.github.com/en/get-started/quickstart/fork-a-repo[forking, window=_blank] the code base. If you don't want to take this route (or don't know what those commands are), you can download the code using the Download Zip option as shown in the following figure: +Before beginning, you should download the code from link:https://github.com/thoughtspot/tse-fundamentals-step-by-step[GitHub, window=_blank]. The recommended approach is to use the link:https://github.com/git-guides/git-clone[`git clone`, window=_blank] command to make a local copy, perhaps after link:https://docs.github.com/en/get-started/quickstart/fork-a-repo[forking, window=_blank] the code base. If you don't want to take this route (or don't know what those commands are), you can download the code using the Download Zip option as shown in the following figure: -`git clone https://github.com/thoughtspot/tse-step-by-step/` +`git clone https://github.com/thoughtspot/tse-fundamentals-step-by-step` [.widthAuto] [.bordered] diff --git a/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-lesson-11.adoc b/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-lesson-11.adoc index d04a1108d..210ed8613 100644 --- a/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-lesson-11.adoc +++ b/modules/tutorials/pages/tse-fundamentals/tse-fundamentals-lesson-11.adoc @@ -19,7 +19,7 @@ To learn about new features, check the link:https://developers.thoughtspot.com/d link:https://thoughtspot.github.io/cs_tools[CS Tools, window=_blank] is not technically part of ThoughtSpot Embedded. CS Tools is a community-supported set of open source tools that allow you to do things like extract usage information, automate TML activities, and more easily manage users, etc. -See the link:https://thoughtspot.github.io/cs_tools/tools/[list of tools, window=_blank] for the current capabilities. +See the link:https://thoughtspot.github.io/cs_tools/[list of tools, window=_blank] for the current capabilities. And if you are interested, you can even contribute ideas and code. [.widthAuto] diff --git a/src/assets/styles/index.scss b/src/assets/styles/index.scss index c5dccb4d0..37989f177 100644 --- a/src/assets/styles/index.scss +++ b/src/assets/styles/index.scss @@ -28,6 +28,20 @@ body { padding: $gutter; font-family: 'Optimo-Plain'; font-size: $font-size-normal; + overflow-y: hidden; + animation: display-transition 1s ease-out; +} + +@keyframes display-transition { + 0% { + opacity: 0; + } + 99%{ + opacity: 0; + } + 100% { + opacity: 1; + } } main { @@ -35,31 +49,28 @@ main { background-color: var(--body-background-color); } -main.withHeaderFooter { - padding-top: 64px; +main { display: flex; - min-height: 100vh; - overflow: hidden; + height: calc(100lvh - $header-height); } - - * { box-sizing: border-box; } -strong, b { - font-weight: bold; +strong, +b { + font-weight: bold; } .anchor { - display: block; - padding-top: 80px; /* height of sticky header */ - margin-top: -80px; + display: block; + padding-top: 80px; /* height of sticky header */ + margin-top: -80px; } .anchor-link { - scroll-margin: 120px; + scroll-margin: 120px; } a { @@ -103,9 +114,45 @@ a { /*end visited class*/ +.headerPlaceholder { + height: $header-height; +} + .introWrapper { display: flex; } + +.documentWrapperContainer { + height: calc(100lvh - $document-padding); + width: calc(100%); + overflow-y: auto; + + &:not(:last-child) { + margin-right: 4rem; + } +} + +.documentWrapperContainer::-webkit-scrollbar { + display: none; +} + +.docmapWrapper { + height: calc(100lvh - $document-padding); + padding: 10px $padding-md 80px $padding-md; + width: 25%; + overflow-y: auto; +} + +.docmapWrapper::-webkit-scrollbar { + display: none; +} + +.playgroundWrapper { + height: 100%; + width: 100%; + overflow-y: auto; +} + .pb-10 { padding-bottom: 10px; } @@ -113,7 +160,7 @@ a { // TODO : improve all this to use flex .restApiWrapper { width: 100%; - height: 100vh; + height: 100lvh; overflow: hidden; iframe { @@ -125,7 +172,7 @@ a { // in case header is loaded .withHeaderFooter .restApiWrapper { - height: calc(100vh - 65px); + height: 100%; } button { @@ -241,7 +288,6 @@ button { align-items: center; } - .earlyAccess { border-radius: $beta-border-radius; display: inline-flex; @@ -258,7 +304,6 @@ button { align-items: center; } - .blueBackground { background-color: $note-color; } @@ -633,12 +678,32 @@ a.anchor { border-radius: 4px; } -/* Scrollbar styling end*/ -@media screen and (min-width: 767px) and (max-width: 1024px) { - .documentBody { - width: calc(100% - 260px); +.documentBody { + width: 100%; + height: 100%; + overflow-x: auto; +} + +@media screen and (min-width: 1024px) and (max-width: 1300px) { + .docmapWrapper { + width: 35%; + } +} + +@media screen and (min-width: $tablet-resolution-min) and (max-width: $tablet-resolution-max) { + .docmapWrapper { + display: none; + } +} + +@media screen and (max-width: $tablet-resolution-max) { + .docmapWrapper { + display: none; } +} +/* Scrollbar styling end*/ +@media screen and (min-width: 767px) and (max-width: 1024px) { .homeBanner { display: none; } @@ -648,8 +713,12 @@ a.anchor { max-width: 100%; } - .documentWrapper { + .documentWrapperContainer { width: 100%; + + &:not(:last-child) { + margin-right: 0px; + } } .homeHeaderText { width: 100%; @@ -667,8 +736,38 @@ a.anchor { } } +@media screen and (max-width: $tablet-resolution-min) { + .documentWrapperContainer { + width: 100%; + overflow-x: auto; + + &:not(:last-child) { + margin-right: 0px; + } + + pre { + overflow-x: auto; + } + } +} + +@media screen and (max-width: $mobile-resolution-max) { + .documentWrapperContainer { + width: 100%; + overflow-x: auto; + + &:not(:last-child) { + margin-right: 0px; + } + + pre { + overflow-x: auto; + } + } +} + .leftNavContainer { - margin-top: 0; + height: -webkit-fill-available; } @media screen and (max-width: $mobile-resolution-max) { @@ -690,8 +789,8 @@ a.anchor { } .documentBody { - width: 100%; padding-left: 0; + padding-right: 0; } .homeHeaderText { @@ -723,10 +822,14 @@ a.anchor { .tableContainer { overflow: scroll; } + .leftNavContainer { + margin-top: 0px; + height: auto; + } } @media screen and (max-width: $mobile-resolution-max) { - main.withHeaderFooter { + main { flex-direction: column; } } @@ -894,7 +997,6 @@ a.anchor { } } - .document-body-wrapper { padding: 30px; } diff --git a/src/assets/styles/variables.scss b/src/assets/styles/variables.scss index 2f856750e..4b286002f 100644 --- a/src/assets/styles/variables.scss +++ b/src/assets/styles/variables.scss @@ -251,3 +251,5 @@ $tag-color-light: $lightgrey; --box-shadow-hover: 0 16px 20px 0 rgb(255 255 255 / 6%), 0 16px 20px 0 rgb(255 255 255 / 6%); } + +$header-height: 65px; diff --git a/src/components/DevDocTemplate/askDocs.tsx b/src/components/DevDocTemplate/askDocs.tsx index c6d9e3882..b7bcc7302 100644 --- a/src/components/DevDocTemplate/askDocs.tsx +++ b/src/components/DevDocTemplate/askDocs.tsx @@ -3,10 +3,11 @@ import React from 'react'; export const AskDocs = () => { return (