Oracle E-Business Suite Adapter Samples

Overview

This chapter incudes examples of using the Oracle E-Business Suite Adapter in an integration in Oracle Integration Cloud.

  1. An Example of Using a Business Event as a Trigger (Source) in an Integration

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

  3. An Example of Using a PL/SQL REST Service as an Invoke (Target) Connection in an Integration

  4. An Example of Using an Open Interface REST Service as an Invoke (Target) Connection in an Integration

An Example of Using a Business Event as a Trigger (Source) in an Integration

Sample Business Scenario

A business event "Event for OIP status update notification" (oracle.apps.ont.oip.statuschange.update) is used in this example to explain using the Oracle E-Business Suite Adapter to trigger an integration in Oracle Integration Cloud.

In this example, when a sales order is booked as part of the business flow, Oracle Order Management raises the event oracle.apps.ont.oip.statuschange.update, and a draft invoice is created in Oracle Accounts Receivables.

At the design time, you need to create an integration called "Order to Invoice" with Oracle E-Business Suite Order Management as a trigger (source) connected through the Oracle E-Business Suite Adapter and Oracle E-Business Suite Accounts Receivables as an invoke (target) connected through a generic REST Adapter. The "Order to Invoice" integration will subscribe to this business event.

During the runtime, when the status of the sales order is changed in the order header, the business event oracle.apps.ont.oip.statuschange.update is raised in Oracle E-Business Suite Order Management which triggers the integration. If the status of the sales order is "Booked", the order details information is fetched from Oracle E-Business Suite Order Management. The Oracle E-Business Suite Adapter prepares and propagates the order details as event payload from Order Management to invoke the integration endpoint in Oracle Integration Cloud. As a result, the draft invoice is created in Oracle Accounts Receivables.

Assumption

Use Business Events for Integrations in Oracle Integration Cloud

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

  1. Prepare the Oracle E-Business Suite Instances

  2. Establish Oracle E-Businss Suite Connections

  3. Create an Integration

  4. Add the Oracle E-Business Suite Adapter (Trigger) and the REST Adapter (Invoke) to the Integration

  5. Create Mappings

  6. Assign Business Identifier for Tracking

  7. Activate and Test the Integration

Prepare the Oracle E-Business Suite Instances

Before adding Oracle E-Business Suite connections, you must prepare the following Oracle E-Business Suite instances to ensure the required setup or configuration is in place.

Prepare the Order Management Instance

Perform the following tasks to ensure the required setup and configuration for Oracle E-Business Suite Order Management is ready for integrations in Oracle Integration Cloud:

  1. Ensure that you perform the required setup tasks to enable the Oracle E-Business Suite Adapter.

    These tasks include configuring Oracle E-Business Suite REST services, configuring the access to these services, deploying required REST services in Oracle E-Business Suite, and granting the user privileges to these services.

    Specifically, ensure that you deploy the following REST services and have grants for the operations user:

    • Metadata Provider REST service

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

      • Deploy the Metadata Provider API with GET HTTP method for all the methods contained in the API

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

    • Event Manager REST service

      • Deploy the Event Manager API with "subscription" as the service alias name

      • Deploy the Event Manager API with POST HTTP method for all the methods contained in the API

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

    For detailed instructions on these tasks, see: Setup Tasks for Enabling the Oracle E-Business Suite Adapter.

  2. Ensure that you perform the required setup tasks to enable the inbound (trigger or source) integrations.

    These tasks include storing the Oracle Integration Cloud user credentials in Oracle E-Business Suite FND vault, setting up proxy URLs in Oracle E-Business Suite, and importing TLS certificates to Oracle E-Business Suite. For detailed instructions, see: Setup Tasks for Using the Oracle E-Business Suite Adapter as a Trigger (Source) Connection.

  3. Deploy the Order Management API, OE_ORDER_PUB (Process Order), as a REST service and grant the method access privileges to the operations user.

    In this example, only grant the "Get Order" method contained in the API to the operations user.

  4. Ensure that the profile option "OM: Raise Status Change Business Event" is set to Yes.

Prepare the Oracle Accounts Receivables Instance

Perform the following tasks to ensure the required setup and configuration for Oracle E-Business Suite Accounts Receivables is ready to use in an integration in Oracle Integration Cloud:

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

    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. Deploy the Invoice Creation API as a REST service with the following requirements and grant the desired method access privilege to the operations user:

    • Deploy the Invoice Creation API with "invoice" as the service alias name

    • Deploy the Invoice Creation API with POST HTTP method only for the "Create Single Invoice" method contained in the API

      Note: PL/SQL APIs can be exposed as REST services only with POST HTTP method.

    • Grant the access privilege only for the Create Single Invoice method contained in the 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.

Establish Oracle E-Business Suite Connections

Before creating an integration, you need to establish the following connections that will be used later in this example:

Create the Connection for Oracle E-Business Suite Order Management

This section describes how to create a connection for the Oracle E-Business Suite Order Management instance by using the Oracle E-Business Suite Adapter. This connection will be added later as a trigger (source) in an integration.

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

  1. Log in to the Oracle Integration Cloud home page, select the Designer option from the navigation pane, and then Connections.

  2. On the Connections page, click Create.

  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.

    For example, enter "Oracle E-Business Suite" in the Search field. The Oracle E-Business Suite Adapter is filtered from the list of adapters.

    Click the Select button for "Oracle E-Business Suite" to use the Oracle E-Business Suite Adapter. The Create New Connection dialog appears.

  4. Enter the following information for the Oracle E-Business Suite Order Management connection:

    • Connection Name: Enter "Order Management".

    • Identifier: Accept the default populated identifier such as, ORDER_MANAGEMENT".

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

    • Description: Enter "Create an Oracle E-Business Suite Order Management connection" as the description.

    Click Create to create the connection.

  5. The Connection Details page is displayed for the "Order Management" connection you just created. 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 Order Management instance.

      Click OK to save your work.

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

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

      Click OK to save your work.

    After you specify the required connection information, the "Order Management" connection detail page appears.

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

  7. Click Save to save your connection.

    Click Exit Connection.

Oracle E-Business Suite connection "Order Management" appears in the Connections page.

Create the Connection for Oracle E-Business Suite Accounts Receivables

As described earlier that Oracle E-Business Suite Order Management and Accounts Receivables are two different instances used in this example, you need to create a connection for the Oracle Accounts Receivables instance by using the REST Adapter. This connection will be added later as an invoke (target) to an integration.

  1. Log in to the Oracle Integration Cloud home page, select the Designer option from the navigation pane, and then Connections.

  2. On the Connections page, click Create.

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

    Enter "REST" in the Search field. The REST Adapter is filtered from the list of adapters.

    Create Connection - Select Adapter Dialog

    the picture is described in the document text

    Click the Select button for "REST" to use the REST Adapter. The Create New Connection dialog appears.

  4. Enter the following information for the Oracle E-Business Suite Accounts Receivables connection:

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

    • Identifier: Accept the default populated identifier such as "RECEIVABLES".

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

    • Description: Enter "Create a connection for Oracle E-Business Suite Receivables" as the description.

    Click Create to create the connection.

  5. The Connection Details page is displayed for the "Receivables" connection you just created. 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.

    • Click Configure Connectivity to open the Connection Properties dialog. Enter the following information:

      • Connection Type: Select "REST API Base URL".

      • Connection URL: Enter a connection URL (http://<ebs host name>:<port>/webservices/rest/invoice) for the Invoice Creation REST service with invoice alias name that you deployed earlier while preparing the Receivables instance.

        Click OK to save your work.

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

        Accept the "Basic Authentication" as the default security policy.

        Enter operations as the username and its associated password in the Credentials dialog to access the Invoice Creation REST service you specified earlier in the Connection Properties dialog.

        Credentials Dialog

        the picture is described in the document text

        Click OK to save your work.

  6. Click Test to test the connection you just specified for Oracle E-Business Suite Accounts Receivables.

  7. Click Save to save your connection.

    Click Exit Connection

Oracle E-Business Suite connection "Receivables" now appears in the Connections page.

Create an Integration

Based on the business scenario described earlier, you need to create an integration called "Order to Invoice" with the Orchestration pattern. This pattern allows you to orchestrate trigger, invoke, and switch activities if required into a process diagram in an integration. You can also add mappings on switch branches later if needed.

This section describes how to create an integration with the Orchestration pattern. Information on adding each activity in the diagram is explained later in this chapter.

Perform the following steps to create an integration:

  1. Log in to the Oracle Integration Cloud home page, select the Designer option from the navigation pane, and then Integrations.

  2. On the Integrations page, click Create.

    The Create Integration - Select a Style dialog appears.

    Depending on your integration requirements, when adding the Oracle E-Business Suite Adapter as a trigger (source) connection, you can use it with "App Driven Orchestration", "Basic Routing", and "Publish To OIC" patterns.

    In this example, click Select for the "App Driven Orchestration" integration pattern.

    Create Integration - Select a Style Dialog with "App Driven Orchestration" Pattern Selected

    the picture is described in the document text

  3. The Create New Integration dialog appears. Enter the following information:

    • What do you want to call your integration? Enter a meaningful name for your integration, such as "Order to Invoice".

    • Identifier: Accept the default identifier value "ORDER_TO_INVOICE".

    • Version: Accept the default version number.

    • What does this integration do? Enter "Create an integration for order to invoice" as the description for this integration.

    • Which package does this integration belong to? Leave it blank.

  4. Click Create and Save.

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

Add the Oracle E-Business Suite Adapter (Trigger) and the REST Adapter (Invoke) to the Integration

In this example, the orchestration flow diagram created for this integration includes the following activities:

Add the Oracle E-Business Suite Adapter as a Trigger with a Business Event

Perform the following steps to add the first activity called "Order_Status_Update" for the Oracle E-Business Suite Order Management connection:

  1. In the "Order to Invoice" integration page, drag and drop the Oracle E-Business Suite connection called "Order Management" from the Triggers section in the upper right corner to the large + section within the circle in the integration canvas.

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

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

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

    • What does this endpoint do? - Enter the description of this integration endpoint.

    • What do you want to configure the endpoint for? - Select Business Event.

    Configure Oracle E-Business Suite Adapter Endpoint - Basic Information Page

    the picture is described in the document text

    Click Next to proceed with the rest of the configuration.

  3. In the Business Events page, specify the following information for your connection:

    • Product Family: Select "Order Management Suite" from the drop-down list.

    • Product: Select "Order Management" from the drop-down list.

    • Business Event: Select "Event for OIP status update notification" from the populated list.

      After you select an event name, the corresponding event information, including internal name (oracle.apps.ont.oip.statuschange.update), event status "Enabled", and description, is automatically populated in this page.

    Configure Oracle E-Business Suite Adapter Endpoint - Business Event Page

    the picture is described in the document text

    Click Next.

  4. The Summary page appears with the selected event information.

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

    Click Done.

    The "Order_Status_Update" endpoint now appears as a trigger in the integration flow.

    The Order_Status_Update Activity in the Process Flow

    the picture is described in the document text

Add a Switch with Two Branch Rules

Perform the following steps to add a Switch:

  1. Drag and drop the "Switch" action from the Actions section on the right to the integration right after the Order_Status_Update activity.

    This action adds two rules allowing you to define routing expression branches for your integration.

    Integration Flow Diagram with Two Branches

    the picture is described in the document text

  2. Click edit on the first rule. The Condition Builder page appears.

  3. In the Condition Builder, enter the following information to create the condition: All of Name = 'STATUS_CODE' and Value = 'BOOKED':

    • Enter "Booked Order" as the Expression Name.

    • In Source section, expand the BusinessEvent_Input node, then the InputParameters node, then the BusinessEvent node, then the ParameterList node, and then the Parameter node.

      1. Drag and drop the Name element to the right top under the New Condition section.

        • Select = from the drop-down list.

        • Enter 'STATUS_CODE' in the text box as the condition value.

        Click the Add Condition (+) icon.

      2. Drag and drop the Value element to the right top under the New Condition section.

        • Select = from the drop-down list.

        • Enter 'BOOKED' in the text box as the condition value.

        Click the Add Condition (+) icon.

    • In the Match field, select "All of" from the list.

    Condition Builder Dialog

    the picture is described in the document text

    Save your work. Click Close to return to the integration.

Add the Oracle E-Business Suite Adapter as an Invoke for the "Get_Order" Activity

Perform the following steps to add the Oracle E-Business Suite Adapter as an invoke connection:

  1. Drag and drop the Oracle E-Business Suite connection "Order Management" from the Invokes section on the right to the integration right after the Booked Order rule.

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

  2. In the Basic Info page, enter the following information:

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

    • What does this endpoint do? - Enter the description of this integration endpoint, such as "Get an order in Oracle E-Business Suite".

    Click Next.

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

    • Product Family: Select "Order Management Suite" from the drop-down list.

    • Product: Select "Order Management".

    • Interface Type: Select "PL/SQL".

    • API: Select "Process Order API" from the populated list for this example.

      The corresponding API internal name (OE_ORDER_PUB) and description are automatically populated.

    Click Next.

  4. In the Operations page, select a desired method name contained in the selected API (OE_ORDER_PUB). For example, select "GET_ORDER". The corresponding service status value "Ready to Use" is displayed in this page, along with the description information.

    Note: The Service Status of the selected method GET_ORDER should be "Ready to Use".

    Configure Oracle E-Business Suite Adapter Endpoint - Operations Page

    the picture is described in the document text

    Click Next.

  5. The Summary page displays the selected API information. This includes the selected product family name (Order Management Suite), product name (Order Management), web service name (OE_ORDER_PUB), integration pattern (Synchronous), operation name (GET_ORDER), and the operation status (Ready to Use).

    Configure Oracle E-Business Suite Adapter Endpoint - Summary Page

    the picture is described in the document text

    Click Done.

    The "Get_Order" activity for Order Management now appears as part of the integration flow, along with the "Get_Order" map icon where you can define the mapping later. See: Create Mappings.

Add the REST Adapter as an Invoke for the "Receivables" Activity

Perform the following steps to add the REST Adapter as an invoke connection:

  1. Drag and drop the Oracle E-Business Suite connection "Receivables" from the INVOKES toolbar on the left to the integration, after the Get_Order activity in the Booked Order route.

    The Configure Oracle REST Endpoint wizard appears. Enter the following information in the Basic Info page:

    • What do you want to call your endpoint? - Enter the name of this endpoint, such as "Create_Invoice".

    • What does this endpoint do? - Enter the usage of this endpoint, such as "Provide REST endpoint with input payload for invoice creation".

    • What is the endpoint's relative resource URI? - Enter "/create_single_invoice/".

    • What action does the endpoint perform? - Select "POST" from the drop-down list.

    • Configure a request payload for this endpoint - Select this check box indicating that a request payload is required in this activity.

    Configure Oracle REST Endpoint - Basic Info Page

    the picture is described in the document text

    Click Next.

  2. In the Request page, perform the following tasks:

    • In the "Select the request payload file" section, select the XML schema radio button.

      Please note that the request payload file type can be either XML schema or JSON format.

    • Browse and select the sample XSD for the Create Invoice REST service.

      For the sample XSD information, see Sample XSD for the Oracle E-Business Suite Adapter as a Trigger with a Business Event Example.

    • In the Element field, select "CREATE_SINGLE_INVOICE_Input" from the drop-down list.

    • In the "Select the type of payload with which you want the endpoint to receive" section, select the XML button as the payload type.

    Configure Oracle REST Endpoint - Request Page

    the picture is described in the document text

    In this example, we do not need to configure this endpoint to receive Response.

  3. Click Next. This displays the Summary page with the following REST service information that you specified earlier:

    • REST Service URL: http://<host name>:<port>/webservices/rest/invoice/create_single_invoice/.

    • Method: POST

    • Request Media Type: application/xml

    Click Done.

    The Create_Invoice activity appears in the integration flow, listed as the last activity in the Booked Order rule.

    Similar to the "Get_Order" activity, the "Create_Invoice" map icon also appears (along with the Create_Invoice activity) where you can define the mapping later. See: Create Mappings

    Save the integration.

At the end of this step, the integration flow contains the activities added in this section.

The "Order to Invoice" Integration Flow Diagram

the picture is described in the document text

Create Mappings

Oracle E-Business Suite Business Event is defined by the WF_EVENT_T data structure. After adding the required connections to the integration, you need to create the following mappings to pass the required parameter values to the subsequent REST services:

Create Mappings for the Get_Order Map

In this example, a sales order Header Id is available as one of the business event parameters. In WF_EVENT_T, event parameters are available as Name-Value pair in repeating Parameter element. To obtain the value of the Header Id parameter and pass it to the subsequent Get_Order service call, you need to create mappings for Get_Order.

  1. In the Order_Status_Update integration flow, click edit for the Map to Get_Order icon.

    Integration Flow Diagram with Get_Order Map Selected

    the picture is described in the document text

    The mapper is displayed.

  2. In the mapper, the business event related elements are displayed in the Source section, whereas the Get_Order related parameters are listed in the Target area. To obtain the value of the sales order Header Id (P_HEADER_ID) included as part of the event parameters and pass it to the subsequent Get_Order REST service, you need to define the XSL expression for the P_HEADER_ID parameter.

  3. Define the XSL expression for the P_HEADER_ID parameter by performing the following tasks:

    1. In the Target section, expand the GET_ORDER_Input node, and then the InputParameters node. Click the P_HEADER_ID element to open the Build Mappings page.

    2. In the Mapping area of the Build Mappings page, notice that the P_HEADER_ID element is displayed as the Target element.

    3. In Source section of the Build Mappings page, expand the BusinessEvent_Input node, then the InputParameters node, then the BusinessEvent node, then the ParameterList node, and then the Parameter node.

    4. Drag and drop the Value element from the Source section to the Mapping section as the value for the P_HEADER_ID element.

    5. Similarly, drag and drop the XSL element "if" and the Name element from the Source section to the Mapping section to define the XSL expression <xsl:if test="nssrcmpr:Name='HEADER_ID'">.

    6. Drag and drop the XSL element "for-each" from the Source section to the Mapping section to define the XSL expression <xsl:for-each select="/nssrcmpr:BusinessEvent_Input/nssrcmpr:InputParameters/nssrcmpr:BusinessEvent/nssrcmpr:ParameterList/nssrcmpr:Parameter">.

      Mappings for the P_HEADER_ID Parameter

      the picture is described in the document text

    7. Save your work.

      Expand the nodes to ensure that the P_HEADER_ID parameter is included as part of the structure.

  4. Perform the following tasks to assign constant values to the target elements:

    1. In the Target section, expand the GET_ORDER_Input node, and then the RESTHeader node.

      Click the Responsibility element to open the Build Mappings page.

    2. Enter "ORDER_MGMT_SUPER_USER" in the text box as the value for the Responsibility element.

    Similarly, use the same approach to assign appropriate values to the target elements listed in the following table:

    Path Element Value
    GET_ORDER_Input/RESTHeader RespApplication ONT
    GET_ORDER_Input/RESTHeader SecurityGroup STANDARD
    GET_ORDER_Input/RESTHeader NLSLanguage AMERICAN
    GET_ORDER_Input/RESTHeader Org_Id 204
    GET_ORDER_Input/InputParameters P_API_VERSION_NUMBER 1.0
    GET_ORDER_Input/InputParameters P_INIT_MSG_LIST F
    GET_ORDER_Input/InputParameters P_ORG_ID 204

    After you complete the mappings for Get_Order, the mapped source values should appear in the Mapping column of the Target section.

    Mappings for the Get_Order Activity

    the picture is described in the document text

  5. Click Save to save your work.

Create Mappings for Create_Invoice

Perform the following steps to create the mappings:

  1. In the Order_Status_Update integration flow, click edit for the Map to Create_Invoice icon.

    The mapper appears.

  2. Assign constant values to the target elements.

    1. In the Target section, expand the execute node, then the CREATE_SINGLE_INVOICE_Input node, and then the RESTHeader node.

      Click the Responsibility element to open the Build Mappings page.

    2. Enter "RECEIVABLES_VISION_OPERATIONS" in the text box as the value for the Responsibility element.

    Similarly, use the same approach to assign appropriate values to the target elements listed in the following table:

    Path Element Value
    CREATE_SINGLE_INVOICE_Input/RESTHeader RespApplication AR
    CREATE_SINGLE_INVOICE_Input/RESTHeader SecurityGroup STANDARD
    CREATE_SINGLE_INVOICE_Input/RESTHeader NLSLanguage AMERICAN
    CREATE_SINGLE_INVOICE_Input/RESTHeader Org_Id 204
    CREATE_SINGLE_INVOICE_Input/InputParameters P_API_VERSION 1.0
    CREATE_SINGLE_INVOICE_Input/InputParameters P_INIT_MSG_LIST T
    CREATE_SINGLE_INVOICE_Input/InputParameters P_COMMIT T
    CREATE_SINGLE_INVOICE_Input/InputParameters/P_BATCH_SOURCE_REC BATCH_SOURCE_ID 1188
    CREATE_SINGLE_INVOICE_Input/InputParameters/P_TRX_HEADER_TBL/P_TRX_HEADER_TBL_ITEM TRX_HEADER_ID 101
    CREATE_SINGLE_INVOICE_Input/InputParameters/P_TRX_HEADER_TBL/P_TRX_HEADER_TBL_ITEM CUST_TRX_TYPE_ID 1684
    CREATE_SINGLE_INVOICE_Input/InputParameters/P_TRX_HEADER_TBL/P_TRX_HEADER_TBL_ITEM BILL_TO_CUSTOMER_ID 1290
    CREATE_SINGLE_INVOICE_Input/InputParameters/P_TRX_HEADER_TBL/P_TRX_HEADER_TBL_ITEM SHIP_TO_CUSTOMER_ID 1290
    CREATE_SINGLE_INVOICE_Input/InputParameters/P_TRX_HEADER_TBL/P_TRX_HEADER_TBL_ITEM COMMENTS Invoice created via ICS integration for booked Sales Order in Order Management

    After you complete this step, the mapped source values should appear in the Mapping column of the Target section.

    Mappings with Constant Values

    the picture is described in the document text

  3. Add the following mapping for the header:

    • In the Source section, enter "HEADER_ID" in the Search field to locate this parameter.

      Select the HEADER_ID element from the X_HEADER_REC node.

    • In the Target section, expand the execute node, then the CREATE_SINGLE_INVOICE_Input node, then the InputParameters node, then the P_TRX_HEADER_TBL node, and then the P_TRX_HEADER_TBL_ITEM node.

      Select the TRX_NUMBER element.

    Drag the HEADER_ID element from the Source section to the TRX_NUMBER element in the Target section to map the data.

    After the mapping, the source element HEADER_ID should appear in the Mapping column next to the TRX_NUMBER element in the Target section.

    Mapping the Source HEADER_ID to the Target TRX_NUMBER

    the picture is described in the document text

  4. Use the same approach, as described in the previous step, to add the following sets of mappings for the line items:

    Source Path Source Element Target Path Target Element
    BusinessEvent_Input/InputParameters/BusinessEvent/X_LINE_TBL/X_LINE_TBL_ITEM LINE_NUMBER execute/CREATE_SINGLE_INVOICE_Input/InputParameters/P_TRX_LINES_TBL/P_TRX_LINES_TBL_ITEM LINE_NUMBER
    BusinessEvent_Input/InputParameters/BusinessEvent/X_LINE_TBL/X_LINE_TBL_ITEM ORDERED_ITEM execute/CREATE_SINGLE_INVOICE_Input/InputParameters/P_TRX_LINES_TBL/P_TRX_LINES_TBL_ITEM DESCRIPTION
    BusinessEvent_Input/InputParameters/BusinessEvent/X_LINE_TBL/X_LINE_TBL_ITEM ORDERED_QUANTITY execute/CREATE_SINGLE_INVOICE_Input/InputParameters/P_TRX_LINES_TBL/P_TRX_LINES_TBL_ITEM QUANTITY_ORDERED
    BusinessEvent_Input/InputParameters/BusinessEvent/X_LINE_TBL/X_LINE_TBL_ITEM ORDERED_QUANTITY execute/CREATE_SINGLE_INVOICE_Input/InputParameters/P_TRX_LINES_TBL/P_TRX_LINES_TBL_ITEM QUANTITY_INVOICED
    BusinessEvent_Input/InputParameters/BusinessEvent/X_LINE_TBL/X_LINE_TBL_ITEM UNIT_SELLING_PRICE execute/CREATE_SINGLE_INVOICE_Input/InputParameters/P_TRX_LINES_TBL/P_TRX_LINES_TBL_ITEM UNIT_SELLING_PRICE

    Once you complete this step, the mapped source values should appear next to the corresponding target elements with the green check mark icons:

    Mappings for the Line Items

    the picture is described in the document text

  5. Assign the following values:

    • In the Target section, expand the execute node, then the CREATE_SINGLE_INVOICE_Input node, then the InputParameters node, and then the P_TRX_DIST_TBL node.

      Click the P_TRX_DIST_TBL_ITEM element to open the Build Mappings page.

      In the Mapping section, enter the following information:

      <nsmpr1:P_TRX_DIST_ID/>.

    • In the Target section, expand the execute node, then the CREATE_SINGLE_INVOICE_Input node, then the InputParameters node, and then the P_TRX_SALESCREDITS_TBL node.

      Click the P_TRX_SALESCREDITS_TBL_ITEM element to open the Build Mappings page.

      In the Mapping area, enter the following information:

      <nsmpr1:P_TRX_SALESCREDITS_ID/>.

    The newly assigned mapping values should appear next to the corresponding elements in the Target section.

    Target Section with Mapped Values

    the picture is described in the document text

    Save your work.

  6. Click Exit Mapper.

  7. Save the integration.

Assign 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 BusinessEvent_Input node, then the InputParameters node, and then the BusinessEvent node.

    Drag and drop the Event Key element to the Tracking Field column in the table as the primary Tracking field.

  3. Click Done.

  4. Save your work and then click Exit Integration.

Activate and Test the Integration

Perform the following steps to activate the integration:

  1. On the Integrations page, click the switch icon for the "Order to Invoice" integration that you created earlier to activate the integration.

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

    The status of the "Order to Invoice" integration is now changed to ACTIVE with a green check mark icon.

Test the Integration at Runtime

  1. Log in to Oracle E-Business Suite as the operations user who has the Order Management Super User, Vision Operations (USA) responsibility.

  2. Select Order, Returns and then Sales Order from the navigation menu to open the Sales Orders form.

  3. In the Sales Orders form, select the Order Information tab.

  4. Create a new Sales Order for customer "A.C. Networks" with the following information:

    • Customer: A.C. Networks

    • Operation Unit: Vision Operations

    • Order Type: Mixed

    • Ship To Location: Provo (OPS) 3405 East Bay Blvd. Provo, UT 84606, US

    • Bill To Location: Provo (OPS) 3405 East Bay Blvd. Provo, UT 84606, US

    • Price List: Corporate

    • Currency: USD

    Sales Orders Form

    the picture is described in the document text

  5. Select the Line Items tab to add the following line item:

    • Ordered Item: AS54888

    • Quantity: 1

    • Item Type: STANDARD

    • UOM: Each

    • Unit Price: Accept the populated unit price.

    • Request Date: Accept the populated date (such as 14-MAY-2016)

    Sales Order Form: Line Items

    the picture is described in the document text

  6. Save this new order.

    This order is created with "Entered" status.

  7. Click Book Order.

    The order status is now updated to "Booked". It internally raises a business event oracle.apps.ont.oip.statuschange.update which will trigger the integration.

In the design time, the "Order to Invoice" integration created earlier in Oracle Integration Cloud will subscribe to this business event. At runtime, since the order status is changed to "Booked", Oracle Order Management will raise the business event which triggers the integration in Oracle Integration Cloud. The order details information is fetched from Oracle E-Business Suite Order Management and passed as event payload to create the invoice in Oracle Accounts Receivables.

Monitor the Result in Oracle Integration Cloud

  1. Log in to Oracle Integration Cloud home page, click Monitoring.

  2. In the navigation pane, click Tracking.

    The Tracking page appears.

  3. Click the instance created for the "Order to Invoice" integration.

  4. Click "Event Key" to display the flow diagram of the integration instance.

    This page provides the instance tracking information. Notice that the status of this instance is "Completed" indicating that the integration is executed successfully. You can verify if there is any error occurred if desired.

Validate the Result in Oracle E-Business Suite Accounts Receivables

Log in to Oracle Accounts Receivables as the operations user who has the Receivables, Vision Operations (USA) responsibility. Select Transactions and then Transactions from the navigation menu.

Locate the invoice transaction for the "A.C. Networks" customer by selecting Query for Transaction. The invoice should be created in Oracle Accounts Receivables.

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

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.

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. 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.

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.

Use XML Gateway Messages for Integrations in Oracle Integration Cloud

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

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

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

  3. Create an Integration

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

  5. Assign Business Identifier for Tracking

  6. Activate the Integration

  7. Configure Trading Partner Information for Post Integration

  8. Test and Validate the Integration

Prepare the Oracle E-Business Suite 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 TLS certificates of Oracle Integration Cloud to Oracle E-Business Suite if required.

    For information on importing TLS 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.

Establish 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:

  1. Log in to the Oracle Integration Cloud home page, select the Designer option from the navigation pane, and then Connections.

  2. On the Connections page, click Create.

  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 Create New Connection dialog appears.

  4. Enter the following information for your connection:

    • 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 the "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.

Create an Integration

This section provides the instructions on creating an integration called "PROCESS PO" with the "Publish To OIC" 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. Log in to the Oracle Integration Cloud home page, select the Designer option from the navigation pane, and then Integrations.

  2. On the Integrations page, click Create.

    The Create Integration - Select a Style dialog appears.

    Depending on your integration requirements, when adding the Oracle E-Business Suite Adapter as a trigger (source) connection, you can use it with "App Driven Orchestration", "Basic Routing", and "Publish To OIC" patterns.

    In this example, click Select for the "Publish To OIC" integration pattern.

    Create Integration - Select a Style Dialog with "Publish To OIC" Pattern Selected

    the picture is described in the document text

  3. The Create New Integration 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".

  4. Click Create and Save.

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

Add 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.

    Configure Oracle E-Business Suite Adapter Endpoint - Basic Info Page

    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.

    Configure Oracle E-Business Suite Adapter Endpoint - XML Gateway Message Page

    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.

    Configure Oracle E-Business Suite Adapter Endpoint - 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.

Assign 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.

    Business Identifiers For Tracking Dialog

    the picture is described in the document text

  3. Click Done.

  4. Save your work and then click Exit Integration.

Activate the Integration

Activate the Integration

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

  1. On the Integrations page, click the switch icon for the "PROCESS PO" integration that you created earlier to activate the integration.

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

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

Record the Integration Endpoint in Oracle Integration Cloud

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://<IC Host>:<Port>/ic/api/integration/v1/flows/ebusiness/PROCESS_PO/1.0/metadata

This recorded integration endpoint URL (without the metadata at the end) will be used as the protocol address value when defining a trading partner in the post integration configuration, as described in Configure Trading Partner Information for Post Integration.

Configure 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://<OIC Host>:<Port>/ic/api/integration/v1/flows/ebusiness/PROCESS_PO/1.0/metadata.

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://<OIC Host>:<Port>/ic/api/integration/v1/flows/ebusiness/PROCESS_PO/1.0/

      Enter the integration endpoint URL (without metadata at the end) you recorded earlier.

    • Username: <OIC Username>

      Enter the Oracle Integration Cloud user credentials used to execute integrations in Oracle Integration Cloud.

    • Password: OIC_password

      Replace OIC_password with the actual password value of the associated OIC username.

    Trading Partner Setup Form

    the picture is described in the document text

  5. Save your work.

Test and Validate 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. 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

    Purchase Orders Form: Lines Tab

    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.

    Approve Document Form

    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.

Monitor the Result in Oracle Integration Cloud

  1. Log in to Oracle Integration Cloud.

    In the Oracle Integration Cloud home page, select the Monitoring option from the navigation pane, and then Integrations.

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

An Example of Using a PL/SQL REST Service as an Invoke (Target) Connection in an Integration

To better understand how to use Oracle E-Business Suite services in Oracle Integration Cloud, this chapter describes an integration example through the use of Oracle E-Business Suite Adapter as an invoke (target) connection.

Sample Business Scenario

Take a PL/SQL API called Sales Order Services (OE_INBOUND_INT) as an example to explain the integration between the Oracle E-Business Suite Adapter and a trigger (source) connection in Oracle Integration Cloud.

In this example, the Oracle E-Business Suite Adapter is used as an invoke (target) connection for service invocation, and the REST Adapter is used as a trigger (source) connection to provide a REST request. When the Oracle E-Business Suite Adapter receives the request message with input payload for order creation from the trigger (source) connection, the OE_INBOUND_INT REST service in Oracle E-Business Suite is invoked to create the order.

Note: Any application adapters can be used as trigger (source) connections to create integrations for your business needs. In this example, the REST Adapter is used as a trigger (source) connection.

Once the integration is successfully executed at runtime, a sales order will be created in Oracle E-Business Suite.

Use Oracle E-Business Suite REST Services for Integrations in Oracle Integration Cloud

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

  1. Establish the Connections for Oracle E-Business Suite and REST Services

  2. Create an Integration

  3. Add the Oracle E-Business Suite Adapter as an Invoke (Target) Connection

  4. Add the REST Adapter as a Trigger (Source) Connection

  5. Create Mappings

  6. Assign Business Identifier for Tracking

  7. Activate and Test the Integration

Establish the Connections for Oracle E-Business Suite and REST Services

Before creating an integration, you need to create the following two connections:

Create an Oracle E-Businss Suite Connection with Oracle E-Business Suite Adapter

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

  1. Log in to the Oracle Integration Cloud home page, select the Designer option from the navigation pane, and then Connections.

  2. On the Connections page, click Create.

    In the Create Connection - Select Adapter dialog appears. Scroll down and select "Oracle E-Business Suite" from the dialog. You can optionally use the search feature to enter a full or partial name to locate the Oracle E-Business Suite Adapter from the dialog. Click the Select button for "Oracle E-Business Suite" to create a connection through the Oracle E-Business Suite Adapter.

  3. In the Create New Connection dialog, enter the following information for your connection:

    • Connection Name: Enter "EBS1225".

    • Identifier: Accept the default populated identifier, such as "EBS1225".

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

    • Description: Enter "Use the Oracle E-Business Suite Adapter connection in an integration" as the description.

    Click Create to create the connection.

  4. 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-Busiess Suite instance.

    Click OK to save your work.

  5. Click Configure Security to open the Credentials dialog.

    Ensure that the 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 instance you specified earlier in the Connection Properties dialog.

    Click OK to save your work.

  6. Click Configure Agents to display the Select an Agent group dialog. A list of available agent groups is automatically populated for your selection.

    Select a desired agent group, such as "EBS", and click Use to enable the selection.

  7. After you specify the connection information for "EBS1225", the connection details page is displayed.

  8. Click Test to test the connection you just specified for Oracle E-Business Suite.

  9. Click Save to save your connection.

    Click Exit Connection.

The Oracle E-Business Suite connection "EBS1225" now appears in the Connections page.

Create an Connection for REST Services

Perform the following steps to create an connection for REST APIs:

  1. On the Connections page, click Create.

    The Create Connection - Select Adapter dialog appears.

  2. Scroll down and select "REST" from the dialog. You can optionally use the search feature to enter a full or partial name to locate the REST Adapter from the dialog.

    Click the Select button for "REST" to create an connection through the REST Adapter.

  3. The New Connection - Information dialog appears.

    Enter "GenericREST" as the Connection Name. The identifier value, GENERICREST, is automatically populated.

    Select "Trigger and Invoke" as the Connection Role. Enter a meaningful description for this connection, such as "The sample source REST endpoint".

  4. Click Create to create the connection.

  5. Click Configure Connectivity to open the Connection Properties dialog where you select "REST API Base URL" as the Connection Type and enter a connection URL (http://<ebs host name>:<port>/webservices/rest/orderMgmt) to connect to an instance for REST services.

    Click OK to save your work.

  6. Click Configure Security to open the Credentials dialog.

    Enter operations as the username and its associated password in the Credentials dialog to access the instance for REST services you specified earlier in the Connection Properties dialog.

    Credentials Diaglog

    the picture is described in the document text

    Click OK to save your work.

  7. Click Test to test the connection you just specified for REST services.

  8. Click Save to save your connection.

    Click Exit Connection.

The "GenericREST" connection for REST services appears in the Connections page, along with the Oracle E-Business Suite connection "EBS1225" that you created earlier.

Create an Integration

Perform the following steps to create an integration between REST services and Oracle E-Business Suite:

  1. Log in to the Oracle Integration Cloud home page, select the Designer option from the navigation pane, and then Integrations.

  2. On the Integrations page, click Create.

    The Create Integration - Select a Style dialog appears.

    When adding the Oracle E-Business Suite Adapter as an invoke (target) connection, you can use it with "Basic Routing", "App Driven Orchestration" and "Subscribe To OIC" patterns based on your business needs.

    In this example, click Select for the "Basic Routing" integration pattern to create an integration with a blank source and target.

    Note: This "Basic Routing" integration pattern allows you to add a desired adapter as a trigger (source) or an invoke (target) connection in an integration. Therefore, you can also use this pattern when adding the Oracle E-Business Suite Adapter as a trigger (source) connection to trigger an integration.

    Create Integration - Select a Style Dialog with "Basic Routing" Selected

    the picture is described in the document text

  3. The Create New Integration dialog appears. Enter the following information:

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

    • Identifier: Accept the default identifier value such as "CREATE ORDER".

    • Version: Accept the default version number.

    • What does this integration do? Enter description information for your integration, such as "Create a sales order in Oracle E-Business Suite".

  4. Click Create and Save.

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

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

Once the integration is created, add the Oracle E-Business Suite connection "EBS1225" that you created earlier as an invoke (target) connection in your integration.

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

  1. In the Create Order integration page, search the "EBS1225" connection that you created earlier from the Connections panel.

  2. In the Integration Designer, drag EBS1225 from the Connections panel on the right to the Target area on the canvas.

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

  3. In the Basic Info page, enter the following information for your endpoint:

    • What do you want to call your endpoint? - Enter "EBS_Reference".

    • What does this endpoint do? - Enter "Create a Sales Order in Oracle E-Business Suite".

    Configure Oracle E-Business Suite Adapter Endpoint - Basic Info Page

    the picture is described in the document text

    Click Next.

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

    • Product Family: Select "Order Management Suite" from the drop-down list.

    • Product: Select "Order Management".

    • Interface Type: Select "PL/SQL" from the list.

    After you select a desired product family, a product, and an interface type, a list of PL/SQL APIs including Oracle seeded APIs and custom ones contained in the selected product "Order Management" is populated for further selection.

    Configure Oracle E-Business Suite Adapter Endpoint - Web Services Page

    the picture is described in the document text

    Select a desired API name, such as "Sales Order Services". The corresponding API internal name (OE_INBOUND_INT) and description are automatically populated.

    Click Next.

  5. The selected API internal name OE_INBOUND_INT appears in the Operations page.

    Select a desired method name contained in the selected OE_INBOUND_INT API for this invoke (target) connection. For example, select "PROCESS_ORDER".

    Configure Oracle E-Business Suite Adapter Endpoint - Operations Page

    the picture is described in the document text

    Click Next.

  6. The Summary page displays all the selected interface details. This information includes the selected "PROCESS_ORDER" operation (with "Ready to Use" status) contained in the "OE_INBOUND_INT" web service from the Order Management Suite product family and Order Management product. This page also displays the default interaction pattern "Synchronize" and security policy "Username Token" for the selected service.

    Configure Oracle E-Business Suite Adapter Endpoint - Summary Page

    the picture is described in the document text

    The Oracle E-Business Suite Adapter Target Endpoint configuration is successfully created.

    Click Done.

  7. Click Save to save your work.

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

Add the REST Adapter as a Trigger (Source) Connection

After adding the Oracle E-Business Suite invoke (target) connection, you need to add a trigger (source) connection in the integration. The trigger (source) connection can be any application adapters suitable for your integrations. In this example, the REST Adapter is used for the integration.

Perform the following steps to add the REST Adapter as a trigger (source) connection:

  1. In the Create Order integration page, locate the "GenericREST" connection that you created earlier by entering "GenericREST" in the Connections field.

  2. Drag GenericREST from the Connections panel on the right to the Trigger (Source) area on the canvas.

    The Configure Oracle REST Endpoint wizard appears.

  3. Enter the following information:

    • What do you want to call your endpoint? - Enter the name of this endpoint, such as "Source".

    • What does this endpoint do? - Enter the usage of this endpoint, such as "Provide REST endpoint with input payload for sales order creation".

    • What is the endpoint's relative resource URI? - Enter /process_order.

    • What action does the endpoint perform? - Select "POST" from the drop-down list.

    Ensure that you select the following two check boxes for this trigger (source) connection:

    • Configure a request payload for this endpoint

    • Configure this endpoint to receive the response

    Configure Oracle REST Endpoint - Basic Info Page

    the picture is described in the document text

    Click Next.

  4. In the Request page, perform the following tasks:

    • In the "Select the request payload file" section, select the JSON schema button.

      Please note that the request payload file type can be either XML schema or JSON format.

    • Click Browse to select a desired request payload file, such as "request.json". Click Open to attach the selected file.

      For the sample request payload, see Sample JSON Payloads for the Oracle E-Business Suite Adapter as an Invoke Example for a PL/SQL REST Service.

    • In the "Select the type of payload with which you want the endpoint to receive" section, select the JSON button as the payload type.

      Configure Oracle REST Endpoint - Request Page

      the picture is described in the document text

    Click Next.

  5. In the Response page, select the JSON Sample button for this example.

    Similar to the request, the response payload type can be either XML schema or JSON format.

    Click Browse to select a desired request payload file, such as "response.json". Click Open to attach the selected file.

    For the sample response payload, see Sample JSON Payloads for the Oracle E-Business Suite Adapter as an Invoke Example for a PL/SQL REST Service.

    In the "Select the type of payload with which you want the endpoint to reply" section, select the JSON button as the payload type.

    Configure Oracle REST Endpoint - Response Page

    the picture is described in the document text

  6. Click Next.

    This displays the Summary page with the following REST service information that you specified earlier:

    • REST Service URI: /process_order/

    • Method: POST

    • Request Media Type: application/json

    • Response Media Type: application/json

    Click Done.

    Click Save to save your work. The GenericREST connection now appears in the Trigger (Source) area on the canvas, along with the "EBS1225" displayed in the Invoke (Target) area.

Create Mappings

This step is to create mappings between the source and target data structures in the integration. It includes the following three mappings:

Create mappings for the request message:

  1. In the middle of the integration, click the Mapper icon for the request.

    Click Create (the + icon) to display the mapper.

    Icon to Create Mapping for the Request

    the picture is described in the document text

  2. Create the mappings between the source and target elements:

    • In the Source section, expand the execute node, then the request-wrapper node, then the PROCESS_ORDER_Input node, and then the InputParameters node.

      Select the P_API_VERSION_NUMBER element.

    • In the Target section, expand the PROCESS_ORDER_Input node, and then the InputParameters node.

      Select the P_API_VERSION_NUMBER element.

    Drag the P_API_VERSION_NUMBER element from the Source section to the P_API_VERSION_NUMBER element in the Target section to map the data.

    Once you complete this step, the mapped source value and the corresponding target element are connected by a green line.

    Mapper Page with Mapped Source and Target Fields

    the picture is described in the document text

    Similarly, use the same approach to complete the mappings for the elements listed in the following table.

    Source Path Source Element Target Path Target Element
    execute/equest-wrapper/ PROCESS_ORDER_Input/RESTHeader Responsibility PROCESS_ORDER_Input/RESTHeader Responsibility
    execute/equest-wrapper/ PROCESS_ORDER_Input/RESTHeader RespApplication PROCESS_ORDER_Input/RESTHeader RespApplication
    execute/equest-wrapper/ PROCESS_ORDER_Input/RESTHeader SecurityGroup PROCESS_ORDER_Input/RESTSecurityGroupHeader SecurityGroup
    execute/equest-wrapper/ PROCESS_ORDER_Input/RESTHeader NLSLanguage PROCESS_ORDER_Input/RESTHeader NLSLanguage
    execute/equest-wrapper/ PROCESS_ORDER_Input/RESTHeader Org_Id PROCESS_ORDER_Input/RESTHeader Org_Id
    execute/equest-wrapper/ PROCESS_ORDER_Input/InputParameters P_INIT_MSG_LIST PROCESS_ORDER_Input/InputParameters P_INIT_MSG_LIST
    execute/equest-wrapper/ PROCESS_ORDER_Input/InputParameters P_RETURN_VALUES PROCESS_ORDER_Input/InputParameters P_RETURN_VALUES
    execute/equest-wrapper/ PROCESS_ORDER_Input/InputParameters P_ACTION_COMMIT PROCESS_ORDER_Input/InputParameters P_ACTION_COMMIT

    Notice that a green check mark icon appears for the element that has a mapping created. Additionally, the mapped data appears in the Mapping column of the Target section.

  3. Once the mapping is complete, click Save to save your work.

  4. Click Exit Mapper.

Create mappings for the response message:

  1. In the middle of the integration, click the Mapper icon for the response.

    Click Create (the + icon) to display the mapper.

  2. Create mappings to map the source and target elements.

    • In the Source section, expand the PROCESS_ORDERResponse node, and then the OutputParameters node.

      Select the X_RETURN_STATUS element.

    • In the Target section, expand the executeResponse node, then the response-wrapper node, and then the Output Parameters node.

      Select the X_RETURN_STATUS element.

    Drag the X_RETURN_STATUS element from the Source section to the X_RETURN_STATUS element in the Target section to map the data.

  3. Use the same approach to complete the mappings for the elements listed in the following table.

    Source Path Source Element Target Path Target Element
    PROCESS_ORDERResponse/OutputParameters/X_MESSAGES/X_MESSAGES_ITEM MESSAGE_TEXT executeResponse/response-wrapper/OutputParameters/X_MESSAGES/X_MESSAGES_ITEM MESSAGE_TEXT
    PROCESS_ORDERResponse/OutputParameters/X_HEADER_REC ORDER_NUMBER executeResponse/response-wrapper/OutputParameters/X_HEADER_REC ORDER_NUMBER

    Mapper Page with Mapped Source and Target Fields

    the picture is described in the document text

    Click Save to save your work.

  4. Click Exit Mapper.

Create mappings for the fault message:

  1. In the middle of the integration, click the Mapper icon for the fault.

    The Fault Mappings dialog appears.

  2. Under the Route To, select "APIInvocationError" as the fault type.

  3. Under Map, click the Mapper (+) icon to create mapping.

  4. Create the mapping between the source and target elements:

    • In the Source section, expand the fault node.

      Select the errorCode element.

    • In the Target section, expand the APIInvocationError node.

      Select the errorCode element.

    Drag the errorCode element from the Source section to the errorCode element in the Target section to map the data.

  5. Use the same approach to complete the mappings for the elements listed in the following table.

    Source Path Source Element Target Path Target Element
    fault reason APIInvocationError/errorDetails instance
    fault details APIInvocationError/errorDetails errorPath

    Mappings for the Fault

    the picture is described in the document text

  6. Click Save to save your work, and then click Exit Mapper.

The mappings for the request, response, and fault are all created successfully.

Click Save to save your work.

Assign Business Identifier for Tracking

To effectively track payload fields in messages during runtime, you can specify up to three tracking fields to enable runtime tracking on messages.

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

    The Business Identifiers For Tracking dialog appears.

  2. From the Available Source Fields section, drag the payload field that you want to track to the Tracking Field column.

    For example, drag the INVENTORY_ITEM_ID element from the Available Source Fields section to the Tracking Field column in the table.

    Enter "item" as the Tracking Name for the INVENTORY_ITEM_ID element.

    Business Identifiers For Tracking Dialog

    the picture is described in the document text

  3. Click Done.

    Save your work and then click Exit Integration.

Activate and Test the Integration

Activate the Integration

After you complete the integration with desired source and target connections and mappings, you can activate the "Create Order" integration.

Perform the following steps to activate the integration:

  1. On the Integrations page, click the switch icon for the "Create Order" integration that you created earlier to activate the integration.

  2. The Confirmation dialog appears. Click Activate.

    Notice that the status of the "Create Order" integration changes to ACTIVE indicating that the integration is ready to use at runtime.

Test the Integration

To view the activated "Create Order" integration, click the View icon. A pop-up dialog appears with the integration details.

You can copy the Endpoint URL (https://<IC Host>:<Port>/ic/api/integration/v1/flows/ebusiness/CREATE_ORDER/1.0/) and open it in any REST client to invoke the REST service for order creation.

For example, an order number 69359 is created successfully after the service invocation and is shown in the Response tab.

Response Tab with an Order Number

the picture is described in the document text

Verify Order Creation in Oracle E-Business Suite

Log in to Oracle E-Business Suite as a user who has the Order Management Super User, Vision Operations (USA) responsibility.

Select Order Returns and then Sales Order from the navigation menu to open the Sales Orders form.

Search for an order by pressing the F11 key. In the Customer PO field, enter the order ID retrieved from the service invocation. For example, enter 69359 and press the CTRL+F11 keys to execute the query. You should be able to find the order created in Oracle E-Business Suite.

An Example of Using an Open Interface REST Service as an Invoke (Target) Connection in an Integration

Sample Business Scenario

An open interface "AR Autoinvoice" (RAXMTR) is used to explain how to insert invoice data in Oracle E-Business Suite through the invocation of REST services.

In this example, the REST Adapter is used as a trigger (source) connection and the Oracle E-Business Suite Adapter is used as invoke (target) connections to invoke the REST services contained in the RAXMTR open interface.

At runtime when the integration is triggered, the Oracle E-Business Suite Adapter receives a request with input payload from the trigger (source) connection, invokes the RA_INTERFACE_LINES_ALL REST service to insert data, and invokes the SUBMIT_CP_RAXMTR REST service to submit the corresponding concurrent program. Once the integration is executed and completed successfully, invoice line data is inserted into the RA_INTERFACE_LINES_ALL open interface table in Oracle Receivables. Additionally, you will find the log messages as output responses indicating the number of records are inserted into the table and the concurrent request ID. You can then use the request ID to view and verify the report of the RAXMTR concurrent program.

Prerequisites:

Before creating the integration in Oracle Integration Cloud, you need to ensure the following tasks are in place:

Use an Open Interface Table REST Service in an Integration in Oracle Integration Cloud

Based on the integration scenario, this section includes the following tasks:

  1. Establish the Connections for Oracle E-Business Suite and REST Services

  2. Create an Integration with App Driven Orchestration

  3. Add the REST Adapter (Trigger) and the Oracle E-Business Suite Adapter (Invoke) to the Integration

  4. Create Mappings

  5. Assign Business Identifier for Tracking

  6. Activate and Test the Integration

Establish the Connections for Oracle E-Business Suite and REST Services

In this integration example, you need to create the following two connections:

Create an Oracle E-Businss Suite Connection with Oracle E-Business Suite Adapter

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

  1. Log in to the Oracle Integration Cloud home page, select the Designer option from the navigation pane, and then Connections.

  2. On the Connections page, click Create.

    In the Create Connection - Select Adapter dialog appears. Scroll down and select "Oracle E-Business Suite" from the dialog. You can optionally use the search feature to enter a full or partial name to locate the Oracle E-Business Suite Adapter from the dialog. Click the Select button for "Oracle E-Business Suite" to create a connection through the Oracle E-Business Suite Adapter.

  3. In the Create New Connection dialog, enter the following information for your connection:

    • Connection Name: Enter "EBSDemo".

    • Identifier: Accept the default populated identifier, such as "EBSDEMO".

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

    • Description: Enter "Use the Oracle E-Business Suite Adapter connection in an integration" as the description.

    Create New Connection Dialog

    the picture is described in the document text

    Click Create to create the connection.

  4. 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-Busiess Suite instance.

    Click OK to save your work.

  5. Click Configure Security to open the Credentials dialog.

    Ensure that the 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 instance you specified earlier in the Connection Properties dialog.

    Click OK to save your work.

  6. Click Configure Agents to display the Select an Agent group dialog. A list of available agent groups is automatically populated for your selection.

    Select a desired agent group, such as "EBS", and click Use to enable the selection.

  7. After you specify the connection information for "EBSDemo", the connection details page is displayed.

  8. Click Test to test the connection you just specified for Oracle E-Business Suite.

  9. Click Save to save your connection.

    Click Exit Connection.

The Oracle E-Business Suite connection "EBSDemo" now appears in the Connections page.

Create an Connection for REST Services in This Example

Perform the following steps to create an connection for REST APIs:

  1. On the Connections page, click Create.

    The Create Connection - Select Adapter dialog appears.

  2. Scroll down and select "REST" from the dialog. You can optionally use the search feature to enter a full or partial name to locate the REST Adapter from the dialog.

    Click the Select button for "REST" to create an connection through the REST Adapter.

  3. The New Connection - Information dialog appears.

    Enter "RESTSample" as the Connection Name. The identifier value, GENERICREST, is automatically populated.

    Select "Trigger and Invoke" as the Connection Role. Enter a meaningful description for this connection, such as "The sample source REST endpoint".

  4. Click Create to create the connection.

  5. Click Configure Connectivity to open the Connection Properties dialog where you select "REST API Base URL" as the Connection Type and enter a connection URL (http://<ebs host name>:<port>/webservices/rest/autoinvoice/RA_INTERFACE_LINES_ALL/) to connect to an instance for REST services.

    Click OK to save your work.

  6. Click Configure Security to open the Credentials dialog.

    Enter operations as the username and its associated password in the Credentials dialog to access the instance for REST services you specified earlier in the Connection Properties dialog.

    Credentials Diaglog

    the picture is described in the document text

    Click OK to save your work.

  7. Click Test to test the connection you just specified for REST services.

  8. Click Save to save your connection.

    Click Exit Connection.

The "RESTSample" connection for REST services appears in the Connections page, along with the Oracle E-Business Suite connection "EBSDemo" that you created earlier.

Create an Integration with App Driven Orchestration

Perform the following steps to create an integration between REST services and Oracle E-Business Suite:

  1. Log in to the Oracle Integration Cloud home page, select the Designer option from the navigation pane, and then Integrations.

  2. On the Integrations page, click Create.

    The Create Integration - Select a Style dialog appears.

    In this example, click Select for the "App Driven Orchestration" integration pattern to create an integration.

    Create Integration - Select a Style Dialog with "App Driven Orchestration" Selected

    the picture is described in the document text

  3. The Create New Integration dialog appears. Enter the following information:

    • What do you want to call your integration? Enter "EBS OIT Demo" as the name.

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

    • Version: Accept the default version number.

    • What does this integration do? Enter description information for your integration, such as "Inserting records in an Open Interface Table".

  4. Click Create and Save.

    An empty canvas is displayed.

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

Add the REST Adapter (Trigger) and the Oracle E-Business Suite Adapter (Invoke) to the Integration

After creating an integration with "App Driven Orchestration" pattern, you need to orchestrate desired activities for the integration.

In this example, the "EBS OIT Demo" orchestration flow diagram created for this integration includes the following activities:

Add the REST Adapter as a Trigger Connection

The REST Adapter is used in this example to provide invoice information as an input to the RA_INTERFACE_LINES_ALL REST service invocation through the Oracle E-Business Suite Adapter.

Perform the following steps to add the REST Adapter as a trigger (source) connection:

  1. In the "EBS OIT Demo" integration page, drag and drop the REST Adapter connection called "RESTSample" from the Triggers section in the upper right corner to the large + section within the circle in the integration canvas.

    The Configure REST Endpoint wizard appears.

  2. Enter the following information:

    • What do you want to call your endpoint? - Enter the name of this endpoint, such as "REST".

    • What does this endpoint do? - Enter the usage of this endpoint, such as "Provide REST endpoint with input payload".

    • What is the endpoint's relative resource URI? - Enter /RA_INTERFACE_LINES_ALL/.

    • What action does the endpoint perform? - Select "POST" from the drop-down list.

    Ensure that you select the following check box for this trigger (source) connection:

    • Configure a request payload for this endpoint

    Configure REST Endpoint - Basic Info Page

    the picture is described in the document text

    Click Next.

  3. In the Request page, perform the following tasks:

    • In the "Select the request payload file" section, select the XML schema button.

      Please note that the request payload file type can be either XML schema or JSON format.

    • Click Browse to select a desired request payload file, such as "input.xsd". Click Open to attach the selected file. System will parse the schema and display the root element (RA_INTERFACE_LINES_ALL_input) in the Element field.

      For the sample request payload, see Sample XSD for the Oracle E-Business Suite Adapter as an Invoke Example for an Open Interface REST Service.

    • In the "Select the type of payload with which you want the endpoint to receive" section, select the XML button as the payload type.

      Configure REST Endpoint - Request Page

      the picture is described in the document text

    Click Next.

  4. This displays the Summary page with the following REST service information that you specified earlier:

    • REST Service URI: /RA_INTERFACE_LINES_ALL/

    • Method: POST

    • Request Media Type: application/xml

    Click Done.

    Click Save to save your work.

    The "REST" endpoint now appears as a trigger in the integration flow.

Add the Oracle E-Business Suite Adapter as an Invoke Connection for Inserting Records

After adding the REST Adapter as a trigger connection, you can add the Oracle E-Business Suite connection that you created earlier as an invoke (target) connection in your integration. This allows you to invoke an open interface table REST service to insert invoice line data into the open interface table RA_INTERFACE_LINES_ALL in Oracle Receivables.

Perform the following steps to add the Oracle E-Business Suite Adapter in the orchestration flow:

  1. In the "EBS OIT Demo" integration page, drag and drop the "EBSDemo" connection from the Invokes toolbar on the right to the integration, right after the "REST" activity you created earlier.

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

  2. In the Basic Info page, enter the following information for your endpoint:

    • What do you want to call your endpoint? - Enter "RA_Interface_Lines".

    • What does this endpoint do? - Enter "Insert invoice data in Oracle Receivables".

    Click Next.

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

    • Product Family: Select "Financial Receivables Suite" from the drop-down list.

    • Product: Select "Receivables".

    • Interface Type: Select "Open Interface" from the list.

    • API: Select "AR Autoinvoice" for this example.

      The corresponding API internal name (RAXMTR) and description are automatically populated.

    Configure Oracle E-Business Suite Adapter Endpoint - Web Services Page

    the picture is described in the document text

    Click Next.

  4. In the Operations page, select a desired method name contained in the selected API (RAXMTR) for this invoke (target) connection.

    For example, select "RA_INTERFACE_LINES_ALL".

    In the CRUD Operation field, select "Create" from the drop-down list.

    Configure Oracle E-Business Suite Adapter Endpoint - Operations Page

    the picture is described in the document text

    Click Next.

  5. The Summary page displays all the selected interface details. This information includes the selected "RA_INTERFACE_LINES_ALL" operation (with CRUD "Create" operation) contained in the "RAXMTR" web service from the Financial Receivables Suite product family and Receivables product. This page also displays the default interaction pattern "Synchronize" for the selected service.

    Configure Oracle E-Business Suite Adapter Endpoint - Summary Page

    the picture is described in the document text

    The Oracle E-Business Suite Adapter Target Endpoint configuration is successfully created.

    Click Done.

  6. Click Save to save your work.

The connection for Oracle E-Business Suite called "RA_Interface_lines" now appears as part of the orchestration flow.

Add the Oracle E-Business Suite Adapter as an Invoke Connection for Submitting a Concurrent Program

After adding the Oracle E-Business Suite Adapter as an invoke connection (RA_Interface_lines) to invoke the RA_INTERFACE_LINES_ALL REST service, you can add the second invoke connection in the flow to invoke the SUBMIT_CP_RAXMTR REST service to submit the RAXMTR (Autoinvoice Master Program) concurrent program.

Perform the following steps to add the Oracle E-Business Suite Adapter as an invoke (target) connection for concurrent program submission:

  1. In the "EBS OIT Demo" integration page, drag and drop the "EBSDemo" connection from the Invokes toolbar on the right to the integration, right after the "RA_Interface_lines" activity you just created in Step 2.

    Oracle Integration Cloud App Driven Orchestration Flow Page

    the picture is described in the document text

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

  2. In the Basic Info page, enter the following information for your endpoint:

    • What do you want to call your endpoint? - Enter "Submit_RAXMTR".

    • What does this endpoint do? - Enter "Submit the concurrent program for RAXMTR".

    Click Next.

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

    • Product Family: Select "Financial Receivables Suite" from the drop-down list.

    • Product: Select "Receivables".

    • Interface Type: Select "Open Interface" from the list.

    • API: Select "AR Autoinvoice".

      The corresponding API internal name (RAXMTR) and description are automatically populated.

    Click Next.

  4. In the Operations page, select a desired method name contained in the API (RAXMTR) for this invoke (target) connection. In this example, select "SUBMIT_CP_RAXMTR".

    Configure Oracle E-Business Suite Adapter Endpoint - Operations Page

    the picture is described in the document text

    Click Next.

  5. The Summary page displays all the selected interface details. This information includes the selected "SUBMIT_CP_RAXMTR" operation contained in the "RAXMTR" REST service from the Financial Receivables Suite product family and Receivables product. This page also displays the default interaction pattern "Synchronize" for the selected service.

    The Oracle E-Business Suite Adapter Target Endpoint configuration is successfully created.

    Click Done.

  6. Click Save to save your work.

Add the Loggers

After adding both the trigger and invoke connections in the canvas, you can add the logger to log messages. In this example, you need to add the following two loggers in the orchestration flow:

Perform the following steps to add loggers:

  1. Add the First Logger "Interface" for Success Count

    In the "EBS OIT Demo" integration page, from Actions section on right side of canvas, drag and drop the Logger activity to the canvas, right after "RA_Interface_Lines" and before "Submit_RAXMTR".

    The Create Action page appears.

  2. Enter "Interface" as the Name field in the Create Action page.

    Create Action Page

    the picture is described in the document text

    Click Create.

    The logger "Interface" is created successfully.

  3. In the Logger Action page, perform the following tasks:

    Logger Action Page

    the picture is described in the document text

    • In the Log field, select the Always button.

    • In the Logger Message field, click the Pencil icon to provide the logger message in the Log Message page.

      Log Message Page With SuccessCount Expression

      the picture is described in the document text

      Use the String Concat function as Expression to display Success Count.

      In the Source section, expand the RA_INTERFACE_LINES_ALLResponse node, then the OutputParameters node, and then the Summary node.

      Drag and drop the SuccessCount element to the right top under the Expression section. Click Close.

  4. Add the Second Logger "CPSubmitResponse" for Concurrent Program Submit ID

    In the "EBS OIT Demo" integration page, from Actions section on right side of canvas, drag and drop the Logger activity to the canvas, right after "Submit_RAXMTR".

    The Create Action page appears.

  5. Enter "CPSubmitResponse" as the Name field in the Create Action page.

    Click Create.

  6. In the Logger Action page, select the Always button.

    Click the Pencil icon to provide log message in the Log Message page.

    Log Message Page With CP_Submit Expression

    the picture is described in the document text

    Use the String Concat function as Expression to display CP Submit ID.

    In the Source section, expand the Submit_RAXMTR node, then the RAXMTRResponse node, and then the OutputParameters node.

    Drag and drop the CP_Submit element to the right top under the Expression section. Click Close.

Create Mappings

After orchestrated the required activities in this example, you need to create the following mappings to ensure the source and target data between activities can be processed successfully for the integration:

Create Mappings for the RA_Interface_Lines Map

  1. In the "EBS OIT Demo" integration page, click the Edit icon for the Map to RA_Interface_Lines icon.

  2. Perform the following tasks to creating mapping:

    In this example, you need to map all the elements under the RA_INTERFACE_LINES_ALL_Input node from the Source section to the corresponding elements in the RA_INTERFACE_LINES_ALL_Input node under the Target section.

    For example, create the first mapping using the following steps:

    • In the Source section, expand the execute node, then the RA_INTERFACE_LINES_ALL_Input node, and then the RESTHeader node.

      Select the Responsibility element from the RESTHeader node.

    • In the Target section, expand the RA_INTERFACE_LINES_ALL_Input node, and then the RESTHeader node.

      Select the Responsibility element.

    Drag and drop the Responsibility element from the Source section to the Responsibility element in the Target section to map the data.

  3. Use the same mapping mechanism described above to map all the elements under the RA_INTERFACE_LINES_ALL_Input node from the Source section to the corresponding elements in the RA_INTERFACE_LINES_ALL_Input node under the Target section. Specifically, you need to creating mappings for the following elements:

    • All elements under the RESTHeader node from the Source section to the corresponding elements in the Target section

    • The Select element from the Source section to the Select element in the Target section

      Mapping Page for the RESTHeader and Select Elements

      the picture is described in the document text

    • All elements under the InputParameters node from the Source section to the corresponding elements in the InputParameters node in the Target section

      Mappings Page for the InputParameters Elements

      the picture is described in the document text

  4. Save your work.

Create Mappings for the Submit_RAXMTR Map

  1. In the "EBS OIT Demo" integration page, click the Edit icon for the Map to Submit_RAXMTR icon.

  2. In the Mapper page, assign constant values to the target elements.

    1. In the Target section, expand the RA_INTERFACE_LINES_ALL_Input node, and then the RESTHeader node.

      Click the Responsibility element to open the Build Mappings page.

    2. Enter "RECEIVABLES_VISION_OPERATIONS" in the text box as the value for the Responsibility element.

    Similarly, use the same approach to assign appropriate values to the target elements listed in the following table:

    Path Element Value
    RA_INTERFACE_LINES_ALL_Input/RESTHeader RespApplication "AR"
    RA_INTERFACE_LINES_ALL_Input/RESTHeader SecurityGroup "STANDARD"
    RA_INTERFACE_LINES_ALL_Input/RESTHeader NLSLanguage "AMERICAN"
    RA_INTERFACE_LINES_ALL_Input/RESTHeader Org_Id "204"
    RA_INTERFACE_LINES_ALL_Input/InputParameters APPLICATION "AR"
    RA_INTERFACE_LINES_ALL_Input/InputParameters PROGRAM "RAXMTR"
    RA_INTERFACE_LINES_ALL_Input/InputParameters SUB_REQUEST "0"
    RA_INTERFACE_LINES_ALL_Input/InputParameters NumberofInstances "1"
    RA_INTERFACE_LINES_ALL_Input/InputParameters Organization "204"
    RA_INTERFACE_LINES_ALL_Input/InputParameters BatchSourceId "20"
    RA_INTERFACE_LINES_ALL_Input/InputParameters BatchSourceName "PROJECTS INVOICES"
    RA_INTERFACE_LINES_ALL_Input/InputParameters BaseDueDateonTrxDate "Y"

    After you complete this step, the mapped source values should appear in the Mapping column of the Target section.

    Mapping Page for the Submit_RAXMTR Elements

    the picture is described in the document text

  3. Save your work.

Assign Business Identifier for Tracking

Perform the following steps to provide identifiers for tracking during runtime:

  1. In the 'EBS OIT Demo" Integration page, click Tracking.

    The Business Identifiers For Tracking dialog appears.

  2. From the Available Source Fields section, expand the RA_INTERFACE_LINES_ALL_Input node and then the RESTHeader node.

    Drag and drop the Org_Id element to the Tracking Field column in the table as the primary Tracking field.

  3. Click Done.

  4. Save your work and then click Close.

Activate and Test the Integration

Perform the following steps to activate the integration:

  1. On the Integrations page, click the switch icon for the "'EBS OIT Demo" integration that you created earlier to activate the integration.

    Integrations Page

    the picture is described in the document text

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

When this integration is activated, the endpoint to trigger the integration is displayed on top of the page, along with a link to the Tracking page to track instances.

The REST endpoint URL may be as: https://<OIC hostname>:<port>/ic/api/integration/v1/flows/rest/EBS_OIT_DEMO/1.0/metadata

Test the Integration at Runtime

  1. Open a REST client.

  2. Post the following HTTP request:

    <?xml version="1.0" encoding="utf-8"?>
    <RA_INTERFACE_LINES_ALL_Input>
     <RESTHeader>
      <Responsibility>RECEIVABLES_VISION_OPERATIONS</Responsibility>
      <RespApplication>AR</RespApplication>
      <SecurityGroup>STANDARD</SecurityGroup>
      <NLSLanguage>AMERICAN</NLSLanguage>
      <Org_Id>204</Org_Id>
     </RESTHeader>
    <Select>QUANTITY,TRX_NUMBER,BATCH_SOURCE_NAME</Select>
    <InputParameters>
    <RA_INTERFACE_LINES_ALL_REC>
     <INTERFACE_LINE_ATTRIBUTE9>1</INTERFACE_LINE_ATTRIBUTE9>
     <INTERFACE_LINE_ATTRIBUTE11>1</INTERFACE_LINE_ATTRIBUTE11>
     <INTERFACE_LINE_ATTRIBUTE10>1</INTERFACE_LINE_ATTRIBUTE10>
     <ORG_ID>204</ORG_ID>
     <COMMENTS>Created by Service</COMMENTS>
     <QUANTITY>10</QUANTITY>
     <TRX_NUMBER>Demo-Rec1</TRX_NUMBER>
     <CONVERSION_RATE>1</CONVERSION_RATE>
     <CONVERSION_DATE>2018-08-18</CONVERSION_DATE>
     <CONVERSION_TYPE>User</CONVERSION_TYPE>
     <ORIG_SYSTEM_SHIP_ADDRESS_ID>1030</ORIG_SYSTEM_SHIP_ADDRESS_ID>
     <ORIG_SYSTEM_SHIP_CUSTOMER_ID>1004</ORIG_SYSTEM_SHIP_CUSTOMER_ID>
     <ORIG_SYSTEM_BILL_ADDRESS_ID>1030</ORIG_SYSTEM_BILL_ADDRESS_ID>
     <ORIG_SYSTEM_BILL_CUSTOMER_ID>1004</ORIG_SYSTEM_BILL_CUSTOMER_ID>
     <TERM_ID>4</TERM_ID>
     <TERM_NAME>30 Net</TERM_NAME>
     <CUST_TRX_TYPE_ID>1</CUST_TRX_TYPE_ID>
     <CUST_TRX_TYPE_NAME>Invoice</CUST_TRX_TYPE_NAME>
     <AMOUNT>1000.00</AMOUNT>
     <CURRENCY_CODE>USD</CURRENCY_CODE>
     <DESCRIPTION>Project Invoices</DESCRIPTION>
     <LINE_TYPE>LINE</LINE_TYPE>
     <SET_OF_BOOKS_ID>1</SET_OF_BOOKS_ID>
     <BATCH_SOURCE_NAME>PROJECTS INVOICES</BATCH_SOURCE_NAME>
     <INTERFACE_LINE_ATTRIBUTE7>Line</INTERFACE_LINE_ATTRIBUTE7>
     <INTERFACE_LINE_ATTRIBUTE6>1</INTERFACE_LINE_ATTRIBUTE6>
     <INTERFACE_LINE_ATTRIBUTE5>Sole, Mr. Samuel</INTERFACE_LINE_ATTRIBUTE5>
     <INTERFACE_LINE_ATTRIBUTE4>Vision Operations</INTERFACE_LINE_ATTRIBUTE4>
     <INTERFACE_LINE_ATTRIBUTE3>Services 01</INTERFACE_LINE_ATTRIBUTE3>
     <INTERFACE_LINE_ATTRIBUTE2>31</INTERFACE_LINE_ATTRIBUTE2>
     <INTERFACE_LINE_ATTRIBUTE1>ATZ Services</INTERFACE_LINE_ATTRIBUTE1>
     <INTERFACE_LINE_CONTEXT>PROJECTS INVOICES</INTERFACE_LINE_CONTEXT>
    </RA_INTERFACE_LINES_ALL_REC>
    <RA_INTERFACE_LINES_ALL_REC>
     <INTERFACE_LINE_ATTRIBUTE9>1</INTERFACE_LINE_ATTRIBUTE9>
     <INTERFACE_LINE_ATTRIBUTE11>1</INTERFACE_LINE_ATTRIBUTE11>
     <INTERFACE_LINE_ATTRIBUTE10>1</INTERFACE_LINE_ATTRIBUTE10>
     <ORG_ID>204</ORG_ID>
     <COMMENTS>Created by Service</COMMENTS>
     <QUANTITY>20</QUANTITY>
     <TRX_NUMBER>Demo-Rec2</TRX_NUMBER>
     <CONVERSION_RATE>1</CONVERSION_RATE>
     <CONVERSION_DATE>2018-08-18</CONVERSION_DATE>
     <CONVERSION_TYPE>User</CONVERSION_TYPE>
     <ORIG_SYSTEM_SHIP_ADDRESS_ID>1030</ORIG_SYSTEM_SHIP_ADDRESS_ID>
     <ORIG_SYSTEM_SHIP_CUSTOMER_ID>1004</ORIG_SYSTEM_SHIP_CUSTOMER_ID>
     <ORIG_SYSTEM_BILL_ADDRESS_ID>1030</ORIG_SYSTEM_BILL_ADDRESS_ID>
     <ORIG_SYSTEM_BILL_CUSTOMER_ID>1004</ORIG_SYSTEM_BILL_CUSTOMER_ID>
     <TERM_ID>4</TERM_ID>
     <TERM_NAME>30 Net</TERM_NAME>
     <CUST_TRX_TYPE_ID>1</CUST_TRX_TYPE_ID>
     <CUST_TRX_TYPE_NAME>Invoice</CUST_TRX_TYPE_NAME>
     <AMOUNT>1000.00</AMOUNT>
     <CURRENCY_CODE>USD</CURRENCY_CODE>
     <DESCRIPTION>Project Invoices</DESCRIPTION>
     <LINE_TYPE>LINE</LINE_TYPE>
     <SET_OF_BOOKS_ID>1</SET_OF_BOOKS_ID>
     <BATCH_SOURCE_NAME>PROJECTS INVOICES</BATCH_SOURCE_NAME>
     <INTERFACE_LINE_ATTRIBUTE7>Line</INTERFACE_LINE_ATTRIBUTE7>
     <INTERFACE_LINE_ATTRIBUTE6>1</INTERFACE_LINE_ATTRIBUTE6>
     <INTERFACE_LINE_ATTRIBUTE5>Sole, Mr. Samuel</INTERFACE_LINE_ATTRIBUTE5>
     <INTERFACE_LINE_ATTRIBUTE4>Vision Operations</INTERFACE_LINE_ATTRIBUTE4>
     <INTERFACE_LINE_ATTRIBUTE3>Services 01</INTERFACE_LINE_ATTRIBUTE3>
     <INTERFACE_LINE_ATTRIBUTE2>33</INTERFACE_LINE_ATTRIBUTE2>
     <INTERFACE_LINE_ATTRIBUTE1>ATZ Services</INTERFACE_LINE_ATTRIBUTE1>
     <INTERFACE_LINE_CONTEXT>PROJECTS INVOICES</INTERFACE_LINE_CONTEXT>
    </RA_INTERFACE_LINES_ALL_REC>
    </InputParameters>
    </RA_INTERFACE_LINES_ALL_Input>
    
  3. Click the Tracking page link mentioned earlier to display the Tracking Instances page.

    Tracking Instances Page

    the picture is described in the document text

  4. Click the business identifier (such as Org_Id: 204) to display the orchestration flow diagram of the integration instance.

    Orchestration Flow Diagram

    the picture is described in the document text

  5. From the menu, select View Activity Stream to view log messages about Success Count from the Interface step and the log message about concurrent program Submit ID from the 'CPSubmitReponse" step.

    Log messages can be like:

    1. LogActivity -<Date Time>- Success Count <no. of records in payload that was successfully inserted to RA_INTERFACE_LINES_ALL> - Interface

    2. LogActivity -<Date Time>- CP Submit ID <Request ID returned by CP Submit> - CPSubmitResponse

  6. Use the Submit ID to track the status of the associated concurrent program in Oracle E-Business Suite. Once the execution of the concurrent program is completed, you can view the report for the result of this concurrent program.