Upgrading and Migrating SAP SuccessFactors Connector to Version 4.0 - Mule 4
Upgrade Anypoint Connector for SAP SuccessFactors (SuccessFactors Connector) to version 4.0.0 to use OAuth 2.0 SAML Bearer Assertion for authentication.
Changes in This Release
SuccessFactors Connector 4.0 includes the following changes:
-
SuccessFactors Connector 4.0 now supports OAuth 2.0 SAML Bearer Assertion authentication.
The implementation of OAuth 2.0 with Bearer SAML Assertion authentication is based on the internalmule-oauth-clientlibrary, which requires you to use Mule 4.2.x or higher with this version of the connector. -
Refactored error types and exception handling.
-
Renamed the connector package to comply with Mule best practices.
Requirements
To take advantage of the security offered by using OAuth 2.0 SAML Bearer Assertion for authentication, you must configure your SuccessFactors account and instance with an application that can connect using OAuth.
Use the SAP SuccessFactors OData API to Generate Access Tokens
SAP SuccessFactors OData API supports two-legged authentication for OAuth 2.0. You can use the OData APIs to generate access tokens for OAuth 2.0 authentication:
-
Use
/oauth/idpto pass a private key to generate a signed SAML assertion. -
Use
/oauth/tokento pass a token for signing in a SAML assertion. -
Use
/odata/v2to use the access token for authentication and access the OData APIs. -
Use
/oauth/validateto pass the access token to the API and verify that it’s still valid.
A token is only valid for 24 hours after it’s generated.
Upgrade Prerequisites
Before you perform the upgrade, you must create a backup of your files, data, and configurations in case you need to restore to them.
Upgrade Steps
Follow these steps to perform the upgrade:
-
In Anypoint Studio, create a Mule project.
-
In the Mule Palette view, click Search in Exchange.
-
In Add Dependencies to Project, enter
successfactorsin the search field. -
In Available modules, select SuccessFactors and click Add.
-
Click Finish.
-
Verify that the SAP SuccessFactors Connector dependency version is
4.0.0in thepom.xmlfile in the Mule project.
Studio upgrades the connector automatically.
Verify the Upgrade
After you install the latest version of the connector, follow these steps to verify the upgrade:
-
In Studio, verify that there are no errors in the Problems or Console views.
-
Verify that there are no problems in the project
pom.xmlfile. -
Test the connection to verify that the operations work.