Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
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
7 changes: 3 additions & 4 deletions modules/ROOT/pages/access-control-sharing.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/code-samples.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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] +
5 changes: 3 additions & 2 deletions modules/ROOT/pages/customize-css-styles.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
|======

Expand Down
4 changes: 3 additions & 1 deletion modules/ROOT/pages/customize-text-strings.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/deploy-with-tml-apis.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/embed-actions.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
2 changes: 1 addition & 1 deletion modules/ROOT/pages/filters_overview.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/git-rest-api-guide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions modules/ROOT/pages/intro-thoughtspot-objects.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -18,15 +18,15 @@ 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.

*Tables* can have link:https://docs.thoughtspot.com/cloud/latest/security-rls[Row Level Security (RLS), window=_blank] rules that filter the data results based on the signed-in link:https://docs.thoughtspot.com/cloud/latest/user-management[username, window=_blank] or the link:https://docs.thoughtspot.com/cloud/latest/group-management[ThoughtSpot groups, window=_blank] to which the user belongs, and those rules apply to any *Worksheet* or *Model* that uses the *Table*.

[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
Expand Down Expand Up @@ -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]


2 changes: 1 addition & 1 deletion modules/ROOT/pages/lazy-loading-fullheight.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
----
Expand Down
2 changes: 1 addition & 1 deletion modules/ROOT/pages/mobilesdk-quick-start.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
38 changes: 17 additions & 21 deletions modules/ROOT/pages/orgs.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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 +
Expand All @@ -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]#✓#

|=====

Expand Down
4 changes: 2 additions & 2 deletions modules/ROOT/pages/rest-api-java-sdk.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ If you are using Maven, add the REST API Java SDK as a dependency to the POM.xml
<dependency>
<groupId>com.thoughtspot</groupId>
<artifactId>rest-api-sdk</artifactId>
<version>2.16.0</version>
<version>2.17.0</version>
<scope>compile</scope>
</dependency>
----
Expand All @@ -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
}
----
Expand Down
7 changes: 6 additions & 1 deletion modules/ROOT/pages/rest-api-v2-metadata-search.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Loading
Loading