Error When Discovering REST Services or SOAP Services through the Oracle ERP Cloud Adapter

You can receive the following errors when trying to discover REST services or SOAP services through the Oracle ERP Cloud Adapter.

Service Catalog Errors

The Oracle ERP Cloud Adapter relies on the Oracle Fusion Applications REST and SOAP service catalogs to discover the services.

The catalog services are used during the following operations:
  • Adapter configuration: When navigating with the Adapter Endpoint Configuration Wizard, the list of visible services are returned from the Catalog API.
  • Integration activation: During activation, for each Oracle ERP Cloud Adapter connection, Oracle Integration checks the catalog to ensure that the service is listed.
The following issues may occur:
  • When adding a new Oracle ERP Cloud Adapter connection to an integration with the Adapter Endpoint Configuration Wizard, the service/object is missing from the list.
  • When updating an existing Oracle ERP Cloud Adapter connection in an integration, the Adapter Endpoint Configuration Wizard shows a GENERIC error message.
  • When activating the integration, the activation fails when it's unable to locate the service.

Perform the following troubleshooting steps:

Step Description Verification Notes
1

Verify if location-based access control (LBAC) is enabled in Oracle ERP Cloud.

If LBAC is enabled, check if the Oracle Integration instance outbound IP address has been added to the allowlist.

See:
2 Verify that the integration user created for Oracle Fusion Applications has the correct roles assigned to it. See Assign Required Roles to an Integration User.
3 Check the state of the integration user from Oracle Fusion Applications.
Get the user name from the Oracle Integration connection. Verify the following:
  • The password for the user is correct
  • The password did not expire
  • The user name is not disabled
  • The user name is not locked
4 Ensure that your user and its roles are synchronized.
If there have been any user/roles changes in Oracle Fusion Applications, execute the following scheduled processes:
  • Import user and role application security data
  • Retrieve the latest LDAP changes
  • Synchronize the user GUID
  • Send pending LDAP requests

See:
5 Verify that there is no caching issue on the Oracle Integration side.

Refresh metadata for the connection and verify if the issue still occurs. See Refresh Integration Metadata.

Clone the integration and verify if the issue still occurs. See Clone an Integration.

6 Check if the service or event is listed in the Oracle Fusion Applications catalog.
The Interface catalog REST API returns the list of catalog services available in Oracle Fusion Applications:
GET https://fa-base-url/helpPortalApi/otherResources/latest/interfaceCatalogs
To find the available services and events, Oracle Integration uses the following services from Oracle Fusion Applications:
FSCM Catalog: https://fa-base-url/fscmRestApi/resources/latest/describe
CRM Catalog: https://fa-base-url/crmRestApi/resources/latest/describe
HCM Catalog: https://fa-base-url/hcmRestApi/resources/latest/describe
SOAP Catalog: https://fa-base-url/fscmService/ServiceCatalogService?WSDL
See:

Note:

When testing the catalog services, ensure that you are using the same user name and password as in the Oracle ERP Cloud Adapter connection. If you are using OAuth in the connection, obtain a token using the same client application and the same user name.

Examples of Troubleshooting Service Catalog Issues

Here are some examples on how to troubleshoot service catalog issues.

Oracle ERP Cloud Adapter Trigger Connection

Assume you use the Payables Invoice Created event for the integration INTEGRATION_ERP.

Issues:
  • For a new integration, the Oracle ERP Cloud Adapter trigger connect is not listing the Payables Invoice Created event.
  • For the existing INTEGRATION_ERP integration, the Oracle ERP Cloud Adapter configuration fails with the following exception: 
    An error has been encountered in the processing of your selection. 
Please cancel this configuration session and restart your adapter configuration.

Troubleshoot the issue:

  • Verify if the event is listed in the Oracle Fusion Applications event catalog:
    GET https://fa-base-url/soa-infra/PublicEvent/catalog
    You should expect to see the Payables Invoice Created event in the response:
    {
    "events": [
        ...,
        {
            "documentTransform": {
                "targetTypeDefinition": "oramds:/oracle/apps/financials/payables/invoices/transactions/model/entity/events/InvoiceHeaderEO.xsd",
                "keyMaps": [],
                "inputXSLT": "oramds:/oracle/apps/financials/payables/shared/invoices/common/publicEvents/ApInvoiceCreated.xsl",
                "targetElement": "{http://xmlns.oracle.com/apps/financials/payables/invoices/transactions/model/entity/events}ApInvoiceCreatedInfo"
            },
            "enrichmentType": "SOAP",
            "customEvents": [],
            "description": "This business event is published when Invoice is created by the user",
            "name": "{http://xmlns.oracle.com/apps/financials/payables/invoices/transactions/model/entity/events}ApInvoiceCreated",
            "id": "Ap_Invoice_Created",
            "displayName": "Payables Invoice Created"
        },
        ...
    ]
}
    After activating the integration, you can check if a subscription was created:
    GET https://fa-base-url/soa-infra/PublicEvent/subscriptions
    If the integration activation is successful, a subscription should show the integration INTEGRATION_ERP subscribed to the Payables Invoice Created event. You should expect the following response:
    {
    "subscriptions": [
        ...,
        {
            "integrationName": null,
            "endpointType": "SOAP",
            "csfKey":null,
            "integrationVersion": null,
            "serviceInstance": null,
            "endpointURL": "https://<oic-base-url>/ic/ws/integration/v1/flows/erp/INTEGRATION_ERP/1.0/",
            "name": "{http://xmlns.oracle.com/apps/financials/payables/invoices/transactions/model/entity/events}ApInvoiceCreated",
            "id": "aH***=",
            "state": true,
            "filter": null
        }
    ]
}
  • If the event is missing from the event catalog, check with the Oracle Fusion Applications team to find out why the event is missing.

Oracle ERP Cloud Adapter Invoke Connection Using the REST Endpoint

Assume you use the Payables Invoice Created REST API for the integration INTEGRATION_ERP. See Invoices REST Endpoints.

Issues:
  • A new Oracle ERP Cloud Adapter is not listing the REST endpoint.
  • An old Oracle ERP Cloud Adapter configuration fails with the following exception:
    An error has been encountered in the processing of your selection. 
Please cancel this configuration session and restart your adapter configuration.
  • Integration activation fails with the following exception:
    Integration INTEGRATION_ERP (1.0) cannot be activated.
Failed to located the service endpoint for the service https://fa-base-url/fscmRestApi/resources/11.13.18.05/invoices

Troubleshoot the issue:

  • Verify if the REST catalog lists the Payables Invoice REST service:
    GET https://fa-base-url/fscmRestApi/resources/latest/describe?metadataMode=minimal
    You should expect the response to contain the following /fscmRestApi/resources/11.13.18.05/invoices endpoint.
    {
  "Resources" : {
    ...,
    "invoices" : {
      "links" : [ {
        "rel" : "self",
        "href" : "https://fa-base-url/fscmRestApi/resources/11.13.18.05/invoices/describe",
        "name" : "self",
        "kind" : "describe"
      } ]
    },
    ...
  }
}
    Also verify that the REST operation is listed in the invoices catalog:
    GET https://fa-base-url/fscmRestApi/resources/11.13.18.05/invoices/describe
  • If the REST endpoint is missing from the REST catalog or if the REST catalog invocation is failing:

Oracle ERP Cloud Adapter Invoke Connection Using the SOAP Service

Assume you use the ERP Integration Service SOAP service. See ERP Integration Service.

Issues:
  • A new Oracle ERP Cloud Adapter is not listing the SOAP service.
  • The old Oracle ERP Cloud Adapter configuration fails with the following exception:
    An error has been encountered in the processing of your selection. 
Please cancel this configuration session and restart your adapter configuration.
  • Integration activation fails with the following exception:
    Integration INTEGRATION_ERP (1.0) cannot be activated.
Failed to located the service endpoint for the service {http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationService/}ErpIntegrationService

Troubleshoot the issue:

  • Verify that the SOAP catalog lists the ERP Integration Service SOAP service:
    WSDL URL: https://fa-base-url/fscmService/ServiceCatalogService?WSDL
Operation: getAllServiceEndPoints
    View the request payload:
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://xmlns.oracle.com/oracle/apps/fnd/applcore/webservices/types/">
   <soapenv:Header/>
   <soapenv:Body>
      <typ:getAllServiceEndPoints/>
   </soapenv:Body>
</soapenv:Envelope>
    You should expect the response to contain the ERP Integration Service SOAP service:
    <env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/">
   <env:Header/>
   <env:Body>
      ...
         <ns1:result xsi:type="ns0:CatalogService" xmlns:ns0="http://xmlns.oracle.com/oracle/apps/fnd/applcore/webservices/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:ns1="http://xmlns.oracle.com/oracle/apps/fnd/applcore/webservices/types/">
            <ns0:qName>{http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationService/}ErpIntegrationService</ns0:qName>
            <ns0:lbo xsi:nil="true"/>
            <ns0:lifecycle>Active</ns0:lifecycle>
            <ns0:xsdLocation>https://fa-base-url/fscmService/ErpIntegrationService?XSD=/oracle/apps/financials/commonModules/shared/model/erpIntegrationService/ErpIntegrationService.xsd</ns0:xsdLocation>
            <ns0:wsdlAddress>https://fa-base-url/fscmService/ErpIntegrationService?WSDL</ns0:wsdlAddress>
            <ns0:serviceType>BUSINESS_OBJECT</ns0:serviceType>
         </ns1:result>
         ...
      </ns0:getAllServiceEndPointsResponse>
   </env:Body>
</env:Envelope>
  • If the SOAP service is missing from the SOAP catalog:
    • Run the Synchronize option in Oracle Fusion Applications to try to resynchronize the entire SOAP service catalog on the Oracle Fusion Applications instance.

      Open the Developer Connect portal:

      1. From the Navigator menu, select Tools, and then Developer Connect.
      2. To synchronize the service information in the Developer Connect portal, click Synchronize.
      3. Sign in to the application.
      4. Navigate to Tools, and then Developer Connect.
      5. Click the Synchronize button.

      Open Oracle Integration.

      1. Navigate to the connection.
      2. Refresh the metadata.

      See:

    • Try accessing each missing Oracle Fusion Applications WSDL manually from a web browser. For the ERP Integration Service, use the following WSDL URL: 
      https://fa-base-url/fscmService/ErpIntegrationService?WSDL
    • Check with the Oracle Fusion Applications team to find out why the REST endpoint is not listed in the REST catalog.

REST Services Error

If you receive the following error when trying to discover REST services, verify that you also receive the error outside of Oracle Integration by running the curl command described in the Goal section of Doc ID 2576807.1 at My Oracle Support (MOS). If the error occurs, follow the steps in this MOS document to resolve this issue. 

An error occurred while loading the application catalog, ERROR: Exception while parsing the REST 
application catalog fscmRestApp. Error accessing the URL: https://hostname.oraclecloud.com:443/fscmRestApi/
resources/latest/describe?metadataMode=minimal - received HTTP Response Code: 400; Reason Bad Request. This 
might be because REST APIs are not enabled on the application. Please contact your Application Administrator.

SOAP Services Error

If you receive the following error when trying to discover SOAP services, you must verify the entries in your service catalog. 
Failed to located the service endpoint for the service {http://xmlns.oracle.com/apps/financials
/commonModules/shared/model/erpIntegrationService/}ErpIntegrationService. Please contact the administrator..
Integration TEST_SUBMIT_ESS (1.0) cannot be activated.{0}. ; Failed to located the service endpoint for 
the service {http://xmlns.oracle.com/apps/financials/commonModules/shared/model/erpIntegrationService/}
ErpIntegrationService
For example, perform the following steps:
  1. Invoke ServiceCatalog from the SOAP UI client with the following payload:
    client https://elor.fa.us2.oraclecloud.com/fndAppCoreServices/ServiceCatalogService?wsdl
    The payload should look as follows:
    <soapenv:Body>
  <typ:getAllServiceEndPoints/>
</soapenv:Body>
  2. Add authentication and time stamp headers to your payload.
  3. For any missing services, contact Oracle Fusion Applications support to have those services added to the service catalog.
  4. Reactivate your integration.