About Oracle Integration Cloud Service Concepts

The following topics describe each of the components required to create an end-to-end integration. Each integration includes connections and mappings. You can also include lookups, which are reusable mappings for the different codes and terms used in your applications to describe the same item. You can also group integrations into packages.

About Oracle Integration Cloud Service Connections

Connections define information about the instances of each configuration you are integrating. Oracle Integration Cloud Service includes a set of predefined adapters, which are the types of applications on which you can base your connections, such as Oracle Sales Cloud, Oracle Eloqua Cloud, Oracle RightNow Cloud, and others. A connection is based on an adapter. For example, to create a connection to a specific RightNow Cloud application instance, you must select the Oracle RightNow adapter and then specify the WSDL URL, security policy, and security credentials to connect to it.

Note:

When provisioning Oracle Integration Cloud Service, you allocate connections to an instance. Once allocated, you can add more, but cannot reduce the number of connections allocated to an instance. This is shown on the My Services dashboard. Within an instance, it shows you how many connections are being used, but not the number of connections allocated.

Connection Creation

You can create a connection based on any of the following adapters.

Adapter For Information
Adobe eSign Adapter Using the Adobe eSign Adapter
Concur Adapter Using the Concur Adapter

DB2 Adapter

Using the DB2 Adapter
DocuSign Adapter Using the DocuSign Adapter
Eventbrite Adapter Using the Eventbrite Adapter
Evernote Adapter Using the Evernote Adapter
Facebook Adapter Using the Facebook Adapter
File Adapter Using the File Adapter
FTP Adapter Using the FTP Adapter
Gmail Adapter Using the Gmail Adapter
Google Calendar Adapter Using the Google Calendar Adapter
Google Task Adapter Using the Google Task Adapter
JMS Adapter Using the JMS Adapter
LinkedIn Adapter Using the LinkedIn Adapter
Microsoft Calendar Adapter Using the Microsoft Calendar Adapter
Microsoft Contact Adapter Using the Microsoft Contact Adapter
Microsoft Email Adapter Using the Microsoft Email Adapter
Microsoft SQL Server Adapter Using the Microsoft SQL Server Adapter
MailChimp Adapter Using the MailChimp Adapter
MySQL Adapter Using the MySQL Adapter
Oracle Advanced Queuing (AQ) Adapter Using the Oracle Advanced Queuing (AQ) Adapter
Oracle Commerce Cloud Adapter Using the Oracle Commerce Cloud Adapter
Oracle CPQ Cloud Adapter Using the Oracle CPQ Cloud Adapter
Oracle Database Adapter Using the Oracle Database Adapter
Oracle E-Business Suite Adapter Using the Oracle E-Business Suite Adapter
Oracle Field Service Adapter Using the Oracle Field Service Adapter
Oracle Eloqua Cloud Adapter Using the Oracle Eloqua Cloud Adapter
Oracle ERP Cloud Adapter Using the Oracle ERP Cloud Adapter
Oracle HCM Cloud Adapter Using the Oracle HCM Cloud Adapter
Oracle JD Edwards EnterpriseOne Adapter Using the Oracle JD Edwards EnterpriseOne Adapter
Oracle Logistics Adapter Using the Oracle Logistics Adapter
Oracle Messaging Cloud Service Adapter Using the Oracle Messaging Cloud Service Adapter
Oracle NetSuite Adapter Using the Oracle NetSuite Adapter
Oracle Responsys Adapter Using the Oracle Responsys Adapter
Oracle RightNow Cloud Adapter Using the Oracle RightNow Cloud Adapter
Oracle Sales Cloud Adapter Using the Oracle Sales Cloud Adapter
Oracle Siebel Adapter Using the Oracle Siebel Adapter

Oracle Utilities Adapter

Oracle Utilities Adapter
REST Adapter Using the REST Adapter
Salesforce Adapter Using the Salesforce Adapter
SAP Adapter Using the SAP Adapter
SAP Ariba Adapter Using the SAP Ariba Adapter
Oracle SOAP Adapter Using the SOAP Adapter
SuccessFactors Adapter Using the SuccessFactors Adapter
SurveyMonkey Adapter Using the SurveyMonkey Adapter
Trello Adapter Using the Trello Adapter
Twilio Adapter Using the Twilio Adapter
Twitter Adapter Using the Twitter Adapter
Workday Adapter Using the Workday Adapter
Oracle Integration Cloud Service Messaging

Oracle Integration Cloud Service Messaging enables you to publish messages to and subscribe to messages from Oracle Integration Cloud Service.

You may have business use cases in which you need to synchronize objects between applications. For example:
  • Create an object in one application that causes the object to be created in other applications. For example, create a new account in Oracle Sales Cloud Adapter, which causes the creation of an Oracle RightNow organization and an Oracle Eloqua account.

  • Enable multiple applications to subscribe to Oracle Integration Cloud Service and register for updates.

  • Add or remove subscribers without impacting other subscribers or producers.

Oracle Integration Cloud Service Messaging addresses these business requirements through the creation of two types of integrations: one for publishing to Oracle Integration Cloud Service and one for subscribing to Oracle Integration Cloud Service.

  • You create an integration that enables you to publish messages to Oracle Integration Cloud Service by selecting the Publish to ICS option in the Create Integration — Select a Pattern dialog. In this integration:
    • Oracle Integration Cloud Service is added as an invoke and is automatically configured.

    • You configure a trigger (source) adapter (for example, Oracle RightNow, Oracle Sales Cloud, or another).

    • The message to pass to Oracle Integration Cloud Service is opaque, so no request mapper support is provided.

    • No trigger (source) enrichment mapper support is provided.

    • Multiple publishers targeting a single message destination is not supported.

      Note:

      Modifying the publisher after creating the subscribers can potentially impact the subscribers. For example, if you change the published object, any existing subscriber mappings are impacted.
  • You create an integration that enables you to subscribe to messages from Oracle Integration Cloud Service by selecting the Subscribe to ICS option in the Create Integration — Select a Pattern dialog. In this integration:
    • Oracle Integration Cloud Service is added as a trigger (source).

    • You are prompted to select the published integration to which to subscribe.



    • You configure an invoke adapter to subscribe to and receive messages from Oracle Integration Cloud Service.

    • Response mapper support is provided between the published object and the subscriber’s application object.

    • Trigger (source) enrichment mapper support is provided.

See Creating an Integration to Publish Messages to Oracle Integration Cloud Service and Creating an Integration to Subscribe to Oracle Integration Cloud Service.

About Oracle Integration Cloud Service Integrations

Integrations are the main ingredient of Oracle Integration Cloud Service. An integration includes at the least a trigger (source) connection (for requests sent to Oracle Integration Cloud Service) and invoke (target) connection (for requests sent from Oracle Integration Cloud Service to the target) and the field mapping between those two connections.

When you create your integrations, you build on the connections you already created by defining how to process the data for the trigger (source) and invoke (target) connections. This can include defining the type of operations to perform on the data, the business objects and fields against which to perform those operations, required schemas, and so on. To make this easier, the most complex configuration tasks are handled by Oracle Integration Cloud Service. Once your trigger (source) and invoke (target) connections are configured, the mappers between the two are enabled so you can define how the information is transferred between the trigger (source) and invoke (target) data structures for both the request and response messages.

Related Topics

See the following sections for additional information.

About Mappings

One of the key tasks to any integration is defining how data is transferred, or mapped, between two applications.

In most cases, the messages you want to transfer between the applications in an integration have different data structures. A visual mapper enables you to map fields between applications by dragging source fields onto target 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 source and target connections. You can expand and the load data structure levels on demand to display additional levels. There is no limit on the levels of display.
Description of mapper_about_mapping.png follows
Description of the illustration mapper_about_mapping.png

The maps you create are called transformation maps, and use the eXtensible Stylesheet Language (XSL) to describe the data mappings, which lets you perform complex data manipulation and transformation. A standard set of XPath functions are provided for you to define how data is modified when moving from one application to another. A specialized function is also provided for you to reference lookups directly from the mapper.

The mapper supports both qualified and unqualified schemas (that is, schemas without elementFormDefault=”qualified”). Elements and attributes with and without namespace prefixes are also supported.

Substitution groups in schemas are supported. You can see all the substitutable elements in a base element in the mapper, and select the one to use.

Elements and attributes for which mapping is required are identified by a blue asterisk (*) to the left of their names. To display only required fields, click the Filter icon, select Required Fields, and click Apply.
Description of mapper_elem_details.png follows
Description of the illustration mapper_elem_details.png

You can also place your cursor over elements and attributes to display specific schema details such as the data type, if mapping is required, and so on. When you place your cursor over some elements and attributes, additional custom annotations can also be displayed. These annotations are currently only available with the Oracle Sales Cloud Adapter. The Oracle Sales Cloud Adapter obtains this information from the applications and annotates it in the integration WSDL. This information is then read and made visible as annotations in the mapper (for example, title and description). This information can help you better understand what data is being mapped.
Description of mapper_annotations.png follows
Description of the illustration mapper_annotations.png
.

Mapping Request Data Between Applications

Once you create an integration and have the trigger (source) and invoke (target) in place, you can define how data is mapped between the two data structures.

The mapper appears with the source data structure on the left and the target data structure on the right:
  1. Map request data between the source data structure and target data structure.
  2. Click Close.
When returning from the mapper, the map icon changes color to indicate it is complete. Once you create a mapping in an integration, you can return to the mapping and make any necessary changes to how you mapped your data.
See Mapping Data of Using the Oracle Mapper.

Mapping Response Data Between Applications

If your integration pattern contains a response, you can map the response.

  1. Map response data between the source data structure and target data structure.
  2. Click Close.
    When returning from the mapper, the map icon changes color to indicate it is complete.
    Once you create a mapping in an integration, you can return to the mapping and make any necessary changes to how you mapped your data.
See Mapping Data of Using the Oracle Mapper.

About Mapping Multiple Sources to a Target

When mapping data between source and target data structures, some integration scenarios enable you to map the fields of multiple source structures to the fields of a single target structure.

Integration scenarios that include multiple source structure capabilities include the following:
  • Integrations in which message enrichment points have been added (for example, a request message enrichment point, a response message enrichment point, or both points). For example, within the context of the following inbound trigger connection to outbound invoke connection, request mappings and request enrichment mappings are both defined.
    Description of mapper_mult_sources11.png follows
    Description of the illustration mapper_mult_sources11.png

    Clicking the Request Mapping icon shows that there are two sources available for mapping in the Source section. The process structure is the primary source. The $RequestEnrichmentApplicationObject structure is the secondary source. Secondary sources are treated as variables and identified by the $ added to the front. The fields of both sources can be mapped to the fields of the target.
    Description of mapper_mult_sources9.png follows
    Description of the illustration mapper_mult_sources9.png

  • Integration responses with a response mapping between a trigger connection and an invoke connection. For example, within the context of the invoke connection’s response back to the trigger connection, there are response mappings.
    Description of mapper_mult_sources7.png follows
    Description of the illustration mapper_mult_sources7.png

    Clicking the Response Mapping icon shows the two sources available for mapping in the Source section. The GetResponse structure is the primary source. The $SourceApplicationObject structure is the secondary source (note the $). The fields of both sources can be mapped to the fields of the target.
    Description of mapper_mult_sources10.png follows
    Description of the illustration mapper_mult_sources10.png

See Mapping Multiple Sources to a Target of Using the Oracle Mapper.

About Oracle Integration Cloud Service Enrichments

You may have business use cases in which you need to enhance data by calling another service before sending data to an invoke service or before sending data back to a requestor. To address this business requirement, you can optionally add enrichment data sources to the request part, the response part, or both parts of an integration. Enrichments participate in the overall integration flow and can be used in the request and/or response payloads between the trigger and invoke services. Enrichments subscribe to a synchronous request and response message pattern.

Enrichments enable you to:
  • Add additional information. For example, your business use case may require you to:

    • Add a stock price

    • Increase on-site quantities of a product

    • Estimate local currency

  • Convert data, such as mapping data between account numbers. The ability to map data between the request/response payload and the enrichment source application is a key feature of enrichments.

See Adding Request and Response Enrichments.

About Oracle Integration Cloud Service Lookups

Use lookups in your integrations to create reusable tables that map the different terms used to describe the same item across your applications.

A lookup associates values used by one application for a specific item to the values used by other applications for the same item. For example, one application uses a specific set of codes to describe countries, while another application uses a different set of codes to describe the same countries. Lookups can be used for items such as mapping gender codes, nationality codes, currency codes—any type of information that your applications must share with each other but that they represent differently. You may have several lookups for one integration, depending on the number of fields that require mapping. Lookups are also reusable, and can be used by multiple integrations. Lookups are based on a static definition, meaning you create and populate them during design time, and are not changed by runtime activities. These tables are used for looking up values only.

Lookup Function

Oracle Integration Cloud Service provides a lookupValue function that you can call in the mapper to specify when to reference a lookup table. Use this function to look up values at runtime based on information in incoming messages. This way, your integration knows how to map data coming in from one application to data being sent to another application.

See Referencing Lookups of Using the Oracle Mapper.

About Oracle Integration Cloud Service Packages

You can group one or more integrations into a single structure called a package. Packages enable you to easily import and export a group of integrations to and from Oracle Integration Cloud Service. You can import packages from the Oracle Marketplace. These packages consist of a series of prebuilt integrations provided by Oracle. You can also import and export packages that consist of integrations that you or other users created. Packages are optional, meaning that integrations do not need to be part of packages. However, for a package to exist, it must include at least one integration. Packages cannot be locked to exclude other users of your Oracle Integration Cloud Service instance.

Packages are displayed on the Packages page in Oracle Integration Cloud Service. From this page, you can view, delete, import, and export packages. You create packages when you create an integration in the Create Integration dialog. You can also update an integration’s package in the Update Integration dialog.
Description of ics_package_view.png follows
Description of the illustration ics_package_view.png

See Managing Packages and Creating an Integration.

About Connectivity Agents and Integrations Between On-Premises Applications and Oracle Integration Cloud Service

The on-premises connectivity agent enables you to create integrations and exchange messages between on-premises applications and Oracle Integration Cloud Service. Message payloads of up to 5 MB are supported through the use of compression. The on-premises connectivity agent provides multithreading support, which allows for multiple executors to perform downstream message processing.

This type of integration enables you to:

  • Access SOAP endpoints

  • Access non-SOAP endpoints (such as Oracle E-Business Suite and Oracle Siebel)

  • Send requests from a cloud application (for example, send a Create Service Order request from an Oracle RightNow Cloud application) to an on-premises E-Business Suite application

About the Connectivity Agent Framework

The connectivity agent framework consists of the following components:

  • SAAS agent: This agent is installed and runs in Oracle Integration Cloud Service and supports communication with on-premises applications. There is one SAAS agent per Oracle Integration Cloud Service environment.

  • On-premises agent: This agent is installed and runs in an on-premises environment on the same network as internal systems such as Oracle E-Business Suite, Oracle Siebel, Oracle Database, and others. You download the on-premises agent installer from the Agents page in Oracle Integration Cloud Service to your on-premises environment for installation. There can be multiple host systems, each running one or more agents, in a cloud/on premises topology. The on-premises agent does not permit any explicit inbound connections. All connections are established from the on-premises environment to Oracle Integration Cloud Service. This functionality means that:

    Note:

    While multiple connectivity agents can run on a single host, this is not the recommended practice. If you follow this practice, you must ensure that the physical host has enough resources to run multiple connectivity agents.
    • No ports are opened on the on-premises system for communication.

    • All communication is secured using SSL.

    • The on-premises connectivity agent registers with Oracle Integration Cloud Service over SSL using the provided Oracle Integration Cloud Service credentials.

    • The on-premises connectivity agent checks for work by making outbound requests through the firewall.

    • The on-premises connectivity agent can use a proxy to access the internet (the same proxy as other internal applications and browsers use). Authentication support for outbound proxy access is provided.

    • The on-premises connectivity agent connections are configured by the agent retrieving the configuration details from Oracle Integration Cloud Service.

    • The on-premises connectivity agent processes requests by pulling messages from Oracle Integration Cloud Service across SSL.

    • The on-premises connectivity agent posts responses by pushing messages to Oracle Integration Cloud Service across SSL.

    • All communication is initiated by the on-premises connectivity agent.

    • No private SOAP-based web services are exposed.

    • No existing J2EE container is required to deploy the on-premises connectivity agent.

  • Oracle Advanced Queuing (AQ): This component handles message exchange between Oracle Integration Cloud Service and on-premises environments.

  • Outbound adapters: The following adapters can be configured as invoke connections in an integration to support communication with endpoint applications:
    • File

    • Microsoft SQL Server

    • MySQL Database

    • Oracle Database

    • Oracle E-Business Suite

    • REST

    • SAP

    • Siebel

    • SOAP

  • Inbound adapters: The following adapters can be configured as trigger connections in an integration:
    • File

    • JMS

    • Microsoft SQL Server

    • Oracle Database

    • Oracle E-Business Suite

    • SAP

    • Siebel

  • A serviceInvocationError fault mapping defined in the WSDL when using the Oracle Database Adapter.

    This fault enables you to design fault mapping during integration creation. This mapping transforms an Oracle Database Adapter fault when used as a target into the source format defined in its WSDL. You add the Oracle Database Adapter to a scope action in an orchestrated integration and select this fault in the Fault Handler part of the scope action. See Managing a Group of Actions and Fault Handlers with a Scope Action. In the mapper, the elements of serviceInvocationError provide details about the runtime fault:
    • type: The type of fault.

    • title: The title of the fault.

    • detail: Information about the fault cause.

    • errorCode: Information about the fault code.

    • remedialAction: How to fix the fault.

    This fault structure is populated during runtime when any exception occurs in an outbound invocation (for example, a primary key violation).

    If using the Oracle Database Adapter in a map data integration, only reason, detail, and errorCode are available in the mapper.

    See Using Fault Mapping with the Oracle Database Adapter of Using the Oracle Database Adapter for more specific details.

Workflow for Using the Agent

Follow this workflow to use the on-premises agent.

Task Documentation
Create an agent group. Creating an Agent Group
Download and run the on-premises agent installer on your host. During installation setup, you associate the on-premises agent with the agent group.

Downloading and Running the On-Premises Agent Installer

Create an adapter connection in Oracle Integration Cloud Service and associate the connection with the agent group.

Creating an Agent Group

Design an integration that uses this connection. Creating an Integration
Activate the integration. Activating an Integration

See Managing Agent Groups and the On-Premises Agent and Monitoring Agents.