Configure an SAP Connector

Introduction

A Connector stores the settings used to connect to a source system. The SAP Connector connects AnalyticsCreator to supported SAP source interfaces. Use this how-to to create, configure, test, and save an SAP connection in your Data Warehouse (DWH) project, then reopen the saved Connector to verify its settings.

The intended outcome is a saved Connector with the required SAP connection settings and a successful connection test. Reading source metadata and loading data are subsequent tasks.

Screenshot examples: the pictured names, connection placeholders, and checkbox states illustrate the interface. Use the name and settings required by your own Data Warehouse (DWH) project.

Applicability

This workflow creates a new SAP Connector using an application-server host, system number, client, language, and SAP credentials. It assumes the SAP environment and required connection components are already configured. Installing those components, preparing SAP extraction, selecting source objects, and running data loads are separate tasks.

Follow these steps in the AnalyticsCreator desktop interface with the Connector settings shown below. Use the connection-string template provided by your installed version.

Prerequisites

3.1. An open Data Warehouse (DWH) project that you can edit, and a name that identifies the new SAP connection.

3.2. The application-server host, system number, client, language, and SAP credentials for the intended environment. The account must have access to the intended SAP source interface.

3.3. The SAP extraction setup and connection components required by your environment, with their availability confirmed by the SAP administrator.

3.4. Your project's requirement for storing the connection string in CFG.SSIS_Configurations. If the project uses a protected password alias, the corresponding entry must already exist in Encrypted strings, the list of protected values used by connection settings. If the project also requires an Azure source type classification, have its specified value available.

Steps

Open the Connector editor

Confirm that the intended Data Warehouse (DWH) project is open. In the navigation tree, right-click Connectors and select Add connector.

Expected Results: the new Connector editor opens.

Select Add connector from the Connectors folder's context menu. The background diagram contains existing example objects; they are not created by this action.
Connectors folder context menu with Add connector highlighted.

Name the Connector and select SAP

In the Connector editor, enter a name in Connector name that identifies your SAP environment. In Connector type, select SAP. This setting identifies the source technology; confirm it before working with the connection-string template.

Naming example: connector 1 is the name shown in the capture. Enter the name required by your project.

Enter your Connector name and select SAP as the Connector type. The pictured name and connection placeholders are illustrative.
Connector editor with SAP selected in the Connector type list and connector 1 in Connector name.

Enter the SAP connection settings

In Connection string, enter the settings for your SAP environment. A connection string contains the values needed to reach and authenticate to that environment. If you need a starting string, click Template before entering your values.

The SAP template uses the following keys. Replace the bracketed placeholders with values supplied for the same SAP environment, keeping the key names and the syntax of your installed template:

  1. ASHOST — Replace [HOSTNAME] with the SAP application-server host.
  2. SYSNR — Replace [SYSTEM_NUMBER] with the SAP system number.
  3. CLIENT — Replace [MANDANT] with the intended SAP client. The client identifies the SAP client environment for this connection; it is separate from the AnalyticsCreator user.
  4. LANG — Replace [LANGUAGE] with the language value supplied for this SAP connection.
  5. USER / PASSWD — Replace [USER] with the SAP user and [PASSWORD] with that user's password. If your project uses protected passwords, enter the configured encrypted-string alias in place of the password. The editor shows the alias form #ENCRYPTEDSTRING#; use the alias for your existing entry. To inspect that entry, open Options and select Encrypted strings.

SAP template: ASHOST=[HOSTNAME] SYSNR=[SYSTEM_NUMBER] CLIENT=[MANDANT] LANG=[LANGUAGE] USER=[USER] PASSWD=[PASSWORD]

The bracketed words are placeholders to replace, not literal connection values. An encrypted-string alias is a reference to a configured protected value; it is not an unresolved template placeholder. Before testing, check that every bracketed placeholder has been replaced and that the host, system number, client, language, and credentials match the intended environment.

Edit Connection string using your SAP values. This capture still shows template placeholders; it does not show a completed or tested connection.
Connection string field containing SAP template placeholders, with the Template button on the right.

Review connection-string storage and source classification

Review these settings in the Connector editor before testing and saving:

  1. Do not store connection string in CFG.SSIS_Configurations — Select this checkbox when your project requires the connection string to be excluded from the named configuration table. Clear it when the project's configuration requires the string to be stored there. This storage choice is separate from using an encrypted-string alias for the password.
  2. Azure source type — This is a separate source classification. If your project specifies an Azure classification for this connection, select that value. Otherwise, leave this setting unchanged.

The cleared checkbox and the Azure source type field shown in the editor are not universal SAP requirements. Check the storage choice against your project's configuration before continuing.

Test the SAP connection

Click Test connection at the bottom of the Connector editor and read the reported result. A click alone does not establish that the connection succeeded.

If the test reports a failure, use the reported problem to recheck the SAP host, system number, client, language, credentials, or required connection components. Apply the relevant checks in Troubleshooting, correct the settings, and test again. Continue to Save only after the intended connection reports success.

Expected Results: the test reports a successful connection with the settings you entered.

Click Test connection and inspect its result. The capture identifies the button but still contains placeholders and shows no test result.
Test connection button highlighted at the bottom left of the Connector editor; no result message is visible.

Save the Connector

Review Connector name, Connector type, Connection string, and the settings from Review connection-string storage and source classification. If you change the connection settings after a successful test, repeat Test the SAP connection before saving.

Click Save at the bottom of the editor to save the Connector definition.

Click Save after a successful connection test. This capture shows the Save button with an incomplete template; it does not demonstrate a successful test or a saved result.
Save button highlighted at the bottom right of the Connector editor; template placeholders remain visible above.

Reopen and verify the saved Connector

In the navigation tree, expand Connectors and locate the name you saved. Right-click that Connector and select Edit connector.

Check that Connector name is the intended name, Connector type is SAP, and Connection string contains the intended SAP settings, including the password or configured password alias. Check the configuration-storage choice and any specified Azure classification as well.

Click Test connection and confirm that the saved settings produce a successful result. If a correction is needed, update the setting, test again, and click Save after success.

Expected Results

5.1. The Connector is available under Connectors in the intended Data Warehouse (DWH) project, using the name you entered.

5.2. Reopening it with Edit connector shows SAP as its type and the intended connection and storage settings.

5.3. Test connection reports success for the saved settings, as checked in Reopen and verify the saved Connector.

Saving stores the Connector definition. A successful connection test does not establish that source metadata has been read, data has been loaded, or a deployment has completed. A Source is an input object supplied by a Connector; selecting its metadata and loading its data require subsequent workflows.

Decisions and variations

  1. Password or protected alias — Use the password handling required by your project. When using an alias, its protected value must already be configured in Encrypted strings; see Enter the SAP connection settings.
  2. Configuration storage and Azure classification — Follow the project's specified storage requirement and any Azure classification. The decisions and their actions are explained in Review connection-string storage and source classification; the screenshot selections do not establish defaults.
  3. New or existing source metadata — After verifying the Connector, use Read metadata from a Connector with DWH Wizard for a new external metadata read. If the Source definitions are already stored in the Data Warehouse (DWH) project, use Use existing Source metadata with DWH Wizard. Reusing metadata is a separate task and does not verify a live SAP connection.

Troubleshooting

  1. Provider or driver error — If the reported error identifies a missing SAP connection component, have the SAP administrator check the required component in the environment that performs the connection test. Confirm its required configuration before changing the connection string, then test again.
  2. Connection or authentication failure — Read the reported error. Recheck ASHOST, SYSNR, CLIENT, and LANG against the values for the intended SAP environment, and USER and PASSWD against the intended account. Replace any remaining bracketed placeholders. If using an encrypted-string alias, check the corresponding entry through OptionsEncrypted strings. If the values match but the test still fails, ask the SAP administrator to check the reported problem and the account's access to the intended interface.
  3. Saved item not found — Confirm that you clicked Save in the intended Data Warehouse (DWH) project. Right-click the Connectors folder and select List connectors, then look for the actual name you entered. Check the project and list before creating another Connector.