Open Documentation Menu

Configuring the connection of d.velop integration service for SAP Solutions

In SAP SuccessFactors, events are used to send data about the process of triggered events to d.velop integration service for SAP Solutions (dvpIS) via SAP Eventing. Alternatively, the direct connection of dvpIS via the REST interface can be used.

In the following sections, you will learn how to configure the connection of dvpIS using SAP BTP.

Connecting d.velop integration service for SAP Solutions to SAP Event Mesh

SAP SuccessFactors sends data to SAP Event Mesh in the form of events. For this purpose, the application writes the data to a defined queue with a defined topic. d.velop integration service for SAP Solutions (dvpIS) subscribes to the corresponding queue and thus receives the events sent by SAP SuccessFactors for subsequent processing.

This is how it works 

  1. In the case of a Hire event, ensure that SAP SuccessFactors correctly sends data in the form of events to SAP Event Mesh in the appropriate queues with the relevant topic. Use the corresponding tools provided by SAP Event Mesh to test this. More information: Connecting SAP SuccessFactors to SAP Event Mesh via Eventing

  2. Create a destination for SAP Event Mesh in the BTP subaccount in which dvpIS was installed. Use the XML templates from the dvpIS installation directory in the destinations folder. In these XML templates, the various data required for different integration scenarios is marked with placeholders.

  3. Start the BTP Cockpit and switch to your subaccount.

  4. Select Destinations.

  5. Click Create.

  6. Select From File.

  7. Select the file SAP_Event_Mesh.props as the template for connecting to SAP Event Mesh.

  8. Select the newly created destination from the list of entries.

  9. Enter the following values:

    • Authentication: OAuth2ClientCredentials

    • Type: HTTP

    • Proxy-Type: Internet

    • URL: URL for a service endpoint of the Event Mesh service (from the SAP service key)

    • Client ID: The client ID for the Event Mesh service (from the SAP service key)

    • Client Secret: The secret client key for the Event Mesh service (from the SAP service key)

    • Token-Service URL: URL for determining a JSON web token (from the SAP service key)

    • Token-Service URL Type: Dedicated

  10. Add the following keys and values for the destination under Additional Properties:

    • evtSource: queue:<name of queue> (use the queue configured for SAP SuccessFactors)

    • evtTarget: topic:<name of topic> (use the topic defined for SAP SuccessFactors in the previous chapter)

  11. Create a system of system type evt and API type evt in dvpIS and assign the destination created in step 2. Based on the configuration of the destination and the assignment to a system in dvpIS, dvpIS automatically recognizes a connection to SAP Eventing. When dvpIS starts, all events that are sent to the corresponding topic in the queue are registered with SAP Eventing.

  12. Under Environment instance > Event handling, click Inactive or Active to briefly pause or reactivate Eventing.

Connecting d.velop integration service for SAP Solutions to SAP SuccessFactors

To allow d.velop integration service for SAP Solutions (dvpIS) to read data from SAP SuccessFactors via the OData interface and map this data to documents and files as metadata in d.velop documents, corresponding access to the SAP SuccessFactors data is required.

Selecting the role with OData access permissions

This is how it works 

  1. Open the web interface of SAP SuccessFactors.

  2. Navigate to Admin Center. If you cannot find this entry, check your permissions.

  3. In the search field under Tools, search for Manage Permission Roles.

  4. Select a role with OData access permissions for all required entities. Alternatively, you can create a new role with the necessary permissions and then assign this role to the desired user. 

For more information, refer to the SAP SuccessFactors documentation.

Configuring authentication via user name and password (deprecated)

You can configure authentication via a user name and password to connect d.velop integration service for SAP Solutions to SAP SuccessFactors.

Warning

Note that SAP has deprecated authentication via user name and password. You can obtain further information from SAP. In the future, you will only be able to use authentication via OAuth 2.0 (OAuth2SAMLBearerAssertion). 

Use authentication via OAuth 2.0 when configuring new connections and promptly switch existing user name and password authentications to the new method. More information: Configuring authentication via OAuth 2.0

This is how it works 

  1. Open the BTP Cockpit and switch to your subaccount.

  2. Select Destinations.

  3. Click Create.

  4. Select From File.

  5. Select the file SAP_Successfactors.props as the template for connecting to SAP SuccessFactors with a user name and password. Use a SAP SuccessFactors user with the permission to read data from SAP SuccessFactors via the OData interface.

  6. Select the newly created destination from the list of entries. For the connection to SAP SuccessFactors, d.velop integration service for SAP Solutions uses authentication with a user name and password in conjunction with the companyCode value.

  7. Enter the following values:

    • Authentication: BasicAuthentication 

    • Type: HTTP

    • Proxy-Type: Internet

    • User: User name of the SuccessFactors user

    • Password: Password of the SuccessFactors user

    • URL: URL endpoint of the SAP SuccessFactors instance for OData queries

  8. For the destination, add the corresponding code for the SAP SuccessFactors instance under Additional Properties > companyCode

Configuring authentication via OAuth 2.0

Configure authentication using OAuth 2.0 (SAMLBearerAssertion).

Determining the OAuth 2.0 client data – this is how it works

  1. Open the BTP Cockpit and switch to your subaccount.

  2. Click Destination Trust.

  3. Copy the value of Assertion Entity ID.

  4. Select Export to save the configuration file (SAML IdP Trust Configuration) locally.

  5. Open the file in a text editor.

  6. Copy the text between BEGIN CERTIFICATE and END CERTIFICATE (X.509 certificate) to the clipboard.

Setting up the OAuth 2.0 client in SAP SuccessFactors – this is how it works

  1. Open the web interface of SAP SuccessFactors.

  2. Navigate to Manage OAuth2 Client Applications. If you cannot find this entry, check your permissions.

  3. Click Register Client Application.

  4. Enter the following values in the form:

    • ApplicationName: Enter a meaningful name for the connection.

    • Description: Enter a meaningful description for the connection.

    • Application URL: Enter the URL https://<Assertion Entity ID> and replace the placeholder <Assertion Entity ID> with the corresponding value that you copied earlier.

    • X.509 Certificate: Enter the previously copied text of the X.509 certificate.

  5. Click Register. The API Key field then appears. 

  6. Copy the value of API Key.

Setting up the destination in the BTP subaccount of d.velop integration service for SAP Solutions – this is how it works

  1. Open the BTP Cockpit and switch to your subaccount.

  2. Select Destinations.

  3. Click Create.

  4. Select From File.

  5. Select the template file SAP_SuccessFactors_o2.props.

  6. Select the newly created destination from the list of entries.

  7. Enter the following values or replace the placeholders as follows:

    • Token Service URL: In the URL https://sfapiurl/oauth/token?company_id=companyId, replace the placeholders sfapiurl and companyid (without underscore) with the corresponding valid values.

    • URL: In the URL https://sfapiurl/odata/v2, replace the placeholder sfapiurl with the corresponding valid value.

    • Client Key: Enter the previously copied value of API Key.

    • Assertion-Issuer: In the URL https://assertionEntityId, replace the placeholder assertionEntityId with the previously copied value of Assertion Entity ID.

    • Assertion-Recipient: In the URL https://sfapiurl/oauth/token, replace the placeholder sfapiurl with the corresponding valid value.

  8. Under Additional-Properties, enter the following values or replace the placeholders as follows:

    • companyCode: Enter the corresponding valid value of companyId.

    • SystemUser: For the placeholder SfUser, enter the user with OData permissions to be used for the integration. More information: Selecting the role with OData access permissions

    • apiKey: Enter the previously copied value of API Key.

    • userId: Enter the ID of SystemUser.