An Example of Using an XML Gateway Message as a Trigger (Source) in an Integration

Overview

Sample Business Scenario

When a purchase order is approved in the Oracle E-Business Suite Purchasing application, a process purchase order XML message should be sent from Oracle E-Business Suite to Oracle Integration Cloud Service.

In this example, an XML Gateway message "Purchase Order XML message" from Oracle Purchasing is used as a trigger (source) to explain using the Oracle E-Business Suite Adapter to trigger an integration in Oracle Integration Cloud Service. The Oracle E-Business Suite Adapter is used to connect to the Oracle Purchasing instance. Additionally, you need to configure the trading partner in Oracle XML Gateway to send the outbound XML message from Oracle E-Business Suite to the integration endpoint in Oracle Integration Cloud Service.

At runtime, when an order is approved, if the supplier or trading partner is configured to receive the outbound XML message for Process Purchase Order, Oracle E-Business Suite Purchasing will trigger the integration and initiate XML Gateway outbound processing to send the process order XML message from Oracle E-Business Suite to Oracle Integration Cloud Service.

Using XML Gateway Messages for Integrations in Oracle Integration Cloud Service

Based on the business scenario, the following tasks are included in this section:

  1. Preparing the Oracle E-Business Suite Instances Purchasing Instance

  2. Establishing an Oracle E-Businss Suite Connection for Publishing XML Gateway Messages

  3. Creating an Integration

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

  5. Assigning Business Identifier for Tracking

  6. Activating the Integration

  7. Configuring Trading Partner Information for Post Integration

  8. Testing and Validating the Integration

Preparing the Oracle E-Business Suite Instances Purchasing Instance

This example uses the Oracle E-Business Suite Purchasing application to approve a purchase order. Before creating a connection, you must prepare the Oracle E-Business Suite Purchasing instance to ensure the required setup or configuration is in place.

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

    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 and apply the REST service patches to enable the REST service feature. For more information, see step 1, as described in Setup Tasks for Enabling the Oracle E-Business Suite Adapter.

  2. (Optional) Import SSL certificates of Oracle Integration Cloud Service to Oracle E-Business Suite if required.

    For information on importing SSL certificates, refer to step 4 as described in Setup Tasks for Using the Oracle E-Business Suite Adapter as a Trigger (Source) Connection.

  3. (Optional) Set up proxy URLs in Oracle E-Business Suite if required.

    For information on the proxy setup, refer to step 2 as described in Setup Tasks for Using the Oracle E-Business Suite Adapter as a Trigger (Source) Connection.

  4. Deploy the Metadata Provider API as a REST service with the following requirements and grant the method access privileges to the operations user:

    • Deploy the API with "provider" as the service alias name

    • Deploy the API with GET HTTP verb for all the methods contained in the API

    • Grant the access privileges for all the methods contained in the Metadata Provider API to the operations user

    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.

    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.

Establishing an Oracle E-Businss Suite Connection for Publishing XML Gateway Messages

Perform the following steps to establish the connection for Oracle E-Businss Suite in Oracle Integration Cloud Service:

  1. Click Connections.

  2. Click Create New Connection.

  3. In the Create Connection - Select Adapter dialog appears.

    You can locate the Oracle E-Business Suite Adapter by entering a full or partial name to locate "Oracle E-Business Suite" from the dialog.

    Click the Select button for "Oracle E-Business Suite". The New Connection - Information dialog appears.

  4. Enter the following information for your connection:

    Creating the Purchasing Connection

    the picture is described in the document text

    • Connection Name: Enter "Purchasing" as the connection name.

    • Identifier: Accept the default identifier for your Oracle E-Business Suite connection, such as "PURCHASING".

    • Connection Role: Select "Trigger and Invoke" role for this connection.

    • Description: Enter description information for your connection, such as "Create an Oracle E-Business Suite Purchasing connection".

    Click Create to create the connection. The Connection Details page is displayed for the "Purchasing" connection.

  5. Enter additional connection details by specifying the following information:

    • Email Address: Enter an administrator's email address to receive notifications if problems or changes occur in this connection.

    • Connection Properties: Click Configure Connectivity to open the Connection Properties dialog where you enter a URL (http://<ebs host name>:<port>) to connect to an Oracle E-Business Suite instance.

      Click OK to save your work.

    • Security: Click Configure Security to open the Credentials dialog.

      Ensure that "Basic Authentication" is selected as the security policy.

      Enter operations as the username and its associated password in the Credentials dialog to access the Oracle E-Business Suite Purchasing instance you specified earlier in the Connection Properties dialog.

      Click OK.

  6. Click Test to test the "Purchasing" connection you just specified.

  7. Click Save to save your connection.

    Click Exit Connection.

Creating an Integration

This section provides the instructions on creating an integration called "PROCESS PO" with the "Publish To ICS" integration pattern. This pattern allows you to add the Oracle E-Business Suite Purchasing connection specified earlier as a trigger in the integration.

Perform the following steps to create an integration:

  1. In the Integration Cloud Service toolbar, click Designer.

  2. In the Designer Portal, click Integrations.

  3. In the Integrations page, click New Integration.

    The Create Integration - Select a Style/Pattern dialog appears.

    Click Select for the "Publish To ICS" integration pattern.

    Selecting the "Publish To ICS" Pattern for the Integration

    the picture is described in the document text

  4. The New Integration - Information dialog appears. Enter the following information:

    • What do you want to call your integration? Enter "PROCESS PO" as the integration name.

    • Identifier: Accept the default identifier value, such as "PROCESS_PO".

    • Version: Accept the default version number.

    • What does this integration do? Enter description information for your integration, such as "Create an integration for processing a purchase order in Oracle Purchasing".

    Entering Integration Information in the New Integration - Information Dialog

    the picture is described in the document text

  5. Click Create and Save.

To complete the integration, you need to add the following tasks that are described in the next few sections:

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

Once the "PROCESS PO" integration is created, you can add the "Purchasing" connection that you just created by using the Oracle E-Business Suite Adapter as a trigger (source).

Perform the following steps to add the Oracle E-Business Suite Adapter as a trigger in the integration:

  1. In the "PROCESS PO" integration page, search the "Purchasing" connection that you created earlier from the Connections panel.

  2. In the Integration Designer, drag "Purchasing" from the Connections panel on the right to the Trigger (Source) area on the canvas. The Configure Oracle E-Business Suite Adapter Endpoint wizard appears.

  3. Enter the following information In the Basic Info page:

    • What do you want to call your endpoint? - Enter "EBS_Source" as the endpoint name.

    • What does this endpoint do? - Enter "Process a purchase order in Oracle E-Business Suite".

    • What do you want to configure the endpoint for? - Select XML Gateway Map.

    Entering the Basic Information for the Adapter Endpoint with XML Gateway Message

    the picture is described in the document text

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

  4. In the XML Gateway Message page, specify the following information for your trigger (source) connection:

    • Product Family: Select "Procurement" from the product family.

    • Product: Select "Internet Procurement Enterprise Connector" from the list of product names.

    • XML Gateway Map: Select a desired XML Gateway message name from the drop-down list. For example, select "Purchase Order XML message".

      After you select the message map, the corresponding information is automatically populated in this page. This includes the Integration Repository name (PO:PRO), internal name (itg_process_po_007_out), integration standard (OAG 7.2) and the message map description.

    Selecting a Desired XML Gateway Message Map

    the picture is described in the document text

    Click Next.

  5. The Summary page appears with the selected XML Gateway message information that you specified. This includes the XML Gateway message name itg_process_po_007_out from the selected "Procurement" product family and the "Internet Procurement Enterprise Connector" product, as well as the "Request Only" interaction pattern.

    Viewing the Selected XML Gateway Message Information in the Summary Page

    the picture is described in the document text

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

    Click Done.

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

    Displaying "Purchasing" in the Trigger Area with XML Gateway Map in the Integration

    the picture is described in the document text

Assigning Business Identifier for Tracking

Perform the following steps to track payload fields in messages during runtime:

  1. In the Create Order Integration page, click Tracking.

    The Business Identifiers For Tracking dialog appears.

  2. From the Available Source Fields section, expand the XmlGateway_Input node, then the PROCESS_PO_007 node, then the DATAAREA node, then the PROCESS_PO node, and then the POORDERHDR node.

    Drag the POID element to the Tracking Field column in the table.

    The POID is displayed in the Tracking Field with a green check mark next to it in the table.

    Displaying the Selected Identifier for Tracking

    the picture is described in the document text

  3. Click Done.

  4. Save your work and then click Exit Integration.

Activating the Integration

Activating the Integration

After you complete the integration with a desired XML Gateway message, you can activate the integration.

  1. In the Integrations page, click Activate for the "PROCESS PO" integration that you created earlier.

  2. The Confirmation dialog appears. Click Activate to confirm the action.

    Notice that the status of the "PROCESS PO" integration changes to ACTIVE.

Recording the Integration Endpoint in Oracle Integration Cloud Service

After activating the integration, you need to obtain the integration endpoint URL by clicking the Integration Details icon ("i") for the "PROCESS PO" integration. A pop-up window appears. Record the endpoint URL information.

In this example, the endpoint URL should be like:

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

Note: The metadata at the end of the URL is not required.

Obtaining the Integration Endpoint URL in the Integrations Page

the picture is described in the document text

This recorded integration endpoint URL will be used as the protocol address value when defining a trading partner in the post integration configuration, as described in Configuring Trading Partner Information for Post Integration.

Configuring Trading Partner Information for Post Integration

After you activate the integration, you must perform manual tasks to configure the trading partner ("Advanced Network Devices" in this example) for the outbound transaction message selected in the integration. This includes specifying the communication protocol and address as well as the user credentials in Oracle E-Business Suite.

Additionally, obtain the integration endpoint URL you recorded earlier, such as https://<ICS Host>:<Port>/integration/flowapi/rest/PROCESS_PO/v01/.

Perform the following steps to configure the trading partner in Oracle E-Business Suite:

  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 navigation menu. The Define Trading Partner Setup form appears.

  3. In the Trading Partner Setup form, search and locate the desired trading partner called "Advanced Network Devices".

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

    • Transaction Type: PO

    • Transaction Subtype: PRO

    • Standard Code: OAG

    • External Transaction Type: PO

    • External Transaction Subtype: PROCESS

    • Direction: OUT

    • Map: itg_process_po_007_out

    • Connection/Hub : DIRECT

    • Protocol: HTTPS

    • Protocol address:https://<ICS Host>:<Port>/integration/flowapi/rest/PROCESS_PO/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 in the Trading Partner Setup Form

    the picture is described in the document text

  5. Save your work.

Testing and Validating the Integration

Based on the example scenario, once a purchase order is approved in the Oracle E-Business Suite Purchasing application, Oracle Purchasing will initiate XML Gateway outbound processing and publish XML message to Oracle Integration Cloud Service. Therefore, you need to create a purchase order first and then approve the order to trigger the outbound processing from Oracle E-Business Suite.

Perform the following steps to create and approve a new purchase order:

  1. Log in to the Oracle E-Business Suite Purchasing instance as the operations user who has the Purchasing, Vision Operations (USA) responsibility.

    Select Purchase Orders and then Purchase Orders from the navigation menu.

  2. In the Purchase Orders form, create a new purchase order for the configured trading partner or supplier called "Advanced Network Devices" with the following information:

    • Supplier: Advanced Network Devices

    • Type: Standard Purchase Order

    • Site: SANTA CLARA-ERS

    • Ship-To: M1- Seattle Mfg

    • Bill-To: V1- New York City

  3. In the Line tab, add one line item:

    • Num: 1

    • Item: AS10000

    • Description: 405 Digital Camera

    • UOM: Each

    • Quantity: 1

    • Price: 1

    • Freight: Accept the default value

    • FOB: Accept the default value

    • Promised Date: Enter a desired date

    • Need By Date: Enter a desired date

    Entering a Purchase Order Line Item Information in the Purchasing Orders Form

    the picture is described in the document text

  4. Click Save.

    Purchase order is created with "Incomplete" status.

  5. Click Approve.

    The Approve Document form appears.

  6. In the Approval Details tab, select the "Submit for Approval" check box and ensure that the XML button is selected in the Transmission Method region.

    Approving a Purchase Order with Approval Details

    the picture is described in the document text

    Click OK. The order status is now updated from "Incomplete" to "Approved".

    This status change will internally trigger the XML Gateway engine for outbound transactions. Additionally, it will trigger the "PROCESS PO" integration you created in Oracle Integration Cloud Service.

Monitoring the Result in Oracle Integration Cloud Service

  1. Log in to Oracle Integration Cloud Service.

    On the Integration Cloud Service toolbar, click Monitoring.

  2. In the navigator, click Integrations.

    Click the instance created for the "PROCESS PO" integration to monitor the result.