Skip to content

Create an SAP Connection using the Xtract for Alteryx GUI

The following section shows how to create an SAP connection using the Xtract for Alteryx UI.

The Xtract for Alteryx UI provides an alternative to Alteryx’s Data Connection Manager (DCM) by supporting legacy JSON-based source connections alongside DCM storage. This allows users to choose the most appropriate storage method depending on their environment and DCM configuration in Alteryx.

Create an SAP Connection

To create a new SAP Connection in the Xtract for Alteryx UI:

  1. Drag and drop an Xtract for Alteryx component from the Alteryx Designer tool box onto the canvas . The configuration window of the component opens.
    Create-New-Table-Extraction
  2. Click [New] to create a new connection . The window "SAP Connection Details" opens.
  3. Fill out the connection details to establish an SAP connection. The connection details consist of four subsections:
    Connection details
  4. Click [Test Connection] to test the SAP connection. A confirmation window opens.
    Connection test
  5. Click [OK] to save the SAP connection.

The SAP connection is now available for selection in the configuration window .
To edit the SAP connection, select the SAP connection from the dropdown list and click [Edit].

Tip

Values to fill out the connection details can be found in the SAP Logon Pad in the Properties or acquired from SAP Basis team.

System

There are two possibilities to connect to an SAP source system:

  • Use a Single Application Server
  • Use a Load Balancing Server (message server)
Input Field Description
Host Host name or IP address of the application server (Property Host)
Sys. No.: A two-digit number between 00 and 99 (Property SystemNumber)
Input Field Description
Message Server Name or IP address of the message server (Property MessageServer)
Group Property LogonGroup, usually PUBLIC
SID Three-digit System ID (Property SID e.g., MSS)

For more information, see SAP Help: Load Balancing.

Access via SAP router

If you access the SAP source system (Application server or Message server) via an SAP router, set the router string before the host name. Example: If the application server is "hamlet" and the router string is /H/lear.theobald-software.com/H/, set the host property to /H/lear.theobald-software.com/H/hamlet.|

For more information, see SAP Help: SAP-Router.

Client and Language

Input Field Description
Client A three-digit number of the SAP client between 000 and 999, e.g., 800.
Language The logon language for the SAP system, e.g., EN for English or DE for German.

Authentication

The following authentication methods are supported:

  • SNC : encrypted connection between Xtract for Alteryx and SAP with username and password.
  • Plain : SAP username and password (system or dialogue user)
  • SAP Log On Ticket : uses SAP Logon-Tickets in place of user credentials. This connection is not encrypted.

Connection details

Input Field Description
SNC library path Complete path to the SAP cryptograhic library location, e.g., C:\Program Files\SAP\FrontEnd\SecureLogin\lib\sapcrypto.dll.
SNC partner name SAP partner name configured for the SAP application server, e.g., p:SAPserviceERP/Alice@THEOBALD.LOCAL.

Tip

Check the SAP parameter snc/gssapi_lib to determine which library is used for encryption in your SAP system. Your SAP basis has to import and configure the same library on the application server and on the machine that runs Xtract for Alteryx.

For more information on SNC, see Enabling Secure Network Communication (SNC) via X.509 certificate.

Input Field Description
User SAP username.
Password Password of the SAP user.
Input Field Description
Ticket Issuer Enter the URL of an Application Server Java (AS Java) that is configured to issue logon tickets. For more information, see SAP Help: Configuring the AS Java to Issue Logon Tickets.

Miscellaneous

Select an RFC library. The following RFC libraries are supported:

  • Use classic RFC library (librfc32.dll)
  • Use NetWeaver RFC libraries (sapnwrfc.dll)

The RFC API (Remote Function Call) allows to establish an RFC connection to an SAP system from an external system that communicates as Client or Server with the SAP system. For more information on SAP libraries, see SAP Help: RFC Libraries.

SAP does not support the librfc32.dll anymore.

Note

When using the NetWeaver RFC library with DeltaQ or OHS extractions, the RFC destination in SM59 must be set to Unicode.

Trace Directory (Debug Logging)

You can log debug information and save it locally. In the field Trace directory enter a local path to a folder, where you want to save the debug information. For more information, see the knowledge base article How to activate tracing for Xtract Products.
Clear the Trace Directory field when it is not needed.

Warning! : Increase of used hard drive memory

A big amount of information is collected when debug logging is activated. This can decrease the capacity of your hard drives dramatically. Activate the debug logging only when necessary e.g., upon request of the support team.

Store Connections as JSON Files

To store an SAP connection as a local JSON file:

  1. Enable one of the following Alteryx DCM configation modes in the Alteryx settings:

    • DCM Optional (connections are stored as JSON files by default)
    • DCM as Default (connections are stored in the DCM by default, this can be changed in the Xtract for Alteryx UI)

    Tip

    The DCM configuration mode is configured in the system settings by an administrator via Options > Advanced Options > System Settings in Alteryx Designer. Alternatively, you can override the system settings via Options > User Settings > Edit User Settings.

    DMC-configuration-mode

  2. Open the SAP connection details of an Xract tool:

    1. Select an Xtract tool.
    2. In the onfiguration window of the Xtract tool, click [Edit]. The window "SAP Connection Details" opens.
  3. Make sure that the checkbox Store in DCM is disabled. For more information, see Impact of DCM Modes.

    store-in-dcm
  4. Click [OK] to save the connection.

The connection details of the SAP connection are stored in a JSON file in the following directory:
C:\Users\<UserName>\AppData\Roaming\Theobald Software\Xtract for Alteryx\Connections\<SAPSourceName>.json

Impact of DCM Modes

The Alteryx DCM configuration modes affect the Store in DCM option of the Xtract for Alteryx UI as follows:

DCM Mode Impact on Store in DCM
DCM Optional When creating a new connection, Store in DCM is not active and the connection is stored in JSON format by default. To store the connection in the DCM, activate the checkbox Store in DCM.
DCM as Default When creating a new connection, Store in DCM is active and the connection is stored in the DCM by default. To store the connection as a JSON file, deactivate the checkbox Store in DCM.
DCM Only When creating a new connection, Store in DCM is active and there is no option to store the connection as a JSON file.
DCM Enforced When creating a new connection, Store in DCM is active and there is no option to store the connection as a JSON file.
Last update: August 25, 2025