Prerequisites #

Note: 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.

When starting the setup, components can be selected during the installation.

XU-Setup

Component Sub Component Description
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.
Tableau Extract API - Component is only required for Tableau destination.

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.

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:

Filename Description
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.
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 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 --unattended.
Use the start command with the /wait switch to wait until the installation is complete.

Example:

start /wait XtractSetup.exe --unattended

Note: All switches are case sensitive.

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.

Update Preparation

Tip: Subscribe via email to Theobald Software’s regular newsletter that informs about changes in the version history and release notes.

  1. Check if you have a working test environment with a valid license and maintenance.
  2. Make sure that the test environment is a copy of the current production environment.
  3. Check the Version History and release notes in the knowledge base to check, if update is needed.
  4. Create a backup of the current installation.
  5. Conduct any necessary preparations and changes as described in the Release Note / Version History. In case of major changes, use the ConfigConverter.

Upgrading Major Releases - ConfigConverter #

There are two ways of upgrading the product version from XU 2.x and 3.x to XU 4.x:

  • Upgrade during installation
  • Manual upgrade

Upgrade During Installation

  1. Start the Xtract Universal setup.
  2. 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 from XU 2.x or 3.x are available in the new version.
    XU-Setup
  3. Confirm the conversion process in the command line pop-up window.
    XU3_Migration_2

Manual Upgrade

If the ConfigConverter is not executed automatically during installation, the converter can also be started manually from the installation directory: C:\Program Files\XtractUniversal.

XU3_Migration_3

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.