You can export an entire ThoughtSpot worksheet in a flat-file format. After optional modification, you can migrate it to a different cluster, or restore it to the same cluster.

In ThoughtSpot, you can download Worksheets to a flat file in yaml format, modify the file, and subsequently upload this file either to the same cluster, or to a different cluster. This mechanism supports several scenarios that you may encounter:

• Migrating from a development environment to a production environment by downloading the file from the development cluster and uploading the same file into the production cluster
• Implementing metadata changes outside ThoughtSpot UI, such as replacing the underlying tables for the entire table, or replacing a single column from one table with a column in another table
• Making bulk changes, such as mass renaming of objects defined by the worksheets, and managing duplicates

Note: Starting with ThoughtSpot release 6.3, ThoughtSpot Scriptable Worksheets are written in ThoughtSpot Modeling Language (TML). Files from version 6.3 and later have a .tml extension. However, you can import files from 6.2.1 and earlier, with a .yaml or .tsl extension, to 6.3 and later environments with no issue.

Prerequisites

You must have Edit permissions for the worksheet.

Export Worksheet

To export a worksheet, follow these steps:

1. Click Data on the top navigation bar.

2. Click the name of the worksheet you want to edit.

3. Click the ellipses (more options) menu in the upper-right side of the screen.

4. From the menu, select Export Worksheet.

   Here, we are downloading the Sales worksheet.

   

5. The worksheet downloads into your default directory.

   You can access the downloaded *.yaml file, named for your worksheet either through the file system manager, or by clicking on the name of the downloaded file in the left bottom corner of your Internet browser.

   

Working with the Worksheet yaml file

You can change the yaml file that represents the Worksheet by editing its content. See YAML Worksheet specification for the full syntax of the YAML file.

Update a Worksheet

To update an existing worksheet, follow these steps:

1. Click Data on the top navigation bar.

2. Click the name of the worksheet you want to edit.

3. Click the ellipsis (more options) menu in the upper-right side of the screen.

4. From the menu, select Update Worksheet from file.

   Here, we are uploading the edited Sales worksheet.

   

5. In the upload interface, click Browse your files.

   

6. In your file system, find and select the YAML file.

7. In the Update worksheet interface, click Upload.

   

8. If you constructed the Worksheet file correctly, the Upload Worksheet interface displays an Upload successfull message.

9. To examine the updated Worksheet, click Go to Worksheet.

   

Migrate a Worksheet

To migrate a Worksheet from one cluster to another, follow these steps:

1. Export the Worksheet you want to move, as in steps 1 to 5 of the Export Worksheet section above.

   The Worksheet remains on the original cluster as well, unless you delete it.

2. Navigate to the cluster you want to add the worksheet to.

3. Click Data on the top navigation bar.

4. Click the ellipsis (more options) menu in the upper-right side of the screen.

5. Select Create worksheet from file.

   

6. In the Create Worksheet interface, click Browse your files.

   

7. In your file system, find and select the YAML file.

8. Click Upload.

   

9. If you constructed the Worksheet file correctly, the Create Worksheet interface displays an Upload successful message.

10. To examine the new Worksheet, click Go to Worksheet.

    

Related Information

• Worksheet YAML specification