How to set up connector for SAP

Modified on Wed, 27 Aug at 8:17 AM

Table of contents

Introduction
Prerequisites
How to create
Effect on Connector for selecting different execution component
Authentication types explained:
Test & Persist

Introduction

Follow this article to find out how to setup conntectors for SAP

Prerequisites

Before creating a Safran connector, ensure you have:

You should have the permission of Setup Admin role to create a connector
Desktop Client needs to be installed on you machine and/or Autonomous Component needs to be set up for your tenant
Authentication details (Depending on what type is selected)
Any custom request headers defined by your tenant’s configuration

How to create

Access the IDE web application and navigate to Setup > Connectors
Click on the button +New Connector
- A modal will appear having the following required fields:
  - Title, Host System, Execution component
Provide a meaningful title.
Select the execution component.
Select SAP from the Host system dropdown. This will populate the following new fields:
- Required: Base URL, Authentication Type
- Optional: Manage Customer Request Headers
Lastly add details to all of the required fields and hit create.

Please note each connector's URL must be unique otherwise error will be shown

Effect on Connector for selecting different execution component

Authentication types depend on the execution component you choose. Selecting Desktop client as execution component provides the following options as authentication types:

Basic
Windows
WindowsWithoutCSRFToken
AzureSamlOauthToken

While desktop client has more options to authenticate the connector, Autonomous Component provides only one type:

Basic

Authentication types explained:

Each authentication method has its own setup process and use cases. Here's what you need to know:

Basic:

Here is the setting you need to configure, and they are shown with red numbers and described below:

1	Title	Title of the connector
2	Host System	SAP
3	Execution Component	Desktop Client or Autonomous Component
4	Base URL	The root URL of the SAP system or API endpoint the connector will connect to
5	Authentication Type	Basic
6	Username	Your username
7	Password	Password
8	Manage Custom Headers	Custom HTTP headers if required by the host system for API

Windows :

Here is the setting you need to configure, and they are shown with red numbers and described below:

1	Title	Title of the connector
2	Host System	SAP
3	Execution Component	Desktop Client
4	Base URL	The root URL of the SAP system or API endpoint the connector will connect to
5	Authentication Type	Windwos
6	Manage Custom Headers	Custom HTTP headers if required by the host system for API

WindowsWithoutCSRFToken

Here is the setting you need to configure, and they are shown with red numbers and described below:

1	Title	Title of the connector
2	Host System	SAP
3	Execution Component	Desktop Client
4	Base URL	The root URL of the SAP system or API endpoint the connector will connect to
5	Authentication Type	WindowsWithoutCSRFToken
6	Manage Custom Headers	Custom HTTP headers if required by the host system for API

AzureSamlOauthToken

Here is the setting you need to configure, and they are shown with red numbers and described below:

1	Title	Title of the connector
2	Host System	SAP
3	Execution Component	Desktop Client or Autonomous Component
4	Base URL	The root URL of the SAP system or API endpoint the connector will connect to
5	Authentication Type	AzureSamlOauthToken
6	SAP Authority	The URL of the SAP authorization server for token-based authentication.
7	SAP Client Id	A unique identifier for the client application registered with the SAP system.
8	SAP Api Area	Defines the specific API endpoint or module within the SAP system to interact with.
9	SAP API Version	The version of the SAP API that the connector will use to communicate with the system.
10	SAP Grant Type	The grant type used for authentication with SAP.
11	SAP Apim Subscription	The subscription key or identifier for accessing SAP APIs through an API Management (APIM) gateway.
12	SAP Secret Keyvault URL	The URL of the Azure Key Vault storing sensitive SAP credentials.
13	SAP Secret Keyvault Key	The specific key or secret name in the Azure Key Vault for SAP authentication.
14	SAP Apim Trace	Enables or disables tracing for API Management calls to debug SAP API interactions.
15	Client Id	The unique identifier for the client
16	Client Secret	A secure key paired with the Client Id for authenticating the client
17	Tenant Id	The unique identifier for the Azure Active Directory tenant used in authentication.
18	Authority	The authentication endpoint URL for the identity provider
19	Scope	Defines the permissions or access level requested for the SAP API during authentication.
20	Manage Custom Header (optional)	Custom HTTP headers if required by the host system for API

Note: Consult with your Tenant admin to get the required information

Test & Persist

After creating the connector:

For Desktop Client execution:
- Open the IDE Desktop Client
- Navigate to the Connectors tab
- Click Test to verify connection
- Click Persist to fetch schedules and host fields from P6
For Autonomous Component execution:
- Test is done periodically via a background job, but it can be also done using desktop client.
- Alternatively: Go to Setup > Connectors in the web app, and open the newly created connector and click Persist to force retrieval of schedules and host fields from P6. After persisting, reload the page after a few minutes to verify the updated connector status.

Checkout this article to find out more about test & persist