Developing Integration Flows with Oracle Integration Cloud Service


Options



Before You Begin

This tutorial familiarizes you with Oracle Integration Cloud Service and shows you how to create an integration. Some of the sections include demonstration videos that you can watch before you attempt that section of the tutorial.

Time to Complete

This tutorial should take about 1 hour to complete.

Introduction

When integrating services with Oracle’s Integration Could Service, there are two main steps you need to complete. First, you create connections, then you integrate those connections. For each connection you add a contact, configure the connectivity by specifying a WSDL URL, and then secure the connection by adding credentials. To create the integration, you configure the trigger and the invoke, then you map the business objects to each other.

Scenario

In this tutorial, you create an Organization business object in Oracle RightNow, which causes a corresponding AccountServoce business service to be created and populated in Oracle Sales Cloud. The tutorial includes the following six major steps:

  1. Create an Oracle RightNow connection.
  2. Create an Oracle Sales Cloud connection.
  3. Create a new integration that links the two connections.
  4. Configure the connections and map the data so that when Organization data in the Oracle RightNow application is created or updated, it is pushed to the AccountService service in the Oracle Sales Cloud application.
  5. Activate the new integration.
  6. Verify that the integration works correctly.

The following figure illustrates the scenario.

Image shows RightNow UI on the left and Sales Cloud UI on right, and ICS in the middle.  Arrow shows the flow from RightNow, through ICS, to Sales Cloud

Prerequisites

Before starting this tutorial, you must have the following:

  • An Oracle Integration Cloud Service subscription or trial subscription.
  • An Oracle RightNow Cloud Service subscription or trial subscription. Note: In some documentation and user interfaces, the Oracle RightNow Cloud Service is referred to as Oracle Service Cloud.
  • An Oracle Sales Cloud subscription or trial subscription.
  • Running instances of the Oracle RightNow and Sales Cloud applications. You must know the WSDL URLs and the login credentials (username/password) required to connect to them.

For links to some of these resources, see the "Want to Learn More?" section at the end of this tutorial.


 

Create Connections

Connections allow Integration Cloud Service to interact with an application instance. A connection is required for every application instance that participates in an integration. In this tutorial you create two connections – one for an Oracle RightNow application instance and one for an Oracle Sales Cloud application instance.

The WSDL URLs in these steps are used by Integration Cloud Service to access the Oracle RightNow and Oracle Sales Cloud instances participating in the integration. This WSDL provides operations for inserting, updating, and deleting records in application business objects and services. This WSDL also provides operations to retrieve the metadata, custom attributes, and custom objects. In order to create a connection, these instances must be running in a location you can access and you must know the URL for the WSDL file that defines each instance.

Watch "Creating Connections in Integration Cloud Service" to see it before you do it.

Create the Oracle RightNow Connection

  1. Start Oracle Integration Cloud Service.
  2. On the Home page, click Create Connections.

    This image shows the ICS home page with arrow pointing to the create connection box

  3. Click New Connection.

    This image shows the Creaet New Connection button

  4. Type "right" in the Select Adapter Search field and then select the Oracle RightNow adapter.

  5. This image shows the Oracle RightNow selection button

  6. Enter the following connection information in the New Connection - Information dialog.
Field Enter
Name Oracle RightNow My Instance
Identifier ORACLE_RIGHTNOW_MY_INSTANCE
(Note: The default value is entered for you automatically.)
Role Trigger
Description Connect to my Oracle RightNow instance.
  1. Click Create.
  2. In the Email Address field of the Connection Administrator section, enter your email address.
  3. Click Configure Connectivity to configure the WSDL URL. Enter the URL to your Oracle RightNow WSDL file.
  4. Click Configure Security. Enter the username and password required to access your Oracle RightNow application. Note that the Username Password Token option is automatically selected in the Security Policy list. This is the only selection available.
  5. Click Save.
  6. Click Test to verity the connection.

    This image shows the Test icon

    If the test is successful, you see the following message at the top of the window. 
    This image shows the "Connection tested successfully" message

    If the test is not successful, verify that the WSDL URL and credentials that you entered are correct.

  7. Click Exit Connection.

The new connection is added to the top of the connections list.

Create the Oracle Sales Cloud Connection

Creating an Oracle Sales Cloud connection is very similar to creating the Oracle RightNow connection.

  1. Click New Connection.
  2. Type "sales cloud" in the Select Adapter Search field and then select the Oracle Sales Cloud adapter.

    This image shows the Oracle Sales Cloud selection button

  3. Enter the following connection information in the New Connection - Information dialog:
Field Enter
Name Oracle Sales Cloud My Instance
Identifier ORACLE_SALES_CLOUD_MY_INSTANCE
(Note: The default value is entered for you automatically.)
Role Invoke
Description Connect to my Oracle Sales Cloud instance.
  1. Click Create.
  2. In the Email Address field of the Connection Administrator section, enter your email address.
  3. Click Configure Connectivity to configure the WSDL URL. Enter the URL to your Oracle Sales Cloud WSDL file in the OSC Services Catalog WSDL URL field.
  4. Click Configure Security.  Enter the username and password required to access the Oracle Sales Cloud application. Note that the Username Password Token option is automatically selected in the Security Policy list. This is the only selection available.
  5. Save the connection.
  6. Click Test to verity the connection.
  7. This image shows the Test icon

  8. If the test is successful, you see the following message at the top of the window. 

    This image shows the "Connection tested successfully" message

    If the test is not successful, verify that the WSDL URL and credentials that you entered are correct.

  9. Click Exit Connection.

The new connection is added to the top of the connections list.

Create a New Integration

Now that you've created connections, you need to integrate the connections so that data can flow from one (the trigger) to the other (the invoke). In this tutorial the Oracle RightNow application is the trigger and the Oracle Sales Cloud application is the invoke.

 Watch "Creating Integrations in Integration Cloud Service" to see it before you do it.

Create the Integration

To create a new integration, perform the following steps:

  1. Click Designer at the top right corner of the Integration Cloud Service Home page.

      This image shows the Designer button


  1. Click the Integrations icon.
    This image shows the Integrations icon

  1. Click New Integration.

     This image shows the Create Integration button

  1. In the Create an Integration - Select a Style/Pattern dialog, select Basic Map Data.
  2. Enter the following integration information in the Create New Integration dialog:
Field Enter
What do you want to call your integration? MyIntegration
Identifier MYINTEGRATION
(Note: The default value is entered for you automatically.)
Version Nothing to enter.
Use the default value of  01.00.0000.
What does this integration do? Syncs RightNow Organization objects with OSC AccountService.
Which package does this integration belong to? MyPackage
(Note: Packages enable you to group integrations into a single structure that makes them easy to import and export.)
  1. Click Create.

Configure the RightNow Connection (Trigger)

  1. Drag your Oracle RightNow connection to the Trigger area. This invokes the configuration wizard.

    This image shows the integration canvas and the drag-and-drop of the connection over the Source target

  2. Fill in the wizard Basic Info page with the following information:
Field Enter
What do you want to call your endpoint? SyncOrganization
What does this endpoint do? Receives request from RightNow to create Account in Oracle Sales Cloud
  1. Click Next to advance to the Request page.
  2. Scroll down the list of business objects and select Organization from the list.
    This image shows the selection of the Organization object from the list of business objects

  1. Click Next to advance to the Response page.
  2. Because this is a one-way process, there is no response. Select the None response type.

    This image shows the selected None response type

  3. Click Next.
  4. Click Done.
  5. Click Save on the main canvas to save your work.
    This image shows the Save icon

Configure Oracle Sales Cloud Connection (Invoke)

  1. Drag your Oracle Sales Cloud connection to the Invoke area. This invokes the configuration wizard.

    This image shows the integration canvas and the drag-and-drop of the connection over the Target area


  2. Fill in the wizard Basic Info page with the following information:
Field Enter
What do you want to call your endpoint? CreateAccount
What does this endpoint do? Create Account in Oracle Sales Cloud
  1. Click Next to advance to the Operations page.
  2. Select Services from the Browse by dropdown menu.
  3. Select AccountService from the scrolling list of business services.
  4. Select createAccount from the dropdown menu beneath the scrolling list.

    This image shows the AccountServices item in the Services list and the corresponding createAccount operation

  5. Click Next.
  6. Click Done.
  7. Click Save on the main canvas to save your work.
    This image shows the Save icon

Map the Data

One of the key tasks in creating an integration is defining how data is transferred, or mapped, between two applications. In this tutorial, you map the fields of the  Oracle RightNow Organization object (trigger) to the fields of the Oracle Sales Cloud AccountService (invoke). The Oracle Integration Cloud Service visual mapper enables you to map fields between applications by dragging trigger fields onto invoke fields. When you open the mapper for a request or response message in an integration, the data structures are automatically populated with the information pulled from the trigger and invoke connections.

To map data for this integration, perform the following steps:

  1. Click the mapping icon between the trigger and the invoke icons.

    This image shows the integration canvas highlighting the Create Map button

  2. Click the Create icon when prompted.
    This image shows the Create icon
    This opens the mapper.

    This image shows the mapper window with unmapped fields
  3. The source data structure is on the left of the mapper and the target data structure is on the right. Collapse the top-level nodes to make it easier to see the fields with which you want to work.

  4. Drag the source to the target, as listed in the table. Drop the source in the empty field next to the target. As shown in the image above, the green checkmark icon and the line connecting them indicate that these fields have been mapped.

  5. Source Target
    process / Organization / Name createAccount / account / OrganizationName
    process / Organization / NumberOfEmployees createAccount / account / EmployeesTotal
    process / Organization / SalesSettings / TotalRevenue / Currency / Name createAccount / account / CurrencyCode
  6. After you have mapped the three items in the table, on the target side, search for the CreatedByModule field and then click it to invoke the Build Mappings page.

    This image shows the search box used to find the CreatedByModule field
  7.  In the Drag and Drop or Type here text box, type MyIntegration.

    This image shows "MyIntegration" typed in the text box

  8. Click Save, then click Close.
  9. Click Save, then click Exit Mapper.
  10.  This image shows the "Exit Mapper" button

  11. Save the Integration.
  12. This image shows the Save button
  13. Click Exit Integration.
  14. This image shows the Exit Canvas button

Track Fields

Perform the following steps to enable the tracking of payload fields.

  1. Click MyIntegration in the Integrations list..
    This image shows the integration name being clicked
  2. Click Tracking above the integration.
  3. This image shows the Tracking button being clicked.
  4. Drag the LookupName field from the Source section into the Tracking Field column. This lets you track the status of that payload field during runtime.This image shows a field from the Available Source Fields section being dragged to the Tracking Field row.
  5. Click Done.
  6. Note that Flow Progress Indicator shows that the integration is 100% complete.
    This image shows the Flow Progress Indicator at 100%
  7. Click Save.
  8. Click Exit Integration.

Activate the Integration

To activate your integration, perform the following steps:

  1. Find MyIntegration in the Integrations list and click the Activate slider.
  2. This image shows the Activate button being clicked
  3. Click Activate when prompted to confirm. Note: Do not select Enable tracing.
  4. This image shows the Activate button on the Confirmation dialog being clicked.
  5. Verify that the integration is Active.

    This image shows the MyIntegration integration highlighting the Status label showing "Active"

Verify That Your Integration Works

The final step to determine if your integration is working properly is to pass data through your integration from Oracle RightNow to Oracle Sales Cloud. The verification process requires you to create a PHP script that runs in the Oracle RightNow console and initiates contact with Oracle Integration Cloud Service and facilitates the transfer of business objects to the Oracle Sales Cloud connection.

Note: Use the integration's endpoint URL to connect to Integration Cloud Service from your PHP script. To get the integration endpoint URL, find MyIntegration in the integration list, and click the integration's information icon.

This image shows the  integration information icon clicked with the endpoint URL in a red box

Run Your Script to Test the Integration

  1. Launch the Oracle RightNow console.  Note: The RightNow console only runs in the Internet Explorer web browser.
  2. Click the Install Oracle Service Cloud button.

    This image shows the installation screen for the RightNow console

  3. Log in to the console using the credentials you specified when you created the Oracle RightNow connection.

    Screenshor that shows the RightNow console login screen

  4. The console user interface appears.

    This image shows the RightNow console window

  5. Click the arrow at the bottom left of the console window.

    This image shows the arrow to be clicked

  6. Select Configuration and then expand the Site Configuration item.

    This image shows the Site Configuration menu

  7. Double-click Process Designer.

    This image shows the Process Designer menu item

  8. After the process designer opens, select New. The new object event handler window appears.

    This image shows the New button

  9. Click the Browse icon and select the file that contains your PHP script.
    This image shows the PHP Code File text box and Browse button
  10. Select Execute Asynchronously.
  11. Click Save.
  12. Click Test.

    This image shows the Test button and "Tested" result

    The Good URL dialog confirms that the connection is made.  If the connection fails, check the URLs in your PHP script.

Deploy the Event Handler

  1. Select Deploy.
  2. Add the email address used when you set up your connection in Integration Cloud Service.
  3. Select Organization in the tree.

    This image shows Organization in the tree
  4. Select createOrganization.
  5. Select Can Suppress.
  6. Click Save.
  7. Click Deploy.
  8. Click OK.

Verify the New Account in Oracle Sales Cloud

  1. Launch Oracle Sales Cloud.
  2. Click the Accounts icon.
  3. Verify your account appears in the list.

Summary

In this tutorial, you learned to:

  • Create Oracle RightNow and Oracle Sales Cloud connections
  • Create a new integration using the connections
  • Configure the connections
  • Activate your integration
  • Verify that your integration works correctly

Credits

UA Developers: Larry Hoffman and Vanessa Menzies-Flint

Want to Learn More?

Prerequisites

Use the following links to find more information about the prerequisites mentioned in the "Prerequisites" section of this tutorial:

Resources

The following resources complement this tutorial: