Skip to content

Customization

Xtract Core provides a configurable Windows service that acts as a web server to serve incoming API calls. The service and network settings of Xtract Core can be configured using the files in the installaltion directory of Xtract Core.

Files in the Installation Directory

The installation directory contains the following files:

Filename Description
config directory Directory that contains all SAP and destination connections, extractions, and web server settings. This directory is created when executing a POST request for the first time.
logs directory Directory that contains service logs.
private directory Directory that contains keys to encrypt passwords. This directory is created when running an extraction for the first time.
Transport directory Directory that contains SAP function modules. Read the README.pdf within the directory for more information.
Cleaner.exe Application that deletes all cached results and log files.
ConfigConverter.exe Application that converts extractions, connections, etc. from previous a version format to the new format.
listener.exe Application that starts one worker per incomming connection. listener.exe can be renamed (make sure to rename the listener.json as well and update the content of theobald.service.definition.json).
listener.json Contains the default settings of the web server. listener.json can be renamed (make sure that the listener.json has the same name as the listener.exe).
service.exe Application that installs Xtract Core.
theobald.service.definition.json Contains the configuration of the Xtract Core Windows service. theobald.service.definition.json cannot be renamed.
worker.exe Application that handles HTTP requests. worker.exe can be renamed (make sure to update the content of listener.json).
XtractCoreLicense.json License file.

Service Settings

The name (serviceName), displayed name (displayName) and description (description) of the Windows service can be changed in the theobald.service.definition.json file.

theobald.service.definition.json
{
    "description": "A web API for extracting data from SAP systems",
    "displayName": "SAPConnector",
    "serviceName": "SAP Connector Service",
    "servers": [
        {
            "displayName": "listener",
            "path": "listener.exe"
        }
    ]
}

Note

Do not change any values for convertConfig, minCfgVersion and currentVersion.

Network Settings

The network settings of the web server can be changed in the listener.json file.

listener.json
{
    "insecurePort": 1337,
    "securePort": 1338,
    "workerName": "worker.exe",
    "mode": "Localhost(1)" 
}
  1. The property mode supports Any and Localhost.
    • Any listens on the default network interface and the loopback interface.
    • Localhost only listens on the loopback interface.

TLS Configuration

You can enable Transport Layer Security (TLS) to use secured HTTPS communication for the web server. For information on how to set up TLS with Xtract Core, refer to the Knowledge Base Article: Install an X.509 Certificate.

Last update: August 29, 2025