Create Extractions via Commandline

The command line tool xu-config.exe tool creates extractions, sources and destinations outside of the Xtract Universal Designer. The tool is available in the installation directory of Xtract Universal, e.g. C:\Program Files\XtractUniversal\xu-config.exe.

The xu-config.exe tool supports the creation of the following extraction types and destinations:

Prerequisites

The execution of PowerShell scripts must be authorized on your system, see Microsoft Documentation: Managing the execution policy with PowerShell.

Create an SAP Source using Windows Command Prompt

1. Start the Windows command prompt application with administrator rights .
   
2. Navigate to the installation directory of Xtract Universal .
   

3. Run the following shell command to create an encrypted password for your SAP source :

   powershell ./protect-password.ps1
   

4. Use the following command to select the xu-config.exe command line tool from the Xtract Universal installation directory and to create a new SAP source:

   xu-config.exe --source <name> <host> <instance-number> <client> <language> <user> <protected-password>
   

5. Replace the parameters in < > with actual values . The parameters are not case sensitive.
   

6. Press [Enter] to run the command.
7. Check the generated source in the Xtract Universal Designer or in the directory C:\Program Files\XtractUniversal\config\sources.
   

Create a Destination using Windows Command Prompt

1. Start the Windows command prompt application with administrator rights .
   
2. Navigate to the installation directory of Xtract Universal .
   

3. Run the following shell command to create encrypted passwords or keys necessary for the destination :

   powershell ./protect-password.ps1
   

4. Use one the following commands to select the xu-config.exe command line tool from the Xtract Universal installation directory and to create a new destination:

   Azure StorageAmazon AWS S3 with user credentialsAmazon AWS S3 with authentication via IAM role

   xu-config.exe --azure <account> <accesskey> <container> <folder(opt)>
   

   xu-config.exe --s3 --auth user <key> <secretkey> <bucket> <region> <folder(opt)>
   

   xu-config.exe --s3 --auth iam <bucket> <region> <folder(opt)>
   

5. Replace the parameters in < > with actual values . The names of the parameters are not case sensitive.
   

6. Press [Enter] to run the command.
7. Check the generated destination in the Xtract Universal Designer or in the directory C:\Program Files\XtractUniversal\config\destinations.
   

Create a Table Extraction using Windows Command Prompt

1. Start the Windows command prompt application with administrator rights .
   
2. Navigate to the installation directory of Xtract Universal.

3. Use the following command to select the xu-config.exe command line tool from the Xtract Universal installation directory and to create a new Table extraction:

   xu-config.exe --extraction <source> <destination> --table <table>
   

4. Replace the parameters in < >with actual values .

5. Enter a defined SAP Connection, Destination and an SAP Table object for the parameters \<source>, \<destination> and \<table>. The names of the parameters are not case sensitive.
   
6. Press [Enter] to run the command.
7. Check the generated table extraction in the Xtract Universal Designer or in the directory C:\Program Files\XtractUniversal\config\extractions.
   

Examples for all Extraction Types

Create Multiple Extractions using PowerShell

Multiple extractions can be generated semi-automatically using suitable scripts. The scripts for creating extractions can be used to contribute to the generation of an SAP data warehouse.

# read table list
$tableList = "KNA1","LFA1","MARA","CSKT","SKA1"
# set the path to the installation folder
$XUConfig = 'C:\Program Files\XtractUniversal\xu-config.exe'
# source sytem
$source = "ec5"
# destination
$destination = "sqlserver2019"

# loop the tables
foreach ($tableName in $tableList) {
    # create the extraction e.g.
    # xu-config.exe --extraction ec5 sqlserver2019 --table KNA1 
    Try {                   
        write-host -f Green "$tableName : Creation of Extraction is starting "  (Get-Date)                      
        &$XUConfig --extraction $source $destination --table $tableName    

        # check the last exit code
        # 0: successful
        # else unsuccessful
        if($LASTEXITCODE -eq 0) {                           
            write-host -f Green "$tableName : Creation of Extraction  is successful"  (Get-Date)            
        } else {           
            write-host -f Red "$tableName : Creation of Extraction failed with error code $LASTEXITCODE!"  (Get-Date)
            #Write-Host $errorMessage
        }                
    }
    Catch {
        write-host -f Red "$tableName : Creation of Extraction failed with Exception ! " + (Get-Date)  $_.Exception.Message
    }         
}

Related Links

• Documentation: SAP Connection
• Documentation: Define a Table Extraction
• Documentation: Run an Extraction
• Documentation: WHERE Clause
• Documentation: Schedule Extractions