Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
88 commits
Select commit Hold shift + click to select a range
7fc28ab
Update orgs.adoc
bryanthowell-ts Jan 26, 2026
1e146b0
Update embed-authentication.adoc
bryanthowell-ts Jan 26, 2026
6695b03
Update mcp-integration.adoc
bryanthowell-ts Jan 26, 2026
e68bd1b
typo fixes
ShashiSubramanya Jan 29, 2026
4aca084
Update development-and-deployment.adoc
bryanthowell-ts Feb 4, 2026
b424677
instances-and-orgs.png added
bryanthowell-ts Feb 4, 2026
b4a2ec6
Updated spacing
bryanthowell-ts Feb 4, 2026
1513be1
Delete static/doc-images/images/instances-and-orgs.png
bryanthowell-ts Feb 4, 2026
4f591f7
New version
bryanthowell-ts Feb 4, 2026
f09dd8d
Delete static/doc-images/images/instances-and-orgs.png
bryanthowell-ts Feb 4, 2026
864a35c
Instance and orgs diagram
bryanthowell-ts Feb 4, 2026
2f5d0b3
Update development-and-deployment.adoc
bryanthowell-ts Feb 4, 2026
522009b
Detail of how publishing and variables work
bryanthowell-ts Feb 5, 2026
e887175
multi-tenant deployment image
bryanthowell-ts Feb 5, 2026
a9933c5
Single tenant publishing diagram
bryanthowell-ts Feb 5, 2026
91e1059
single tenant deployment image
bryanthowell-ts Feb 5, 2026
884ab1c
Update development-and-deployment.adoc
bryanthowell-ts Feb 5, 2026
4ba31f6
Update development-and-deployment.adoc
bryanthowell-ts Feb 5, 2026
847ad68
Update mcp-integration.adoc
bryanthowell-ts Mar 9, 2026
84ab21a
Update orgs.adoc
bryanthowell-ts Mar 9, 2026
5332eaf
Update trusted-authentication.adoc
bryanthowell-ts Mar 9, 2026
088d0f7
Add files via upload
bryanthowell-ts Mar 9, 2026
2372179
Update trusted-authentication.adoc
bryanthowell-ts Mar 9, 2026
ad6a93c
Update just-in-time-provisioning.adoc
bryanthowell-ts Mar 9, 2026
8fd6f77
Update trusted-auth-token-request-service.adoc
bryanthowell-ts Mar 9, 2026
ecde225
Update trusted-auth-token-request-service.adoc
bryanthowell-ts Mar 9, 2026
eef8559
Update just-in-time-provisioning.adoc
bryanthowell-ts Mar 9, 2026
8c6877b
Update just-in-time-provisioning.adoc
bryanthowell-ts Mar 9, 2026
18c6925
Update just-in-time-provisioning.adoc
bryanthowell-ts Mar 9, 2026
4eb5432
Update trusted-authentication.adoc
bryanthowell-ts Mar 10, 2026
35bca42
Update just-in-time-provisioning.adoc
bryanthowell-ts Mar 10, 2026
5ace4a3
Update just-in-time-provisioning.adoc
bryanthowell-ts Mar 10, 2026
b657053
Update just-in-time-provisioning.adoc
bryanthowell-ts Mar 10, 2026
8a7ab37
Update just-in-time-provisioning.adoc
bryanthowell-ts Mar 10, 2026
52df955
Update development-and-deployment.adoc
bryanthowell-ts Mar 11, 2026
b0d2b74
Update variables.adoc
bryanthowell-ts Mar 11, 2026
8683593
Update nav.adoc
bryanthowell-ts Mar 11, 2026
acb419b
Update nav.adoc
bryanthowell-ts Mar 11, 2026
3fd9947
Update nav.adoc
bryanthowell-ts Mar 11, 2026
b0dc335
Update nav.adoc
bryanthowell-ts Mar 11, 2026
928db71
Merge pull request #430 from thoughtspot/main
bryanthowell-ts Mar 11, 2026
fd13cc6
Update nav.adoc
bryanthowell-ts Mar 11, 2026
1dedcfc
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 11, 2026
ab119f3
Update nav.adoc
bryanthowell-ts Mar 12, 2026
9e3bd23
Add files via upload
bryanthowell-ts Mar 12, 2026
861cfbf
Update development-and-deployment.adoc
bryanthowell-ts Mar 12, 2026
db38896
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 12, 2026
75c2aa1
fixed
ruchI9897 Mar 12, 2026
5b950bb
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 12, 2026
566d36d
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 12, 2026
43e820d
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 13, 2026
8adf651
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 13, 2026
15ff498
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 13, 2026
2b75a47
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 13, 2026
ee2ee85
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 13, 2026
49a9fb4
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 13, 2026
a1f5494
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 13, 2026
0167d52
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 13, 2026
042db81
typo fixes
ShashiSubramanya Mar 14, 2026
c3d3356
fixed
ruchI9897 Mar 12, 2026
77fdf88
edits
ShashiSubramanya Mar 14, 2026
a720ded
Update modify-tml.adoc
bryanthowell-ts Mar 16, 2026
cee2cb8
Update modify-tml.adoc
bryanthowell-ts Mar 16, 2026
2d778ee
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 16, 2026
9819d98
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 16, 2026
9d13d31
Update nav.adoc
bryanthowell-ts Mar 16, 2026
6103868
Create git-provider-integration.adoc
bryanthowell-ts Mar 16, 2026
aeab531
Update git-provider-integration.adoc
bryanthowell-ts Mar 16, 2026
15294e3
Update deploy-with-tml-apis.adoc
bryanthowell-ts Mar 16, 2026
d9e1284
Update git-provider-integration.adoc
bryanthowell-ts Mar 16, 2026
30bfc8d
Update git-rest-api-guide.adoc
bryanthowell-ts Mar 16, 2026
eefcc36
Update git-configuration.adoc
bryanthowell-ts Mar 16, 2026
77b4938
Update git-provider-integration.adoc
bryanthowell-ts Mar 16, 2026
091c1c7
Update git-provider-integration.adoc
bryanthowell-ts Mar 16, 2026
f05156d
Update git-provider-integration.adoc
bryanthowell-ts Mar 16, 2026
0cbad26
Update git-provider-integration.adoc
bryanthowell-ts Mar 16, 2026
3cd550c
Update git-provider-integration.adoc
bryanthowell-ts Mar 16, 2026
f361161
Add files via upload
bryanthowell-ts Mar 16, 2026
47bcc97
Update git-provider-integration.adoc
bryanthowell-ts Mar 16, 2026
193e81a
Update git-provider-integration.adoc
bryanthowell-ts Mar 16, 2026
9034fc9
typo fixes, xref and link updates
ShashiSubramanya Mar 17, 2026
4cd45f6
Merge branch 'main' into per-org-subdomain-1
ShashiSubramanya Mar 17, 2026
c82f0c1
api ref edit
ShashiSubramanya Mar 17, 2026
4b8dbcf
Merge pull request #407 from thoughtspot/sdlc_revamp_1
ShashiSubramanya Mar 17, 2026
ef55012
typo fixes and minor edits
ShashiSubramanya Mar 17, 2026
79a3c3a
Merge pull request #428 from thoughtspot/trusted-jit-updates
ShashiSubramanya Mar 17, 2026
0f38378
Merge pull request #401 from thoughtspot/per-org-subdomain-1
ShashiSubramanya Mar 17, 2026
c992dc9
broken link fixes, worksheet terminology fixes
ShashiSubramanya Mar 17, 2026
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
16 changes: 9 additions & 7 deletions modules/ROOT/pages/common/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@
***** link:{{navprefix}}/custom-action-payload[Callback response payload]
***** link:{{navprefix}}/edit-custom-action[Set the position of a custom action]
***** link:{{navprefix}}/add-action-viz[Add a local action to a visualization]
***** link:{{navprefix}}/add-action-worksheet[Add a local action to a worksheet]
***** link:{{navprefix}}/add-action-worksheet[Add a local action to a model]
**** link:{{navprefix}}/code-based-custom-action[Code based custom actions]
*** link:{{navprefix}}/customize-links[Customize links]
*** link:{{navprefix}}/set-locale[Customize locale]
Expand Down Expand Up @@ -236,16 +236,18 @@ include::generated/typedoc/CustomSideNav.adoc[]
* link:{{navprefix}}/development-and-deployment[Deployment and integration]
** link:{{navprefix}}/development-and-deployment[Development and deployment]
*** link:{{navprefix}}/thoughtspot-objects[ThoughtSpot objects overview]
*** link:{{navprefix}}/variables[Custom variables]
*** link:{{navprefix}}/git-integration[Deploy with Git]
**** link:{{navprefix}}/git-configuration[Configure Git integration]
**** link:{{navprefix}}/git-api[Version Control REST APIs]
**** link:{{navprefix}}/guid-mapping[GUID mapping]
*** link:{{navprefix}}/variables[Variables]
*** link:{{navprefix}}/parameterze-metdata[Parameterize metadata]
*** link:{{navprefix}}/deploy-with-tml-apis[Deploy with TML APIs]
**** link:{{navprefix}}/git-provider-integration[Git provider integration]
**** link:{{navprefix}}/modify-tml[TML modification]
*** link:{{navprefix}}/publish-data-overview[Publish content to Orgs]
**** link:{{navprefix}}/parameterze-metdata[Parameterize metadata]
**** link:{{navprefix}}/publish-to-orgs[Publish objects to Orgs]
*** link:{{navprefix}}/git-integration[Deploy with GitHub APIs (legacy)]
**** link:{{navprefix}}/git-configuration[Configure GitHub integration]
**** link:{{navprefix}}/git-api[GitHub REST APIs]
**** link:{{navprefix}}/guid-mapping[GUID mapping]


** link:{{navprefix}}/multi-tenancy[Multi-tenancy]
*** link:{{navprefix}}/orgs[Multi-tenancy with Orgs]
Expand Down
434 changes: 221 additions & 213 deletions modules/ROOT/pages/deploy-with-tml-apis.adoc

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion modules/ROOT/pages/deprecated-features.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ Use the new version of REST API v2.0 endpoints and SDK versions available for th

==== Documentation
Starting from 9.0.0.cl, the API documentation for the REST API v2 [beta betaBackground]^Beta^ endpoints will not be accessible from the REST API Playground in ThoughtSpot.
For information about the REST API v2 [beta betaBackground]^Beta^ endpoints, see xref:rest-api-v2-reference-beta.adoc[REST API v2 ^Beta^ reference].
//For information about the REST API v2 [beta betaBackground]^Beta^ endpoints, see xref:rest-api-v2-reference-beta.adoc[REST API v2 ^Beta^ reference].

Recommended action::
For information about REST API v2.0 endpoints, refer to the following articles and visit the link:{{navprefix}}/restV2-playground?apiResourceId=http%2Fgetting-started%2Fintroduction[REST API v2 Playground].
Expand Down
98 changes: 87 additions & 11 deletions modules/ROOT/pages/development-and-deployment.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,31 +12,99 @@ ThoughtSpot instances act as a constantly running service, so xref:development-a

ThoughtSpot provides numerous tools for building a structured deployment process, built around the link:https://docs.thoughtspot.com/cloud/latest/tml[ThoughtSpot Modeling Language (TML), window=_blank] format for representing the xref:intro-thoughtspot-objects.adoc[objects within ThoughtSpot].

== Best practices
The primary tool for structured development and deployment in ThoughtSpot is called xref:orgs.adoc[Orgs].
== Overview
ThoughtSpot may provision your organization one or more separate *instances*, each with an individual URL.

Each Org in ThoughtSpot can be xref:version_control.adoc[paired] to a link:https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches[branch, target=_blank] in a link:https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories[Git repository, target=_blank] as a single *environment*.
Within a ThoughtSpot instance, the administrator of the Primary Org can create any number of logical tenants called xref:orgs.adoc[Orgs].

xref:orgs.adoc[Orgs] are fully separated tenants on a single ThoughtSpot instance. For TSE customers and others who need a structured development and deployment process, Orgs should always be enabled.

Once your environments are configured, you can xref:version_control.adoc#moving-tml-changes-between-environments[move data models and content] from the initial "dev environment" to any other environment using the xref:git-rest-api-guide.adoc[Git integration REST APIs].
image::./images/instances_and_orgs.png[Instances and Orgs]

By setting the `xref:intro-thoughtspot-objects.adoc#object-identifiers[obj_id]` property of objects, objects in various Orgs that are related copies of one another will have the same `obj_id`, allowing for tracking related objects and updating them without concern for each object's unique GUID.

[NOTE]
====
ThoughtSpot does not recommend TML export and import across different versions of ThoughtSpot application because the TML syntax, supported features, and object schemas can vary between releases and can sometimes lead to compatibility issues and validation errors.
ThoughtSpot does not recommend TML export and import from a *newer version* of ThoughtSpot to an instance on a *previous version*, because the TML syntax, supported features, and object schemas can vary between releases and can sometimes lead to compatibility issues and validation errors.
====

== Version Control
*Version control* is the process of tracking changes that occur to objects in ThoughtSpot.

A single branch in Git can be used for version control of a single Org in ThoughtSpot.

ThoughtSpot provides a GitHub-based link:https://docs.thoughtspot.com/cloud/10.15.0.cl/git-version-control[automated version control in the UI] for Liveboards and answers or a customized process can be built using the TML Export API to any Git provider.

It is best to use separate branches or even repositories for the UI automated version control and direct REST API processes.

When using the TML REST APIs and a Git provider, you can also implement version control branches, but they should be separate from the "deploy branches":

image::./images/version-control-branches.png[version control branches diagram]

It is important to have a version control branch for any "prod" Orgs with end user created content, which otherwise will not be archived in any way.

== Deployment
*Deployment* is the process of *making copies of objects* from one Org to another Org.

Deployment is used in the process of building a *release* from a *dev Org* and then deploying copies of the release objects via TML to *test*, *uat*, and eventual *prod* Orgs.

The TML Export and Import APIs allow customizable release and deployment processes to integrate with any Git provider.

The standard deployment pattern for a xref:multi-tenancy-intro.adoc[multi-tenanted prod database] is shown below. RLS rules will filter the shared data models on the "prod" Org so that standard LBs and Answers only show the right data for each end customer, who are all only added as users to the "prod" Org.

image::./images/multi_tenant_deployment.png[Multi-tenant Database Deployment SDLC Pattern]

In a scenario where xref:single-tenant-data-models.adoc[end customer databases are single-tenanted], an Org can be created programmatically matching with the level of tenant separation, so that there is an Org representing each separate logical database.

There are two techniques for managing Orgs for single-tenanted databases:

* Publishing [beta betaBackground]^Beta^
* Deploy to each Org using TML Import

== Publishing

*xref:publishing-overview.adoc[Publishing]* makes objects available in other Orgs without making copies.

Variables can be set at the Org level to override the Connection and Table object details for Publishing objects when they are accessed in a specific Org. Variables for connections and tables work with both Publishing and TML Import.

image::./images/publishing_diagram.png[Publishing and Variables]

With single-tenanted prod Orgs, the *Publishing* feature allows the final deployment step to import TML into the *publisher* Org, updating the *Published* objects, which instantly updates the objects in every Org the objects are published to.

image::./images/single_tenant_publishing.png[Publishing to Single-Tenants]

If there are structural differences within the various databases that make Publishing unviable, the TML Import process can be used to deploy unique copies of the release TML into each Org. This process may also include modifying the release TML to introduce variation into the objects that are deployed.

image::./images/single_tenant_deployment.png[Individual Deployment to Single-Tenants]




////
Each Org in ThoughtSpot can be xref:version_control.adoc[paired] to a link:https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches[branch, target=_blank] in a link:https://docs.github.com/en/repositories/creating-and-managing-repositories/about-repositories[Git repository, target=_blank] as a single *environment*.
////

////
Once your environments are configured, you can xref:version_control.adoc#moving-tml-changes-between-environments[move data models and content] from the initial "dev environment" to any other environment using the xref:git-rest-api-guide.adoc[Git integration REST APIs].
////



////
If you have used ThoughtSpot for a long time and are enabling Orgs for the first time, please see xref:moving-to-orgs.adoc[moving to Orgs from single-tenant ThoughtSpot instance].
////
== Standard structure of Orgs
////
== Typical Orgs pattern for SDLC
When Orgs are enabled, the *Primary Org* (`org_id: 0`) should be treated as the "root" or "super-admin" Org, and all "real content" should exist on Orgs other than the Primary.

Additionally, the *Primary Org* is the only Org where *Published* objects can originate, so *Primary* serves as the *Publisher* Org within SDLC flows that involve Publishing.

The most basic standard configuration for separated development and deployment, with a xref:multi-tenancy-best-practices.adoc[multi-tenanted "prod" environment], has the following environments:

- *Primary*: only used for administration of instance and Orgs themselves
- *Dev*: ThoughtSpot customer internal development team builds data models and standard Liveboards and Answers
- *Prod*: Data models and standard content are published to this environment by service account. All end customers get READ-ONLY access to data models, standard Liveboards, and Answers.
- *dev*: ThoughtSpot customer internal development team builds data models and standard Liveboards and Answers
- *test*:
- *prod*: Data models and standard content are published to this environment by service account. All end customers get READ-ONLY access to data models, standard Liveboards, and Answers.

image::./images/multi-tenanted_prod_deployment.png[Multi-tenanted prod deployment model]

Expand All @@ -47,20 +115,25 @@ RLS filters the shared data models on the "prod" Org so that standard LBs and An
If the production end customer data models are xref:single-tenant-data-models.adoc[single-tenanted (logical separation for each end customer)], such that a different connection is necessary), then the standard deployment involves a "release"/"pre-prod" Org and then one prod Org per end customer.

image::./images/single-tenant_prod_per_customer.png[Single-tenant final deployment model]

////
////
=== Additional "typical" Orgs

- *Test*, *UAT*: Additional steps in the publishing process between Dev and Prod, for verification before changes are deployed into Prod
- *Internal Org(s)*: Org(s) for ThoughtSpot customer's own business work, never to be shared with end customers
- Separate *'dev' instance*: Some people want a fully separated environment for dev, especially if doing MAJOR changes, even to cluster config. Recommend there be a 'Test Org' on the 'Prod Instance' to push to first, before pushing to 'Prod'
- Separate *regional instances*: prod per customer Orgs may extend to multiple ThoughtSpot instances in different regional cloud data centers
////

////
[#deploy-between-environments]
== Deploying content between environments
////

The workflow for a very simple "dev" to "prod" flow on the same environment shown here, is the same pattern for any source-to-destination environment flow:

image::./images/development-deployment-process.png[Development and deployment workflow]
////

////
=== Git deployment
The xref:version_control.adoc[Git REST APIs] are designed for the best practice pattern of building on a Dev Org and then deploying to any number of Orgs through Prod(s).
Expand All @@ -74,9 +147,12 @@ You will need a xref:guid-mapping.adoc[GUID Mapping file] that records the `orig

== Multi-tenancy and data security
The exact deployment pattern chosen will depend on the design of your data warehouse. Please see the xref:multi-tenancy-intro.adoc[full documentation on multi-tenancy within ThoughtSpot] to determine which deployment pattern best fits your needs.
////

////
== Publishing content to Orgs within a ThoughtSpot instance

Starting with the 10.10.0.cl release, ThoughtSpot provides the ability to parameterize object properties using variables for each Org and publish objects directly from the Primary Org to other Orgs on a multi-tenant instance. The publishing feature [beta betaBackground]^Beta^ enables administrators to create a single main object in the Primary Org and distribute it to other Orgs within the instance.

For more information, see xref:publishing-overview.adoc[Publishing content to Orgs].
For more information, see xref:publishing-overview.adoc[Publishing content to Orgs].
////
9 changes: 7 additions & 2 deletions modules/ROOT/pages/embed-authentication.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ a| Do not use this method if you don’t want the SDK to redirect your entire ap
* This authentication will fail if multifactor authentication (MFA) is enabled on your ThoughtSpot instance. Contact https://community.thoughtspot.com/customers/s/login/?ec=302&startURL=%2Fcustomers%2Fs%2Fcontactsupport[ThoughtSpot Support] for assistance.
|=====

[NOTE]
====
xref:orgs.adoc#per-org-subdomain[Per Org Subdomain] can be enabled to allow Orgs with different IdPs to be identified properly within the authentication flows triggered by the Visual Embed SDK.
====

== User accounts
Many ThoughtSpot features are tied to individual user accounts with a valid email address. xref:just-in-time-provisioning.adoc[Just-In-Time Provisioning] and user management REST APIs make it easy to create and update user accounts as part of the SSO process.

Expand Down Expand Up @@ -218,7 +223,7 @@ The `init` method returns an event emitter, which you can use to listen to `Auth

[source,TypeScript]
----
authStatus = init(embedConfig); authStatus.on(AuthStatus.FAILURE, (reason) => {
const authStatus = init(embedConfig); authStatus.on(AuthStatus.FAILURE, (reason) => {
console.log('Authentication failed');
});
----
Expand Down Expand Up @@ -267,7 +272,7 @@ import { logout } from "@thoughtspot/visual-embed-sdk";
logout();
----

The `logout` function returns a promise that resolves when the user is logged out of ThoughtSpot. When you call `logout`, the `autoLogin` attribute is set to `false` to prevent the SDK from automatically logging in the user again. If you do not want to disable `autoLogin`, set the `doNotDisableAutoLogin` parameter to `false`.
The `logout` function returns a promise that resolves when the user is logged out of ThoughtSpot. When you call `logout`, the `autoLogin` attribute is set to `false` to prevent the SDK from automatically logging in the user again. If you do not want to disable `autoLogin`, set the `doNotDisableAutoLogin` parameter to `true`.

You can also call `init` again with the `autoLogin` property set to `true` to re-login a user.

Loading
Loading