Setting Up and Creating an Oracle E-Business Suite Adapter Connection

Setup Overview

Before creating an Oracle E-Business Suite connection with the Oracle E-Business Suite Adapter, you must perform the setup tasks to ensure it works properly.

This chapter includes the following topics:

If an XML Gateway message is used as a trigger (source) in an integration, you must perform additional post activation tasks once you activate the integration to ensure the message works properly in Oracle Integration Cloud Service. See: Post Activation Manual Steps for XML Gateway Messages as a Trigger.

Setup Tasks for Enabling the Oracle E-Business Suite Adapter

Perform the following steps to set up the Oracle E-Business Suite Adapter:

  1. Configure Oracle E-Business Suite Integrated SOA Gateway REST services.

    Oracle E-Business Suite Integrated SOA Gateway is an essential component for the Oracle E-Business Suite Adapter in Oracle Integration Cloud Service. It is the path to access all Oracle E-Business Suite REST services that you can use in integrations in Oracle Integration Cloud Service.

    If you have not configured Oracle E-Business Suite Integrated SOA Gateway, perform the setup and configuration steps as described in the following documents:

    • For Oracle E-Business Suite 12.2

      Refer to Section B: Configuring Oracle E-Business Suite REST Services, Installing Oracle E-Business Suite Integrated SOA Gateway, Release 12.2, My Oracle Support Knowledge Document 1311068.1.

      Ensure that you apply the latest patches for REST services in Document 1311068.1.

    • For Oracle E-Business Suite 12.1.3

      Ensure that you configure Oracle E-Business Suite Integrated SOA Gateway to enable the REST service features. If Oracle E-Business Suite Integrated SOA Gateway is not configured, follow the setup tasks as described in My Oracle Support Knowledge Document 556540.1 to configure Oracle E-Business Suite Integrated SOA Gateway Release 12.1.3.

      If Oracle E-Business Suite Integrated SOA Gateway is already configured in your instance, then apply these REST service patches in the sequence as described in My Oracle Support Knowledge Document 1998019.1 to enable the REST service features.

  2. Configure access to Oracle E-Business Suite services.

    To access Oracle E-Business Suite services from Oracle Integration Cloud Service, Oracle E-Business Suite services must be accessible in either of the following ways:

    • These services are deployed in an environment set up in a DMZ (DeMilitarized Zone) configuration so that Oracle E-Business Suite REST services are publicly accessible through the Internet.

      For DMZ configuration instructions in Oracle E-Business Suite, see Oracle E-Business Suite Release 12.2 Configuration in a DMZ, My Oracle Support Knowledge Document 1375670.1.

    • If your Oracle E-Business Suite is not set up in a DMZ configuration, these services must be accessible through Oracle Integration Cloud Service agent framework.

      For information about creating agent groups as well as downloading the agent installer from Oracle Integration Cloud Service and executing the installer to install the on-premises agent in your local environment, see the Managing Agent Groups and the On-Premises Agent section in the Developing Integration Cloud Services chapter, Oracle Cloud Using Oracle Integration Cloud Service.

      Please note that the on-premises agent should not be installed in an Oracle E-Business Suite instance. Instead, it should be installed in a separate machine.

  3. Deploy the required REST services in Oracle E-Business Suite.

    To use Oracle E-Business Suite REST services for integrations, ensure that you have performed the following tasks:

    • Deploy the Metadata Provider/Integration Repository service

      The Metadata Provider/Integration Repository service is an API that fetches a list of services available for integration. To integrate these Oracle E-Business Suite services, you must deploy the "Metadata Provider" API as a REST service.

      You can search the "Metadata Provider" API from the Integration Repository, and then select the Metadata Provider API from the search results to display the interface details page.

      Please note that you must enter "provider" as the service alias name for the Metadata Provider API and select the GET HTTP method check boxes for ALL the methods contained in the API before deploying it as a REST service.

      Important: If the Metadata Provider API is not deployed as a REST service with GET HTTP method and "provider" as the service alias, the Oracle E-Business Suite Adapter in Oracle Integration Cloud Service will not work as expected.

    • Deploy the Event Manager service

      To use business events from Oracle E-Business Suite as a trigger (source) in an integration in Oracle Integration Cloud Service, you must deploy the Event Manager API as a REST service.

      Similar to the Metadata Provider service, you can search the "Event Manager" API from the Integration Repository, and then deploy it as a REST service. Before the deployment, you must enter "subscription" as the service alias name and select the POST HTTP method check boxes for ALL the methods contained in the API.

    • Deploy business function related APIs as Oracle E-Business Suite REST services

      If you want to integrate or use Oracle E-Business Suite integration interfaces in Oracle Integration Cloud Service, you must first deploy these interface definitions as Oracle E-Business Suite REST services.

      For example, to process a sales order in Oracle E-Business Suite, you must deploy the Sales Order Service (OE_INBOUND_INT) API as a REST service first before you can use this deployed Sales Order Service REST service from Oracle Integration Cloud Service through the Oracle E-Business Suite Adapter.

    For information on deploying REST services, see Deploying REST Web Services, Administering Native Integration Interfaces and Services chapter, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

  4. Grant the required user privileges.

    To use Oracle E-Business Suite REST services through the Oracle E-Business Suite Adapter in Oracle Integration Cloud Service, ensure that an Oracle E-Business Suite user has the privileges to:

    • Access the Metadata Provider/Integration Repository service

      Allowing the access of the "Metadata Provider" API enables the user to browse Oracle E-Business Suite services in Oracle Integration Cloud Service through the Oracle E-Business Suite Adapter.

    • Access the Event Manager service

      This enables the user to use business events as a trigger in Oracle Integration Cloud Service when adding the Oracle E-Business Suite Adapter as a trigger (source) in an integration.

    • Access or execute desired Oracle E-Business Suite APIs and services

      To protect application data from unauthorized access or execution, you must grant the user the interface access privileges for the REST services provided through Oracle E-Business Suite Integrated SOA Gateway.

    The Oracle E-Business Suite user credentials should be used to create an Oracle E-Business Suite connection in Oracle Integration Cloud Service. For example, if you plan to use an Oracle E-Business Suite user hrmanager from Oracle Integration Cloud Service to "create employee" in Oracle E-Business Suite, you need to:

    • Create a security grant on all the methods contained in the Metadata Provider API to the hrmanager Oracle E-Business Suite user.

    • Create a security grant on all the methods contained in the Event Manager API to the hrmanager Oracle E-Business Suite user.

    • Create a security grant on the "Create Employee" method in the Employee API to the hrmanager Oracle E-Business Suite user.

    • Use the hrmanager user credentials while creating an Oracle E-Business Suite connection in Oracle Integration Cloud Service.

    At runtime, the username and password information provided through the Oracle E-Business Suite Adapter connection will be passed to Oracle E-Business Suite for user authentication for the service being invoked in an integration.

    For information on creating security grants for REST services, see Managing Grants for Interfaces with Support for SOAP and REST Web Services, Administering Native Integration Interfaces and Services chapter, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

    For information on creating a connection with Oracle E-Business Suite Adapter, see: Creating an Oracle E-Business Suite Connection with Oracle E-Business Suite Adapter.

Setup Tasks for an SSL-Enabled Oracle E-Business Suite Environment

If your Oracle E-Business Suite instance is SSL enabled, to access the Oracle E-Business Suite instance in Oracle Integration Cloud Service, import additional certificates into Oracle Integration Cloud Service.

For information on uploading certificates, see Uploading an SSL Certificate, Creating Connections, Developing Integration Cloud Services chapter, Oracle Cloud Using Oracle Integration Cloud Service.

Setup Tasks for Using the Oracle E-Business Suite Adapter as a Trigger (Source) Connection

To successfully use business events and XML Gateway messages as inbound integrations in Oracle Integration Cloud Service through the Oracle E-Business Suite Adapter, you must perform the following one-time setup tasks in Oracle E-Business Suite to enable the feature:

  1. Store the ICS user credentials in Oracle E-Business Suite FND vault.

    Execute the PL/SQL script $FND_TOP/sql/afvltput.sql from Oracle E-Business Suite backend to upload and store the user credentials in Oracle E-Business Suite FND vault.

    1. Connect to an Oracle E-Business Suite database:

      sqlplus apps/<apps password>

    2. Execute the script to upload the ICS username:

      @$FND_TOP/sql/afvltput.sql FND REST_USERNAME <ICS WebLogic Username>

      Replace <ICS WebLogic Username> with the username, such as weblogic.

    3. Execute the script to upload the ICS password:

      @$FND_TOP/sql/afvltput.sql FND REST_PASSWORD <ICS WebLogic Password>

      Replace <ICS WebLogic Password> with the associated password value.

    At runtime, the user credentials are retrieved from Oracle E-Business Suite FND vault and are embedded in the HTTP request along with business event data to Oracle Integration Cloud Service. It is included based on the HTTP Basic Authentication scheme. Oracle Integration Cloud Service then authenticates the user credentials based on the HTTP Basic Authentication method and accepts the business event data.

  2. Configure proxy host and port for XML Gateway messages.

    1. Log in to Oracle E-Business Suite as a user who has the System Administrator responsibility.

      Select Oracle Applications Manager from the navigation menu. Navigate to the Site Map.

    2. Click AutoConfig.

    3. In the Context Files page, click the Edit Parameters icon for the Applications tier context file.

    4. In the Context File Parameters page, select the System tab.

      Expand the oa_web_server node and update the values for the following AutoConfig variables:

      Name Variable Value
      OXTAOutUseProxy s_oxta_proxy true
      OXTAOutProxyHost s_oxta_proxyhost <proxy host>
      OXTAOutProxyPort s_oxta_proxyport <proxy port>

      Save your work.

    5. Run AutoConfig from the application tier.

      Refer to Using AutoConfig to Manage System Configurations in Oracle E-Business Suite Release 12, My Oracle Support Knowledge Document 387859.1.

      Refer to the Oracle E-Business Suite Setup Guide R12.2 (Part Number E22953-13) for information on changing AutoConfig variables and executing AutoConfig in the application tier.

  3. Configure proxy host and port at Concurrent Manger Tier JVM.

    To access Oracle Integration Cloud Service from Oracle E-Business Suite on-premise which is behind the firewall, all outbound requests from Oracle E-Business Suite need to be routed through proxy host and port. Therefore, you need to configure and set up the proxy appropriately at the Concurrent Manger Tier JVM.

    1. Log in to Oracle E-Business Suite as a user who has the System Administrator responsibility.

      Select Oracle Applications Manager from the navigation menu. Navigate to the Site Map.

    2. Click AutoConfig.

    3. In the Context Files page, click the Edit Parameters icon for the Applications tier context file.

    4. In the Context File Parameters page, select the Environments tab. Expand the oa_environments:adovars node to locate the APPSJREOPTS (AutoConfig variable or OA_VAR "s_appsjreopts").

    5. Enter the following additional JVM parameters:

      -Dhttp.proxyHost=<http proxy host>

      -Dhttp.proxyPort=<http proxy port>

      -Dhttps.proxyHost=<ssl proxy host>

      -Dhttps.proxyPort=<ssl proxy port>

      Save your work.

    6. Run AutoConfig from the application tier.

      Refer to Using AutoConfig to Manage System Configurations in Oracle E-Business Suite Release 12, My Oracle Support Knowledge Document 387859.1.

      Refer to the Oracle E-Business Suite Setup Guide R12.2 (Part Number E22953-13) for information on changing AutoConfig variables and executing AutoConfig in the application tier.

  4. (Optional) Import the SSL certificates to cacerts in Oracle E-Business Suite.

    This step is required only if Oracle Integration Cloud Service server certificate is not in the Oracle E-Business Suite trusted certificate list.

    Exporting the Oracle Integration Cloud Service Certificates

    Perform the following steps to export the Oracle Integration Cloud Service certificates:

    1. Access the Oracle Integration Cloud Service instance with the HTTPS URL from a web browser.

    2. After the Oracle Integration Cloud Service UI page has been successfully loaded in a browser, double click the Lock icon in the bottom right corner of the browser and export the certificates. For example,

      Note: Different browser versions may have different steps to export SSL certificates.

      • In Internet Explorer, double click the Lock icon, then select Details, and then Copy to File.

      • In Mozilla Firefox, double click the Lock icon, then select Security, then View Certificate, then Details, and then Export.

      Alternatively, you can use the browser menu to export the certificates using the following steps:

      1. In Internet Explorer, select Internet Options from the Tools drop-down menu to open the Internet Options pop-up window.

      2. In the Content tab, click Certificates.

      3. In the Personal (or Other People) tab, select your certificates and click Export.

    3. You can export or save the certificates either in DER encoded binary X.509 (.crt) or in Base64 encoded. For example, the exported certificate is named as rootCA.crt.

    Importing the Oracle Integration Cloud Service Certificates to Oracle E-Business Suite

    Perform the following steps to import the Oracle Integration Cloud Service certificates to Oracle E-Business Suite:

    1. Navigate to the $AF_JRE_TOP/lib/security directory.

    2. Backup the existing cacerts file.

    3. Copy the Oracle Integration Cloud Service server's root certificate rootCA.crt imported earlier to the security directory.

    4. Execute the following command to ensure that cacerts has the write permissions:

      $ chmod u+w cacerts

    5. Add the server's root certificate rootCA.crt to the cacerts file:

      $ keytool -importcert -keystore cacerts -storepass -alias rootCA -file rootCA.crt -v

      Enter the keystore password when prompted. If the certificate already exists in the cacerts file, keytool will warn you and allow you to cancel the import. Cancel the import.

    6. When you have completed the modifications to the cacerts file, reset the permissions:

      $ chmod u-w cacerts

    7. Restart Oracle E-Business Suite application tier services. Use the adstpall.sh and adstrtal.sh scripts in the $ADMIN_SCRIPTS_HOME directory to stop and restart all services.