Prerequisites #

Note: administrator permissions are required to install Xtract IS.

To use Xtract IS, the file XtractISSetup.exe must be executed and installed both on the local development environment (Visual Studio or SSDT) and on the SSIS server. For more information, see section Licensing.

Normal Setup #

In the standard setup, execute the XtractISSetup.exe file and follow the instructions of the setup program.

XIS_Setup

During setup, various DLLs are copied to certain directories to be used by Integration Services.

The license installation procedure is described in the section Installing the license.

Installation Folder 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 folder Folder with customer-specific function modules (.txt) corresponding to SAP transport requests (.zip).
InstallXtractIS.exe Application for installing and registering the Xtract IS components and DLLs on the system.
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.
xis_version.bat Version batch file. When starting xis_version.bat, make sure to pass XtractISVersionInfo.exe file from the installation directory as a parameter.
XtractLicenseManager.exe Application to manage and view licenses.
uninst.exe Tool for uninstalling and removing Xtract IS with all its components from your machine.
gac-uninstall.bat Tool to clear the GAC of all Xtract IS related components.
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.

Silent Setup #

Note: All switches are case sensitive.

The setup program can also be started without the GUI. This type of setup program execution is called “silent setup”. If you want to execute the silent setup, use the switch /S .
To set the installation path, use the switch /D.

You can find more settings for the setup on the following website: Command Line Usage.

Blocking, Exit-Codes and Authorization

Using the /w switch at the beginning of the statement provides the following functions:

  • You can let the setup program or the license manager block the calling process (e.g., a batch) until the installation is finished.
  • You can receive a correct exit code to check the successful and correct installation finish

Examples:

start /w XtractISSetup.exe /S
start /w XtractLicenseManager.exe "My License\XtractIS.License.json"
start /w XtractLicenseManager.exe XtractIS.License.json

Displaying the Xtract IS components within SSIS #

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.

XIS_SSIS_Toolbox

Warning! Xtract IS components not visible
With the current version of the SSDT for VS 2015, SQL Server vNext or SQL Server 2017 are selected by default as the target environment for the deployment network of SSIS projects. With this setting, the Xtract IS components are not visible in the SSIS toolbox.
Change the target environment for the deployment to SQL Server 2016 to display the Xtract IS components in the toolbox.

XIS_deployment_target_version_vNext