Installation
This page shows how and where to install Xtract Universal.
Prerequisites
Administrator permissions are required to install Xtract Universal.
Setup
XtractUniversalSetup.exe is an industry standard setup. Execute the XtractUniversalSetup.exe file and follow the instructions of the setup program.
When starting the installation program, optional components can be selected during the setup.
| Component | Description |
|---|---|
| Main Product Files | All required files to use Xtract Universal. |
| Designer | Installs the Designer application, uncheck this option if you want to use Xtract Universal without a graphical interface. |
| Server | Installs the Xtract Universal Server |
| Convert config files | Converts extractions, sources, destinations, etc. from previous version format to new format. Crucial when installing major releases and upgrading from e.g., version 3.x to 4.x. |
| Install Service | Installs the server component as a windows service that runs under a virtual service account with the least required privileges, see Server. |
| XtractUniversal Report Server Plugin | Plugin required by the Power BI Report Server destination. |
| Start Menu Shortcuts | Component that adds shortcuts to the start menu. |
Note
Make sure to mark the option “Server > Install Service” during the Installation, as installing a server without the service is only used for development purposes.
For information on how to install a license, see Licensing.
Warning
Errors due to different version numbers.
Differences in version numbers of Designer and Server may lead to errors.
Make sure that Designer and Server have identical version numbers.
Installation Directory Files
The list below shows several most important files that are placed into the default directory C:\Program Files\XtractUniversal after installation:
| Filename | Description |
|---|---|
| ABAP directory | Directory with SAP function modules. Read the readme.txt within the directory for more information. See also SAP Customization. |
| Alteryx directory | Directory with a plugin setup for the Alteryx destination. |
| logs directory | Directory with server and extraction etc. logs, see Logs. |
| config directory | Directory containing all SAP connections, extractions, destinations and other settings. See also Backup and Migration. |
| powerbi directory | Directory containing files related to Power BI Connector destination. |
| private directory | Directory containing keys for encrypted SAP passwords. This directory contains sensitive information and must be to be secured accordingly. |
| result-cache directory | Directory with extraction cache files, only applicable for Pull Destinations. |
| xu.exe | Command line tool used for executing extractions, see Schedule an Extraction. |
| xu-config.exe | Command line tool used for creating extractions, see Create Extractions without the Xtract Universal Designer GUI. |
| XtractCleanup.exe | Application that deletes all cached results and log files, depending on the Web Server settings of Xtract Universal. |
| XtractDesigner.exe | Xtract Universal Designer application to create, test and monitor extractions. |
| ConfigConverter.exe | Application that converts extractions, sources, destinations, etc. from previous version format to new format. Crucial when installing major releases and upgrading from e.g., version 3.x to 4.x. |
| uninstall.exe | Tool for uninstalling and removing Xtract Universal with all its components from your machine. |
| XtractUniversalSetup.exe | Setup of the currently installed version, see Migration to a Different Machine. |
| XtractUniversal Report Server Plugin | Plugin required by the Power BI Report Server destination. |
| Eula_XtractUniversal.rtf | Document containing the license agreement for the use of the software Xtract Universal. |
| XtractUniversalLicense.json | License file with information about the server, the component and runtime. |
Note
The Xtract Universal Server can be started as a console program for test purposes. For more details on starting Xtract Universal Server as a console program, see Knowledge Base Article: Target Principal Field.
The installation of Xtract Universal can be initiated unattended without the GUI in a non-interactive way via the Windows Command Prompt. Execute the XtractUniversalSetup.exe via command line and use the switch --unattended.
XtractUniversalSetup.exe is 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.
Version Number
When installing Xtract Universal, the version of the product is displayed in the installation menu. To check the version of the installed product in Windows, open the Windows Settings and navigate to Apps > Installed apps.
Installation of the Standalone Designer
My Theobald Software - Portal for Customers and Partners offers a download option for a standalone version of the Xtract Universal Designer. The standalone Designer can be used to connect to a central Xtract Universal repository without any software installation.
Prerequisites
The Xtract Universal Server has to be installed on a central server instance e.g., a company-wide application server. As a result, access to a common Xtract Universal repository, e.g., C:\Program Files\XtractUniversal\config is possible and can be used by several Xtract Universal users.
How to Use the Standalone-Designer
After the standalone Designer is downloaded, unpack the files from the .zip folder to any directory. The folder contains two executable files:
XtractDesigner.exestarts the Designerxu.exeis the command line tool used for executing extractions, see Call via Commandline
Use the XtractDesigner.exe file to start the Designer. Before you connect to a central Xtract Universal Server, make sure you have access rights to the server and repository, see Access Management.
Note
When updating the software, you have to manually download the latest version of the standalone Designer from My Theobald Software - Portal for Customers and Partners and replace the old files.
Note
The standalone Designer might be classified as 'dangerous' by antivirus software. Make sure the Designer is not blocked by antivirus software.