Note: administrator permissions are required to install Xtract Universal.
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 a product that is already installed, go to Control Panel > Programs > Programs and Features in Windows. Find the product in the list of installed software. The product version is displayed in the column Version.
XtractUniversalSetup.exe is an industry standard setup. Execute the XtractUniversalSetup.exe file and follow the instructions of the setup.
When starting the setup, components can be selected during the installation.
|Main Product Files||-||All required files to use Xtract Universal.|
|Designer||-||Installs the Designer application, uncheck the option if you want to use Xtract Universal without a graphical interface.|
|Server||Installs the Xtract Universal Server|
|Install Service||Installs the server component as a windows service. See also section Start 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.|
|Start Menu Shortcuts||-||Component that adds shortcuts to the start menu.|
Note: Mark the option “Server > Install Service” during the installation, as installing a server without the service is only used for development purposes.
The license installation procedure is described in the section Installing the license.
Program Directory Files #
The list below shows several most important files that are placed into the default directory
C:\Program Files\XtractUniversal after installation:
|ABAP directory||Directory with SAP function modules. Read the readme.txt within the directory for more information. See also SAP Customizing.|
|Alteryx directory||Directory with a plugin setup for the Alteryx destination.|
|logs directory||Directory with server and extraction etc. logs. See also section Logging.|
|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.|
|result-cache directory||Directory with extraction cache files, only applicable for pull destinations. See also sections Pull Destinations and General Settings > Misc. Tab > Cache Result Setting.|
|xu.exe||Command line tool used for executing extractions. See also section Scheduling an Extraction.|
|xu-config.exe||Command line tool used for creating extractions. For more information, refer to the knowledge base article Creating extractions without using 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 also Migrating to a Different Machine.|
|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: For more details on starting the Xtract Universal Server as a console application see the knowledge base article How to use target principal field.
Unattended Installation #
The installation can be initiated without the GUI in a non-interactive way via the Windows Command Prompt.
To execute the installation in silent mode, use the switch
Use the start command with the
/wait switch to wait until the installation is complete.
start /wait XtractSetup.exe --unattended
Note: All switches are case sensitive.
How to use the Standalone Designer #
My Theobald Software - Portal for Customers and Partners offers a download option for a standalone version of the Xtract Universal Designer for Windows. The standalone Designer can be used to connect to a central Xtract Universal repository without any software installation.
The Xtract Universal Service 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 (
C:\Program Files\XtractUniversal\config) is possible and can be used by several Xtract Universal users.
Starting the Standalone-Designer
When the download of the standalone Designer is completed, unpack the files from the
.zip folder to any directory.
The folder contains two executable files:
XtractDesigner.exestarts the Designer.
xu.exeis the command line tool used for executing extractions, see Call via Commandline.
XtractDesigner.exe file to start the Designer. Before you connect to a central XU-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.
New Installation and Update #
Warning! Data loss:
System updates or changes can restrict software functionalities and this may lead to data loss.
Create a backup of the directory:
C:\Program Files\XtractUniversal\config at regular intervals.
A regular update of the software is crucial for stable performance, especially major changes and high ([H]) priority updates. Check the Version History for updates. A newer version can be installed over the older version. All settings and created objects are preserved. When migrating data and settings to another server, follow the instructions described in section Backup and Migration.
Tip: Subscribe via email to Theobald Software’s technical newsletter that informs about new feature releases, knowledge base articles and and release notes.
- Check if you have a working test environment with a valid license and maintenance.
- Make sure that the test environment is a copy of the current production environment.
- Check the Version History and release notes in the knowledge base to check, if an update is needed.
- Create a backup of the current installation.
- Conduct any necessary preparations and changes as described in the Release Note / Version History. In case of major changes, use the ConfigConverter.
Note: When you update your test environment by copying single
config folders from the production environment, the
version.txt file must be copied, too.
version.txtis located in the
Upgrading Major Releases - ConfigConverter #
There are two ways of upgrading the product version:
- Upgrade during installation
- Manual upgrade
Upgrade During Installation
- Start the Xtract Universal setup.
- Make sure to mark the checkbox Convert config files checkbox.
The option Convert config files starts the ConfigConverter application, which ensures that all extractions, source systems, destinations, server and user settings are available in the new version.
- Confirm the conversion process in the command line pop-up window.
Note: When executing the ConfigConverter a backup folder is created in the installation directory, e.g.,
C:\Program Files\XtractUniversal\backup-[old version number].
This folder only stores the extractions that have been changed by the ConfigConverter.
If the ConfigConverter is not executed automatically during installation, the converter can also be started manually from the installation directory:
Note: Any issues that may occur during the conversion process are displayed in the command line window. Copy and send the command line context to the support team, if required.