Adding the Oracle E-Business Suite Adapter Connection to an Integration

Overview

When you drag the Oracle E-Business Suite Adapter into the trigger or invoke area of an integration, the Adapter Endpoint Configuration Wizard appears. This wizard guides you through configuration of Oracle E-Business Suite Adapter endpoint properties.

The following sections describe the wizard pages that guide you through configuration of the Oracle E-Business Suite Adapter as a trigger or an invoke in an integration.

Adding the Oracle E-Business Suite Adapter as a Trigger (Source) Connection

When you use the Oracle E-Business Suite Adapter as a trigger in an integration, you can have an option to use either a business event or an XML Gateway message as an inbound integration in Oracle Integration Cloud Service.

Important: Before adding the Oracle E-Business Suite Adapter as a trigger (source) connection for an inbound integration, ensure that you have performed the required setup tasks to enable this feature. See Setup Tasks for Using the Oracle E-Business Suite Adapter as a Trigger (Source) Connection.

For information about error messages if occur while adding the Oracle E-Business Suite Adapter as a trigger (source) connection in an integration, see Error Messages While Creating an Integration with Oracle E-Business Suite Adapter as a Trigger (Source) Connection.

Perform the following steps to add the Oracle E-Business Suite Adapter as a trigger (source) connection in your integration:

  1. In the Integration Designer, drag Oracle E-Business Suite from the Connections panel on the left to the Trigger (Source) area on the canvas.

    The Configure Oracle E-Business Suite Adapter Endpoint wizard appears.

  2. In the Basic Info page, enter the following information for the Oracle E-Business Suite Adapter Endpoint that you are creating:

    Entering the Basic Information for the Adapter Endpoint with Business Event

    the picture is described in the document text

    • What do you want to call your endpoint? - Provide a meaningful name so that others can understand the responsibilities of this connection, such as "EBS_Source_event" or "EBS_Source_XML".

    • What does this endpoint do? - Enter an optional description of the connection's responsibilities, such as "Raise a business event" or "Use XML Gateway message".

    • What do you want to configure the endpoint for? - Select either one of the interface types that you want to configure in your integration:

    Click Next to proceed with the rest of the configuration for your integration.

Configuring an Oracle E-Business Suite Business Event in an Integration

Publishing Business Events from Oracle E-Business Suite to Oracle Integration Cloud Service

When Business Event is selected in the Basic Info page in an integration, you need to specify a desired business event in the Business Events page.

When a business event is raised in Oracle E-Business Suite at runtime, the Oracle E-Business Suite Adapter will propagate the event information from Oracle E-Business Suite to Oracle Integration Cloud Service.

Perform the following steps to configure a business event in an integration:

  1. After adding the Oracle E-Business Suite Adapter as a trigger (source) connection in an integration, select Business Event in the Basic Info page.

    See: Adding the Oracle E-Business Suite Adapter as a Trigger (Source) Connection.

  2. In the Business Events page, specify the following information:

    • Product Family: Select a desired Oracle E-Business Suite application family that you want to use for your integration, for example, Applications Technology.

      The available Oracle E-Business Suite application families from the drop-down list are based on the Oracle E-Business Suite instance you are connecting.

    • Product: Select a desired product name available from the selected product family, for example, XML Gateway.

      Once you select a desired product, a list of business events including Oracle seeded events and custom ones contained in the selected product is populated for further selection.

      Note: You can define custom business events to meet your needs if required, annotate the custom events, and then upload them to the Integration Repository.

      For information on creating custom business events, see Creating Custom Integration Interfaces, Creating and Using Custom Integration Interfaces chapter, Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.

      For information on uploading custom interfaces to Oracle Integration Repository resided in Oracle E-Business Suite Integrated SOA Gateway, see Generating and Uploading iLDT Files, and Uploading ILDT Files to Integration Repository, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

    • Business Event: Locate a desired business event through either of the following ways:

      • Select a desired event name from the drop-down list. For example, select "CLN: Event for Notification Processing".

        Selecting a Business Event from the Event List

        the picture is described in the document text

      • Use the Filter by name field to find your desired event. For example, enter "CLN" in this field to find the event names starting with "CLN".

        Entering a Partial or Full Name to Locate a Desired Event

        the picture is described in the document text

      After you select a business event, the corresponding event information is automatically populated in this page. This includes the event internal name (oracle.apps.cln.np.processnotification) and its description information.

    Click Next.

  3. The Summary page appears with the selected business event information.

    The Oracle E-Business Suite Adapter Source Endpoint configuration is successfully created with the selected event.

    Click Done.

    The connection for Oracle E-Businses Suite now appears in the Trigger (Source) area on the canvas.

For more information on using business events in integrations, see An Example of Using a Business Event as a Trigger (Source) in an Integration.

Configuring an Oracle E-Business Suite XML Gateway Message in an Integration

When XML Gateway Map is selected in the Basic Info page in an integration, you need to specify a desired XML Gateway message in the XML Gateway Message page.

When an XML Gateway outbound transaction occurs in Oracle E-Business Suite at runtime, this message will be enqueued to the ECX_OUTBOUND queue as an existing XML Gateway processing. Oracle Transport Agent (OTA) from Oracle XML Gateway will fetch the message from the queue and post it to Oracle Integration Cloud Service.

Perform the following steps to configure an XML Gateway message in an integration:

  1. After adding the Oracle E-Business Suite Adapter as a trigger (source) connection in an integration, select XML Gateway Map in the Basic Info page.

    See: Adding the Oracle E-Business Suite Adapter as a Trigger (Source) Connection.

  2. In the XML Gateway Message page, specify the following information for your source connection:

    • Product Family: Select a desired Oracle E-Business Suite application family that you want to use for your integration, for example, Service Suite.

      The available Oracle E-Business Suite application families from the drop-down list are based on the Oracle E-Business Suite instance you are connecting.

    • Product: Select a desired product name available from the selected product family, for example, Telecommunications Billing Integrator.

      Once you select a desired product, a list of XML Gateway message maps including Oracle seeded message maps and custom ones contained in the selected product is populated for further selection.

      Note: You can define custom XML Gateway message maps to meet your needs if required, annotate the custom message maps, and then upload them to the Integration Repository.

      For information on creating custom XML Gateway messages, see XML Gateway Annotations, Integration Repository Annotation Standards, Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.

      For information on uploading custom interfaces to Oracle Integration Repository resided in Oracle E-Business Suite Integrated SOA Gateway, see Generating and Uploading iLDT Files, and Uploading ILDT Files to Integration Repository, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

    • XML Gateway Message: Locate a desired message map through either of the following ways:

      • Select a desired message map name from the drop-down list. For example, select "Add Salesorder".

        Selecting a Desired XML Gateway Message Map from the List

        the picture is described in the document text

      • Use the Filter by name field to find your desired map. For example, enter "add" in this field to find the message map names starting with "add".

        Enter a Partial or Full Name to Locate a Desired XML Gateway Message Map

        the picture is described in the document text

      After you select a desired message map, the corresponding information is automatically populated in this page. This includes the Integration Repository name (XNB:SOO), internal name (XNB_OM_SALESORDER_OAG72_OUT), integration standard (OAG 7.2) and the message map description.

    Click Next.

  3. The Summary page appears with the selected XML Gateway message information that you specified earlier. This includes the XML Gateway message name XNB_OM_SALESORDER_OAG72_OUTfrom the selected "Service Suite" product family and "Telecommunications Billing Integrator" product, as well as the "Request Only" interaction pattern.

    the picture is described in the document text

    The Oracle E-Business Suite Adapter Source Endpoint configuration is successfully created with the selected message map.

    Important: To successfully use the selected message map in Oracle Integration Cloud Service, you must perform required manual tasks after you activate the integration. These manual steps are included in the Instructions section as part of the Summary page. See: Post Activation Manual Steps for XML Gateway Messages as a Trigger.

  4. Click Done.

    The connection for Oracle E-Businses Suite now appears in the Trigger (Source) area on the canvas.

For more information on using XML Gateway messages in integrations, see An Example of Using an XML Gateway Message as a Trigger (Source) in an Integration.

Post Activation Manual Steps for XML Gateway Messages as a Trigger

After you create an integration with an XML Gateway message from Oracle E-Business Suite in Oracle Integration Cloud Service, you must manually perform the following tasks:

  1. Activate the integration.

  2. Obtain the integration endpoint URL.

    In the Integrations page, click the Integration Details icon ("i") for a desired integration. The endpoint URL should be displayed in a pop-up window with the following format:

    https://<ICS Host>:<Port>/integration/flowapi/rest/<integration>/v01/.

    The URL will be used later as the protocol address when configuring a trading partner in Oracle XML Gateway.

    • <integration> indicates the alias name for a deployed REST service, such as "PROCESS_PO" in this sample.

    • Do not include metadata listed at the end of the URL when defining a trading partner.

    Integrations Page Showing an Endpoint URL

    the picture is described in the document text

  3. Configure a desired trading partner in Oracle E-Business Suite by specifying the communication protocol and address as well as the user credentials for the XML message specified in an integration.

    1. Log in to Oracle E-Business Suite as a user (such as sysadmin) who has the XML Gateway responsibility.

    2. Select the XML Gateway responsibility and then select Define Trading Partners from the navigator. The Define Trading Partner Setup form appears.

    3. Search and locate a desired trading partner to be configured.

    4. In the Trading Partner Details region, add the following information for the trading partner:

      • Transaction Type: A desired transaction type for your XML Gateway message, such as PO

      • Transaction Subtype: A desired subtype for your XML Gateway message, such as PRO

      • Map: A desired XML Gateway message, such as itg_process_po_007_out

      • Connection/Hub: DIRECT

      • Protocol: HTTPS

      • Protocol address: https://<ICS Host>:<Port>/integration/flowapi/rest/<integration>/v01/

        Enter the integration endpoint URL you recorded earlier.

      • Username: <ICS Username>

        Enter the Oracle E-Business Suite user credentials used to create an Oracle E-Business Suite connection in Oracle Integration Cloud Service.

      • Password: <ICS Password>

      Updating the Trading Partner Details for the Outbound XML Gateway Message

      the picture is described in the document text

    5. Save your work.

    For more information on setting up trading partners, see Trading Partner Setup, Oracle XML Gateway User's Guide.

Adding the Oracle E-Business Suite Adapter as an Invoke (Target) Connection

Perform the following steps to add the Oracle E-Business Suite Adapter as an invoke (target) connection in an integration:

  1. In the Integration Designer, drag Oracle E-Business Suite from the Connections panel on the right to the Invoke (Target) area on the canvas.

    The Configure Oracle E-Business Suite Adapter Endpoint wizard appears.

  2. In the Basic Info page, enter the following information for the Oracle E-Business Suite Adapter target endpoint:

    • What do you want to call your endpoint? - Provide a meaningful name so that others can understand the responsibilities of this connection, such as "EBS_CreateOrder".

    • What does this endpoint do? - Enter an optional description of the connection's responsibilities, such as "Create a Sales Order in Oracle E-Business Suite".

    Entering the Basic Information for the Target Endpoint

    the picture is described in the document text

    Click Next.

  3. In the Web Services page, specify the following information for your target connection:

    • Product Family: Select a desired Oracle E-Business Suite application family that you want to use for your integration, for example, Order Management Suite.

      The available Oracle E-Business Suite application families from the drop-down list are based on the Oracle E-Business Suite instance you are connecting.

    • Product: Select a desired product name available from the selected product family, for example, Order Management.

      Selecting a Product Family and Product for a Web Service

      the picture is described in the document text

      Once you select a desired product family and a product, a list of the supported interfaces including Oracle seeded and custom interfaces contained in the selected product is populated for further selection.

      Important: In this release, only PL/SQL APIs and concurrent programs are available for selection when adding the Oracle E-Business Suite Adapter as an invoke (target) connection in an integration.

      Note: You can define custom PL/SQL APIs and concurrent programs to meet your needs if required, annotate the custom integration interfaces, and then upload them to the Integration Repository. You can deploy the custom PL/SQL APIs and concurrent programs as REST services from Oracle E-Business Suite Integrated SOA Gateway. These REST services will then be available to use for integrations in Oracle Integration Cloud Service.

      For information on creating custom PL/SQL APIs and concurrent programs, see Creating Custom Integration Interfaces, Creating and Using Custom Integration Interfaces chapter, Oracle E-Business Suite Integrated SOA Gateway Developer's Guide.

      For information on uploading custom interfaces to Oracle Integration Repository resided in Oracle E-Business Suite Integrated SOA Gateway, see Generating and Uploading iLDT Files, and Uploading ILDT Files to Integration Repository, Oracle E-Business Suite Integrated SOA Gateway Implementation Guide.

    • API: Select a desired interface through either of the following ways:

      • Select a desired interface name from the drop-down list. For example, select the "Sales Order Services" PL/SQL API.

        Selecting a PL/SQL API from the Populated List

        the picture is described in the document text

        The corresponding interface information is automatically populated. This includes the interface internal name (OE_INBOUND_INT) and description.

        Note: Other than selecting a PL/SQL API, you can select a desired concurrent program in your integration. For example, select a concurrent program "Claim Settlement Fetcher Program" from the Marketing Suite product family and the Trade Management product.

        Selecting a Concurrent Program from the Populated List

        the picture is described in the document text

      • Use the Filter by name field to find your desired interface. For example, enter "sales" in this field to find the interface names starting with "sales".

      Note: If one ore more methods contained in the selected interface are deployed as REST service operations, after you click Next, the Operations page appears.

      If none of the methods within the selected interface is deployed as a REST service operation, then an error message is shown instead, indicating that the associated REST service is not available. You must deploy the selected interface as a REST service first before using it in an integration.

      Showing an Error for a Not Available API

      the picture is described in the document text

    Click Next.

  4. In the Operations page, the selected interface internal name OE_INBOUND_INT is automatically populated.

    Choose a desired method name contained in the selected interface for this target connection. For example, select "PROCESS_ORDER".

    Selecting a Method in the Operations Page

    the picture is described in the document text

    Note: If you select a concurrent program in your integration, such as "Claim Settlement Fetcher Program" as shown in the following screenshot, you can select "Process" in the Operations page.

    Selecting a Concurrent Program Method in the Operations Page

    the picture is described in the document text

    Once the desired method is selected, its corresponding REST service status is displayed in the Service Status field.

    • Ready to Use

      This indicates that the selected method is deployed as a REST service operation and it is ready to use in your integration.

    • Not Deployed

      If the selected method is not deployed as a REST service operation, then "Not Deployed" is shown as the service status instead. A warning message also appears, indicating that you must deploy the method as a REST service operation first before using it in your integration.

      Showing a Method with "Not Deployed" Service Status

      the picture is described in the document text

      To deploy the selected method as a REST service operation, you need to log in to Oracle E-Business Suite as a user who has the Integration Administrator role. Select the Integrated SOA Gateway responsibility and the Integration Repository link from the navigation menu. Search and locate the selected interface from the Integration Repository, and then deploy it as a REST service. Only when the REST service is available in Oracle E-Business Suite, you can proceed and complete the process of adding Oracle E-Business Suite as an invoke (target) connection.

      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.

    Click Next.

  5. The Summary page appears with the selected interface information. The Oracle E-Business Suite Adapter Target Endpoint configuration is successfully created.

    Click Done.

    The connection for Oracle E-Businses Suite now appears in the Invoke (Target) area on the canvas.

Once the Oracle E-Businses Suite invoke (target) connection is created, you can add an application adapter as a trigger (source) connection to complete your integration creation. For information on adding a trigger (source) connection, see Developing Integration Cloud Services, Oracle Cloud Using Oracle Integration Cloud Service.

For information about error messages if occur while creating an integration with the Oracle E-Business Suite Adapter as an invoke (target) connection in Oracle Integration Cloud Service, see Error Messages While Creating an Integration with the Oracle E-Business Suite Adapter as an Invoke (Target) Connection.