Contact Us 1-800-596-4880

Upgrading and Migrating SAP S/4HANA SOAP Connector to 3.x

Upgrade Anypoint Connector for SAP S/4HANA SOAP (SAP S/4HANA SOAP Connector) from version 2.x to version 3.x.

Supported Upgrade Paths

From Version To Version

2.x

3.x

Changes

3.0

  • This connector is now compatible with Java 17 only.

  • SAML and XACML (OpenSAML) support is no longer included.

  • The connection timeout unit XML attribute is now connectionTimeoutTimeUnit. Version 2.6 used connectionTimeoutUnit. The service discovery timeout unit XML attribute is now serviceDiscoveryTimeoutTimeUnit. Version 2.6 used serviceDiscoveryTimeoutUnit. For more information, see Config.

  • The new Metadata resolution timeout (metadataResolutionTimeout) and Metadata Resolution Timeout Time Unit (metadataResolutionTimeoutTimeUnit) fields set how long the connector waits to retrieve WSDL and schema documents. The timeout defaults to 5 minutes. For more information, see Basic Authentication, Certificate Authentication, and Oauth2 Client Credentials Authentication.

  • The Invoke operation and the Outbound Message Listener source now include an Encoding field so you can override the configuration encoding for that operation or source. For more information, see Invoke and Outbound Message Listener.

  • The Invoke operation can now throw S4HANA-SOAP:NOT_FOUND and S4HANA-SOAP:UNAUTHORIZED. For more information, see Invoke.

  • Proxy configuration is on the Proxy tab. Choose the default child or the NTLM child of proxy-config. NTLM Domain applies only to NTLM and is required for that proxy type. For more information, see Default and NTLM.

  • Metadata keys are stored only after every configured WSDL validates. A duplicate message type name fails resolution and does not leave a partial metadata cache.

  • Custom SOAP handlers or interceptors that depend on Apache CXF 3 or WSS4J 2 must be updated for Apache CXF 4.2.4 and WSS4J 4.0.2.

  • The connector now rejects conflicting character encodings when sources share a listener path and raises SOURCE_SUBSCRIPTION_CONFLICT instead of accepting the configuration. Sources that share a path must use the same encoding. For more information, see Listener Config.

  • These libraries are upgraded to address reported security vulnerabilities:

    • The wss4j-ws-security-dom library is upgraded to version 4.0.2.

    • The jackson-databind, jackson-dataformat-xml, and jackson-core libraries are upgraded to version 2.22.4.

    • The commons-collections4 library is upgraded to version 4.6.0.

    • The guava library is upgraded to version 33.7.2-jre.

    • The joda-time library is upgraded to version 2.13.0.

    • The asm library is upgraded to version 9.11.1.

Requirements

Ensure your system meets the following compatibility requirements before you perform the upgrade:

Application/Service Version

Mule runtime

4.9.0 and later

OpenJDK

17

SAP S/4HANA SOAP API

v1

The connector build includes a FIPS profile. In that profile, X.509 tests that use a PKCS12 client certificate or PKCS12 truststore signature verification are skipped.

Upgrade Prerequisites

Before you perform the upgrade, you must:

  1. Create a backup of your files, data, and configuration in case you need to restore to the previous version.

  2. Upgrade the application’s Mule runtime to 4.9.0 or later and use Java 17.

  3. If your application runs on Mule 4.8 or earlier, or on Java 8 or Java 11, keep SAP S/4HANA SOAP Connector 2.6.x.

  4. Review shared listener paths and use the same character encoding for every source on a shared path.

  5. If you use custom SOAP handlers or interceptors, update them for Apache CXF 4.2.4 and WSS4J 4.0.2.

  6. If you use SAML or XACML through OpenSAML, plan for that support not being included in 3.x.

  7. Install SAP S/4HANA SOAP Connector 3.x to replace the connector operations that were previously included in version 2.x.

Upgrade Steps

Follow these steps to perform the upgrade from SAP S/4HANA SOAP Connector 2.x to SAP S/4HANA SOAP Connector 3.x:

  1. In Anypoint Studio, create a Mule project.

  2. In the Mule Palette view, click Search in Exchange.

  3. In the Add Dependencies to Project window, enter SAP S/4HANA SOAP in the search field.

  4. In the Available modules section, select SAP S/4HANA SOAP Connector and click Add.

  5. Click Finish.

  6. Verify that the mule-sap-s4hana-soap-cloud-connector dependency version is 3.x.x in the pom.xml file, where x.x is the minor release and patch version number. For example, if you are upgrading to version 3.0, the dependency version in the pom.xml file should be 3.0.0.

Studio upgrades the connector automatically.

Verify the Upgrade

After you install the latest version of the connector, follow these steps to verify the upgrade:

  1. In Studio, verify that there are no errors in the Problems or Console views.

  2. Check the project pom.xml file and verify that there are no problems.

  3. Test the connection and verify that the operations work.

Troubleshooting

If there are problems with caching the parameters and caching the metadata, try restarting Studio.

Revert the Upgrade

If it is necessary to revert to the previous version of SAP S/4HANA SOAP Connector, change the mule-sap-s4hana-soap-cloud-connector dependency version in the project’s pom.xml file to the previous version.

You must update the project’s pom.xml file in Anypoint Studio. Applications that can’t run on Mule runtime 4.9.0 or later and Java 17 must stay on version 2.6.x.