Skip to content

Connection Settings

This page contains an overview of the SAP connection settings in the window "Change Source".
To open the server settings, navigate to [Server] > [Manager Sources] in the main window of the Designer and click [ ].

sap-source-general

General

Some input fields for the SAP connection vary depending on the selected connection method.

sap-source-general

Host

Host name or IP address of the application server (Property Host).

Instance No.

A two-digit number between 00 and 99 (Property SystemNumber).

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.

sap-source-general-load-balancing

Message Server

Name or IP address of the message server (Property MessageServer).

System ID

Three-digit System ID (Property SID e.g., MSS).

Logon group

Property LogonGroup, usually PUBLIC.

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.

sap-source-websocket

Host

Name or IP address of the SAP (cloud) system.

Port

Port of the SAP (cloud) system, e.g., 443.

Library

Path to the SAP Cryptographic Library (download available in the SAP Service Marketplace).

Client PSE

Path to the client .pse file, see Knowledge Base Article: Create a Client PSE to connect to SAP Cloud Systems

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

Some input fields for the SAP connection vary depending on the selected authentication method.

sap-source-authentication-plain

User

SAP username.

Password

Password of the SAP user.

User name is alias

Activate this option when connecting to an SAP cloud system using the WebSocket connection method. When this option is active, the name entered in the field User is used as the internet user alias.

Request SAP credentials from caller when running extractions

If this option is active, SAP credentials entered in the fields User and Password are not applied. Instead, SAP credentials need to be provided via basic authentication when running an extraction. Caching the result of extractions is inactive.

sap-source-authentication-snc

User

SAP username.

Password

Password of the SAP user.

User name is alias

Activate this option when connecting to an SAP cloud system using the WebSocket connection method. When this option is active, the name entered in the field User is used as the internet user alias.

SNC library

Path to the SNC library, e.g., C:\Program Files\SAP\FrontEnd\SecureLogin\sapcrypto.dll

SNC Partner Name

The SAP Partner Name configured for the SAP application server, e.g., p:SAPserviceERP/Alice@THEOBALD.LOCAL.

Use static SAP credentials / Windows service account

This option activates SNC without SSO. If available, the SAP credentials in the fields User and Password are used for authentication. The Windows Active Directory user that opens the connection is the service account under which the Xtract Universal Windows service runs.

Request SAP credentials from caller

This option activates SNC with user and password. If this option is active, SAP credentials entered in the fields User and Password are not applied. Instead, SAP credentials need to be provided via basic authentication when running an extraction.

SSO - Log in as caller via External ID

This option activates SSO with External ID. SSO with External ID uses a Personal Security Environment (PSE) to create a trust relationship between the SAP application server and the service account that runs Xtract Universal. This allows Xtract Universal to impersonate any SAP user. For more information, see Knowledge Base Article: SSO with External ID.

SSO - Impersonate caller via Kerberos

This option activates Kerberos SSO. The Windows Active Directory user is used for authentication. For this scenario “HTTPS - Restricted to AD users with Designer read access” must be selected and configured in the Server Settings. For more information, see Knowledge Base Article: SSO with Kerberos SNC.

SSO - Enroll certificate on behalf of caller

This option activates Certificate SSO. The Certificate SSO authentication uses Certificate Enrollment (Enroll-On-Behalf-Of) via Active Directory Certificate Services for the Windows Active Directory user who calls the extraction. For this scenario “HTTPS - Restricted to AD users with Designer read access” must be configured in the Server Settings. For more information, see Knowledge Base Article: SSO with Client Certificates.

sap-source-authentication-logon-ticket

Ticket issuer URL

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.

Impersonate caller when running extractions (Kerberos SSO)

Activate this option to open the connection in the Windows Active Directory user context of the caller. Otherwise the connection is opened in the context of the service account under which the Xtract Universal Windows service runs. For more information, see Knowledge Base Article: SSO with Logon-Ticket.

RFC Options

sap-source-rfc-options

RFC Libraries

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

  • NetWeaver RFC library (sapnwrfc.dll)
  • Classic RFC library (librfc32.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 librfc32.dll anymore.

Note

For some older SAP releases, e.g., R/3 4.6C, it is necessary to enter the user name in upper case when using the NetWeaver RFC library.

Note

When using the NetWeaver RFC library with the DeltaQ extraction type or the OHS extraction type, the RFC destination in SAP transaction SM59 must be set to Unicode. We recommend using the not supported librfc32.dll for some extraction types, e.g., DeltaQ as it runs more stable than the NetWeaver RFC library.

Trace Directory

You can log debug information and save it locally.
Enter a path to a local directory in the field Trace directory to save the debug information. For more information, see Troubleshooting: Trace Directory.

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.

Use SAPGUI

There are SAP Reports and BAPIs that require an installed SAP GUI even when they are called remotely. Activate this option only if necessary.

Warning

'sapgui' start failed.
Sometimes SAP opens a pop-up window that requires input when running extractions. To deactivate pop-up windows, open the SAP GUI Logon pad and navigate to Options... > Security Settings. Click the [Open Security Configuration] button and select Allow as the Default Action. Apply the changes and close the SAP GUI Logon pad.

Access Control

sap-source-access-control

Access control can be performed at the source level. This access control overrides the settings at the server level. For more information, see Access Management.


Last update: July 12, 2024