Contact Us 1-800-596-4880

Upgrading and Migrating Oracle EBS 12.1 Connector to 6.x

Upgrade Anypoint Connector for Oracle E-Business Suite (Oracle EBS 12.1 Connector) from version 5.x to version 6.x.

Supported Upgrade Paths

From Version To Version

5.x

6.x

Changes in This Release

6.0

  • This connector is now compatible with Java 17 only.

  • PL/SQL and Web Services connections now include separate Read Timeout, Connection Timeout, and Connection Idle Timeout fields with corresponding Read Timeout Unit, Connection Timeout Unit, and Connection Idle Timeout Unit fields. Each timeout defaults to 30 with a unit of SECONDS. The PL/SQL Read Timeout previously defaulted to 30000 milliseconds, so its effective duration remains 30 seconds. HTTP proxy fields remain available for PL/SQL. For more information, see PLSQL Connection Type and Web Services Connection Type.

  • PL/SQL and Web Services connections now support TLS Context. For Web Services, this replaces TrustStore file name, TrustStore password, and Disable Common Name checking. For more information, see TLS.

  • The source XML elements are now business-events-listener and xml-gateway-outbound-listener, instead of business-events-source and xml-gateway-outbound-source. For more information, see Business Events Listener and XML Gateway Outbound Listener.

  • Payload fields for web service operations, the Invoke PL SQL operation, and the XML Gateway operation now use the Any type, instead of Binary. The Invoke PL SQL operation and both listeners also return Any. For more information, see Invoke PL SQL, Business Events Listener, and XML Gateway Outbound Listener.

  • The redelivery policy now identifies messages with Message Identifier. Use Secure Hash and Id Expression are fields of that type. For more information, see Redelivery Policy and Redelivery Policy Message Identifier.

  • The repeatable file-store stream field Max In Memory Size is now In Memory Size. For more information, see Repeatable File Store Stream.

  • Custom PL/SQL WSDLs now undergo secure validation. DOCTYPE declarations, XInclude, and imports, includes, or redefines with nonempty external locations are rejected, whether the locations are relative or absolute. Rejected WSDLs cause ORACLE-EBS:INVALID_WSDL.

  • PL/SQL invocation endpoints now include a trailing slash (/plsql/<package>/) to match Oracle EBS Integrated SOA Gateway requirements.

  • PL/SQL connection retries now retain successfully created SOAP clients after a partial connection failure and recreate only missing clients while the connection configuration is unchanged.

  • The Business Events Listener and XML Gateway Outbound Listener now close their consumers before their JMS sessions and don’t trigger reconnection when stopped. For more information, see Business Events Listener and XML Gateway Outbound Listener.

  • These libraries are upgraded to address reported security vulnerabilities:

    • The Apache CXF libraries are upgraded to version 4.2.4.

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

    • The gson library is upgraded to version 2.15.0.

    • The commons-lang3 library is upgraded to version 3.21.0.

    • The xmlsec library is upgraded to version 4.0.4.

    • The jakarta.xml.bind-api library is upgraded to version 4.0.5.

    • The jaxb-runtime library is upgraded to version 4.0.9.

    • The jakarta.xml.ws-api library is upgraded to version 4.0.3.

    • The jakarta.xml.soap-api library is upgraded to version 3.0.2.

    • The saaj-impl library is upgraded to version 3.0.6.

Requirements

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

Application/Service Version

Mule runtime

4.9 and later

Oracle EBS

12.1.x

OpenJDK

17

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. Ensure that your environment meets the version 6.x requirements.

  3. Review applications that set Max In Memory Size on a repeatable file-store stream, or that set Use Secure Hash and Id Expression directly on the redelivery policy.

  4. Review explicit timeout values and units. If you retain a value of 30000, set its unit to MILLISECONDS to preserve a 30-second timeout.

  5. To preserve the previous PL/SQL connection and idle timeout settings, set both Connection Timeout and Connection Idle Timeout to the previous Connection Idle Timeout value. Set both Connection Timeout Unit and Connection Idle Timeout Unit to the previous Connection Timeout Unit value.

  6. Replace the Web Services TrustStore file name, TrustStore password, and Disable Common Name checking fields with TLS Context and verify your certificate validation settings.

  7. Rename source elements to business-events-listener and xml-gateway-outbound-listener in the application XML.

  8. Ensure custom PL/SQL WSDLs meet the secure validation requirements.

  9. Ensure custom PL/SQL WSDL endpoints return self-contained WSDLs directly, without HTTP redirects. Include required WSDL and XML Schema definitions within the document.

  10. When using custom PL/SQL packages, ensure the runtime user can create, write, and restrict access to the ${user.home}/.mulesoft/oracle-ebs-connector/wsdl-cache directory. The connector deletes cached WSDL files during disconnect or stop.

  11. Verify that externally supplied Oracle JDBC and AQ libraries support Java 17 and work together in your deployment. The connector declares Oracle JDBC ojdbc8 version 19.33.0.0 and AQ API version 19.3.0.0 as provided dependencies. These declarations don’t replace the libraries supplied by your application.

  12. Install Oracle EBS 12.1 Connector 6.x to replace the connector operations that were previously included in version 5.x.

Upgrade Steps

Follow these steps to perform the upgrade from Oracle EBS 12.1 Connector 5.x to Oracle EBS 12.1 Connector 6.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 Oracle EBS in the search field.

  4. In the Available modules section, select Oracle EBS 12.1 Connector and click Add.

  5. Click Finish.

  6. Verify that the mule-oracle-ebs-connector dependency version is 6.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 6.0, the dependency version in the pom.xml file should be 6.0.0.

Studio updates the connector dependency. You must also make the configuration changes described in Upgrade Prerequisites.

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.

  4. Verify DataSense and invocation for both bundled and custom PL/SQL packages, including connections that use TLS or an HTTP proxy.

  5. Start and stop both JMS listeners and verify subscriptions and message delivery in your deployment environment.

For durable Business Events Listener subscriptions, an omitted or empty Subscription Name continues to default to muleBusinessEvents. This behavior is unchanged from 5.x.

Troubleshooting

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

For an ORACLE-EBS:INVALID_WSDL error, use a self-contained custom PL/SQL WSDL without DOCTYPE declarations or XInclude. Inline required WSDL and XML Schema definitions rather than only removing their external location attributes.

For ORACLE-EBS:CONNECTIVITY during WSDL retrieval, check the endpoint, credentials, proxy, TLS, and timeout settings. Ensure the endpoint returns the WSDL directly without an HTTP redirect. Also check that the runtime user’s home directory is writable and that the connector can create and restrict access to its WSDL cache directory.

Revert the Upgrade

If it is necessary to revert to the previous version of Oracle EBS 12.1 Connector, change the mule-oracle-ebs-connector dependency version in the project’s pom.xml file to 5.3.5.

Rollback is a connector downgrade. There is no data migration.

Restore the backed-up 5.x configuration, including source names, TLS settings, timeout values, and error handlers.

You must update the project’s pom.xml file in Anypoint Studio.