Contact Us 1-800-596-4880
  1. Homepage
  2. ServiceNow Connector (7.0)

  3. Upgrading and Migrating ServiceNow Connector

All Connectors

Upgrading and Migrating ServiceNow Connector to 7.x

Upgrade Anypoint Connector for ServiceNow (ServiceNow Connector) from version 6.x to version 7.x.

Supported Upgrade Paths

From Version To Version

6.x

7.x

Changes in This Release

7.0

  • This connector is now compatible with Java 17 only.

  • The SOAP engine is upgraded to version 3.0.3, which is based on Apache CXF 4.x. The SoapFaultException class moves from org.mule.runtime.soap.api.exception to org.mule.soap.api.exception. Update custom code that references the previous package.

  • The default Signature Digest Algorithm is now SHA256 instead of SHA1. The SHA1 digest and RSAwithSHA1 signature options are removed. Signature and canonicalization algorithm values now use uppercase names. Update configurations that use the removed options or previous names. For more information, see WSS Signing Configuration Adapter.

  • You can now configure an HTTP or NTLM proxy and a TLS context for both connection types. For more information, see Basic Authentication and OAuth 2.0 Authorization Code.

  • The new TLS configuration supports enabled protocols, cipher suites, trust stores, key stores, and certificate revocation checks. HTTP and NTLM proxy configurations support authentication and hosts that bypass the proxy. For more information, see TLS, Proxy, and NTLM Proxy.

  • ServiceNow Version is now deprecated. It’s retained on the global configuration for backward compatibility. The connector uses the API exposed by the ServiceNow instance specified in Service Address, so you don’t need a replacement version setting.

  • User Tables List and Encoding are now configured on the global configuration instead of on the connection providers. The global configuration also supports Read Timeout and Read Timeout Unit. For more information, see Configuration.

  • The Invoke operation and the New / Updated Record source can now override the global encoding and read timeout settings. For more information, see Invoke and New / Updated Record.

  • Show Reference Values on the Invoke operation and Display System References on the New / Updated Record source are now enumerations instead of strings, with the values TRUE, FALSE, and ALL. For more information, see Invoke and New / Updated Record.

  • The read timeout unit XML attribute changes from readTimeoutUnit to readTimeoutTimeUnit for both HTTP message dispatcher providers. The global configuration also uses the readTimeoutTimeUnit XML attribute, displayed as Read Timeout Unit. For more information, see Basic Authentication HTTP Message Dispatcher Provider and OAuth2 HTTP Message Dispatcher Provider.

  • The Basic Authentication connection provider now uses connection caching instead of pooling. The Pooling Profile configuration is removed. For more information, see Basic Authentication.

  • Authentication, access-denied, not-found, SOAP fault, and bad response failures now raise declared connector errors. The Invoke operation declares SERVICENOW:SECURITY and SERVICENOW:NOT_FOUND. Request timeouts and dispatch failures raise SERVICENOW:TIMEOUT and SERVICENOW:CANNOT_DISPATCH. Review error handlers that previously matched generic failures. For more information, see Invoke.

  • SOAP response headers are now returned as repeatable XML streams. For more information, see SOAP Output Envelope.

  • Table names used by Invoke must contain only ASCII letters, digits, and underscores. Invalid names raise SERVICENOW:BAD_REQUEST.

  • The SOAP engine and related security dependencies are upgraded to address reported security vulnerabilities. Unused pinned dependencies are removed.

  • These libraries are upgraded to address reported security vulnerabilities:

    • The Apache CXF libraries are upgraded to version 4.2.4.

    • The Apache WSS4J libraries are upgraded to version 4.0.2.

    • The xmlsec library is upgraded to version 4.0.4.

    • The xmlschema-core library is upgraded to version 2.3.3.

    • The json library is upgraded to version 20260814.

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

    • The commons-codec library is upgraded to version 1.22.1.

    • The woodstox-core library is upgraded to version 7.2.2.

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

    • The asm library is upgraded to version 9.11.1.

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

Requirements

Before you upgrade, ensure that your environment uses Mule runtime engine 4.9.0 or later and OpenJDK 17.

Upgrade Steps

  1. Update the ServiceNow Connector dependency in your project’s pom.xml file to version 7.x.x.

  2. Update the Mule runtime engine to version 4.9.0 or later and run the application on OpenJDK 17.

  3. Move the encoding attribute from the connection provider to the global servicenow:config element. Remove the deprecated serviceNowVersion attribute or move it to <servicenow:config> if you’re retaining it for backward compatibility. It doesn’t configure the ServiceNow API version. Move the <servicenow:user-tables> child element out of the connection provider and place it under <servicenow:config>, after the connection element.

  4. Rename readTimeoutUnit to readTimeoutTimeUnit in existing Basic Authentication and OAuth HTTP message dispatcher configurations.

  5. If required, configure Read Timeout and Read Timeout Unit on the global configuration. Configure Encoding, Read Timeout, and Read Timeout Time Unit overrides on the Invoke operation or the New / Updated Record source when their values differ from the global configuration.

  6. Replace custom references to org.mule.runtime.soap.api.exception.SoapFaultException with org.mule.soap.api.exception.SoapFaultException.

  7. Replace RSAwithSHA1 with a supported signature algorithm. Replace any explicit signatureDigestAlgorithm="SHA1" setting with a supported digest, such as SHA256. If no digest is configured, the new default is SHA256. Verify that the chosen signing and digest algorithms are compatible with the ServiceNow WS-Security policy.

  8. Update signature algorithm values to RSA_WITH_SHA224, RSA_WITH_SHA256, RSA_WITH_SHA384, or RSA_WITH_SHA512. Update canonicalization algorithm values to CANONICAL_XML_1_0, CANONICAL_XML_1_1, or EXCLUSIVE_XML_CANONICALIZATION_1_0.

  9. Remove the Pooling Profile configuration from Basic Authentication connections.

  10. Review on-error handlers for connector operations. Update handlers that rely on generic failures to handle the declared connector errors that now represent security, not found, SOAP fault, bad response, timeout, and request dispatch failures.

  11. Review code and transformations that consume SOAP response headers. Header values are now repeatable XML streams rather than strings. HTTP protocol headers in SoapAttributes are separate and remain string values.

  12. Verify that table names passed to Invoke contain only ASCII letters, digits, and underscores.

  13. Test each connector connection and operation after the upgrade.

See Also

Back to top