Start the Designer
This page shows how to connect the Xtract Universal Designer with a Xtract Universal Server.
Connect the Designer to a Server
When starting the Xtract Universal Designer, the window "Connect to Xtract Universal Server" opens.
Enter connection and user details to connect the Designer to a Xtract Universal Server.
- Launch the Xtract Universal Designer.
- When the Xtract Universal Server is a local server, the server address is localhost.
The default port (8064) may vary depending on the configuration.
- If the service is not running on default port 8064, specify the port by adding :[port] after the host name. The default port can be configured in the server settings.
- Select an authentication method. Once logged in, you can activate or deactivate methods of authentication, see Access Management.
- Click [ Connect] to connect the Designer to the Server. The main window of the Designer opens.
- Launch the Xtract Universal Designer.
- When the Xtract Universal Designer and the Xtract Universal Server run on different machines, enter the host name of the Xtract Universal Server. Make sure the port is not blocked by your firewall.
- If the service does not run on default port 8064, specify the port by adding :[port] after the host name. The default port can be configured in the server settings.
- Select an authentication method. Once logged in, you can activate or deactivate methods of authentication, see Access Management.
- Click [ Connect] to connect the Designer to the Server. The main window of the Designer opens.
Xtract Universal offers different methods of authenticating and securing the connection between the Xtract Universal Designer and the Xtract Universal Server. The default authentication methods are authentication via Windows credentials (current user) and Anonymous (no encryption).
Main Window of the Designer
The Designer features different functionalities to design and configure extractions.
Tip
Press F1 to open the documentation page for particular windows.
Main Menu Bar
| Icon | Menu Item | Description | Details |
|---|---|---|---|
| Reset Preferences | Reset connection settings to server | Connect the Designer to a Server | |
| Disconnect | Log off the server | - | |
| Exit | Close the Designer | - |
| Icon | Menu Item | Description | Details |
|---|---|---|---|
| New | Create a new extraction | Create an Extraction | |
| Edit | Edit an existing extraction | - | |
| Delete | Delete an existing extraction | - | |
| Clone | Clone an existing extraction | - | |
| Add/Remove Keywords | Define keywords of selected extractions | General Settings | |
| Source | Select an existing SAP source system | SAP Connection | |
| Destination | Select a destination | Destinations | |
| Log | Open extraction log | Extraction Logs | |
| Run | Run a selected extraction | Run an Extraction | |
| Abort | Abort a selected extraction | - | |
| Clear Result Cache | Clear extraction cache | Cache results | |
| Refresh | Refresh extraction status | - | |
| Filter | Define filters or keywords | Define Keywords |
| Icon | Menu Item | Description | Details |
|---|---|---|---|
| Logs | Open server logs | Server Logs | |
| Settings | Open server settings | Server Settings | |
| Manage Sources | Edit connection to source system | SAP Connection | |
| Manage Destinations | Edit or delete destinations | Destinations. |
| Icon | Menu Item | Description | Details |
|---|---|---|---|
| Set User Password | Set or change user password | User Managements | |
| Manage Users | Manage user groups | User Groups |
| Icon | Menu Item | Description | Details |
|---|---|---|---|
 | Online Help (EN) | Open the HelpCenter | - |
| Submit Support Ticket | Open the Ticket Portal | Support Portal | |
| Download latest version | Link to My Theobald Software | Customer Portal | |
| Info | Product information | - | |
| Version History | List of recent software changes | Changelog |
GUI Buttons
| Icon | Button | Description | Details |
|---|---|---|---|
| New | Create a new extraction | Create an Extraction | |
| Edit | Edit existing extraction | - | |
| Delete | Delete existing extraction | - | |
| Clone | Clone existing extraction | - | |
| Refresh | Update of the extraction status | - | |
| Search | Filter extraction names | List of Extractions | |
| Source | Select existing SAP source system | SAP Connection | |
| Destination | Select destination | Destinations | |
| Log | Open extraction log | Extraction Logs | |
| Run | Run a selected extraction | Run an Extraction |
Extraction Groups
Extractions can be organized in groups, see Organize Extractions. The treeview in the main window of the Designer displays all extraction groups and reflects the folder structure in the following directory: C:\Program Files\XtractUniversal\config\extractions.
Select a group to display the list of extractions that are located in the corresponding directory.
List of Extractions
List of all extractions in the currently selected extraction group divided by name, type, modification and creation date etc.
Tip
Use the search bar above the list to filter extractions. Wildcards (*) are not supported.
More extensive filter options are available using the GUI Buttons .
Tip
To adjust the settings of multiple extractions at once, select multiple extractions using Ctrl+Left Button.
You can now adjust the [ Destination] and [ Source] settings for all selected extractions, see GUI Buttons.
Double Click: Double-clicking an extraction works as a shortcut to the [ Edit] button.
Right-click: Right-clicking an extraction in the list opens the following menu:
| Icon | Menu Item | Description | Details |
|---|---|---|---|
| Edit | Edit an existing extraction | - | |
| Delete | Delete an existing extraction | - | |
| Clone | Clone an existing extraction | - | |
| Add/Remove Keywords | Define keywords of selected extractions | General Settings | |
| Log | Open extraction log | Extraction Logs | |
| Source settings | Select an existing SAP source system | - | |
| Destination settings | Select a destination | Destinations | |
| Run | Run a selected extraction | Run an Extraction | |
| Run in browser | Run a selected extraction in the default web browser | - | |
| Run in xu.exe | Run a selected extraction in the command-line tool xu.exe | Execute Extractions with xu.exe | |
| Abort | Abort a selected extraction | - |
Status Bar
The status bar contains information about the following:
- Number of defined extractions in the selected folder, the overall number of extractions and the number of licensed extractions
- Login username
- Server authentication method
- Designer access rights
- License type and validity period
- Connected XU server version
- Connected XU client version