Bridge Specifications
| Vendor | ThoughtSpot |
| Tool Name | ThoughtSpot |
| Tool Version | 4.5 |
| Tool Web Site | https://www.thoughtspot.com/ |
| Supported Methodology | [Business Intelligence] Multi-Model, BI Design (RDBMS Source, Dimensional Target, Transformation Lineage, Expression Parsing), BI Report (Relational Source, Dimensional Source, Report Structure) via REST API |
SPECIFICATIONS
Tool: ThoughtSpot / ThoughtSpot version 4.5 via REST API
See https://www.thoughtspot.com/
Metadata: [Business Intelligence] Multi-Model, BI Design (RDBMS Source, Dimensional Target, Transformation Lineage, Expression Parsing), BI Report (Relational Source, Dimensional Source, Report Structure)
Component: ThoughtSpotBi version 11.0.0
OVERVIEW
Imports metadata from a ThoughtSpot server.
REQUIREMENTS
n/a
FREQUENTLY ASKED QUESTIONS
n/a
LIMITATIONS
Refer to the current general known limitations at http://metaintegration.com/Products/MIMB/MIMBKnownLimitations.html or bundled in Documentation/ReadMe/MIMBKnownLimitations.html
SUPPORT
Provide a trouble shooting package with:
- the debug log (can be set in the UI or in conf/conf.properties with MIR_LOG_LEVEL=6)
- the metadata backup if available (can be set in the Miscellaneous parameter with option -backup)
Bridge Parameters
| Parameter Name | Description | Type | Values | Default | Scope | ||
| Server URL | Enter the ThoughtSpot Server URL here. | STRING | https://localhost/ | Mandatory | |||
| Login User | Enter the username which the bridge will use to log in. | STRING | tsadmin | Mandatory | |||
| Login password | Enter the password associated with the username which the bridge will use to log in. | PASSWORD | |||||
| Sticker filter | Used to select answer and pinboard reports by their assigned stickers. If a report has a sticker that was specified as a filter, it will be selected for import. You can specify multiple stickers, separated by semicolon (;) character. |
REPOSITORY_SUBSET | |||||
| Group filter | Used to select answer and pinboard reports by their author's assigned groups. If a report's author belongs to a group that was specified as filter, it will be selected for import. You can specify multiple user groups, separated by semicolon (;) character. |
REPOSITORY_SUBSET | |||||
| Incremental import | Incremental import only extracts what has changed since the last import. The initial full metadata harvesting (model import) of a very large source system can take a long time. However the extracted metadata are organized as a multi-model, where each model is a unit of change (e.g. Schema of a RDBMS server, or report of BI server). Subsequent model imports are dramatically faster than the initial import as this bridge will automatically try to detect changes in the source system, in order to only process the modified, added or deleted models and reuse all unchanged metadata from the model cache. Note however that the detection of change is more or less efficient depending on the sources system: e.g. BI servers can quickly provide the list of new, modified or deleted reports, but not all data stores offer a schema level change detection. 'True' Import only the changes made since the last import 'False' import all metadata. This option is required after upgrading the bridge in particular to take full advantage of any additional metadata coverage. For debugging purpose, the option -cache.clear of the Miscellaneous parameter can be used to clear one model from the cache which is located (by default) in: $HOME/data/MIMB/cache/<BridgeId>/<ModelId> |
BOOLEAN |
|
True | |||
| Miscellaneous | INTRODUCTION Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g. -connection.cast MyDatabase1="SQL Server" Some options can be used multiple times if applicable, e.g. -connection.rename NewConnection1=OldConnection1 -connection.rename NewConnection2=OldConnection2; As the list of options can become a long string, it is possible to load it from a file which must be located in ${MODEL_BRIDGE_HOME}\data\MIMB\parameters and have the extension .txt. In such case, all options must be defined within that file as the only value of this parameter, e.g. ETL/Miscellaneous.txt JAVA ENVIRONMENT OPTIONS -java.memory <Java Memory's maximum size> (previously -m) 1G by default on 64bits JRE or as set in conf/conf.properties, e.g. -java.memory 8G -java.memory 8000M -java.parameters <Java Runtime Environment command line options> (previously -j) This option must be the last one in the Miscellaneous parameter as all the text after -java.parameters is passed "as is" to the JRE, e.g. -java.parameters -Dname=value -Xms1G The following option must be set when a proxy is used to access internet (this is critical to access https://repo.maven.apache.org/maven2/ (and exceptionally a few other tool sites) in order to download the necessary third party software libraries. -java.parameters -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttps.proxyHost=127.0.0.1 -Dhttps.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass -Dhttps.proxyUser=user -Dhttps.proxyPassword=pass -java.executable <Java Runtime Environment full path name> (previously -jre) It can be an absolute path to javaw.exe on Windows or a link/script path on Linux, e.g. -java.executable "c:\Program Files\Java\jre1.8.0_211\bin\javaw.exe" -environment.variable <name>=<value> (previously -v) None by default, e.g. -environment.variable var2="value2 with spaces" MODEL IMPORT OPTIONS -model.name <model name> Override the model name, e.g. -model.name "My Model Name" -prescript <script name> The script must be located in the bin directory, and have .bat or .sh extension. The script path must not include any parent directory symbol (..). The script should return exit code 0 to indicate success, or another value to indicate failure. For example: -prescript "script.bat arg1 arg2" -cache.clear Clears the cache before the import, and therefore will run a full import without incremental harvesting. Warning: this is a system option managed by the application calling the bridge and should not be set by users. -backup <directory> Full path of an empty directory to save the metadata input files for further troubleshooting. DATA CONNECTION OPTIONS Data Connections are produced by the import bridges typically from ETL/DI and BI tools to refer to the source and target data stores they use. These data connections are then used by metadata management tools to connect them (metadata stitching) to their actual data stores (e.g. databases, file system, etc.) in order to produce the full end to end data flow lineage and impact analysis. The name of each data connection is unique by import model. The data connection names used within DI/BI design tools are used when possible, otherwise connection names are generated to be short but meaningful such as the database / schema name, the file system path, or Uniform Resource Identifier (URI). The following options allows to manipulate connections. These options replaces the legacy options -c, -cd, and -cs. -connection.cast ConnectionName=ConnectionType Casts a generic database connection (e.g. ODBC/JDBC) to a precise database type (e.g. ORACLE) for SQL Parsing, e.g. -connection.cast "My Database"="SQL SERVER". The list of supported data store connection types includes: ACCESS CASSANDRA DB2 DENODO HIVE MYSQL NETEZZA ORACLE POSTGRESQL PRESTO REDSHIFT SALESFORCE SAP HANA SNOWFLAKE SQL SERVER SYBASE TERADATA VECTORWISE VERTICA -connection.rename OldConnection=NewConnection Renames an existing connection to a new name, e.g. -connection.rename OldConnectionName=NewConnectionName Multiple existing database connections can be renamed and merged into one new database connection, e.g. -connection.rename MySchema1=MyDatabase -connection.rename MySchema2=MyDatabase -connection.split oldConnection.Schema1=newConnection Splits a database connection into one or multiple database connections. A single database connection can be split into one connection per schema, e.g. -connection.split MyDatabase All database connections can be split into one connection per schema, e.g. -connection.split * A database connection can be explicitly split creating a new database connection by appending a schema name to a database, e.g. -connection.split MyDatabase.schema1=MySchema1 -connection.map DestinationPath=SourcePath Maps a source path to destination path. This is useful for file system connections when different paths points to the same object (directory or file). On Hadoop, a process can write into a CSV file specified with the HDFS full path, but another process reads from a HIVE table implemented (external) by the same file specified using a relative path with default file name and extension, e.g. -connection.map hdfs://host:8020/users/user1/folder/file.csv=/user1/folder On Linux, a given directory (or file) like /data can be referred to by multiple symbolic links like /users/john and /users/paul, e.g. -connection.map /users/John=/data -connection.map /users/paul=/data On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g. -connection.map M:\=C:\data -connection.map N:\=C:\data -connection.casesensitive ConnectionName Overrides the default case insensitive matching rules for the object identifiers inside the specified connection, provided the detected type of the data store by itself supports this configuration (e.g. Microsoft SQL Server, MySql etc.), e.g. -connection.casesensitive "My Database" |
STRING |
Bridge Mapping
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"ThoughtSpot" Metamodel ThoughtSpot (Repository) |
Mapping Comments |
| DirectoryStructureModel | Server | |
| Name | Name | |
| Folder | Sticker, Group | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| StoreContent | Answer, Business Data Model, Database, Pinboard | |
| Author | Author | |
| CreationTime | Creation Time | |
| Description | Description | |
| LastModificationTime | Last Modification Time | |
| Modifier | Modifier | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type |
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"ThoughtSpot" Metamodel ThoughtSpot (Business Data Model) |
Mapping Comments |
| ClassDiagram | Diagram | |
| Name | Name | |
| Dimension | Logical Table, Worksheet | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| PhysicalName | Physical Name | |
| DimensionAttribute | Logical Column | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| Join | Relationship | |
| Name | Name | |
| NativeId | Native Id | |
| StoreModel | Business Data Model | |
| ModificationTime | Modification Time | |
| Name | Name |
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"ThoughtSpot" Metamodel ThoughtSpot (Answer) |
Mapping Comments |
| Condition | Filter | |
| Name | Name | |
| NativeId | Native Id | |
| ReportAttribute | Logical Column | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| ReportChart | Visualization | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| ReportDataSet | Worksheet | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| ReportField | Field | |
| Name | Name | |
| ReportPage | Answer Sheet | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| StoreModel | Answer Model | |
| Author | Author | |
| CreationTime | Creation Time | |
| Description | Description | |
| ModificationTime | Modification Time | |
| Modifier | Modifier | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type |
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"ThoughtSpot" Metamodel ThoughtSpot (Database) |
Mapping Comments |
| Attribute | Column | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| Class | Table | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| DatabaseSchema | Schema | |
| Name | Name | |
| StoreModel | Database | |
| Name | Name |
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"ThoughtSpot" Metamodel ThoughtSpot (Pinboard) |
Mapping Comments |
| Condition | Filter | |
| Name | Name | |
| NativeId | Native Id | |
| Report | Answer Book | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| ReportAttribute | Logical Column | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| ReportChart | Visualization | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| ReportDataSet | Worksheet | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| ReportField | Field | |
| Name | Name | |
| ReportPage | Pinboard Sheet, Answer Sheet | |
| Description | Description | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type | |
| StoreModel | Pinboard Model | |
| Author | Author | |
| CreationTime | Creation Time | |
| Description | Description | |
| ModificationTime | Modification Time | |
| Modifier | Modifier | |
| Name | Name | |
| NativeId | Native Id | |
| NativeType | Native Type |