Bridge Specifications
| Vendor | MicroStrategy |
| Tool Name | Intelligence Server |
| Tool Version | 11.x |
| Tool Web Site | http://www.microstrategy.com/ |
| Supported Methodology | [Business Intelligence] Multi-Model, BI Design (RDBMS Source, Dimensional Target, Transformation Lineage), BI Report (Dimensional Source, Report Structure) via REST API |
SPECIFICATIONS
Tool: MicroStrategy / Intelligence Server version 11.x via REST API
See http://www.microstrategy.com/
Metadata: [Business Intelligence] Multi-Model, BI Design (RDBMS Source, Dimensional Target, Transformation Lineage), BI Report (Dimensional Source, Report Structure)
Component: MicroStrategyServer version 11.2.0
OVERVIEW
*** bridge_spec_microstrategyserver_import_description
Bridge Parameters
| Parameter Name | Description | Type | Values | Default | Scope | ||
| Server URL | Server URL. http://localhost:8080/MicroStrategyLibrary | STRING | http://localhost:8080/MicroStrategyLibrary | Mandatory | |||
| Project(s) | Enter the name(s) of the Project or projects that you want to connect to in the selected Project Source. | REPOSITORY_SUBSET | MicroStrategy Tutorial | ||||
| Login user | The user name used to connect to the Project Source. This import bridge is warrantied to be read only and will never affect the Repository contents. It is therefore safe to attempt the initial metadata harvesting as 'Administrator' in order to ensure that the entire Repository content is extracted without any access permission issue. Eventually, the administrator can set up a 'read only' user. Refer to the tool documentation on permissions and security for more details. |
STRING | Administrator | Mandatory | |||
| Login password | The password used to connect to the Project Source. | PASSWORD | |||||
| Default language | Specify the language you would like to use. For example en_us or de |
STRING | |||||
| Data model table design level | Controls the design level of the imported tables. It is particularly relevant when exporting metadata to a target tool which supports two views of the model: a logical view and a physical view. Some Data Modeling tools support this concept, where you can decide if a table appears both as a physical table and as a logical entity. Some Business Intelligence tools also support this concept, where you can decide if a table appears both in the physical model and in the business view of the model. 'Logical and physical' Tables will appear in both in the logical view and in the physical view of the model. 'Physical' Tables will appear only in the physical view of the model. |
ENUMERATED |
|
Physical | |||
| Import joins | Should joins be imported? 'True' The joins are imported. 'False' The joins are not imported. |
BOOLEAN |
|
True | |||
| Import hierarchies | Should hierarchies be imported? 'True' The hierarchies are imported. 'False' The hierarchies are not imported. |
BOOLEAN |
|
True | |||
| Multiple threads | Number of worker threads to harvest metadata asynchronously. - Leave the parameter blank to have the import bridge compute the value, between 1 and 6, based on JVM architecture and number of available CPU cores. - Specify a numeric value greater or equal to 1 to provide the actual number of threads. If the value specified is invalid, a warning will be issued and 1 will be used instead. If you experience out of memory conditions when harvesting metadata asynchronously, experiment with smaller numbers. If your machine has a lot of available memory (e.g. 10 GB or more), you can try larger numbers when harvesting many documents at once. Note that setting the number too high can actually decrease the performance due to resource contention. |
NUMERIC | |||||
| Miscellaneous | INTRODUCTION Specify miscellaneous options starting with a dash and optionally followed by parameters, e.g. -connection.cast MyDatabase1="MICROSOFT 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. Note: The majority of proxies are concerned with encrypting (HTTPS) the outside (of the company) traffic and trust the inside traffic that can access proxy over HTTP. In this case, an HTTPS request reaches the proxy over HTTP where the proxy HTTPS-encrypts it. -java.parameters -java.parameters -Dhttp.proxyHost=127.0.0.1 -Dhttp.proxyPort=3128 -Dhttp.proxyUser=user -Dhttp.proxyPassword=pass MODEL IMPORT OPTIONS -model.name <model name> Override the model name, e.g. -model.name "My Model Name" -prescript <script name> This option allows running a script before the bridge execution. The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), 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" -postscript <script name> This option allows running a script after successful execution of the bridge. The script must be located in the bin directory (or as specified with M_SCRIPT_PATH in conf/conf.properties), 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: -postscript "script.bat arg1 arg2" -cache.clear Clears the cache before the import, and therefore will run a full import without incremental harvesting. If the model was not changed and the -cache.clear parameter is not used (incremental harvesting), then a new version will not be created. If the model was not changed and the -cache.clear parameter is set (full source import instead of incremental), then a new version will be created. -backup <directory> Allows to save the input metadata for further troubleshooting. The provided <directory> must be empty. -restore <directory> Specify the backup <directory> to be restored. 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 option 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"="MICROSOFT SQL SERVER". The list of supported data store connection types includes: ACCESS APACHE CASSANDRA DB2/UDB DENODO GOOGLE BIGQUERY HIVE MYSQL NETEZZA ORACLE POSTGRESQL PRESTO REDSHIFT SALESFORCE SAP HANA SNOWFLAKE MICROSOFT SQL AZURE MICROSOFT SQL SERVER SYBASE SQL SERVER SYBASE AS ENTERPRISE TERADATA VECTORWISE HP 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 SourcePath=DestinationPath 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 /user1/folder=hdfs://host:8020/users/user1/folder/file.csv 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 /data=/users/John -connection.map /data=/users/paul On Windows, a given directory like C:\data can be referred to by multiple network drives like M: and N:, e.g. -connection.map C:\data=M:\ -connection.map C:\data=N:\ -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" -connection.caseinsensitive ConnectionName... Overrides the default case sensitive 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.caseinsensitive "My Database" -connection.level AggregationLevel Specifies the aggregation level for the external connections, e.g.-connection.level catalog The list of the supported values: server catalog schema (default) MICROSTRATEGY OPTIONS -sf Skip importing filters. -sp Skip importing prompts. -folders.exclude <file path> The folders.exclude option allows you to exclude folders within a project. You have to specify path to file with list of MicroStrategy folder paths. -folders.exclude E:\Microstrategy\folders.txt folders.txt file contains for example two folder paths \MicroStrategy Tutorial\Object Templates \MicroStrategy Tutorial\Profiles -folders.include <file path> The folders.include option allows you to import only specific folders within a project. You have to specify path to file with list of MicroStrategy folder paths. -folders.include E:\Microstrategy\folders.txt folders.txt file contains for example two folder paths \MicroStrategy Tutorial\Object Templates \MicroStrategy Tutorial\Profiles |
STRING |
Bridge Mapping
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"MicroStrategy (REST API) 11.x - New Beta Bridge" Metamodel MicroStrategy |
Mapping Comments |
| Argument | Function Parameter | |
| Comment | Comments | |
| Description | Description | |
| Name | Name | |
| NativeId | ID | MicroStrategy object ID |
| Association | Keys and referential integrity constraints are not persisted in the metadata | |
| AssociationRole | Keys and referential integrity constraints are not persisted in the metadata | |
| AssociationRoleNameMap | Keys and referential integrity constraints are not persisted in the metadata | |
| Attribute | Warehouse Table Column | |
| Comment | Comments | |
| Description | Description | |
| DesignLevel | as defined by the "Table Logical information" bridge option | |
| Name | Name | |
| NativeId | ID | MicroStrategy object ID |
| Position | as returned by the API | |
| BaseType | Datatype | |
| DataType | See datatype conversion array | |
| Name | Derived from the datatype | |
| NativeId | ID | MicroStrategy object ID |
| PhysicalName | Derived from the datatype | |
| CandidateKey | Keys and referential integrity constraints are not persisted in the metadata | |
| Class | Warehouse Table | |
| Comment | Comments | |
| CppClassType | Set to ENTITY | |
| CppPersistent | Set to True | |
| Description | Description | |
| DesignLevel | as defined by the "Table Logical information" bridge option | |
| Name | Name | |
| NativeId | ID | MicroStrategy object ID |
| ClassifierMap | Used to hold the lineage metadata | |
| NativeId | ID | MicroStrategy object ID |
| Condition | LogicalTable Lookup, Filter | Indicated how to perform the join between the LogicalTables Conditions are also created when importing Filters |
| DatabaseSchema | Warehouse Table | |
| Name | Namespace | |
| NativeId | ID | MicroStrategy object ID |
| DerivedType | Datatype | |
| DataType | DataType | See datatype conversion array |
| Length | Length in bytes | |
| Name | Derived from the datatype | |
| NativeId | ID | MicroStrategy object ID |
| PhysicalName | Derived from the datatype | |
| Scale | Scale | |
| DesignPackage | Folder | The imported MicroStrategy objects are placed in their respective folder |
| Comment | Comments | |
| Description | Description | |
| Name | Name | |
| NativeId | ID | MicroStrategy object ID |
| UserDefined | Set to TRUE | |
| Dimension | LogicalTable, Attribute, Fact, Metric | Each LogicalTable is imported as a Dimension Dimensions are also created to act as Classifier for Attributes, Facts and Metrics |
| Comment | Comments | |
| Description | Description | |
| Name | Name | |
| NativeId | ID | MicroStrategy object ID |
| Type | set to FACT if the logical table contains facts, REGULAR otherwise | |
| UserDefined | set to TRUE | |
| DimensionAttribute | LogicalTable BaseAttributeForm | Each BaseAttributeForm (implementation of an AttributeForm in the context of a Logical Table) is imported as DimensionAttribute |
| Comment | Comments | |
| Description | AttributeFormDescription | |
| Name | "AttributeName (AttributeFormName)" | |
| NativeId | ID | MicroStrategy object ID |
| Position | as returned by the API | |
| DrillPath | Hierarchy | Hierarchies are imported as MIRDrillPath as they can have many top levels (entry points) and they can span across levels of different MIRDimensions |
| Comment | Comments | |
| Description | Description | |
| Name | Name | |
| NativeId | ID | MicroStrategy object ID |
| DrillPathLevelAssociation | Hierarchy | Used to connect the Levels used in a Hierarchy |
| NativeId | ID | MicroStrategy object ID |
| Position | irrelevant for ragged hierarchies | |
| FeatureMap | AttributeForm, Fact | Used to hold the lineage and expressions metadata |
| NativeId | ID | MicroStrategy object ID |
| Operation | Expression text | empty if there is direct mapping to a source feature |
| Filter | Filter, CustomGroup, Security Filter | |
| Comment | Comments | |
| Description | Description | |
| Name | Name | |
| NativeId | ID | MicroStrategy object ID |
| ForeignKey | Keys and referential integrity constraints are not persisted in the metadata | |
| Join | LogicalTable Lookup | Joins are imported based on the lookup LogicalTable of each AttributeForm |
| JoinRole | LogicalTable Lookup | Connects two LogicalTables involved in a Join |
| Level | Attribute | Attributes are imported as Levels |
| Comment | Comments | |
| Description | Description | |
| Name | Name | |
| NativeId | ID | MicroStrategy object ID |
| LevelAssociation | AttributeRelationship | Specifies the parent-child relationships between levels, used in DrillPaths via DrillPathLevelAssociation objects |
| LevelAttribute | AttributeForm | |
| Comment | Comments | |
| Description | Description | |
| Name | Name | |
| NativeId | ID | MicroStrategy object ID |
| Measure | LogicalTable FactInfo, Fact, Metric | Each Fact is imported as Measure Each FactInfo (implementation of a Fact in the context of a Logical Table) is imported as Measure Each Metric is imported as a Measure |
| Comment | Comments | |
| Description | Description | |
| Name | Name | |
| NativeId | ID | MicroStrategy object ID |
| Position | Position of the FactInfo in the LogicalTable, as returned by the API | |
| Operation | Function | Each Function is imported as an Operation |
| Comment | Comments | |
| Description | Description | |
| Name | Name | |
| NativeId | ID | MicroStrategy object ID |
| Prompt | Prompt | |
| Name | Name | |
| Question | Display Description / Meaning | |
| PromptAnswer | Prompt | |
| Comment | Comments | |
| Description | Description | |
| Name | Name | |
| NativeId | ID | |
| Report | Report, Document | |
| Comment | Comments | |
| Description | Description | |
| Name | Name | |
| ReportAttribute | Attribute, Metric, Limit, Consolidation, Subtotal | Represents objects used in the report |
| Name | Name | |
| ReportAxis | Report Axis | Represent the report Vertical, Horizontal and Page axis |
| ReportChart | Chart Report | |
| ReportDataSet | Attribute, Metric, Limit, Consolidation, Subtotal | Represents objects used in the report, and how they are grouped |
| Name | Name | |
| ReportField | Report template element | |
| ReportPage | Report | |
| ReportPageBody | Document Body | |
| ReportPageFooter | Document Footer | |
| ReportPageHeader | Document Header | |
| ReportTable | Grid Report | |
| ReportText | Text field | |
| Value | textual value | |
| StoreConnection | Warehouse Catalog | |
| NativeId | ID | MicroStrategy object ID |
| StoreModel | Project | The project is accessed via a Data Source Name pointing to a MicroStrategy Intelligence Server |
| Comment | Comments | |
| Description | Description | |
| Name | Name | |
| NativeId | ID | MicroStrategy object ID |
| SystemType | Type | |
| SystemTypeOld | Type |