TML for Worksheets

Use TML to modify a ThoughtSpot object in a flat-file format. Then, migrate the object to a different cluster, or restore it to the same cluster.

To work with TML files for Worksheets, you can download these objects to flat files in .TML format, modify the files, and subsequently upload the files either to the same cluster, or to a different cluster. To learn how to export, change, and update Worksheets, see Import and export TML files.

The syntax examples in this article contain every possible parameter in TML files for Worksheets. Some of these parameters are not in these files by default. If you want to use them, you must add them yourself. For example, the fqn parameter is not present in any TML file by default, but you can add it to differentiate a table from another table with the same name.

As you work with TML files, keep in mind that changing elements of the TML file, such as the name of a column or table, may affect dependents. This is specifically true if you are editing TML files outside ThoughtSpot. When you change the name of a table in a TML file, and then import that file into ThoughtSpot, ThoughtSpot automatically updates that table name in any dependents, such as Answers that use the table as a data source. However, if you download multiple TML files from one ThoughtSpot cluster, then change the table name in TML, and upload all the files to a brand-new cluster, ThoughtSpot doesn’t know that the dependents should use that table. You must also change the table name in the dependents.

Syntax of the Worksheet TML file

The TML file for Worksheets has a specific syntax.

See the TML parameters for Worksheets for details about the keywords used in this example.

See Limitations of working with TML files for more information about actions you can’t perform using TML.

You may not see each of these parameters in your own TML files, depending on whether each variable is explicitly defined. For example, if you do not have any filters on your Worksheet, the filters parameter does not appear. You can add that variable to the TML file to specify filters for your Worksheet.

To reduce ambiguity, you may need to add the optional fqn parameter to your TML file when you reference source tables or connections. This is necessary if you have multiple connections or tables with the same name. If you do not add the fqn parameter, and the connection or table you reference does not have a unique name, the file import fails.

Refer to TML for joins for more information on the functionality and syntax of Worksheet joins in TML.

If you edit the joins in the Worksheet TML file, you are only editing the joins for that specific Worksheet. You are not editing the joins at the table level. To modify table-level joins, you must edit the source table’s TML file.
guid: <worksheet_guid>
worksheet:
  name: <worksheet_name>
  description:
    This is a multi-line description of the worksheet
    Description line 2
  tables:
  - name: <table_name_1>
    id : <optional_table_id>
    fqn : <optional_GUID_of_table_name>
  - name: <table_name_2>
  - name: <table_name_n>
  joins:
  - name: <join_name_1>
    source: <source_table_name>
    destination: <destination_table_name>
    type: [RIGHT_OUTER | LEFT_OUTER | INNER | OUTER]
    on: <join_expression_string>
    is_one_to_one: [ false | true ]
  - ...
  table_paths:
  - id: <table_path_name_1>
    table: <table_name_1>
    join_path:
    - join:
      - <join_name_1>
      - <join_name_n>
  - id: <table_path_name_2>
    table: <table_name_2>
    join_path:
    - join:
      - <join_name_2>
  - id: <table_path_name_n>
    table: <table_name_n>
    join_path:
    - join:
      - <join_name_n>
  formulas:
  - name: <formula_name_1>
    expr: <formula_definition_1>
    [id]: <optional_unique_identifier>
  - name: <formula_name_2>
    expr: <formula_definition_2>
  - name: <formula_name_3>
    expr: <formula_definition_3>
  filters:
  - column: <filtered_column_name_1>
    oper: <filter_operator>
    values: <filtered_values>
    - value 1
    - value 2
    - value n
  - column: <filtered_column_name_2>
  worksheet_columns:
  - name: <column_name_1>
    description: <optional_column_description>
    column_id: <table_path>::<column_id_1>
    properties:
      column_type: [ MEASURE | ATTRIBUTE ]
      aggregation: [ SUM | COUNT | AVERAGE | MAX | MIN |
                     COUNT_DISTINCT | NONE | STD_DEVIATION | VARIANCE]
      index_type: [ DONT_INDEX | DEFAULT | PREFIX_ONLY |
                    PREFIX_AND_SUBSTRING | PREFIX_AND_WORD_SUBSTRING ]
      index_priority: <index_priority>
      synonyms :
             <synonym_1>
             <synonym_2>
      is_attribution_dimension : [true | false]
      is_additive : [ true | false ]
      calendar : [ default | calendar_name ]
      format_pattern : <format_pattern_string>
      currency_type :
        is_browser : true
          OR
        column : <column_name>
          OR
        iso_code : <valid_ISO_code>
      is_hidden: [ true | false ]
      geo_config:
        latitude : true
          OR
        longitude : true
          OR
        country : true
          OR
        region_name:
        - country : <name_supported_country>
        - region_name : <region_name_in_UI>
          OR
        custom_file_guid: <custom_map_guid>
        geometryType: <custom_map_geometry_type>
      spotiq_preference: <spotiq_preference_string>
    name: <column_name_2>
    description: <column_description>
    column_id: <table_path>::<column_id_2>
    ...
  properties:
    is_bypass_rls: [ true | false ]
    join_progressive: [ true | false ]
  parameters:
  - id: <parameter_1_id>
    name: <parameter_1_name>
    data_type: <parameter_1_data_type>
    default_value: <parameter_1_default_value>
    range_config:
      range_min: <parameter_1_range_minimum>
      range_max: <parameter_1_range_maximum>
      include_min: [true | false]
      include_max: [true | false]
  - id: <parameter_2_id>
    name: <parameter_2_name>
    data_type: <parameter_2_data_type>
    default_value: <parameter_1_default_value>
    list_config:
      list_choice:
      - value: <list_value_1>
        display_name: <value_1_display_name>
      - value: <list_value_2>
        display_name: <value_2_display_name>
      - value: <list_value_n>
        display_name: <value_n_display_name>
        linked_parameters: <table_name>::<parameter_name_in_ThoughtSpot>
  - id: <parameter_n_id>
    name: <parameter_n_name>
    data_type: <parameter_n_data_type>
    default_value: <parameter_n_default_value>
    range_config:
      range_min: <parameter_n_range_minimum>
      range_max: <parameter_n_range_maximum>
      include_min: [true | false]
      include_max: [true | false]
  lesson_plans
  - lesson_id: <lesson_id_number_1>
    lesson_plan_string <lesson_plan_string_1>
  - lesson_id: <lesson_id_number_2>
    lesson_plan_string <lesson_plan_string_2>
  - lesson_id: <lesson_id_number_n>
    lesson_plan_string <lesson_plan_string_n>
  joins_with:
  - name: <join_name_1>
    description: <optional_join_description_1>
    destination:
      name: <destination_table_name_1>
      fqn: <optional_table_guid_1>
    on: <join_expression_string_1>
    type: [RIGHT_OUTER | LEFT_OUTER | INNER | OUTER]
    is_one_to_one: [ false | true ]
    name: <join_name_2>
    name: <join_name_n>

TML parameters for Worksheets

These parameters and their definitions are specific to Worksheets; this list doesn’t contain every parameter in every TML file. Similarly, the parameter definitions may vary from object to object, since the parameters may have different roles in different objects.

a - g i - l n - w
aggregation

The default aggregation of the Worksheet column.

Aggregation options depend on the data type.

Possible values are SUM, COUNT, AVERAGE, MAX, MIN, COUNT_DISTINCT, NONE, STD_DEVIATION, and VARIANCE

Default: SUM.

calendar

Specifies the calendar used by a date column.

Can be the Gregorian calendar (default), a fiscal calendar, or any custom calendar.

column

The id of the column(s) being filtered on.

column_id

The id of the Worksheet column.

column_id is in the following format: column_id: <id>::<name>. id comes from Worksheet.table_path, and name comes from Table.column. For example: column_id: Customer_Dimension::Customer_Name.

column_type

The type of data the column represents.

Possible values: MEASURE or ATTRIBUTE. The default is: MEASURE.

currency_type

The source of the currency type.

One of:

is_browser : true

infers the currency data from the locale of your browser

column : <column_name>

extracts the currency information from a specified column

iso_code : <valid_ISO_code>

applies currency based on the ISO code;

See ISO 4217 Currency Codes and Set currency type for more information.

custom_file_guid

The GUID for a custom map uploaded by an administrator.

data_type

The data type of the Parameter.

default_value

The default value for a Parameter in a Worksheet. Specified when creating a Parameter.

description

The text that describes an object: a worksheet, a worksheet column, or a join.

destination

The name of the destination table or view for a join.

display_name

The name or value that displays in the Parameter dialog for an accepted value, if a display name was set when creating a Parameter. For example, if the Parameter accepts true and false, the display names might be yes and no.

expr

The definition of the formula.

filters

Contains specifications for Worksheet filters.

format_pattern

The format pattern string that controls the display of a number, date, or currency column.

formulas

The list of formulas in the Worksheet.

Each formula is identified by name, the expr (expression), and an optional id attribute.

fqn

The table or connection’s GUID. You can find this string of letters and numbers at the end of the URL for that table or connection.

For example, in https://<company>.thoughtspot.com/#/data/tables/34226aaa-4bcf-4d6b-9045-24cb1e9437cb, the GUID is 34226aaa-4bcf-4d6b-9045-24cb1e9437cb.

Use this optional parameter to reduce ambiguity and identify a specific table, if you have multiple tables with the same name. When exporting a TML file, you have the option to Export FQNs of referenced objects, which ensures that the TML files you export contain FQNs for the underlying tables and connections. If you do not add the fqn parameter, and the connection or table you reference does not have a unique name, the file import fails.

geo_config

Specifies the geographic information of a column. See Add a geographical data setting

One of:

latitude : true

for columns that specify the latitude

longitude : true

for columns that specify the longitude

country : true

for columns that specify the country

region_name

for specifying a region in a country

Uses two paired parameters:

  • country: <country_name>

  • region_name: <region_name_in_UI>; can be State, Postal Code, District, and so on.

custom_file_guid: <custom map GUID>

for columns that use a custom map. Must be followed by geometryType

geometryType: <custom_map_geometry_type>

for columns that use a custom map. Must be preceded by custom_file_guid. Accepts the following values: POINT, LINE_STRING, LINEAR_RING, POLYGON, MULTI_POINT, MULTI_LINE_STRING, MULTI_POLYGON, GEOMETRY_COLLECTION, CIRCLE

geometryType

Specifies the geometry type of the TopoJSON file. Required for geographical configuration of Worksheet or table columns that use a custom map. Accepts the following values: POINT, LINE_STRING, LINEAR_RING, POLYGON, MULTI_POINT, MULTI_LINE_STRING, MULTI_POLYGON, GEOMETRY_COLLECTION, CIRCLE

guid

The GUID for the Worksheet. You can find this string of letters and numbers at the end of the URL for an object.

id

Specifies the id of an object, such as table_paths, formula.

include_max

Indicates if the maximum value in a Parameter range is a valid value. For example, if the range is 0-10, and include_max is false, the value 10 is not valid for that Parameter.

Valid values are true and false.

include_min

Indicates if the minimum value in a Parameter range is a valid value. For example, if the range is 0-10, and include_min is false, the value 0 is not valid for that Parameter.

Valid values are true and false.

index_priority

A value (1-10) that determines where to rank a column’s name and values in the search suggestions

ThoughtSpot prioritizes columns with higher values.

index_type

The indexing type for the Worksheet column.

Possible values: DONT_INDEX, DEFAULT (see Understand the default indexing behavior), PREFIX_ONLY, PREFIX_AND_SUBSTRING, and PREFIX_AND_WORD_SUBSTRING

Default: DEFAULT

is_additive

Controls extended aggregate options for attribute columns.

For attribute columns that have a numeric data type (FLOAT, DOUBLE, or INTEGER) or a date data type (DATE, DATETIME, TIMESTAMP, or TIME)

Possible values: true or false.

Default: true.

is_attribution_dimension

Controls if the column is an attribution dimension.

Used in managing chasm traps.

Possible values: true by default, false to designate a column as not producing meaningful attributions across a chasm trap

Default: true

is_bypass_rls

Specifies if the Worksheet supports bypass of Row-level security (RLS) rules.

Possible values: true or false

Default: false

is_hidden

The visibility of the column.

Possible values: true to hide the column, false not to hide the column
Default: false

is_one_to_one

Specifies the cardinality of the join. This is an optional parameter.

Possible values: true, false

Default: false

join

Specific join, used in defining higher-level objects, such as table paths.

Defined as name within joins definition.

join_path

Specification of a composite join as a list of distinct join attributes.

These join attributes list relevant joins, previously defined in the joins, by name.

Default: {}

join_progressive

Specifies when to apply joins on a Worksheet.

Possible values: true when joins are applied only for tables whose columns are included in the search, and false for all possible joins

Default: true

joins

Contains a list of joins between the tables and views.

If you edit the joins in the Worksheet TML file, you are only editing the joins for that specific Worksheet. You are not editing the joins at the table level. To modify table-level joins, you must edit the source table’s TML file.

Each join is identified by name, and the additional attributes of source, destination, type, and is_one_to_one.

joins_with

Contains a list of external joins for which this Worksheet is the source.
Each join is identified by name and optional description, and the additional attributes of destination, type, on, and is_one_to_one.

lesson_id

The numeric ID of the Search Assist Coach lesson created for the Worksheet. The first lesson shown to users has an ID of 0, the second lesson has an ID of 1, and so on.

lesson_plan_string

The content of the Search Assist Coach lesson created for the Worksheet. For example, "What were [Lo Tax] by [Lo Shipmode] in [Lo Commitdate].'2019' ?".

lesson_plans

Contains a list of Search Assist Coach lessons created for the Worksheet.

linked_parameters

Links the Worksheet parameter to the underlying table parameter. Takes the syntax "table_name::table_parameter_name". The table parameter name should be the name of the parameter in ThoughtSpot.

Only applicable to tables imported from SAP Hana.
list_choice

Contains the list of accepted values for a Parameter, if a list was configured when creating a Parameter.

list_config

Contains the list of accepted values for a Parameter, if a list was configured when creating a Parameter.

name

The name of an object. Applies to worksheet, joins, formula, connection, destination, and so on.

on

The join expression: the relationship definition, or the keys that your objects are joined on. For example, [sale::Sale_Last Name] = [employee::Employee_Last Name] AND [sale::Sale_First Name] = [employee::Employee_First Name].

To alter a relationship definition, edit this parameter.

oper

The operator of the Worksheet filter. Accepted operators are "in", "not in", "between", =<, !=, <=, >=, >, or <.

parameters

Container for the Parameters in a Worksheet.

properties

The list of properties of a Worksheet column, a Worksheet itself, or the properties of the output for a formula within a Worksheet.

Each column can have the following properties, depending on its definition: column_type, aggregation, index_type, is_hidden, index_priority, synonyms, is_attribution_dimension, is_additive, calendar, format_pattern, currency_type, geo_config, and spotiq_preference.

Worksheets themselves can have the following properties that affect query generation: is_bypass_rls, and join_progressive.

range_config

Contains the minimum and maximum values for the range of values allowed for a Parameter, if a range is specified when creating a Parameter.

range_max

The maximum value for the range of values allowed for a Parameter, if a range is specified when creating a Parameter.

range_min

The minimum value for the range of values allowed for a Parameter, if a range is specified when creating a Parameter.

source

Name of the source table or view for a join.

spotiq_preference

Specifies whether to include a column in SpotIQ analysis. Specify EXCLUDE, or this property defaults to include the column in SpotIQ Analysis.

synonyms

Alternate names for the column, used in search.

table

Specific table, used in defining higher-level objects, such as table paths.

Defined as name within tables definition.

table_paths

The list of table paths. Each table path is identified by the id, and additional attributes of table and join_path.

tables

List of tables used by the Worksheet.

Each table is identified by name.

type

The join type. This is an optional parameter.

Possible values: LEFT_OUTER for left outer join, RIGHT_OUTER for right outer join, INNER for inner join, OUTER for full outer join.

Default: INNER

value

An accepted value for a Parameter, if a list was configured when creating a Parameter.

values

The values being filtered (excluded or included) in a Worksheet.

worksheet

Top-level container for all object definitions within the Worksheet.

worksheet_columns

The list of columns in the Worksheet.

Each Worksheet is identified by name, description, column_id, and properties.

Limitations of working with TML files

There are certain limitations to the changes you can apply by editing Worksheets through TML.

  • Formulas and columns can either have a new name, or a new expression. You can’t change both, unless migrating or updating the Worksheet two times.

  • It isn’t possible to reverse the join direction in the TML script.

  • TML doesn’t support data type modifications.

  • You can’t import manually compressed .zip files. You can only import .zip files that you exported from ThoughtSpot: a custom set of TML files, an object and its associated data sources, or multiple objects of the same type that you exported from the object list page.

  • You can’t modify joins at the table level from the Worksheet, view, or Answer TML file. You can only override the joins for that specific Worksheet, view, or Answer. To modify table-level joins, you must edit the source table’s TML file.

  • When deleting columns, you only delete ThoughtSpot’s record of the column. You don’t delete the column in your external database.