Getting Started

This section shows how to install and set up Xtract Universal for the first time.

Installation

1. Download a 30 day trial version of Xtract Universal or download the latest version from the customer portal.
2. Run the Xtract Universal executable (XtractUniversalSetup.exe) to install the Xtract Universal Designer and the Xtract Universal Server. For information on system requirements, see Requirements.
3. Make sure that the Xtract Universal Service is running on your windows system and that the default port 8065 is not blocked by your firewall.
   
4. Open the Xtract Universal Designer application and click [ Connect] to connect to the Xtract Universal Server using the default settings.
   

For more information, see Setup.

Connect to SAP

Before connecting to SAP for the first time, set up an SAP dialog user with the necessary SAP user rights.

1. In the main window of the Designer, click [New]. The window "Change Source" opens.
   
2. Enter a name for the SAP connection in the field Name, e.g., s4hana, bw, etc.
3. In the General tab, enter the system details of your SAP system. Input values for the SAP connection can be found in the Properties of the SAP Logon Pad or they can be requested from the SAP Basis team.
   
4. In the Authentication tab, enter the SAP credentials of the SAP dialog user.
5. Click [Test designer connection] to validate the connection between the Xtract Universal Designer and the SAP system.
6. Click [Test server connection] to validate the connection between the Xtract Universal Server and the SAP system.
7. Click [OK] to save the SAP source.

For more information, see SAP Connection.

Create an Extraction

Extractions are the main entities of Xtract Universal. They define what data to extract from SAP and where to write the data. Follow the steps below to create a new extraction:

1. In the main window of the Designer, click [New]. The window "Create Extraction" opens.
2. Select an SAP Connection from the drop-down menu in Source .
   
3. Enter a name for the extraction .

4. Select one of the following extraction types :

   Extraction Type	Description
   BAPI	Execute BAPIs and Function Modules.
   BWCube	Extract data from SAP BW InfoCubes and BEx Queries.
   BW Hierarchy	Extract Hierarchies from an SAP BW / BI system.
   DeltaQ	Extract data from DataSources (OLTP) and extractors from ERP and ECC systems.
   ODP	Extract data via the SAP Operational Data Provisioning (ODP) framework.
   OHS	Extract data from InfoSpokes and OHS destinations.
   Query	Extract data from ERP queries. Note: BEx queries are covered by BWCube.
   Report	Extract data from SAP ABAP reports.
   Table	Extract data from SAP tables and views.
   Table CDC	Extract delta data from SAP tables and views.

5. Click [OK]. The main window of the extraction type opens automatically.
   Follow the instructions in the documentation of the selected extraction type to set up the extraction.

A Simple Extraction for Beginners

Follow the steps below to extract customer master data from the SAP table KNA1:

1. Create an extraction that uses the Table extraction type.
2. In the main window of the extraction type, click [Add] to look up an SAP table. The window "Table Lookup" opens.
   
3. In the field Table Name, enter the name of the table to extract (KNA1) . Use wildcards (*) if needed.
   
4. Click [ ] . Search results are displayed.
5. Select the table KNA1 and click [OK]. The application returns to the main window of the extraction type.
6. Optional: Select the table columns you want to extract. By default all columns are extracted. For more information on filter options and advanced settings, see, Define the Table Extraction Type
7. Click [Load live preview] to display a live preview of the first 100 records.
8. Click [OK] to save the extraction type.

The extraction is now listed in the main window of the Designer. To edit an extraction, double-click the extraction.

Run an Extraction

Extractions can be run directly in the Xtract Universal Designer or via web service and command line. Follow the steps below to testrun your extraction in the Designer:

1. In the main window of the Designer, select an extraction and click [Run] . The window "Run Extraction" opens.
2. Click [Run] to execute the extraction. The status in the subsection General Info indicates if the extraction finished successfully.
3. Open the Output tab to view the extracted data .

For more information, see Execute and Automate.

Write Data to a Target Environment

Xtract Universal allows you to load data to a wide range of target environments, including databases, cloud storages, BI tools, etc. By default, extractions use the http-csv destination as a target environment.

Follow the steps below to add a new destination to Xtract Universal:

1. In the main window of the Designer, navigate to Server > Manage Destinations. The window “Manage Destinations” opens.
   
2. Click [Add] to create a new destination. The window "Destination Details" opens.
   
3. Enter a Name for the destination.
4. Select a destination type from the drop-down menu. A list of connection details opens.
5. Fill out the destination details to connect to the destination.
   Destination details vary depending on the destination type. For more information about destination details, select your destination: Select a destination Alteryx Amazon S3 Amazon Redshift Dataiku EXASolution Flat File CSV Flat File JSON Flat File Parquet Google Cloud Storage HTTP CSV HTTP JSON Huawei Cloud OBS IBM Db2 KNIME Microsoft Azure Storage Microsoft Azure Synapse Analytics Microsoft Fabric (OneLake) Microsoft Power BI Microsoft Power BI Report Server Microsoft SharePoint Microsoft SQL Server MySQL Oracle PostgreSQL QlikSense and QlikView Salesforce SAP HANA Snowflake Tableau
6. Click [OK] to confirm your input.

The destination is now available and can be assigned to extractions.

Assign a Destination to an Extraction

Extractions write data to their assigned destination. Follow the steps below to assign a destination to an extraction:

1. In the main window of the Designer, select an extraction.
2. Click [ Destination]. The window “Destination Settings” opens.
   
3. In the “Destination Settings” window, select a destination from the drop down menu.
   
4. Optional: change the destination settings.
   Destination settings are specific to the selected extraction and vary depending on the destination type. For more information about destination settings, select your destination: Select a destination Alteryx Amazon S3 Amazon Redshift Dataiku EXASolution Flat File CSV Flat File JSON Flat File Parquet Google Cloud Storage HTTP CSV HTTP JSON Huawei Cloud OBS IBM Db2 KNIME Microsoft Azure Storage Microsoft Azure Synapse Analytics Microsoft Fabric (OneLake) Microsoft Power BI Microsoft Power BI Report Server Microsoft SharePoint Microsoft SQL Server MySQL Oracle PostgreSQL QlikSense and QlikView Salesforce SAP HANA Snowflake Tableau
   
5. Click [OK] to confirm your input.

When running the extraction, the extracted SAP data is now written to the destination. For more information on available destinations, see Destinations.