Microsoft SQL Server Integration Services (SSIS) (File) - Import
Availability-note
AWS
AWS-only features are available at any of the following URLs: us.cloud.talend.com, eu.cloud.talend.com, ap.cloud.talend.com
Bridge Requirements
This bridge:requires Internet access to https://repo.maven.apache.org/maven2/ and/or other tool sites to download drivers into <TDC_HOME>/data/download/MIMB/.
Bridge Specifications
| Vendor | Microsoft |
| Tool Name | SQL Server Integration Services (SSIS) |
| Tool Version | 9.0 (2005) to 15x (2019) |
| Tool Web Site | https://docs.microsoft.com/en-us/sql/integration-services/ |
| Supported Methodology | [Data Integration] Multi-Model, ETL (Source and Target Data Stores, Transformation Lineage, Expression Parsing) via DTSX XML File |
| Data Profiling |  |
| Incremental Harvesting | |
| Multi-Model Harvesting |  |
| Remote Repository Browsing for Model Selection | |
SPECIFICATIONS
Tool: Microsoft / SQL Server Integration Services (SSIS) version 9.0 (2005) to 15x (2019) via DTSX XML File
See https://docs.microsoft.com/en-us/sql/integration-services/
Metadata: [Data Integration] Multi-Model, ETL (Source and Target Data Stores, Transformation Lineage, Expression Parsing)
Component: MicrosoftSqlServerIs version 11.2.0
DISCLAIMER
This import bridge requires internet access to download third-party libraries:
- such as https://repo.maven.apache.org/maven2/ to download open source third-party libraries,
- and more sites for other third-party software such as database specific JDBC drivers.
The downloaded third-party libraries are stored into $HOME/data/download/MIMB/
- If HTTPS fails, the import bridge then tries with HTTP.
- If a proxy is used to access internet, you must configure that proxy in the JRE (see the -j option in the Miscellaneous parameter).
- If the import bridge does not have full access to internet, that $HOME/data/download/MIMB/ directory can be copied from another server with internet access where the command $HOME/bin/MIMB.sh (or .bat) -d can be used to download all third-party libraries used by all bridges at once.
By running this import bridge, you hereby acknowledge responsibility for the license terms and any potential security vulnerabilities from these downloaded third-party software libraries.
OVERVIEW
The import bridge imports SSIS Packages from a dtsx file.
REQUIREMENTS
n/a
FREQUENTLY ASKED QUESTIONS
n/a
LIMITATIONS
Refer to the current general known limitations at MIMB Known Limitations or bundled in Documentation/ReadMe/MIMBKnownLimitations.html
SUPPORT
Provide a troubleshooting 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 -backup option, although this common option is not implemented on all bridges for technical reasons).
When an issue is encountered with SSIS parameters, please provide a backup of metadata that includes parameter(s). It should allow us to reproduce, explain, and, if necessary, address the issue(s).
Bridge Parameters
| Parameter Name | Description | Type | Values | Default | Scope | |||||||||||||||||||||||||
| File | Specify the DTSX file path to import from. All depended external connection files with 'conmg' extension must be in the same directory. |
FILE |
|
|||||||||||||||||||||||||||
| Directory | Path to directory containing DTSX files to import. Leave it empty when using the 'File' parameter. All depended external connection files with 'conmg' extension must be in the same directory. |
DIRECTORY | ||||||||||||||||||||||||||||
| Variable values file | MICROSOFT SQL SERVER IS CONFIGURATION OVERRIDE File defines overrides for SSIS parameters and variables. SSIS supports project and package level parameters (and variables). The bridge understands and uses them for lineage building. We support parameters since SSIS version 2005. Each definition consists of name and value pair(e.g. param_name=param_value_verride). Each name should be prefixed with NAMESPACE. For example: $Project::project_parameter_1=global_override_1 $Package::package_parameter_1=global_override_2 User::user_variable_1=global_override_3 System::system_variable_1=global_override_4 Configuration pair can be set on ROOT(file beginning) or separated by CONTEXT([Project:project_name.]package_name[.task_name]). For example: $Project::project_parameter_1=global_override_1 // ROOT override [PackageName] $Project::project_parameter_1=global_override_2 // package specific overrride [PackageName.TaskName] User::task_variable_1=global_override_3 // task specific override For multi-project import CONTEXT requires Project prefix. For example: $Project::project_parameter_1=global_override_1 // ROOT, all projects override [Project:Project_1] $Project::project_parameter_1=global_override_2 // project "Project_1" specific overrride [Project:Project_1.PackageName.TaskName] $Project::project_parameter_1=global_override_3 // project "Project_1" package and task specific overrride [Project:Project_2.PackageName] $Project::project_parameter_1=global_override_4 // project "Project_2" package specific overrride Consider using the file when SSIS employs variables (without reasonable default values) in SQL statements. It should help with understanding lineage through SQL statements. When the same variable is defined multiple times in a context, the latest definition is used. However, when the same variable is defined in [Package] and [Package.Task] contexts the definition in the higher level context, [Package.Task] is used. Variable names are case sensitive. The file overrides default variable values if any defined in SSIS. |
FILE |
|
|||||||||||||||||||||||||||
| Encoding | Specifies an encoding character set of the source file for 'Execute SQL Task' when property 'SQLSourceType' is set to 'File connection'. | ENUMERATED |
|
windows-1252 | ||||||||||||||||||||||||||
| Password | The value of the password for the protected package. | PASSWORD | ||||||||||||||||||||||||||||
| 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> This option allows to save the bridge input metadata for further troubleshooting. The provided <directory> must be empty. The primary use of this option is for data store import bridges, in particular JDBC based database import bridges. Note that this option is not operational on some bridges including: - File based import bridges (as such input files can be used instead) - DI/BI repository import bridges (as the tool's repository native backup can be used instead) - Some API based import bridges (e.g. COM based) for technical reasons. 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.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) ETL OPTIONS These options are available on all ETL/DI tools and scripting import bridges in order to: - Process all SQL parsing - Build runtime models from design models and runtime variables - Calculate runtime summary lineage -etl.summary.add.ultimate (previously -ppus) Adds the ultimate runtime lineage summary (may generate a very large model). -etl.summary.only.ultimate (previously -ppsp) Only produces the ultimate runtime lineage summary (may generate a very large model). -etl.connections.add.internal.design (previously -pppd) Adds the internal ETL design data connectors (needed for ETL conversion). -etl.connections.remove.input (previously -ri) Removes all input (source) data connections (to reduce the size of the generated model). -etl.transformations.enable.xml This option enables the parsing and support of XML transformations in DI/ETL import bridges such as Informatica PowerCenter, Informatica Developer, Microsoft SSIS, IBM DataStage, and Talend Data Integration. In case of Informatica, such XML transformations corresponds to the following PowerCenter features https://docs.informatica.com/data-integration/powercenter/10-5/xml-guide/midstream-xml-transformations.html https://docs.informatica.com/data-integration/powercenter/10-5/xml-guide/xml-source-qualifier-transformation.html Note that this option may significantly slow down the import. MICROSOFT SQL SERVER IS OPTIONS -s enable specifying mappings between Transformation Script inputs and outputs externally. In this case, the inputs go to a table in '_Script_' database and outputs come from a table in the database. One can specify mapping relationships between inputs and outputs by defining a mapping between their tables. By default the import bridge interconnect all inputs to all outputs in Transformation Scripts. -p <path to dtutil.exe> The dtutil.exe is a Microsoft utility that can decrypt protected files. It is only available for Windows. This utility is SQL Server version specific. When multiple versions of SQL Server are installed use the appropriate utility version. The import attempts to find and use dtutil.exe automatically by looking for the executable by the default location for different SQL Server versions starting from the latest. Utilize this option if the import is unable to locate the dtutil.exe and reports an error. E.g. -p 'C:\Program Files\Microsoft SQL Server\120\DTS\Binn\dtutil.exe' -connection.fullyqualifiedname Prefixes connection names with {$project_name}:{$package_name}: tags. Helps to distinguish connections with same name in different packages. -connection.catalogname <boolean> Controls #{$catalog_name} suffix in relation database connection names. -connection.catalogname false -environment <string> Specify used Environment in format "environment_folder\environment_name". Actual if environment variable used. -cd <string> Split or merge file system connections by a directory path. Useful to split a connection into two or more root folders, that can be stitched to two or more file stores. To split the connection 'orig_con' into two connections: 'a_con' based upon the 'a' folder and the rest remains in the orig_con connection: -cd a_con=orig_con:/a To split the connection 'orig_con' into two connections: 'a_con' based upon the 'root/a' folder: -cd a_con=orig_con:/root/a - Useful to merge several connections into one. To merge two connections 'C:' with a root folder 'R1' and 'B:' with a root folder 'R2' into one connection 'C:' with two root folders - 'R1' and 'R2': -cd C:\=B:\ |
STRING |
Bridge Mapping
| Meta Integration Repository (MIR) Metamodel (based on the OMG CWM standard) |
"Microsoft SQL Server Integration Services (SSIS) (File)" Metamodel Microsoft SQL Server IS (Data Flow Task) |
Mapping Comments |
| AggregationTransformation | Aggregate | |
| Description | Description | |
| Name | Name | |
| ConnectionDataAttribute | Variable, Result Column, External Column | |
| Description | Description | |
| Name | Name | |
| ConnectionDataSet | Variables, Table, Stored Procedure, File | |
| Description | Description | |
| Name | Name | |
| ConnectionNamespace | Directory | |
| Description | Description | |
| Name | Name | |
| ConnectionPackage | Database Schema | |
| Description | Description | |
| Name | Name | |
| DiModel | Data Flow Task | |
| Description | Description | |
| Name | Name | |
| ExpressionTransformation | Character Map, Derived Column, Data Conversion | |
| Description | Description | |
| Name | Name | |
| FilteringTransformation | CDC Splitter, Conditional Split | |
| Description | Description | |
| Name | Name | |
| GenericConnectedTransformation | Script Component, Cache Transform, OLE DB Command, Slowly Changing Dimension | |
| ConnectionName | Connection Manager | |
| Description | Description | |
| Name | Name | |
| GenericTransformation | Percentage Sampling, Import Column, Fuzzy Grouping, Custom Component, Generic, Export Column, Unpivot, Data Mining Query, Multicast, Row Sampling, Audit, Balanced Data Distributor, Pivot, Row Count, Copy Column | @nativeType='Import Column', DataMiningQuery,MultiCast,ExportColumn,CopyColumn,ImportColumn,OleDbCommand |
| Description | Description | |
| Name | Name | |
| JoinTransformation | Merge Join | |
| Description | Description | |
| Name | Name | |
| LookupTransformation | Term Extraction, Lookup, Fuzzy Lookup, Term Lookup | |
| ConnectionName | Connection Manager | |
| Description | Description | |
| Name | Name | |
| ReaderTransformation | ODBC Source, Excel Source, Flat File Source, OLE DB Source, CDC Source, ADO NET Source, Source, XML Source, Raw File Source | |
| ConnectionName | Connection Manager | |
| Description | Description | |
| Name | Name | |
| SortingTransformation | Sort | |
| Description | Description | |
| Name | Name | |
| StoreConnection | Connection | |
| Description | Description | |
| Name | Name | |
| SystemType | System Type | |
| TransformationDataAttribute | Column | |
| Description | Description | |
| Name | Name | |
| TransformationDataSet | Input, Conditional Output, Output | |
| Description | Description | |
| Name | Name | |
| UnionTransformation | Union All, Merge | |
| Description | Description | |
| Name | Name | |
| WriterTransformation | Destination, Data Streaming Destination, Partition Processing | |
| ConnectionName | Connection Manager | |
| Description | Description | |
| Name | Name |