TML properties

The default aggregation of the output for a formula. In a Liveboard TML file, the default aggregation of the Worksheet, View, or table column, or the aggregation of the output for a formula.

Aliases can be set for tables that are being used in the model. Aliases are especially useful for role playing dimension scenarios where an alias can be assigned to the same table that is being used in different roles.

Defines the identifier of the column that the set is associated with.

Top-level container for all object definitions within an answer, or answer or visualization within a Liveboard.

A list of columns generated by the search query.

The GUID of an Answer. Used in Monitor alert TML files to specify the KPI used to create the alert. If you are importing or editing a Liveboard, use the pinboard_viz_id section instead, and do not include answer_id.

The type of authentication used to connect to the connection. Note that authentication type is usually SERVICE_ACCOUNT, although certain connections also support KEY_PAIR.

Specifies the columns for each axis on a chart.

Size of bin.

Container for group configuration for bin-based column sets.

Specifies the calendar used by a date column.

Contains configuration for the Answer, if it displays in chart format.

A list of columns in the chart.

A JSON string with more advanced chart and table configuration.

A top-level container for all object definitions within a cohort.

Describes the type of grouping contained in a set.

Describes the type of set, either column or query set.

The id of the column(s) being filtered on. When a Liveboard 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.

Describes 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).

Enter the name of the column group. Column group names must be unique.

Create column groups to sort columns in the Search Data panel.

The type of data the output of the formula represents.

The list of columns available from the data sources in the Model.

When set to true, combines all values which do not belong to any group.

Defines how multiple group conditions should be combined for group-based column sets. Options are ALL or ANY.

The operator used in the condition of a Monitor threshold-based alert. The options are COMPARATOR_GT (greater than), COMPARATOR_LT (less than), COMPARATOR_GEQ (greater than or equal to), COMPARATOR_LEQ (less than or equal to), COMPARATOR_EQ (equal to), COMPARATOR_NEQ (not equal to), PERCENTAGE_CHANGE_COMPARATOR_CHANGES_BY (changes by %), PERCENTAGE_CHANGE_COMPARATOR_INCREASES_BY (increases by %), PERCENTAGE_CHANGE_COMPARATOR_DECREASES_BY (decreases by %). The PERCENTAGE_CHANGE operators are only valid if your KPI includes a time-series keyword, such as weekly.

Container for the Monitor threshold-based alert condition. Contains either a simple condition or a percentage change condition. To change a threshold-based alert to a scheduled alert, remove the condition section.

Conditions for each group for group-based column sets.

Container for all cohort configurations.

A way to identify the external data warehouse connecting to ThoughtSpot.

Container for information about the creator of a Monitor alert. The creator information is only visible for administrators.

Contains frequency information for delivery of Monitor alerts.

The source of the currency type.

The GUID for a custom map uploaded by an administrator.

Optional display name for a column.

Define this property in each column to mark which column group(s) the column should be allocated to. When marking a column for multiple column groups, separate the group names using a comma.

The data type of the formula output. If the data type is INT32 or INT64, 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 numbered days of the month, 1-31, when a Monitor alert should be sent. For example, "3,18,25".

The numbered days of the week, 0-6, when a Monitor alert should be sent. For example, "0,3,5". 0 refers to Sunday, and 6 refers to Saturday.

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).

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).

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).

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).

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

When enabled, the column groups will be sorted alphabetically by group name in the data panel. When disabled, the groups will be sorted in the data panel in the order defined in the TML.

The text that describes an object.

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

Determines whether the answer displays as a chart or a table. Specify either CHART_MODE or TABLE_MODE.

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.

If the visualization is a headline, this parameter specifies the column the headline comes from.

The epoch time at which the alert should end. This is almost always 0, which means the alert continues to be triggered indefinitely. Do not edit this parameter.

A list of visualizations the Liveboard editor chose to exclude from the filter. Only appears when using selective filters.

The definition of the formula. This should be the same as the formula expression in the formula editor.

Contains specifications for filters.

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

The list of formulas in the object.

Frequency with which ThoughtSpot sends a Monitor alert, either HOURLY, DAILY, WEEKLY, or MONTHLY.

Contains information about when ThoughtSpot sends a scheduled Monitor alert.

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

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

Specifies the geometry type of the TopoJSON file. Required for geographical configuration of Model 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

Name for combined group values which are not part of Query Set query.

Container for group configuration for group-based column sets.

The GUID for the object.

Specifies the type of aggregation the headline uses.

The height of the Liveboard visualization.

Set to true to hide values which are not part of the Query Set query.

Specifies the hour that a Monitor alert is scheduled to be sent. For example, if you specify 9 for the hour parameter and 17 for the minute parameter, ThoughtSpot sends the Monitor alert at 9:17 AM.

Specifies the id of an object, such as tables.

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.

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.

Set as true/false for each column group. When defined as true, the defined column group includes all columns not sorted into the other column groups.

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

The indexing type for the column.

Controls extended aggregate options for attribute columns.

Controls if the column is an attribution dimension.

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

The visibility of the column.

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

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

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

Specifies when to apply joins on a Model.

Contains a list of joins between the tables and views.

Contains a list of external joins for which this object 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.

Name of the Parameter referenced in a formula in an object.

Specifies the Liveboard layout, in the order that a visualization_id is listed.

Top-level container for all object definitions within the Liveboard or SpotIQ result.

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

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

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

Links the Model 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.

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

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

The 'automatically select my chart' option in the UI. If set to true, the chart type does not change, even when you change the search query.

Maximum value for bin.

Container for the KPI used in the Monitor alert.

Minimum value for bin.

Specifies the minute that a Monitor alert is scheduled to be sent. For example, if you specify 9 for the hour parameter and 17 for the minute parameter, ThoughtSpot sends the Monitor alert at 9:17 AM.

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

Top-level container for all object definitions within the Monitor alert.

The numbered months of the year (1-12, starting with January, even if you use a custom/fiscal calendar) in which the Monitor alert should be sent. For example, to send an alert only in March and September, specify '3,9'.

The name of an object. Applies to monitor_alert.

Name for combined group values which are not part of any group in group-based sets.

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].

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

Operator for group conditions for group-based column sets.

A list of columns, in the order they appear in the table.

The owner of a column or query set.

The value a Parameter is set to in an Answer, if different from the default value.

Contains information on the value a Parameter is set to in an Answer, if different from its default value. If there is no override_value line, the Parameter is set to the default value.

Container for the Parameters in an Answer.

Container for the Parameters in a Model.

Container for the Monitor threshold-based alert condition, if the alert condition involves a percentage change. If the alert condition involves a simple condition (greater than, less than, equal, not equal to, greater than or equal to, less than or equal to), ThoughtSpot uses simple_condition instead of percentage_change_condition.

ID of the personalised View the monitor alert is based on. If no personalised_view_id is included, this TML creates an alert with no ad-hoc filters applied. If a personalised_view_id is available and supplied as part of the metric_id, the filters and parameters applied to the personalised View are applied to create the contextual alert.

Container for the filters and parameters applied on the personalized View. If the TML contains only personalised_view_info and no personalised_view_id, the TML creates a new personalised View, and the contextual alert created uses the filters and parameters provided in the personalised_view_info.

Phrase associated with a view column.

The GUID of a Liveboard. Used in Monitor alert TML files to specify the KPI used to create the alert. If you are importing or editing an Answer, use answer_id instead, and do not include any part of the pinboard_viz_id section.

Contains information about the KPI used to create a Monitor alert. If you are importing or editing an Answer, use answer_id instead, and do not include any part of the pinboard_viz_id section.

The list of the properties of the output for a formula within an Answer, or a container for the key-value pairs that define a connection.

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

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

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

The Global join that is being referenced in the model.

Return column for column-based query sets.

A container for the full definition of row-level security rules for the table.

A conditional formatting rule.

A container for the names and expressions of row-level security rules for the table.

The name of the parameter from the SAP Hana calculated view.

The schema that the table is a part of.

Name of the column generated by the view. To change the name of the column in the view, edit the name parameter.

A string that represents the fully disambiguated search query. Refer to Components of a Search Query to understand syntax.

Specifies the second that a Monitor alert is scheduled to be sent. For example, if you specify "30" for the second parameter, 9 for the hour parameter, and 17 for the minute parameter, ThoughtSpot sends the Monitor alert at 9:17 and 30 seconds. You can only specify seconds in TML, not in the UI.

Determines whether to show the headline for this column. true shows the headline.

Container for the Monitor threshold-based alert condition. If the alert condition involves a percentage change, ThoughtSpot uses percentage_change_condition instead of simple_condition.

The size of a visualization in a Liveboard, if using ThoughtSpot’s predetermined sizes. The options are EXTRA_SMALL, SMALL, MEDIUM, LARGE, LARGE_SMALL, MEDIUM_SMALL, and EXTRA_LARGE.

The epoch time at which the user created the alert. Do not edit this parameter.

Name of the source table or view for a join.

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

Name of the SQL’s output column as per the select clause in the view’s SQL query.

A string that represents the SQL query used to create the SQL view.

Top-level container for all object definitions within the SQL view.

The list of columns in the SQL view.

Use the status property to define whether to enable or disable column groups. When disabled, columns return to the default sort in the data panel, while the column properties in the TML file are unaffected.

List of users subscribed to a Monitor alert.

Alternate names for the column, used in search.

Contains configuration for the answer, if it displays in table format. In a Models TML file, specific table used in defining higher-level objects, such as table paths.

The columns in an Answer that is being displayed in table format.

The list of table paths.

List of tables used by the underlying KPI. Each table is defined by name.

List of tabs in the Liveboard.

Container for the threshold value in a Monitor threshold-based alert.

Specifies the timezone ThoughtSpot should use when sending an alert. For example, if you live in New York City (ET) and are creating an alert for someone in Los Angeles (PST), you may want to specify that the alert should be sent at 9 AM in the America/Los_Angeles timezone. Specify the timezone with the full name: America/Los_Angeles, not PST.

The type of date filter. Within the chart section of an Answer TML file, this is the chart type. Within a Connection TML file, this is the type of connection. Within a Join file, this is the join type.

The email address of the creator of a Monitor alert, or the email addresses of subscribed users for a Monitor alert. The creator information is only visible for administrators. If you specify both a username and a user_email for the creator of a Monitor alert, the username specified takes precedence. If the user_email is the only parameter specified and multiple ThoughtSpot users have that email address, the TML validation returns an error, and you must specify a username.

The username of the creator of a Monitor alert, or the usernames of subscribed users for a Monitor alert. The creator information is only visible for administrators. If you specify both a username and a user_email for the creator of a Monitor alert, the username specified takes precedence.

The threshold value in a Monitor threshold-based alert, or an accepted value for a Parameter, if a list was configured when creating a Parameter. In a Connection TML file, the value defined in a key-value pair. In a Liveboard TML file, the configured value of the Parameter referenced in a formula in the last saved state of the Liveboard or an Answer within a Liveboard.

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

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

The list of columns in the view.

The id of a visualization.

The visualizations in a Liveboard: tables, charts, and headlines.

The GUID for the Liveboard visualization. The GUID provides a distinct way to identify the Liveboard visualization, even if it has the same name as another Liveboard visualization.

The GUID of a Liveboard visualization. Used in Monitor alert TML files to specify the KPI used to create the alert. If you are importing or editing an Answer, use answer_id instead, and do not include any part of the pinboard_viz_id section.

Container for worksheet id and name to which the cohort belongs.

The list of columns in the Worksheet.

The width of the Liveboard visualization.

The horizontal location of the Liveboard visualization, relative to the upper left of the Liveboard.

The vertical location of the Liveboard visualization, relative to the upper left of the Liveboard.