Use ThoughtSpot Modeling Language to modify a Worksheet, View, table, Pinboard, or Answer, in a flat-file format. Then you can migrate the object to a different cluster, or restore it to the same cluster.

To work with Scriptable Worksheets, Views, tables, Answers, and Pinboards in ThoughtSpot, you can download these objects to a flat file in .TML format, modify it, and subsequently upload this file either to the same cluster, or to a different cluster. To learn how to export, change, and update Worksheets, Views, tables, Answers, and Pinboards, see Scriptability.

In this article, you learn the syntax of the TML files for each Scriptable object. You also learn how to add and modify joins for Worksheets, Views, and tables.

Syntax of the Worksheet TML file

The TML file for Scriptable Worksheets has a specific syntax.

See the Parameters section for details about the keywords used in this example.

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.

Refer to join syntax for more information on the functionality and syntax or Worksheet, View, and table joins in TML.

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: <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>
      spotiq_preference: <spotiq_preference_string>
      search_iq_preferred: [ true | false ]      
    name: <column_name_2>
    description: <column_description>
    column_id: <column_id_2>
    ...  
  properties:
    is_bypass_rls: [ true | false ]
    join_progressive: [ 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>

Syntax of the View TML file

The TML file for Scriptable Views has a specific syntax.

See the Parameters section for details about the keywords used in this example.

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 a description for your View, the description parameter does not appear. You can add that variable to the TML file to specify a description for your View.

Refer to join syntax for more information on the functionality and syntax or Worksheet, View, and table joins in TML.

guid: <view_guid>
view:
  name: <view_name>
  description:
    This is a multi-line description of the View.
    Description line 2
  tables:
    identity:  
    - id: <table_id_1>
      name: <table_name_1>
      fqn: <optional_table_guid_1>
    identity:  
    - id: <table_id_n>
      name: <table_name_n>
      fqn: <optional_table_guid_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:
  - id: <formula_id_1>
    name: <formula_name_1>
    expr: <formula_definition_1>
    properties: <formula_properties_1>
      column_type: [ MEASURE | ATTRIBUTE ]
      data_type: [ BOOL | VARCHAR | DOUBLE | FLOAT | INT | BIGINT | DATE | DATETIME | TIMESTAMP | TIME ]
      aggregation: [ SUM | COUNT | AVERAGE | MAX | MIN |
                         COUNT_DISTINCT | NONE | STD_DEVIATION | VARIANCE]       
  - id: <formula_id_n>
    name: <formula_name_n>
    expr: <formula_definition_n>
    properties: <formula_properties_n>  
  filters:
  - column: <filtered_column_name_1>
    oper: <filter_operator>
    values: <filtered_values>
    - value 1
    - value 2
  - column: <filtered_column_name_n>
  search_query: <query_string>
  view_columns:
  - name: <column_name_1>
    description: <optional_column_description>
    column_id: <column_id_1>
    phrase: <phrase_string_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>
      spotiq_preference: <spotiq_preference_string>
      search_iq_preferred: [ true | false ]      
    name: <column_name_2>
    description: <column_description>
    column_id: <column_id_2>
    ...  

Syntax of the table TML file

The TML file for Scriptable tables has a specific syntax.

See the Parameters section for details about the keywords used in this example.

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 did not define an index_priority for your table, the index_priority parameter does not appear. You can add that variable to the TML file to specify an index priority for the table.

Refer to join syntax for more information on the functionality and syntax of worksheet, view, and table joins in TML.

guid: <table_guid>
table:
  name: <table_name>
  db: <database_name>
  schema: <schema_name>
  db_table: <database_table_name>
  connection:
    name: <connection_name>
    type: <connection_type>
  columns:
  - name: <column_name_1>
    db_column_name: <database_column_name>
    data_type: [ BOOL | VARCHAR | DOUBLE | FLOAT | INT32 | INT64 | DATE | TIME ]
    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>
      spotiq_preference: <spotiq_preference_string>
      search_iq_preferred: [ true | false ]
    db_column_properties:
      data_type: [ BOOL | VARCHAR | DOUBLE | FLOAT | INT32 | INT64 | DATE | TIME ]
  - name: <column_name_2>
  - name: <column_name_n>
  rls_rules:
    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>
    rules:
    - name: <rls_rule_name_1>
      expr: <rls_rule_expression_1>
    - name: <rls_rule_name_2>
      expr: <rls_rule_expression_2>
    - name: <rls_rule_name_n>
      expr: <rls_rule_expression_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>

Join syntax

The syntax and functionality of joins in the table TML file differs from the syntax and functionality for Worksheet and View TML files.

When you edit the information in the joins section of the TML for a Worksheet or View, you override the table join(s) from the table the Worksheet or View comes from. However, you only override the join(s) for the specific Worksheet or View you are editing, not for the source table.

When you edit the information in the joins_with section of the TML for a table, you edit the join information for the source table, the destination table, and any dependents, such as Worksheets and Views. Note that you can only edit joins for which the table is the source table.

Worksheet and View join syntax

For Worksheets and Views, the join syntax is the following:

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>

Worksheet and View join functionality and limitations

With Worksheet and View joins, you can accomplish the following tasks:

  • Add new joins at the Worksheet or View level
  • Modify existing joins at the Worksheet or View level
  • Delete existing joins at the Worksheet or View level

Worksheet and View joins have the following limitation:

  • You cannot modify joins at the table level from the Worksheet or View TML file. You can only override the joins for that specific Worksheet or View.

Table join syntax

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>

Table join functionality and limitations

With table joins, you can accomplish the following tasks:

  • Add new joins at the table level. Joins only appear in the table TML file of the source table in a join, or the table on the Many side of a Many to One join. You can only add and edit table joins from the TML file of the table on the Many side of the join.
  • Create generic or range joins at the table level. Previously, you could only create non-generic joins through the TML, such as Table1.date = Table2.date. Now, you can create generic joins through the TML, such as Table1.date = Table2.date AND Table1.date > Table2.start_date AND Table1.date < Table2.end_date. Joins only appear in the table TML file of the source table in a join, or the table on the Many side of a Many to One join. You can only add and edit table joins from the TML file of the table on the Many side of the join.

  • Edit existing joins by changing the name of the join and modifying it to your specifications. Changing the name of the join creates a new join; you must then delete the old join in the UI. Joins only appear in the table TML file of the source table in a join, or the table on the Many side of a Many to One join. You can only add and edit table joins from the TML file of the table on the Many side of the join.

Table joins have the following limitations:

  • You cannot delete a join by removing it from the TML. You must delete it through the UI.
  • You cannot directly edit an existing join; you must rename it, edit it to your specifications, and then delete the old join the UI.
  • Renaming a join creates a new join with that name and does not delete the old join with the original name.

Generic joins

The functionality for generic joins in TML files allows the following elements:

  • Constants: int, double, bool, date, and string
  • Comparison operators: =, !=, <, >, <=, and >=
  • Columns
  • Boolean operators: AND, OR, and NOT

Syntax of the Answer TML file

The TML file for Scriptable Answers has a specific syntax.

See the Parameters section for details about the keywords used in this example.

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 did not define any conditional formatting, the conditional_formatting variable does not appear. You can add that variable in the TML file to specify conditional formatting.

guid: <answer_guid>
answer:
  name: <answer_name>
  description:
    This is a multi-line description of the answer
    Description line 2
  tables:
  - id: <table_id>
    name: <table_name_1>
    fqn : <optional_GUID_of_table_name>
  formulas:
  - id: <formula_id_1>
    name: <formula_name_1>
    expr: <formula_definition_1>
    properties: <formula_properties_1>
      column_type: [ MEASURE | ATTRIBUTE ]
      data_type: [ BOOL | VARCHAR | DOUBLE | FLOAT | INT | BIGINT | DATE | DATETIME | TIMESTAMP | TIME ]
      aggregation: [ SUM | COUNT | AVERAGE | MAX | MIN |
                     COUNT_DISTINCT | NONE | STD_DEVIATION | VARIANCE]       
  - id: <formula_id_2>
    name: <formula_name_2>
    expr: <formula_definition_2>
    properties: <formula_properties_2>
  - id: <formula_id_3>
    name: <formula_name_3>
    expr: <formula_definition_3>
    properties: <formula_properties_3>  
  search_query: <search_query_string>
  answer_columns:
  - id: <column_id_1>
    name: <column_name_1>
    custom_name: <custom_name_1>
  - name: <column_name_2>
  table:
    table_columns:
    - column_id: <column_id_1>
      conditional_formatting:
      - range:
        min: <conditional_formatting_minimum>
        max: <conditional_formatting_maximum>
      - rule: <conditional_formatting_rule_1>
          range:
            min: <conditional_formatting_minimum>
            max: <conditional_formatting_maximum>
          color: <color_string>
          plotAsBand: [ true | false ]
      - rule: <conditional_formatting_rule_2> 
      show_headline: [ true | false ]
      headline_aggregation: <headline_aggregation_string>
    - column_id: <column_id_2>
    ordered_column_ids:
    - column_id: <column_id_1>
    - column_id: <column_id_2> 
    client_state: <client_state_string>
  chart:
    type: <chart_type>
    chart_columns: <chart_column_1>
    - column_id: <column_id_1>
      conditional_formatting:
      - rule: <conditional_formatting_rule_1>
          range:
            min: <conditional_formatting_minimum>
            max: <conditional_formatting_maximum>
          color: <color_string>
          plotAsBand: [ true | false ]
      - rule: <conditional_formatting_rule_2> 
    - column_id: <column_id_2>
    axis_configs: <axis_config_1>
    - x:
      - column_id: <column_id_x_axis>
    - y:
      - column_id: <column_id_y_axis>
      color:
      - column_id: <column_id_color>
    axis_configs: <axis_config_2>
    locked: [ true | false ]
    client_state: <client_state_string>
  display_mode: <display_mode_string>

Syntax of the Pinboard TML file

The TML file for Scriptable Pinboards has a specific syntax.

See the Parameters section for details about the keywords used in this example.

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 Pinboard, the filters parameter does not appear. You can add that variable to the TML file to specify filters for your Pinboard.

guid: <pinboard_guid>
pinboard:
  name: <pinboard_name>
  description:
    This is a multi-line description of the pinboard
    Description line 2
  visualizations:
  - id: <viz_id_1>
    answer:
    This section includes all the Answer specification for a visualization, from name to display_mode, in the Answer syntax section above.
  - id: <viz_id_2>
    answer:
    This section includes all the Answer specification for a second visualization. In this case, the visualization is a headline.
    display_headline_column: <headline_column>    
  filters:
    - column:
      - <primary_filter_column_name_1>
      - <linked_filter_column_name_2>
      - <linked_filter_column_name_n>
      oper: <filter_operator>
      values: <filtered_values>
      - value 1
      - value 2
      - value n
      excluded_visualizations:
      - excluded_viz_id_1
      - excluded_viz_id_2
    - column: <filtered_column_name_2>
    ...
  layout:
    tiles:
    - visualization_id: <visualization_id_1>
      size: <viz_id_1_size>
    - visualization_id: <visualization_id_2>

Parameters of TML files

aggregation
The default aggregation of the Worksheet, View, or table column, or the aggregation of the output for a formula.
Aggregation options depend on the data type.
Possible values: SUM, COUNT, AVERAGE, MAX, MIN, COUNT_DISTINCT, NONE, STD_DEVIATION, and VARIANCE
Default: SUM
answer
Top-level container for all object definitions within an Answer.
answer_columns
A list of columns generated by the search query.
axis_configs
Specifies the columns for each axis on a chart. If you are displaying a column chart with a line chart overlaying it, for example, you would need to specify more than one axis_config.
calendar
Specifies the calendar used by a date column
Can be the Gregorian calendar (default), a fiscal calendar, or any custom calendar.
See Set up a custom calendar
chart
Contains configuration for the Answer, if it displays in chart format.
chart_columns
A list of columns in the chart.
client_state
A JSON string with more advanced chart and table configuration.
color
Color to use for conditional formatting or for the columns of an Answer in chart form, in the form of a HEX value.
column
The id of the column(s) being filtered on. When a Pinboard contains linked filters, or filters that affect visualizations based on more than one Worksheet, the primary filter column appears first in the list of columns in the TML. The linked filter column appears after the primary filter column.
columns
The columns in the table.
column_id
The id of the Worksheet or View column.
For Answers, column_id refers to how the column appears in the query. For example, if you sorted by Quarter in your search, from the Commit Date column, the column_id of the column is Quarter(Commit Date).
column_type
The type of data the column represents. For a formula, the column_type refers to the output of the formula.
Possible values: MEASURE or ATTRIBUTE
For Worksheets, the default is: MEASURE
For formulas, the default depends on the data_type. If the data type is INT or BIGINT, the formula output’s column_type defaults to Measure. If the data type is BOOL, VARCHAR, DOUBLE, FLOAT, DATE, DATETIME, or TIME, the formula output’s column_type defaults to Attribute.
conditional_formatting
Conditional formatting for the chart or table of an Answer.
connection
A way to identify the external data warehouse connection that the table resides in. To add tables or columns to an Embrace connection, you must specify this parameter.
currency_type
The source of currency type
One of:
  • is_browser : true infer 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
See Set currency type
custom_name
Optional display name for a column.
data_type
The data type of the formula output or column. If the data type is INT or BIGINT, the formula output’s column_type defaults to Measure. If the data type is BOOL, VARCHAR, DOUBLE, FLOAT, DATE, DATETIME, or TIME, the formula output’s column_type defaults to Attribute. The possible data types are Boolean, Text, Date, Datetime, Time, Numeric, and Decimal.
db
The database that a table resides in. Note that this is not the same as the data warehouse (Falcon, Amazon Redshift, or Snowflake, for example).
db_column_name
The name of the column in the database. Note that this database is not the same as the data warehouse (Amazon Redshift or Snowflake, for example).
db_column_properties
The properties of the column in the database. Note that this database is not the same as the data warehouse (Amazon Redshift or Snowflake, for example).
db_table
The name of the table in the database. Note that this database is not the same as the data warehouse (Falcon, Amazon Redshift, or Snowflake, for example).
description
The text that describes an object: a worksheet, a worksheet_column, answer, pinboard, view, view_column and so on.
destination
The name of the destination table or View for a join
display_mode
Determines whether the Answer displays as a chart or a table. Specify either CHART_MODE or TABLE_MODE.
display_headline_column
If the visualization is a headline, this parameter specifies the column the headline comes from.
excluded_visualizations
A list of visualizations the Pinboard editor chose to exclude from the filter. Only appears when using selective filters.
expr
The definition of the formula or row level security (RLS) rule. For RLS rules, the syntax for variables in TML should be the same as the syntax of the variables in the rule on the table.
filters
Contains specifications for Pinboard, View, and Worksheet filters.
format_pattern
The format pattern string that controls the display of a number, date, or currency column
See Set number, date, and currency formats
formulas
The list of formulas in the Worksheet, View, or Answer.
Each formula is identified by name, the expr (expression), and an optional id attribute.
fqn
The table's GUID. You can find this string of letters and numbers at the end of the URL for that table. For example, in https://<company>.thoughtspot.com/#/data/tables/34226aaa-4bcf-4d6b-9045-24cb1e9437cb, the GUID is 34226aaa-4bcf-4d6b-9045-24cb1e9437cb.
geo_config
Specifies the geographic information of a column
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>, which can be State, Postal Code, District, and so on.
See Add a geographical data setting
guid
The GUID for the Answer, Pinboard, table, Worksheet, or View. You can find this string of letters and numbers at the end of the URL for an object.
headline_aggregation
Specifies the type of headline aggregation. Can be COUNT, COUNT_DISTINCT, SUM, MIN, MAX, AVERAGE, or TABLE_AGGR.
id
Specifies the id of an object, such as table_paths, formula.
For Answers, id refers to how the column appears in the query. For example, if you sorted by Quarter in your search, from the Commit Date column, the id of the column is Quarter(Commit Date). Refer to Components of a Search Query to understand syntax.
For formulas within Answers, id refers to the display name of the formula. If you do not give your formula a name, it appears as 'Untitled Formula'.
identity
Specifies the identity of a table, based on its name, id, and fqn.
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.
See Change a column’s suggestion priority.
index_type
The indexing option of the Worksheet, View, or table column
Possible values: DONT_INDEX, DEFAULT (see Understand the default indexing behavior), PREFIX_ONLY, PREFIX_AND_SUBSTRING, and PREFIX_AND_WORD_SUBSTRING
Default: DEFAULT
See Index Type Values
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
See Making an ATTRIBUTE column ADDITIVE
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
See Change the attribution dimension
is_bypass_rls
Specifies if the worksheet supports bypass of Row-level security (RLS)
Possible values: true or false
Default: false
See Privileges that allow users to set, or be exempt from, RLS
is_hidden
The visibility of the column
Possible values: true to hide the column, false not to hide the column
Default: false
See Hide a column
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
See How the worksheet join rule works
joins

Contains a list of joins between the tables and Views.

If you edit the joins in the Worksheet or View TML file, you are only editing the joins for that specific Worksheet or View. 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 table 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.

layout
Specifies the Pinboard layout, in the order that a visualization_id is listed.
lesson_plan_string
A string that represents the fully disambiguated search query used in a Search Assist Coach lesson on a Worksheet. For example, "What is the [Quantity] of items from [Customer Nation].'egypt' per [Datekey].'day of week' by [Color] ?". Refer to Components of a Search Query to understand syntax.
lesson_plans
A list of Search Assist Coach lessons for the Worksheet.
lesson_id
The id of the Search Assist Coach lesson. For example, the first lesson to appear to users has an id of 0, the next lesson has an id of 1, and so on.
locked
The 'automatically select my chart' option in the UI. If set to true, the chart type does not change, even when you add items to the query.
max
Maximum value for conditional formatting.
min
Minimum value for conditional formatting.
name
The name of an object. Applies to worksheet, table,joins, formula, rls_rules, answer, pinboard, view, table, connection, destination, and so on.
For Answers, name refers to how the column appears in the query. For example, if you sorted by Quarter in your search, from the Commit Date column, the name of the column is Quarter(Commit Date). Refer to Components of a Search Query to understand syntax.
on

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

You cannot directly edit a relationship definition. To alter a relationship definition, you must rename the join or create a new join.

oper
The operator of the Pinboard, View or Worksheet filter. Accepted operators are "in", "not in", "between", =<, !=, <=, >=, >, or <.
ordered_column_ids
A list of columns, in the order they appear in the table.
phrase
Phrase associated with a View column.
pinboard
Top-level container for all object definitions within the Pinboard.
properties
The list of properties of a Worksheet, table, or View column, a Worksheet or View itself, or the properties of the output for a formula within an Answer, Worksheet, or View.
For Worksheets, Views, and tables, 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, spotiq_preference, and search_iq_preferred.
Worksheets and Views themselves can have the following properties that affect query generation: is_bypass_rls, and join_progressive.
For Answers, each formula's output can have the following properties, depending on its definition: column_type and aggregation.
plotAsBand
Specifies whether to plot the chart conditional formatting like a band on the Visualization. This is the 'fill chart' option in the UI.
range
Range for the conditional formatting to apply to, with a specified min and max.
rls_rules
A container for the full definition of row level security rules for the table.
rule
A conditional formatting rule.
rules
A container for the names and expressions of row level security rules for the table.
schema
The schema that the table is a part of.
search_query
A string that represents the fully disambiguated search query. Used in Answers and Views. Refer to Components of a Search Query to understand syntax.
show_headline
Determines whether to show the headline for this column. true shows the headline.
size
The size of a visualization in a Pinboard. The options are EXTRA_SMALL, SMALL, MEDIUM, LARGE, LARGE_SMALL, MEDIUM_SMALL, and EXTRA_LARGE.
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.
Refer to Set columns to exlude from SpotIQ analyses.
synonyms
Alternate names for the column, used in search
See Create synonyms for a column
table
Top-level container for all object definitions within the table.
Specific table, used in defining higher-level objects, such as table paths.
Defined as name within tables definition.
For Answers, this parameter contains configuration for the Answer, if it displays in table format.
table_columns
The columns in an Answer that is being displayed in table format.
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, answer, or table RLS rule.
Each table is identified by name.
type
For Worksheets, Views, and in the joins section of an Answer TML file, this is 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
For tables, this is the Embrace connection type.
Possible values: Snowflake, Google BigQuery, Microsoft Azure, or Amazon Redshift.
Within the chart section of an Answer TML file, this is the chart type.
Possible values: COLUMN, BAR, LINE, PIE, SCATTER, BUBBLE, STACKED_COLUMN, AREA, PARETO, COLUMN, GEO_AREA, GEO_BUBBLE, GEO_HEATMAP, GEO_EARTH_BAR, GEO_EARTH_AREA, GEO_EARTH_GRAPH, GEO_EARTH_BUBBLE, GEO_EARTH_HEATMAP, WATERFALL, TREEMAP, HEATMAP, STACKED_AREA, LINE_COLUMN, FUNNEL, LINE_STACKED_COLUMN, PIVOT_TABLE, SANKEY, GRID_TABLE, SPIDER_WEB, WHISKER_SCATTER, STACKED_BAR, or CANDLESTICK.
values
The values being filtered (excluded or included) in a Pinboard, View, or Worksheet.
view
Top-level container for all object definitions within the View.
view_columns
The list of columns in the View.
Each column is identified by name, description, column_id, phrase and properties.
visualizations
The visualizations in a Pinboard: tables, charts, and headlines.
visualization_id
The id of a visualization. Used to specify the Pinboard's layout.
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 a Worksheet, Answer, table, View, or Pinboard through TML.

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

  • It is not possible to reverse the join direction in the TML script.

  • You cannot create new tables using Scriptability. You can only update existing tables.

  • You can only change logical tables using Scriptability. You cannot change the physical version of the table that exists in a database. When you change the column_name, for example, the name changes in the application, but not in the physical table in the database.

  • You cannot create Scriptable representations of R- or Python-powered visualizations.

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

  • Joins only appear in the table TML file of the source table in a join, or the table on the Many side of a Many to One join. You can only add and edit table joins from the TML file of the table on the Many side of the join. You cannot view or modify table-level joins from the destination table’s TML file.

  • You cannot 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.

  • You cannot directly edit a relationship definition. To alter a relationship definition, you must rename the join or create a new join.

  • You cannot delete joins from the TML file. You must delete them in the UI.

  • You cannot remove columns or tables from an Embrace connection. You can only add them.