Xtract IS is required when developing and running SSIS packages.
Prerequisites #
Note: Administrator permissions are required to install Xtract IS.
Make sure to install the necessary tools in the correct order:
| Order | Runtime Environment | Development Environment(s) |
|---|---|---|
| 1 | SQL Server (+ Integration Services) | Visual Studio + SQL Server Data Tools |
| 2 | Visual Studio + SQL Server Data Tools | SQL Server Integration Services |
| 3 | Xtract IS | Xtract IS |
Note: When you install Visual Studio, make sure to select the Data Storage & Processing toolset.
SQL Server runs on the runtime environment. On the runtime environment, the developed SSIS packages are deployed (SSISDB) and can be scheduled by means of SQL Server Agent.
In order to use Xtract IS Data Flow Tasks, the XtractISSetup.exe file must be installed on all instances with a valid license. For more information, see section Licensing.
Installation via Setup Program #
Execute the XtractISSetup.exe file and follow the instructions of the setup program.
The Xtract IS Setup installs Xtract IS as a plug-in into SSIS.
The license installation procedure is described in the section Installing the license.
Installation Directory Files
The list below shows several most important files that are placed into the default directory C:\Program Files\XtractIS after installation:
| Filename | Description |
|---|---|
| ABAP Directory | Directory with SAP function modules. Read the readme.txt within the directory for more information. See also SAP Customizing. |
| XtractISSetup.exe | Application for installing and registering the Xtract IS components within SSIS. |
| XtractISConversionPreparer.exe | Tool, which prepares older version of SSIS packages (containing Xtract IS components) for migration to newer versions of SSIS. See also section SSIS Migration. |
| XtractISVerisonInfo.exe | Starts the XtractISVerisonInfo.exe via the command line tool to display and read the currently installed version. |
| XtractLicenseManager.exe | Application to manage and view licenses. |
| Uninstall Xtract IS | Tool for uninstalling and removing Xtract IS with all its components from your machine. |
| gac-uninstall.bat | For debugging only. Tool to clear the GAC of all Xtract IS related components in case of installation issues. |
| Eula_XtractIS.rtf | Document containing the license agreement for the use of the software Xtract IS. |
| XtractISLicense.json | License file with information about the server, the component and runtime. |
| UninstallDllLicense.bat | For older license files. See Updating the Xtract.License.dll to XtractISLicense.json |
Unattended Installation #
The installation of Xtract IS and the Xtract License Manager can be initiated unattended without the GUI.
- To execute the
XtractISSetup.exein unattended mode, use the switch –unattended. - To execute the
XtractLicenseManager.exe(License Manager) in unattended mode, pass the path to the license file as a command line argument.
XtractISSetup.exe and XtractLicenseManager.exe are Windows applications, meaning the Windows Command Prompt does not wait until the installation is complete.
To wait until the installation is complete, use the start command with the /wait switch.
Note: All switches are case sensitive.
start /wait XtractISSetup.exe --unattended
start /wait XtractLicenseManager.exe "C:\Program Files\XtractIS\XtractISLicense.json"
Product Version #
When installing a product by Theobald Software, the version of the product is displayed in the installation menu.
We recommend installing the latest version
To check the version of the installed product, go to Settings > Apps in Windows and check the product version.
Displaying Xtract IS components within Visual Studio #
After a successful installation of the Xtract IS, the Xtract IS components are automatically available in the SSIS Toolbox of a Data Flow Task in your Visual Studio Integration Services project.
The Xtract IS components may still be invisible due to version incompatibility issues.
The deployment target version of the SSIS project used must match the version of the installed SQL Server Data Tools (SSDT). If the versions do not match, the necessary Xtract IS extensions will be missing from the SQL Server installation (SSDT) and runtime errors may be displayed.
Change the Target Server version for deployment to display the Xtract IS components in the toolbox.
