Run Extractions in Xtract Universal

Xtract Universal Designer offers a test run option for extractions.
You can define runtime parameters and other options to run an extraction directly from the Xtract Universal Designer.

Run Extractions in the Designer

1. In the main window of the Designer, select an extraction and click [Run] . The window "Run Extraction" opens.
   
2. If needed, define extraction parameters:
   • Select the checkbox of the parameter you want to override . The parameter is automatically added to the extraction URL and the xu-exe string.
   • Enter a value for the parameter.
3. Click [Run] to execute the extraction.

The status in the subsection General Info indicates if the extraction finished successfully and if the extracted data was written to the destination.

Run Extraction Window

The "Run extraction" window consists the following subsections:

• General Info
• Runtime parameters
• URL and commandline
• Logs and Output
• Buttons

General Info

Runtime Parameters

The three tabs "Extraction", "Source" and "Custom" contain extraction parameter to dynamize extractions. When editing extraction parameters, the URL and commandline of the extraction also change.

For more information, see Extraction Parameters.

URL and Commandline

The strings displayed in URL and xu.exe are generated and update automatically when changing extraction parameters. Use the strings to run the extraction outside of the Xtract Universal Designer.

URL

The extraction URL can be used in different integration scenarios and use cases. Examples:

• Use the extraction URL when it is not possible to use the command line tool xu.exe, e.g. in cloud based environments.
• Use the extraction URL when the extraction is set to a Pull Destination.
• Use the extraction URL to run the extraction in a web browser, e.g., for testing purposes.

Copy the URL with Ctrl+C or use the [] button on the right.

xu.exe

This command allows running an extraction with the command line tool xu.exe, that is installed with Xtract Universal. The tool is located in the installation directory of Xtract Universal, e.g., C:\Program Files\XtractUniversal\xu.exe.

Copy the expression with Ctrl+C or use the [] button on the right.

It is recommended to use the command line tool with Push Destinations. It can be called from a Windows script or any scheduler, that can invoke Windows commandline calls.
In the most simple case, the Windows task scheduler can be used for calling and scheduling extractions using xu.exe.

By default the following parameters are generated for any extraction:

• "-s" (Server for extraction)
• "-p" (Listening port of the Xtract Universal Server)
• "-n" (Name of the extraction)

Logs and Output

When an extraction is executed, information about the extraction is displayed in the following section.

Log

In the Log tab the extraction log is displayed in real time. Activate the checkbox Auto scroll to the end to automatically scroll down to the last protocol.

xu.exe

In the xu.exe tab the log of the command line tool is displayed.

Output

In the Output tab the results of the extraction are displayed. This option is only available for the following destinations:

• HTTP-CSV
• HTTP-JSON
• Alteryx
• Microsoft SQL Server
• Power BI Report Server (SQL Server Reporting Services)
• QlikSense&QlikView

Display rows from line
The extraction results are displayed to a maximum amount of 500 rows. The number of rows to be displayed can be changed using the Display rows from line boxes.

[Display]
To filter the results, enter filter values above the columns of the results and click [Display].

[Clear search]
To undo any data filtering, click [Clear search], followed by [Display].

Buttons

[Run]
Runs the extraction.

[Abort]
Aborts the extraction.

[Close]
Closes the "Run Extraction" window.