Oracle Integration Cloud Service User guide

PDF

Document

Oracle® Cloud

Using Oracle Integration Cloud Service

Release 17.4

E55390-33

October 2017

Oracle Cloud Using Oracle Integration Cloud Service, Release 17.4

E55390-33

Primary Author: Mark Kennedy

Contributing Authors: Larry Hoffman

Contributors: Development, Product Management, and Quality Assurance teams

This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.

Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.

The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing.

If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable:

U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are

"commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agencyspecific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.

No other rights are granted to the U.S. Government.

This software or hardware is developed for general use in a variety of information management applications.

It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.

Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.

Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro

Devices. UNIX is a registered trademark of The Open Group.

This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle.

vii

Viewing the Message Payload of a Failed Integration Instance

Resubmitting Failed Messages

Viewing the Status of Message Recovery

Managing Business Identifiers for Tracking Fields in Messages

Tracking Business Identifiers in Integrations During Runtime

Tracking Business Identifiers in Integrations in Which Routing Paths Are

Defined

Filtering the Display of Business Identifiers in Integrations

Viewing Preinstalled Adapters and Registering Custom Adapters

Sending Service Failure Alerts, System Status Reports, and Integration Error

Reports by Notification Emails

Setting Logging Levels and Downloading Diagnostic Logs

Reporting Incidents

Purging and Retaining Data in the Database

Adapter Configuration Reference

Configuring Basic Information Properties

What You Can Do from the Basic Info Page

What You See on the Basic Info Page

Configuring Salesforce Properties

Understanding Salesforce Constraints

Configuring Salesforce Trigger Outbound Messaging Properties

What You Can Do from the Salesforce Trigger Outbound Messaging Page

What You See on the Salesforce Trigger Outbound Messaging Page

Configuring Salesforce Trigger Response Properties

What You Can Do from the Salesforce Trigger Response Page

What You See on the Salesforce Trigger Response Page

Configuring Salesforce Trigger Callback Response Properties

What You Can Do from the Salesforce Trigger Callback Response Page

What You See on the Salesforce Trigger Callback Response Page

Configuring Salesforce Invoke Basic Information Properties

What You Can Do from the Salesforce Invoke Basic Info Page

What You See on the Salesforce Invoke Basic Info Page

Configuring Salesforce Invoke Operation Properties

What You Can Do from the Salesforce Invoke Operations Page

What You See on the Salesforce Invoke Operations Page

Configuring Salesforce Invoke Header Properties

What You Can Do from the Salesforce Invoke Headers Page

What You See on the Salesforce Invoke Headers Page

Configuring Salesforce Invoke Custom Operations Properties

What You Can Do from the Salesforce Invoke Custom Operations Page

viii

What You See on the Salesforce Invoke Custom Operations Page

Performing Salesforce Adapter Postconfiguration Tasks

Configuring Trigger Oracle Integration Cloud Service Messaging

What You Can Do from the Trigger Oracle Integration Cloud Service Messaging

Page

What You See on the Trigger Oracle Integration Cloud Service Messaging Page

Reviewing Configuration Values on the Summary Page

What You Can Do from the Summary Page

What You See on the Summary Page

Using On-Premises Oracle Integration Cloud Service

Downloading and Running the On-Premises Oracle Integration Cloud Service

Installer

Managing Users and Roles

Creating Users and Assigning Roles

Editing On-Premises Users

Deleting On-Premises Users

Preface

Using Oracle Integration Cloud Service describes how to use Oracle Integration Cloud

Service to integrate your applications.

Topics:

•

Audience

•

Documentation Accessibility

•

Related Resources

•

Conventions

Audience

Using Oracle Integration Cloud Service is intended for users who want to create, activate, and monitor application integrations.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle

Accessibility Program website at http://www.oracle.com/pls/topic/lookup?

ctx=acc&id=docacc

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info

or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Related Resources

See these Oracle resources:

• Oracle Cloud http://cloud.oracle.com

•

Using the Oracle Mapper

•

Using the Adobe eSign Adapter

•

Using the Concur Adapter

•

Using the DB2 Adapter

•

Using the DocuSign Adapter

•

Using the Evernote Adapter

•

Using the Eventbrite Adapter

•

Using the Facebook Adapter

•

Using the File Adapter

•

Using the FTP Adapter

•

Using the Gmail Adapter

•

Using the Google Calendar Adapter

•

Using the Google Task Adapter

•

Using the JMS Adapter

•

Using the LinkedIn Adapter

•

Using the MailChimp Adapter

•

Using the Microsoft Calendar Adapter

•

Using the Microsoft Contact Adapter

•

Using the Microsoft Email Adapter

•

Using the Microsoft SQL Server Adapter

•

Using the MySQL Adapter

•

Using the Oracle Advanced Queuing (AQ) Adapter

•

Using the Oracle Commerce Cloud Adapter

•

Using the Oracle CPQ Cloud Adapter

•

Using the Oracle Database Adapter

•

Using Oracle E-Business Suite Adapter

•

Using the Oracle Eloqua Cloud Adapter

•

Using the Oracle ERP Cloud Adapter

•

Using the Oracle Field Service Adapter

•

Using the Oracle HCM Cloud Adapter

•

Using the Oracle JD Edwards EnterpriseOne Adapter

•

Using the Oracle Logistics Adapter

•

Using the Oracle Messaging Cloud Service Adapter

•

Using the Oracle NetSuite Adapter

•

Using the Oracle Responsys Adapter

•

Using the Oracle RightNow Cloud Adapter

•

Using the Oracle Sales Cloud Adapter

•

Using the Oracle Siebel Adapter

•

Using the Oracle Utilities Adapter

•

Using the REST Adapter

•

Using the Salesforce Adapter

•

Using the SAP Adapter

Preface xi

Preface

•

Using the SAP Ariba Adapter

•

Using the ServiceNow Adapter

•

Using the SOAP Adapter

•

Using the SuccessFactors Adapter

•

Using the SurveyMonkey Adapter

•

Using the Trello Adapter

•

Using the Twilio Adapter

•

Using the Twitter Adapter

Conventions

The following text conventions are used in this document:

Convention boldface

italic

monospace

Meaning

Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary.

Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values.

Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter.

xii

Getting Started with Oracle Integration

Cloud Service

Review the following topics to learn about how Oracle Integration Cloud Service works. These topics provide information about Oracle Integration Cloud Service concepts and components to help you get started with creating your own integrations.

Topics

•

Running the Sample Integrations

•

About Oracle Integration Cloud Service

•

About Oracle Integration Cloud Service Concepts

•

About Monitoring

•

About Error Management

•

About Business Identifiers for Tracking Fields in Messages

•

Starting Oracle Integration Cloud Service

•

Navigating Oracle Integration Cloud Service

Running the Sample Integrations

When you provision a new instance of Oracle Integration Cloud Service, the following sample integrations are automatically included. These samples help you get you up and running quickly and show you how easy it is to activate, invoke, and monitor an integration between endpoints.

See the following sections to run and monitor the samples. It is recommended that you run these samples in the following order because several samples build upon one another.

Sample

Echo

Hello World

Complexity This Sample

Demonstrates How to ...

None

Hello World Invoke Minimal

Use simple logging with a

REST Adapter as a trigger in a request-response orchestrated integration.

Use simple log and email notification actions with a

REST Adapter in an orchestrated integration.

Call and invoke a simple

REST web service in an orchestrated integration.

Simple logging is also used.

See ...

Running the Echo Sample

Running the Hello World

Sample

Running the Hello World

Invoke Sample

1-1

Chapter 1

Running the Sample Integrations

Sample

Hello World Data

Map Invoke

File Transfer

Incident details from Service Cloud

Complexity This Sample

Demonstrates How to ...

Minimal

Medium

Call and invoke a simple

REST web service using the

Map Data integration pattern.

Read an opaque file from a

" directory and write the file to an "

/upload

" directory in a simple scheduled orchestration. After activating the integration, you go to the Actions menu and select Submit now or

Add Schedule to run the scheduled integration.

Get incident details from the

Oracle Service Cloud for an incident ID and send the incident details to the caller as a response.

See ...

Running the Hello World

Data Map Invoke Sample

Running the File Transfer

Sample

Running the Incident Details from Service Cloud Sample

Note:

The documentation for running these samples is also available when you click the Information icon for an activated integration and select How to run.

Running the Echo Sample

This sample demonstrates how to use simple logging with a REST Adapter as a trigger in a request-response orchestrated integration. The REST Adapter is triggered when you specify a URL. A browser response is sent to you. A logging message is created and logged to the activity stream for viewing. You also track the integration and monitor message status.

1-2

Chapter 1

Running the Sample Integrations

Complexity

None.

Prerequisites

None.

How To Activate

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

In the row for the Echo sample, click the Activate icon, then click Activate when prompted.

Wait for the icon to turn green, indicating that it is activated.

How To Run

Enter the following URL in a browser. You can also copy this URL from the

Information icon for this sample.

https://hostname:port/integration/flowapi/rest/ECHO/v01/{message}

For example: https://my_pod.us.company.com:port/integration/flowapi/rest/ECHO/v01/Invoking my first integration.

1-3

Chapter 1

Running the Sample Integrations

What Results Do You See

• You receive the following response in your browser:

{

"Message" : "Invoking my first integration.",

"Welcome" : "\"Welcome to ICS!!! Echo was successful.\""

}

How To Monitor

In the upper left corner, click the hamburger menu.

In the navigation pane, click the icon, then click the Monitoring diagram.

By default, the Dashboard page displays overall system status, including the percentage of successful messages, total number of messages, total number of successful messages, and total number of failed messages. Details about currently used connections, currently activated integrations, and scheduled integrations are also provided. You can also view the activity stream and download diagnostic logs and incident reports. From the Integration Health dropdown menu, you can view overall system health and design time metrics.

Click Activity Stream to view details about the invocation.

In the navigation pane, click Tracking and note that the integration is listed as completed.

In the navigation pane, click Integrations and note the status of the message processed.

How To View

Click the icon.

Click the Integrations box.

Click the Echo integration.

A read-only version of the integration is displayed for viewing. Because the integration is active, it cannot be edited.

1-4

Chapter 1

Running the Sample Integrations

View the flow of the integration.

• A REST Adapter is configured as a trigger (inbound) connection in the integration. The REST Adapter is configured with a resource endpoint of

{message}

and a GET operation. The REST Adapter is triggered when you specify the URL in

How to Run

• A logging message is created and logged to the activity stream. A browser response is sent to you.

Learn More About The Features in this Sample

• Creating Orchestrated Integrations

• REST Adapter Capabilities

• Logging Messages with a Logger Action

• Getting Started with the Mapper

Running the Hello World Sample

This sample demonstrates how to use simple log and email notification actions with a

REST Adapter in an orchestrated integration. The REST Adapter is triggered when you specify a URL. A switch activity with two rules is defined. If you provide an email address and name when triggering the REST Adapter, a browser response and email response are sent to you. If you provide only a name when triggering the REST

Adapter, only a browser response is sent to you. With either switch rule, a logging message is created and logged to the activity stream for viewing. You also track the integration and monitor message status.

1-5

Chapter 1

Running the Sample Integrations

Complexity

None.

Prerequisites

None.

How To Activate

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

In the row for the Hello World sample, click the Activate icon, then click Activate when prompted.

1-6

Chapter 1

Running the Sample Integrations

Wait for the icon to turn green, indicating that it is activated.

How To Run

Enter one of the following URLs in a browser. You can also access these URLs from the Information icon for this integration.

http://hostname:port/integration/flowapi/rest/HELLO_WORLD/v01/names/{name} http://hostname:port/integration/flowapi/rest/HELLO_WORLD/v01/names/{name}?

email={email.address}

For example: https://my_pod.us.company.com:port/integration/flowapi/rest/HELLO_WORLD/v01/ names/Mark https://my_pod.us.company.com:port/integration/flowapi/rest/HELLO_WORLD/v01/ names/[email protected]

What Results Do You See

• If you specified only your name, you receive the following response in your browser:

{

"Hello" : "Mark",

"Message" : "\"Welcome to ICS!!!\"",

"Email" : "\"Email address was not provided.\""

}

• If you specified your name and email address, you receive the following response in your browser:

{

"Hello" : "Mark",

"Message" : "\"Welcome to ICS! Check your email.\"",

"Email" : "[email protected]"

} and you receive a Hello email with the following contents:

Hello Mark,

Welcome to Oracle Integration Cloud Service!

How To Monitor

In the upper left corner of the page, click the menu.

In the navigation pane, click the icon, then click the Monitoring diagram.

1-7

Chapter 1

Running the Sample Integrations

Click Activity Stream to view details about the invocation.

In the navigation pane, click Tracking and note that the Hello World integration instance is listed as completed.

In the navigation pane, click Integrations and note that the message was successfully received and processed without any errors.

How To View

Click the icon.

Click the Integrations box.

Click the Hello World integration.

A read-only version of the integration is displayed for viewing. Because the integration is active, it cannot be edited.

View the flow of the integration:

• A REST Adapter is configured as a trigger (inbound) connection in the integration. The REST Adapter is configured with a resource endpoint of

/ names{name}

and a GET operation. The REST Adapter is triggered when you specify the URL in

How to Run

• A switch activity with two rules is defined:

– If an email address and name are provided in the invocation URL (upper rule), a logging message is created and logged to the activity stream and a notification action is configured with parameters for your name and email address. The message body of the email is also defined in the notification action. A browser response and email response are sent to you.

– If only a name is provided in the invocation (lower rule), a logging message is created and logged to the activity stream. A browser response is sent to you.

1-8

Chapter 1

Running the Sample Integrations

Learn More About The Features in this Sample

• Creating Orchestrated Integrations

• Defining Switch Branches

• REST Adapter Capabilities

• Logging Messages with a Logger Action

• Getting Started with the Mapper

Running the Hello World Invoke Sample

This sample demonstrates how to call and invoke a simple REST web service in an orchestrated integration. The REST Adapter is triggered when you specify a URL. The

Hello World REST Adapter you previously used in the Hello World sample is invoked in the integration. The name and email address response are sent to you in JSON format. A logging message is created and logged to the activity stream for viewing.

You also track the integration and monitor message status.

1-9

Chapter 1

Running the Sample Integrations

Complexity

Minimal.

Prerequisites

The Hello World sample integration must be activated before configuring the connection in

How to Configure

How to Configure

Before you can activate and run this sample, you must configure the connection and security properties of the Sample Hello World Invoke REST Adapter used in this sample.

In the home page, click the Connections diagram.

Click Sample Hello World Invoke.

1-10

Chapter 1

Running the Sample Integrations

Click Configure Connectivity to specify information to connect to the application/ endpoint and process requests.

For Connection Type, select Swagger Definition URL.

For Connection URL, enter the following: https://hostname:port/integration/flowapi/rest/HELLO_WORLD/v01/metadata/ swagger

Click OK.

Click Configure Security.

Enter the username and password that you used to log in to Oracle Integration

Cloud Service, then click OK.

Click Test to test your configuration. A message is displayed that describes the results of the test. If successful, you are ready to activate the integration.

Connection Sample Hello World Invoke was tested successfully.

Click Save, then click Close.

How To Activate

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

In the row for the Hello World Invoke sample, click the Activate icon, then click

Activate when prompted.

Wait for the icon to turn green, indicating that it is activated.

How To Run

Enter one of the following URLs in a browser. You can also access these URLs from the Information icon for this integration.

1-11

Chapter 1

Running the Sample Integrations https://host:port/integration/flowapi/rest/HELLO_WORLD_INVOKE/v01/info?name={Name} https://host:port/integration/flowapi/rest/HELLO_WORLD_INVOKE/v01/info?

name={Name}&email={Email Address}

For example: https://my_pod.us.company.com:port/integration/flowapi/rest/HELLO_WORLD_INVOKE/v01/ info?name=Mark https://my_pod.us.company.com:port/integration/flowapi/rest/HELLO_WORLD_INVOKE/v01/ info?name=Mark&[email protected]

What Results Do You See

If you specified a name and email, you receive the following response in your browser:

{

"Hello" : "mark",

"Message" : "\"Welcome to ICS! Check your email.\"You have successfully called a

REST service!",

"Email" : "[email protected]"

} and you receive a Hello email with the following contents:

Hello Mark,

Welcome to Oracle Integration Cloud Service!

How To Monitor

In the upper left corner of the page, click the menu.

In the navigation pane, click the icon, then click the Monitoring diagram.

Click Activity Stream to view details about the invocation.

In the navigation pane, click Tracking and note that Hello World Invoke is listed as completed. Hello World, which was invoked by Hello World Invoke, has also completed.

1-12

Chapter 1

Running the Sample Integrations

In the navigation pane, click Integrations and note that the messages were successfully received and processed without any errors.

How To View

Click the icon.

Click the Integrations diagram.

Click the Hello World Invoke integration.

A read-only version of the integration is displayed for viewing. Because the integration is active, it cannot be edited.

View the flow of the integration:

• A REST Adapter is configured as a trigger (inbound) connection in the integration. The REST Adapter is configured with a resource endpoint of

/info and a GET operation, and retrieves a name and email address. This REST

Adapter is triggered when you specify the URL in How to Run .

• A logging message is created and logged to the activity stream.

• The Hello World REST Adapter you previously used in the Hello World sample is invoked in the integration. The REST Adapter is configured with a business object of

/name/{name}

, a GET operation, and a request query parameter of email

. The name and email address response are sent to you in

JSON format.

1-13

Chapter 1

Running the Sample Integrations

Learn More About The Features in this Sample

• Creating Orchestrated Integrations

• REST Adapter Capabilities

• Logging Messages with a Logger Action

• Getting Started with the Mapper

Running the Hello World Data Map Invoke Sample

This sample demonstrates how to call and invoke a simple REST web service using the Map Data integration pattern. The REST Adapter is triggered when you specify a

URL. The Hello World Invoke REST Adapter is invoked in the integration. The name and email address response are sent to you in JSON format. A logging message is created and logged to the activity stream for viewing. You also track the integration and monitor message status.

1-14

Chapter 1

Running the Sample Integrations

Complexity

Minimal.

Prerequisites

The Hello World sample integration must be activated before configuring the connection in

How to Configure

How to Configure

Before you can activate and run this sample, you must configure the connection and security properties of the Sample Hello World Invoke REST Adapter used in this sample.

In the home page, click the Connections diagram.

Click Sample Hello World Invoke.

Click Configure Connectivity to specify information to connect to the application/ endpoint and process requests.

For Connection Type, select Swagger Definition URL.

For Connection URL, enter the following:

https://hostname:port/integration/flowapi/rest/HELLO_WORLD/v01/metadata/ swagger

Click OK.

Click Configure Security.

Enter the username and password that you used to log in to Oracle Integration

Cloud Service, then click OK.

Click Test to test your configuration. A message is displayed that describes the results of the test. If successful, you are ready to activate the integration.

Connection Sample Hello World Invoke was tested successfully.

Click Save, then click Close.

How To Activate

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

1-15

Chapter 1

Running the Sample Integrations

In the row for the Hello World Data Map Invoke sample, click the Activate icon, then click Activate when prompted.

Wait for the icon to turn green, indicating that it is activated.

How To Run

Enter one of the following URLs in a browser.

https://hostname:port/integration/flowapi/rest/HELLO_WORLD_MAP_DATA_INVOKE/v01/ info?name={Name} https://hostname:port/integration/flowapi/rest/HELLO_WORLD_MAP_DATA_INVOKE/v01/ info?name={Name}&email={Email Address}

For example: https://my_pod.us.company.com:port/integration/flowapi/rest/

HELLO_WORLD_MAP_DATA_INVOKE/v01/info?name=mark https://my_pod.us.company.com:port/integration/flowapi/rest/

HELLO_WORLD_MAP_DATA_INVOKE/v01/info?name=mark&[email protected]

What Results Do You See

• If you specified only your name, you receive the following response in your browser:

{

"Hello" : "mark",

"Message" : "\"Welcome to ICS!!!\"You have successfully called a REST service!",

"Email" : "\"Email address was not provided.\""

}

• If you specified your name and email address, you receive the following response in your browser:

{

"Hello" : "mark",

1-16

Chapter 1

Running the Sample Integrations

"Message" : "\"Welcome to ICS! Check your email.\"You have successfully called a REST service!",

"Email" : "[email protected]"

} and you receive a Hello email with the following contents:

Hello mark,

Welcome to Oracle Integration Cloud Service !

How To Monitor

In the upper left corner of the page, click the menu.

In the navigation pane, click the icon, then click the Monitoring diagram.

Click Activity Stream to view details about the invocation.

In the navigation pane, click Tracking and note that the Hello World Map Data

Invoke instance is listed as completed. Hello World, which was invoked by Hello

World Map Data Invoke, has also completed.

In the navigation pane, click Integrations and note that the messages were successfully received and processed without any errors.

How To View

Click the icon.

1-17

Chapter 1

Running the Sample Integrations

Click the Integrations diagram.

Click the Hello World Data Map Invoke integration.

A read-only version of the integration is displayed for viewing. Because the integration is active, it cannot be edited.

View the flow of the integration:

• A REST Adapter is configured as a trigger (inbound) connection in the integration. The REST Adapter is configured with a resource endpoint of

/info and a GET operation, and retrieves a name and email address. The REST

Adapter is triggered when you specify the URL in How to Run .

• A logging message is created and logged to the activity stream.

• The Hello World Invoke REST Adapter is invoked in the integration. The

REST Adapter is configured with a business object of

/name/{name}

, a GET operation, and a request query parameter of email

. The name and email address response are sent to you in JSON format.

Learn More About The Features in this Sample

• Creating an Integration

• REST Adapter Capabilities

• Getting Started with the Mapper

Running the File Transfer Sample

This sample demonstrates how to read an opaque file from a "

" directory and write the file to an "

/upload

" directory in a scheduled orchestrated integration. An FTP

Adapter reads the file from the

directory and another FTP Adapter writes the file to the

/upload

directory. An assign action is configured to assign variables for the file name and file size. A logging message is created to indicate that the file name has been read. The message is logged to the activity stream for viewing. You also track the integration and monitor message status.

1-18

Chapter 1

Running the Sample Integrations

Complexity

Medium.

Prerequisites

None.

How To Activate

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

In the row for the File Transfer sample, click the Activate icon, then click Activate when prompted.

Wait for the icon to turn green, indicating that it is activated.

How to Configure

Before you can activate and run this sample, you must configure the connection and security properties of the Sample FTP connection FTP Adapter used in this sample.

In the home page, click the Connections diagram.

Click Sample FTP connection.

Click Configure Connectivity to specify information to connect to the application/ endpoint and process requests.

For FTP Server Host Address, enter speedtest.tele2.net.

For FTP Server Port, enter

Click OK.

1-19

Chapter 1

Running the Sample Integrations

Click Configure Security.

For Security Policy, select FTP Server Access Policy.

For Username, enter anonymous

Enter the same password twice. You can use any password.

Click OK.

Click Test to test your configuration. A message is displayed that describes the results of the test. If successful, you are ready to activate the integration.

Connection Sample FTP connection was tested successfully.

Click Save, then click Close.

How To Run

From the Actions menu for the integration, select one of the following options:.

• Select Submit Now to run the scheduled integration immediately:

View the following message at the top of the page. You are ready to monitor the results of the file transfer.

Submit Now request to run integration File Transfer sample

(verion_number) was submitted successfully with request id number.

• Select Add Schedule to schedule a time at which to run the integration:

The Run File Transfer sample page is displayed.

Accept the default values for Type (Basic) and Frequency (Only Once).

For This schedule runs, click the time and select Modify start date.

Use the Calendar icon to specify a soon-to-occur start time, and click OK.

Click Save, then click Close.

The Schedule and Future Runs page is displayed.

Click Start Schedule.

The time at which the integration is scheduled to run is displayed at the bottom of the page.

1-20

Chapter 1

Running the Sample Integrations

When the scheduled time passes, click the refresh icon. The scheduled integration is no longer listed, indicating that it has run.

Click Close.

How To Monitor

In the upper left corner of the page, click the menu.

In the navigation pane, click the icon, then click the Monitoring diagram.

Click Activity Stream to view details about the scheduled integration. The log indicates the 1 KB file was uploaded to the

/upload

directory.

In the navigation pane, click Tracking and note that the File Transfer sample integration instance is listed as completed. You can see the filename and file size, which enables you to look for particular files in case of problems.

In the navigation pane, click Integrations and note that the message was successfully received and processed without any errors. For this example,

Schedule is not defined is displayed because this scheduled integration was invoked with the Submit Now option.

1-21

Chapter 1

Running the Sample Integrations

How To View

Click the icon.

Click the Integrations diagram.

Click the File Transfer integration.

A read-only version of the integration is displayed for viewing. Because the integration is active, it cannot be edited.

View the flow of the integration:

• The Schedule icon indicates that this is a scheduled orchestrated integration.

The schedule invokes this integration.

• An FTP Adapter (ReadFile) is configured to read a file in binary mode from the

directory of the server you specified in the Connections page. No schema is defined for this file transfer, so it is treated as an attachment.

• A logging message is created to indicate that the file name has been read.

The message is logged to the activity stream.

• An assign action is configured to assign variables for the file name and file size. This enables you to track issues based on filename and size.

• An FTP Adapter (WriteFile) is configured to write a file to the

/upload

directory on the same server that matches the file name pattern of

1KB%yyMMddHHmmssSS

%.zip

• A logging message is created to indicate the file name has been uploaded to the

/upload

directory. The message is logged to the activity stream.

Learn More About The Features in this Sample

• Scheduling Integration Runs

• FTP Adapter Capabilities

• Creating Orchestrated Integrations

• Logging Messages with a Logger Action

• Assigning Values to Scalar Variables in an Assign Action

• Getting Started with the Mapper

1-22

Chapter 1

Running the Sample Integrations

Running the Incident Details from Service Cloud Sample

This sample demonstrates how to get incident details from the Oracle Service Cloud for an incident ID and send the incident details to the caller as a response. The REST

Adapter is triggered when you specify a URL. The Oracle RightNow Cloud Adapter is invoked in the integration. The Oracle RightNow Cloud Adapter is configured to get incident details from the Oracle Service Cloud. The incident response is returned to you. A logging message is created and logged to the activity stream for viewing. You also track the integration and monitor message status.

Complexity

Medium.

Prerequisites

To run this sample, you must first subscribe to Oracle RightNow Cloud and configure an Oracle RightNow Cloud Adapter connection. After subscribing, you receive the

1-23

Chapter 1

Running the Sample Integrations

WSDL, username, and password to specify for the Oracle RightNow Adapter on the

Connections page. See Creating an Oracle RightNow Cloud Adapter Connection.

How To Activate

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

In the row for the Incident Details from Service Cloud sample, click the Activate icon, then click Activate when prompted.

Wait for the icon to turn green, indicating that it is activated.

How To Run

Enter the following URL in a browser with a valid incident ID value: https://hostname:port/integration/flowapi/rest/SAMPL_INCID_DETAI_FROM_SERVI_CLO/v01/ incident/12

For example: https://my_pod.us.company.com:port/integration/flowapi/rest/

SAMPL_INCID_DETAI_FROM_SERVI_CLO/v01/incident/12

What Results Do You See

You receive the following incident details response in your browser from the Oracle

Service Cloud:

{

"IncidentName" : "Survey Feedback",

"LookupName" : "111206-000001",

"CreatedTime" : "2011-12-06T22:35:11.000Z",

"UpdatedTime" : "2011-12-06T22:35:11.000Z"

}

1-24

Chapter 1

Running the Sample Integrations

How To Monitor

In the upper left corner of the page, click the menu.

In the navigation pane, click the icon, then click the Monitoring diagram.

Click Activity Stream to view details about the incident ID.

In the navigation pane, click Tracking and note that the Incident details from

Service Cloud integration instance is listed as completed.

In the navigation pane, click Integrations and note that the message was successfully received and processed without any errors.

How To View

Click the icon.

Click the Integrations diagram.

Click the Incident details from Service Cloud integration.

A read-only version of the integration is displayed for viewing. Because the integration is active, it cannot be edited.

View the flow of the integration:

• A REST Adapter is configured as a trigger (inbound) connection in the integration. The REST Adapter is configured with a resource endpoint of

/ incident{id}

and a GET operation, and retrieves the incident ID. This REST

Adapter is triggered when you specify the URL in How to Run .

1-25

Chapter 1

Running the Sample Integrations

• A logging message is created and logged to the activity stream.

• The Oracle RightNow Cloud Adapter is invoked in the integration. The adapter is configured with an incident business object and a CRUD Get operation to get incident details from the Oracle Service Cloud. The incident response is returned to you.

Learn More About The Features in this Sample

• Creating Orchestrated Integrations

• REST Adapter Capabilities

• Logging Messages with a Logger Action

• Getting Started with the Mapper

• Oracle RightNow Cloud Adapter Capabilities

1-26

Chapter 1

About Oracle Integration Cloud Service

Oracle Integration Cloud Service is a complete, secure, but lightweight integration solution that enables you to connect your applications in the cloud. It simplifies connectivity between your applications and connects both your applications that live in the cloud and your applications that still live on premises. Oracle Integration Cloud

Service provides secure, enterprise-grade connectivity regardless of the applications you are connecting or where they reside.

Oracle Integration Cloud Service provides native connectivity to Oracle Software as a

Service (SaaS) applications, such as Oracle Sales Cloud, Oracle RightNow Cloud, and so on. Oracle Integration Cloud Service adapters simplify connectivity by handling the underlying complexities of connecting to applications using industry-wide best practices. You only need to create a connection that provides minimal connectivity information for each system. Oracle Integration Cloud Service lookups map the different codes or terms used by the applications you are integrating to describe similar items (such as country or gender codes). Finally, the visual data mapper enables you to quickly create direct mappings between the trigger and invoke data structures. From the mapper, you can also access lookup tables and use standard

XPath functions to map data between your applications.

Once you integrate your applications and activate the integrations to the runtime environment, the dashboard displays information about the running integrations so you can monitor the status and processing statistics for each integration. The dashboard measures and tracks the performance of your transactions by capturing and reporting key information, such as throughput, the number of messages processed successfully, and the number of messages that failed processing. You can also manage business identifiers that track fields in messages and manage errors by integrations, connections, or specific integration instances.

About Oracle Integration Cloud Service Concepts

The following topics describe each of the components required to create an end-toend 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.

Topics

•

About Oracle Integration Cloud Service Connections

•

About Oracle Integration Cloud Service Integrations

•

About Mappings

•

About Oracle Integration Cloud Service Enrichments

•

About Oracle Integration Cloud Service Lookups

•

About Oracle Integration Cloud Service Packages

•

About Agents and Integrations Between On-Premises Applications and Oracle

Integration Cloud Service

1-27

Chapter 1

About Oracle Integration Cloud Service Concepts

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. A connection includes the additional information required by the adapter to communicate with a specific instance of an application (this can be referred to as metadata or as connection details). 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.

Video

Connection Creation

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

Adapter

Adobe eSign Adapter

Concur Adapter

DB2 Adapter

DocuSign Adapter

Eventbrite Adapter

Evernote Adapter

Facebook Adapter

File Adapter

FTP Adapter

Gmail Adapter

Google Calendar Adapter

Google Task Adapter

JMS Adapter

LinkedIn Adapter

Microsoft Calendar Adapter

Microsoft Contact Adapter

Microsoft Email Adapter

Microsoft SQL Server Adapter

MailChimp Adapter

MySQL Adapter

Oracle Advanced Queuing (AQ) Adapter

Oracle Commerce Cloud Adapter

Oracle CPQ Cloud Adapter

Oracle Database Adapter

Oracle E-Business Suite Adapter

Oracle Field Service Adapter

Oracle Eloqua Cloud Adapter

For Information

Using the Adobe eSign Adapter

Using the Concur Adapter

Using the DB2 Adapter

Using the DocuSign Adapter

Using the Eventbrite Adapter

Using the Evernote Adapter

Using the Facebook Adapter

Using the File Adapter

Using the FTP Adapter

Using the Gmail Adapter

Using the Google Calendar Adapter

Using the Google Task Adapter

Using the JMS Adapter

Using the LinkedIn Adapter

Using the Microsoft Calendar Adapter

Using the Microsoft Contact Adapter

Using the Microsoft Email Adapter

Using the Microsoft SQL Server Adapter

Using the MailChimp Adapter

Using the MySQL Adapter

Using the Oracle Advanced Queuing (AQ)

Adapter

Using the Oracle Commerce Cloud Adapter

Using the Oracle CPQ Cloud Adapter

Using the Oracle Database Adapter

Using the Oracle E-Business Suite Adapter

Using the Oracle Field Service Adapter

Using the Oracle Eloqua Cloud Adapter

1-28

Chapter 1

About Oracle Integration Cloud Service Concepts

Adapter

Oracle ERP Cloud Adapter

Oracle HCM Cloud Adapter

Oracle JD Edwards EnterpriseOne Adapter

Oracle Logistics Adapter

Oracle Messaging Cloud Service Adapter

Oracle NetSuite Adapter

Oracle Responsys Adapter

Oracle RightNow Cloud Adapter

Oracle Sales Cloud Adapter

Oracle Siebel Adapter

Oracle Utilities Adapter

REST Adapter

Salesforce Adapter

SAP Adapter

SAP Ariba Adapter

Oracle SOAP Adapter

SuccessFactors Adapter

SurveyMonkey Adapter

Trello Adapter

Twilio Adapter

Twitter Adapter

For Information

Using the Oracle ERP Cloud Adapter

Using the Oracle HCM Cloud Adapter

Using the Oracle JD Edwards EnterpriseOne

Adapter

Using the Oracle Logistics Adapter

Using the Oracle Messaging Cloud Service

Adapter

Using the Oracle NetSuite Adapter

Using the Oracle Responsys Adapter

Using the Oracle RightNow Cloud Adapter

Using the Oracle Sales Cloud Adapter

Using the Oracle Siebel Adapter

Oracle Utilities Adapter

Using the REST Adapter

Using the Salesforce Adapter

Using the SAP Adapter

Using the SAP Ariba Adapter

Using the SOAP Adapter

Using the SuccessFactors Adapter

Using the SurveyMonkey Adapter

Using the Trello Adapter

Using the Twilio Adapter

Using the Twitter 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.

1-29

Chapter 1

About Oracle Integration Cloud Service Concepts

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

1-30

Chapter 1

About Oracle Integration Cloud Service Concepts

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.

Video

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.

1-31

Chapter 1

About Oracle Integration Cloud Service Concepts

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.

1-32

Chapter 1

About Oracle Integration Cloud Service Concepts

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.

Video

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:

Map request data between the source data structure and target data structure.

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.

Map response data between the source data structure and target data structure.

Click Close.

1-33

Chapter 1

About Oracle Integration Cloud Service Concepts

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.

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.

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

1-34

Chapter 1

About Oracle Integration Cloud Service Concepts

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.

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

1-35

Chapter 1

About Oracle Integration Cloud Service Concepts

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.

Video

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

1-36

Chapter 1

About Oracle Integration Cloud Service Concepts

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.

See

Managing Packages

and Creating an Integration .

Video

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

Oracle Integration Cloud Service provides an agent framework that 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, which may bring the payload down to 512 KB in size.

The on-premises 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

The 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

1-37

Chapter 1

About Oracle Integration Cloud Service Concepts 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 onpremises 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 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 agents.

– No ports are opened on the on-premises system for communication.

– All communication is secured using SSL.

– The on-premises agent registers with Oracle Integration Cloud Service over

SSL using the provided Oracle Integration Cloud Service credentials.

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

– The on-premises 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 agent connections are configured by the agent retrieving the configuration details from Oracle Integration Cloud Service.

– The on-premises agent processes requests by pulling messages from Oracle

Integration Cloud Service across SSL.

– The on-premises agent posts responses by pushing messages to Oracle

Integration Cloud Service across SSL.

– All communication is initiated by the on-premises agent.

– No private SOAP-based web services are exposed.

– No existing J2EE container is required to deploy the on-premises 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

1-38

Chapter 1

About Oracle Integration Cloud Service Concepts

– 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 On-Premises Agent

You follow this workflow to use the on-premises agent.

Task Documentation

Create an agent group.

Download and run the on-premises agent installer on your host. During installation setup, you associate the onpremises agent with the agent group.

Create an adapter connection in Oracle

Integration Cloud Service and associate the connection with the agent group.

Creating an Agent Group

Downloading and Running the On-Premises Agent

Installer

Creating a Connection with an Agent Group

1-39

Chapter 1

About Monitoring

Task

Design an integration that uses this connection.

Activate the integration.

Documentation

Creating an Integration

Activating an Integration

See

Managing Agent Groups and the On-Premises Agent and

Monitoring Agents .

Video

About Monitoring

The Oracle Integration Cloud Service dashboard displays information about the current state of all your running integrations.

The dashboard gives you a quick view into the performance metrics for all of your active integrations. The graph includes the total number of messages processed, the average processing time, the number of messages with errors, and the success rate.

The Integrations tab lists metrics for each running integration, and you can view a graph of the metrics for each integration in the list. The dashboard also provides a view of recent activity for running integrations and the ability to download all activities.

Video

About Error Management

You can manage integration errors from the Errors pages in Oracle Integration Cloud

Service. The Errors pages display information about individual integration instances and group the errors by integrations and connections over a specified time period.

You can perform the following tasks from the Errors page and its subpages:

• Search for and display errors by integration name or the total error count over a specific time period

1-40

Chapter 1

About Business Identifiers for Tracking Fields in Messages

• Resubmit errors

• Discard (remove) errors by integration name

• Display errors by connection name over a specific time period

• Discard errors by connection name

• Display errors by integration instance identifier, error location, or time of occurrence over a specific time period

• View the instance in which errors occurred

• View the error message

• View and discard errors by instance ID

• View the audit trail and message payload of a failed integration instance

• View the business identifiers of a failed integration instance

Integration Failure Scenarios

Integrations can fail for the following reasons:

• A call to a target system fails because the target system is down (for a short or long time period).

• A source-to-target transformation or target-to-source transformation fails because of faulty XSL coding, an invalid lookup call, or other system issue.

• A target system call results in a business failure for the following possible reasons:

– Incorrect target application configuration

– Invalid lookup data

– Invalid business data

• A call to a trigger system (with a response message) fails because the trigger system is down.

• An enrichment step fails.

• A publish/subscribe scenario fails.

• Any other Oracle Integration Cloud Service system failure.

See

Managing Errors .

About Business Identifiers for Tracking Fields in Messages

Business identifiers enable you to track payload fields in messages during runtime.

You define up to three business identifiers on payload fields during design time. You designate one field as the primary business identifier field, which enables message fields to be tracked during runtime.

During runtime, the Tracking page displays information about the status of business identifiers and their values in your integrations.

1-41

Chapter 1

Starting Oracle Integration Cloud Service

If you have defined business identifiers in integrations that have failed, you can view details on the Errors page.

See

Assigning Business Identifiers for Tracking Fields in Messages

, Managing

Business Identifiers for Tracking Fields in Messages , and

Managing Errors

Starting Oracle Integration Cloud Service

To get started with Oracle Integration Cloud Service, you must have a user account already set up. You access Oracle Integration Cloud Service through a web browser.

You receive your user account when you subscribe to Oracle Integration Cloud

Service.

To access Oracle Integration Cloud Service:

In a web browser, enter the following URL, where hostname is the name of the host you received in your email after provisioning Oracle Integration Cloud

Service, and port_number is the port number on which the server is listening:

https://hostname:port_number/ics

On the login page, enter your user name and password.

The first page to appear is the home page, which illustrates the typical development workflow and provides links both to the functions of Oracle

Integration Cloud Service and to sources of additional information about each function.

Note:

If your instance is down for maintenance (for example, your instance is being upgraded to a newer release), the following message is displayed:

ICS is in maintenance mode. Try again later.

1-42

Chapter 1

Navigating Oracle Integration Cloud Service

Oracle Integration Cloud Service provides multiple ways to access the different features you use to create and monitor your integrations.

Using the Overlays

Overlays are displayed the first time you log in to Oracle Integration Cloud Service.

Overlays are provided on many of the main pages. Overlays guide you on how to perform tasks such as getting started, creating connections, creating integrations, and so on.

1-43

Chapter 1

Navigating Oracle Integration Cloud Service

Click Got it! to dismiss the overlays.

To enable the overlays again, select Help > Guide Me from the username main menu at the top of the page.

Navigating from the Home Page

The home page provides links to the primary development features of Oracle

Integration Cloud Service: connections, integrations, monitoring, lookups, packages, agents, adapters, and libraries.

1-44

Chapter 1

Navigating Oracle Integration Cloud Service

Using the Navigation Pane

Click navigation pane.

in the upper left corner to show the

The navigation pane provides you with access to all the development features in

Oracle Integration Cloud Service.

Click the appropriate design feature:

1-45

Chapter 1

About Oracle Integration Cloud Service Roles and User Accounts

If You Click...

Designer

Monitoring

Settings

Links to the Following Features are

Displayed...

• Integrations

• Connections

• Lookups

• Packages

• Agents

• Adapters

• Libraries

• Dashboards

• Integrations

• Agents

• Tracking

• Runs

• Errors

• Users (if using on-premises Oracle

Integration Cloud Service)

• Certificates

• Notifications

• Database

• Logging Levels

• Recommendations

• API Platform

Click time.

to return to the Oracle Integration Cloud Service home page at any

About Oracle Integration Cloud Service Roles and User

Accounts

Oracle Integration Cloud Service uses roles to control access to tasks and resources.

A role assigned to a user gives certain privileges to the user.

In addition to the roles and privileges described in Oracle Cloud User Roles and

Privileges in Getting Started with Oracle Cloud, the following role is created for Oracle

Integration Cloud Service: Identity Administrator.

The identity administrator can create more users by creating accounts and assigning roles to users. To add user accounts in Oracle Cloud, see Adding Users and Assigning

Roles in Getting Started with Oracle Cloud.

When you create an Oracle Integration Cloud Service user, you can assign that user the following roles:

Role

Oracle Integration Cloud

Service Users Role

Privileges Provided By This Role

Enables you to access all parts of Oracle Integration Cloud

Service to perform the following tasks:

• Create, deploy, and monitor integrations.

• Upload security certificates.

You can assign this role to developers.

1-46

Chapter 1

About Oracle Integration Cloud Service Roles and User Accounts

Role

Oracle Integration Cloud

Service Monitors Role

Oracle Integration Cloud

Service Runtime Role

Oracle Integration Cloud

Service Administrators Role

Privileges Provided By This Role

Enables you to access Oracle Integration Cloud Service to monitor integrations. Only the Monitoring Dashboard is available with this user role. Note the following restrictions with this role:

• If you click the Integrations, Connections, Lookups,

Packages, or Agents icons on the home page, a

User is not authorized to perform this action

message is displayed.

• The Administration tab in the upper right corner that enables you to upload security certificates is not visible.

Enables you to access runtime services. This role is assigned to a user and uses SOAP/REST to communicate with services at runtime. This role only has privileges to execute a flow. With this user, you can pass the user name and password for this user to invoke SOAP/REST APIs.

A user with this role can log in, but cannot perform any actions in Oracle Integration Cloud Service, and receives a

User is not authorized to perform this action message on the home page.

This role is only available to users that have downloaded and installed the on-premises version of Oracle Integration Cloud

Service. See Using On-Premises Oracle Integration Cloud

Service .

In new environments, when an administrator attempts to add new users for nonadministrator roles, only the Identity Domain Administrator and Integration_SE

Integration Service Based Entitlement Administrator options are available for selection.

As a solution, perform the following steps:

Create an Integration service instance.

In the Roles region of the Add User dialog, select Integration from the Service list and select your instance.

Select the Other Roles check box.

Click >> next to the Service list. Once clicked, the Oracle Integration Cloud

Service roles are populated in the Selected Roles section.

Deselect the roles that are not needed.

1-47

Click Add.

Chapter 1

About Oracle Integration Cloud Service Roles and User Accounts

1-48

Developing Integrations with Oracle

Integration Cloud Service

You develop integrations using a simple but robust set of components, including connections to the applications you are integrating, data mappings, business identifiers, and lookups that map similar objects across the applications with which you share data.

Topics

•

Typical Workflow for Creating Integrations with Oracle Integration Cloud Service

•

Creating Connections

•

Creating Integrations

•

Mapping Data

•

Regenerating a WSDL File for Integrations

•

Creating Lookups

•

Creating the lookupValue Function

•

Importing Map Files

•

Importing and Exporting Components

•

Assigning Business Identifiers for Tracking Messages

•

Managing Packages

•

Scheduling Integration Runs

•

Using Libraries to Manage Functions for Integrations

•

Connecting to Oracle Mobile Cloud Service

•

Connecting to Oracle API Platform Cloud Service

Typical Workflow for Creating Integrations with Oracle

Integration Cloud Service

You follow a very simple workflow to develop integrations in Oracle Integration Cloud

Service. The only prerequisites for creating an integration are that the application connections you need are in place and that any lookups you want to use to map information between applications are created.

2-1

Chapter 2

Creating Connections

Step

Description

Create the connections for the applications you want to integrate. The connections can be reused in multiple integrations and are typically created by the administrator.

(Optional) Create lookups that map the different values used by those applications to identify the same type of object (such as gender codes or country codes).

Create the integration. When you do this, you add trigger and invoke connections, assign business identifiers, and then map the data between the two.

More Information

Creating a Connection

Creating a Lookup

Creating an Integration

Adding a Source Connection

Adding a Target Connection

Assigning Business Identifiers

Mapping Data of Using the Oracle Mapper

Activate the integration.

Monitor the integration on the dashboard.

Track payload fields in messages during runtime.

Manage errors at the integration level, connection level, or specific integration instance level.

Activating an Integration

Viewing the Dashboard

Assigning Business Identifiers and

Tracking

Business Identifiers in Integrations During Runtime

Managing Errors

Creating Connections

You define connections to the specific cloud applications that you want to integrate.

The following topics describe how to define connections:

Topics

•

Creating a Connection

•

Adding a Contact Email

•

Configuring Connection Properties

•

Configuring Connection Security

•

Testing the Connection

•

Editing a Connection

•

Cloning a Connection

•

Deleting a Connection

•

Unlocking a Connection

•

Refreshing Integration Metadata

2-2

Chapter 2

Creating Connections

•

Managing Security Certificates

Creating a Connection

The first step in creating an integration is to create the connections to the applications with which you want to share data.

In the Oracle Integration Cloud Service home page, click Connections.

Click Create.

The Create Connection — Select Adapter dialog is displayed.

Select an adapter from the dialog. You can also search for the type of adapter to use by entering a partial or full name in the Search field, and clicking Search.

The Create New Connection dialog is displayed.

Enter the information to describe the connection.

• Enter a meaningful name to help others find your connection when they begin to create their own integrations. The name you enter is automatically added in capital letters to the Identifier field. If you modify the identifier name, do not include a blank space (for example,

Sales Opportunity

• Select the role (direction) in which to use this connection (trigger, invoke, or both). Only the roles supported by this adapter are displayed for selection.

When you select a role, only the connection properties and security policies appropriate to that role are displayed on the Connections page. If you select an adapter that supports both invoke and trigger, but select only one of those roles, then try to drag the adapter into the section you did not select, you receive an error (for example, configure an Oracle RightNow Cloud Adapter as only an invoke, but drag the adapter to the trigger section).

• Enter an optional description of the connection.

2-3

Chapter 2

Creating Connections

Click Create.

Your connection is created and you are now ready to configure connection details, such as email contact, connection properties, security policies, connection login credentials, and (for certain connections) agent group.

Adding a Contact Email

From the Connection Administrator section of the connection, you can add a contact email address for notifications.

In the Email Address field, enter an email address to receive email notifications when problems occur.

In the upper right corner, click Save.

Configuring Connection Properties

Enter connection information so your application can process requests.

Click Configure Connectivity.

The Connection Properties dialog is displayed.

See the following sections for information about specifying connection properties.

Adapter

Adobe eSign Adapter

Concur Adapter

DB2 Adapter

DocuSign Adapter

Eventbrite Adapter

Evernote Adapter

Facebook Adapter

File Adapter

FTP Adapter

Gmail Adapter

Google Calendar Adapter

Google Task Adapter

JMS Adapter

LinkedIn Adapter

Microsoft Calendar Adapter

Microsoft Contact Adapter

Microsoft Email Adapter

Microsoft SQL Server Adapter

MailChimp Adapter

MySQL Adapter

Oracle Advanced Queuing (AQ) Adapter

Oracle Commerce Cloud Adapter

Oracle CPQ Cloud Adapter

Oracle Database Adapter

For Information

Using the Adobe eSign Adapter

Using the Concur Adapter

Using the DB2 Adapter

Using the DocuSign Adapter

Using the Eventbrite Adapter

Using the Evernote Adapter

Using the Facebook Adapter

Using the File Adapter

Using the FTP Adapter

Using the Gmail Adapter

Using the Google Calendar Adapter

Using the Google Task Adapter

Using the JMS Adapter

Using the LinkedIn Adapter

Using the Microsoft Calendar Adapter

Using the Microsoft Contact Adapter

Using the Microsoft Email Adapter

Using the Microsoft SQL Server Adapter

Using the MailChimp Adapter

Using the MySQL Adapter

Using the Oracle Advanced Queuing (AQ)

Adapter

Using the Oracle Commerce Cloud Adapter

Using the Oracle CPQ Adapter

Using the Oracle Database Adapter

2-4

Chapter 2

Creating Connections

Adapter For Information

Oracle E-Business Suite Adapter

Oracle Field Service Adapter

Oracle Eloqua Cloud Adapter

Oracle ERP Cloud Adapter

Using Oracle E-Business Suite Adapter

Using Oracle Field Service Adapter

N/A

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

Oracle NetSuite Adapter

Oracle Messaging Cloud Service Adapter

Using the Oracle Logistics Adapter

Using the Oracle NetSuite Adapter

Using the Oracle Messaging Cloud Service

Adapter

Using the Oracle Responsys Adapter

Oracle Responsys Adapter

Oracle RightNow Cloud Adapter

Oracle Sales Cloud Adapter

Oracle Siebel Adapter

Oracle Utilities Adapter

REST Adapter

Using the Oracle RightNow Cloud Adapter

Using the Oracle Sales Cloud Adapter

Using the Oracle Siebel Adapter

Using the Oracle Utilities Adapter

Using the REST Adapter

Salesforce Adapter

SAP Adapter

SAP Ariba Adapter

ServiceNow Adapter

Oracle SOAP Adapter

SuccessFactors Adapter

SurveyMonkey Adapter

Trello Adapter

Twilio Adapter

Twitter Adapter

Using the Salesforce Adapter

Using the SAP Adapter

Using the SAP Ariba Adapter

Using the ServiceNow Adapter

Using the SOAP Adapter

Using the SuccessFactors Adapter

Using the SurveyMonkey Adapter

Using the Trello Adapter

Using the Twilio Adapter

Using the Twitter Adapter

Click OK.

You are now ready to configure connection security.

Configuring Connection Security

Configure security for your connection by selecting the security policy and specifying login credentials.

Click Configure Security.

See the following sections for information about selecting the security policy and entering your login credentials.

Adapter

Adobe eSign Adapter

Concur Adapter

DB2 Adapter

DocuSign Adapter

Eventbrite Adapter

Evernote Adapter

For Information

Using the Adobe eSign Adapter

Using the Concur Adapter

Using the DB2 Adapter

Using the DocuSign Adapter

Using the Eventbrite Adapter

Using the Evernote Adapter

2-5

Chapter 2

Creating Connections

Adapter For Information

Facebook Adapter

File Adapter

FTP Adapter

Gmail Adapter

Google Calendar Adapter

Google Task Adapter

Using the Facebook Adapter

Using the FTP Adapter

Using the Gmail Adapter

Using the Google Calendar Adapter

Using the Google Task Adapter

Oracle JD Edwards EnterpriseOne Adapter

Using the JD Edwards EnterpriseOne

Adapter

JMS Adapter

Using the JMS Adapter

LinkedIn Adapter

Microsoft Calendar Adapter

Microsoft Contact Adapter

Using the LinkedIn Adapter

Using the Microsoft Calendar Adapter

Using the Microsoft Contact Adapter

Microsoft Email Adapter

Microsoft SQL Server Adapter

MailChimp Adapter

MySQL Adapter

Oracle Advanced Queuing (AQ) Adapter

Oracle Commerce Cloud Adapter

Oracle CPQ Cloud Adapter

Oracle NetSuite Adapter

Oracle Database Adapter

Oracle E-Business Suite Adapter

Oracle Field Service Adapter

Oracle Eloqua Cloud Adapter

Oracle ERP Cloud Adapter

Oracle HCM Cloud Adapter

Oracle Logistics Adapter

Oracle Messaging Cloud Service Adapter

Using the Microsoft Email Adapter

Using the Microsoft SQL Server Adapter

Using the MailChimp Adapter

Using the MySQL Adapter

Using the Oracle Advanced Queuing (AQ)

Adapter

Using the Oracle Commerce Cloud Adapter

Using the Oracle CPQ Adapter

Using the Oracle NetSuite Adapter

Using the Oracle Database Adapter

Using Oracle E-Business Suite Adapter

Using Oracle Field Service Adapter

Oracle Responsys Adapter

Oracle RightNow Cloud Adapter

Oracle Sales Cloud Adapter

Oracle Siebel Adapter

REST Adapter

Salesforce Adapter

SAP Adapter

SAP Ariba Adapter

ServiceNow Adapter

SuccessFactors Adapter

Oracle SOAP Adapter

SurveyMonkey Adapter

Trello Adapter

Twilio Adapter

Twitter Adapter

Using the Oracle Eloqua Cloud Adapter

Using the Oracle ERP Cloud Adapter

Using the Oracle HCM Cloud Adapter

Using the Oracle Logistics Adapter

Using the Oracle Messaging Cloud Service

Adapter

Using the Oracle Responsys Adapter

Using the Oracle RightNow Cloud Adapter

Using the Oracle Sales Cloud Adapter

Using the Oracle Siebel Adapter

Using the REST Adapter

Using the Salesforce Adapter

Using the SAP Adapter

Using the SAP Ariba Adapter

Using the ServiceNow Adapter

Using the SuccessFactors Adapter

Using the SOAP Adapter

Using the SurveyMonkey Adapter

Using the Trello Adapter

Using the Twilio Adapter

Using the Twitter Adapter

Click OK.

2-6

Chapter 2

Creating Connections

For most adapters, you are now ready to test your connection. For some adapters, you must first configure an agent group.

Testing the Connection

Test your connection to ensure that it is successfully configured.

In the upper right corner of the page, click Test.

Select the type of connection testing to perform:

• Validate and Test: Performs a full validation of the WSDL, including processing of the imported schemas and WSDLs. Complete validation can take several minutes depending on the number of imported schemas and

WSDLs. No requests are sent to the operations exposed in the WSDL.

• Test: Connects to the WSDL URL and performs a syntax check on the WSDL.

No requests are sent to the operations exposed in the WSDL.

If successful, the following message is displayed and the progress indicator shows

100%.

Connection connection_name was tested successfully.

If your connection was unsuccessful, an error message is displayed with details.

Verify that the configuration details you entered are correct.

When complete, click Save, then click Close.

Editing a Connection

You can edit connection settings after creating a new connection.

On the Oracle Integration Cloud Service home page, click Connections.

On the Connections page, search for the connection name.

Select Edit from the connection Actions menu or click the connection name.

The Connection page is displayed.

Make any necessary edits.

If you edit a connection currently used by an active integration, a dialog is displayed indicating that you must re-activate the integration for the connection updates to take effect.

2-7

Chapter 2

Creating Connections

Cloning a Connection

You can clone a copy of an existing connection, even if the connection is locked. This provides a quick way to create a new connection.

On the Oracle Integration Cloud Service home page, click Connections.

On the Connections page, search for the connection name.

Select Clone from the connection Actions menu.

The Clone Connection dialog is displayed.

Enter the connection information.

Click Clone.

Click Edit to configure the credentials of your cloned connection. Cloning a connection does not copy the credentials.

See

Editing a Connection

for instructions.

Deleting a Connection

You can delete a connection from the connection menu.

On the Oracle Integration Cloud Service home page, click Connections.

On the Connections page, search for the connection name.

Click Delete from the connection Actions menu.

2-8

Chapter 2

Creating Connections

The Delete Connection dialog is displayed if the connection is not used in an integration.

Click Yes to confirm deletion.

Unlocking a Connection

When a connection is in edit mode and the browser crashes, the connection becomes locked, which prevents it from being edited.

To unlock the connection:

For example, if you were logged in as icsdeveloper when the browser crashed, log in again as icsdeveloper, and log out. This action unlocks the connection.

On the Oracle Integration Cloud Service home page, click the Connections diagram.

For the connection that is locked, click the menu at the far right, then select

Unlock.

Refreshing Integration Metadata

You can manually refresh the currently-cached metadata available to adapters that have implemented metadata caching. Metadata changes typically relate to customizations of integrations, such as adding custom objects and attributes to integrations. There may also be cases in which integrations have been patched, which results in additional custom objects and attributes being added. This option is similar to clearing the cache in your browser. Without a manual refresh, a staleness check is only performed when you drag a connection into an integration. This is typically sufficient, but in some cases you may know that a refresh is required. For these cases, the Refresh Metadata menu option is provided.

To refresh integration metadata:

Note:

The Refresh Metadata menu option is only available with adapters that have implemented metadata caching.

On the Oracle Integration Cloud Service home page, click Connections.

2-9

Chapter 2

Creating Connections

Locate the connection to refresh.

From the menu at the right, select Refresh Metadata.

A message is displayed indicating that the refresh was successful.

Metadata refresh for connection "connection_type" has been initiated successfully.

Managing Security Certificates

You can manage security certificates in Oracle Integration Cloud Service.

Topics

•

Uploading an SSL Certificate

•

Updating or Deleting an SSL Certificate

Uploading an SSL Certificate

Certificates are used to validate outbound SSL connections. If you make an SSL connection in which the root certificate does not exist in Oracle Integration Cloud

Service, an exception is thrown. In that case, you must upload the appropriate certificate. A certificate enables Oracle Integration Cloud Service to connect with external services. If the external endpoint requires a specific certificate, request the certificate and then upload it into Oracle Integration Cloud Service.

To upload an SSL certificate:

From the Oracle Integration Cloud Service home page, click the

menu in the upper left corner.

Click Settings > Certificates.

All certificates currently uploaded to the trust store are displayed in the Certificates dialog. The Filter By > Type list displays the following details:

• Preinstalled: Displays the certificates automatically installed in Oracle

Integration Cloud Service. These certificates cannot be deleted.

• Uploaded: Displays the certificates uploaded by individual users. These certificates can be deleted and updated.

You can also search for certificates in the Search field. The search results are limited to a maximum of ten records sorted by name for performance and usability reasons. To ensure that your search results are more granular, enter as much of the certificate name as possible.

Click Upload at the top of the page.

2-10

Chapter 2

Creating Connections

In the Upload Certificate dialog box, select the certificate type. Each certificate type enables Oracle Integration Cloud Service to connect with external services.

• Trust Certificate: Use this option to upload a trust certificate.

Enter a unique alias for the certificate.

Click Browse, then select the trust file (for example,

.cer

.crt

) to upload.

• Message Protection Certificate: Use this option to upload a keystore certificate with SAML token support. Create, read, update, and delete (CRUD) operations are supported on this type of certificate.

Enter a unique alias for the certificate.

Click Browse, then select the certificate file (

.cer

.crt

) to upload.

• Identity Certificate: Use this option to upload a certificate for two-way SSL communication.

Click Browse, then select the keystore file (

.jks

) to upload.

Enter the password of the keystore being imported.

Enter the comma-separated list of aliases from the keystore being imported.

Enter the comma-separated list of passwords corresponding to key aliases.

If you want to display the passwords in clear text, select Show Key

Password(s). This enables you to ensure that you are correctly entering a list of keystore passwords.

Click Upload.

Click the certificate name to view details such as the subject of the certificate, the issuer of the certificate, the date the certificate was issued, and the date the certificate expires.

Updating or Deleting an SSL Certificate

You can update or delete certificates you uploaded into Oracle Integration Cloud

Service. You cannot update or delete system certificates automatically included in

Oracle Integration Cloud Service.

To update or delete a certificate:

From the Oracle Integration Cloud Service home page, click the

menu in the upper left corner.

Click Settings > Certificates.

Identify the certificate you want to update or delete through either of the following methods:

Scroll through the complete list or filter the display of system-provided or useruploaded certifications by selecting Filter By > Type > Preinstalled or

Uploaded.

2-11

Chapter 2

Creating Integrations

Search by entering a partial or complete certificate name in the Search field.

To remove search or filter criteria, click the x icon in the banner.

At the far right of the certificate name, click the menu.

To update the certificate, click Update.

Update the certificate as required, such as uploading a new certificate. See

Uploading an SSL Certificate .

Note:

You cannot update an identity certificate. To change an identity certificate, you must first delete and then reupload it.

To delete the certificate, click Delete.

Click Yes when prompted to confirm your selection.

Creating Integrations

Integrations use the connections you created to your applications, and define how information is shared between those applications. You can create new integrations, import integrations, modify or delete integrations, create integrations to publish messages, create integrations to subscribe to messages, and add and remove request and response enrichment triggers. Click one of the following topics for more information.

Topics

•

Editing the Endpoint Information in an Integration

•

Creating an Integration

•

Understanding Integration Patterns

•

Importing a Prebuilt Integration

•

Adding a Trigger (Source) Connection

•

Adding an Invoke (Target) Connection

•

Creating Orchestrated Integrations

•

Creating an Integration to Publish Messages to Oracle Integration Cloud Service

•

Creating an Integration to Subscribe to Oracle Integration Cloud Service

•

Adding Request and Response Enrichments

•

Deleting Request and Response Enrichments

•

Creating Routing Paths for Two Different Invoke Endpoints in Integrations

•

Creating Routing Expression Logic in Both Expression Mode and Condition Mode

•

Deleting Routing Paths

•

Editing the Endpoint Information in an Integration

2-12

Chapter 2

Creating Integrations

Creating an Integration

Creating an integration includes defining the trigger and invoke application connections, and defining how data is mapped between the two applications. The procedure below provides general instructions for creating an integration, with links to more detailed information for certain steps. As you perform each step, the progress indicator changes to let you know how close you are to completing the integration.

If you want to use a lookup table in your data mapping, create the lookup first. See

Creating Lookups for instructions.

To create an integration:

In the Oracle Integration Cloud Service home page, click Integrations.

On the Integrations page, click Create.

The Create Integration - Select a Style/Pattern dialog is displayed.

Select the type of integration pattern applicable to your business needs. See

Understanding Integration Patterns .

The Create New Integration dialog is displayed.

Enter the following information:

Field Description

What triggers this integration?

Note: This field is only displayed if you selected

Orchestration on the

Create Integration - Select a Style/Pattern dialog.

What do you want to call your integration?

Identifier

• Application event or business object: This integration uses an event or a business object to trigger the integration. For example, you create an integration with an Oracle RightNow Adapter as a trigger and an Oracle

Sales Cloud Adapter as an invoke. The Oracle RightNow

Adapter subscribes to an event from the Oracle RightNow application to trigger the integration.

• Schedule: This integration uses a schedule to trigger the integration instead of an adapter. For example, you add an initial invoke adapter to read a trigger file and a second

FTP adapter to download the file for further processing.

After designing this integration, you schedule when to run

it. See Scheduling Integration Runs .

Provide a meaningful name so that others can understand the integration. You can include English alphabetic characters, numbers, underscores, and dashes in the identifier.

Accept the default identifier value. The identifier is the same as the integration name you provided, but in upper case.

2-13

Chapter 2

Creating Integrations

Field

Version

What does this integration do?

Which package does this integration belong to?

Description

Accept the default version number of

01.00.0000

. Or, if you want to change the version number, enter the version using numbers only in this format: xx.xx.xxxx

Integrations are uniquely identified by an identifier and version.

Note the version format of xx.yy.zzzz

, where xx

is the major version and yy.zzzz

is the minor version.

Integrations having the same identifier, but a different major version, can be active at the same time. For example,

INT-A/

1.00.0000

and

INT-A/2.00.0000

can be active at the same time.

When activating an integration while another integration of the same identifier and same major version is already active, the currently activated integration is deactivated prior to activating the selected integration.

For example, if two integrations have the following integration states:

•

INT-A/2.00.0000

- Not active

•

INT-A/2.10.0000

- Not active

Integration

INT-A/2.00.0000

is then activated.

•

INT-A/2.00.0000

is now active.

•

INT-A/2.10.0000

is not active.

Integration

2.10.0000

is then activated.

•

INT-A/2.00.0000

is now not active.

•

INT-A/2.10.0000

is now active.

Provide a meaningful description so that others can understand the integration.

Enter a new or existing package name in which to place your integration. As you enter the initial letters of an existing package, it is displayed for selection. See

Managing Packages

and About Oracle Integration Cloud Service Packages .

Click Create.

The integration designer is displayed with the type of integration pattern you selected in the previous step.

If creating an integration pattern with blank trigger and invoke connections in which to add your own adapters:

Create the trigger connection, as described in

Adding a Source Connection .

Create the invoke connection, as described in

Adding a Target Connection

Map data between the two connections, as described in Mapping Data of

Using the Oracle Mapper.

If creating an integration in which to publish to Oracle Integration Cloud Service:

Create an integration in which you add a trigger adapter to publish messages to Oracle Integration Cloud Service through a predefined Oracle Integration

Cloud Service Messaging invoke, as described in

Creating an Integration to

Publish Messages to Oracle Integration Cloud Service

. No data mapping between the trigger and invoke is permitted.

If creating an integration in which to subscribe to Oracle Integration Cloud Service:

Create an integration in which you add an invoke adapter to subscribe to messages from Oracle Integration Cloud Service through an Oracle

2-14

Chapter 2

Creating Integrations

Integration Cloud Service Messaging trigger, as described in Creating an

Integration to Subscribe to Oracle Integration Cloud Service

Map data between the invoke adapter and the Oracle Integration Cloud

ServiceMessaging trigger to which to subscribe, as described in Mapping Data of Using the Oracle Mapper.

When complete, click Save and then click Close.

You now see your new integration in the Integrations list ready to be activated. See

Activating an Integration for instructions.

Understanding Integration Patterns

You can select from several types of patterns when creating an integration in the

Create Integration - Select a Style/Pattern dialog.

Pattern

Orchestration

Map Data

Publish to ICS

Description

Create a synchronous, asynchronous, or fire-andforget orchestrated integration in Oracle Integration

Cloud Service that uses Oracle BPEL Process

Manager capabilities. Orchestration integration features include the following:

• Switch activities to create multiple routing expressions.

• For-each activities for looping over repeating elements.

• Assign activities for assigning values to scalar variables.

• Ad-hoc mappings on switch branches.

• Callback activities (to end a process and respond back to the sender) and end activities (to end a process without responding back to the sender) in asynchronous integrations.

• Schedule-based integrations

See Creating Orchestrated Integrations

Create an integration with a blank trigger and invoke in which to add your own adapters. You can also create a single routing expression and request and response enrichments, as needed. You cannot create multiple routing expressions. If your integration requires this feature, create an orchestrated integration.

Create an integration in which you add a trigger adapter to publish messages to Oracle Integration

Cloud Service through a predefined Oracle Integration

Cloud Service Messaging invoke. No configuration of the invoke subscriber is required.

The publisher and subscribers participating in this integration pattern can be activated and deactivated independently of each other.

See Creating an Integration to Publish Messages to

Oracle Integration Cloud Service .

2-15

Chapter 2

Creating Integrations

Pattern

Subscribe to ICS

Description

Create an integration in which you add an invoke adapter to subscribe to messages from Oracle

Integration Cloud Service through an Oracle

Integration Cloud Service Messaging trigger. You are prompted to select the publisher to which to subscribe.

You must have already created a publisher to which to subscribe. The publisher does not need to be active, but must already be completely configured.

Any business identifiers defined on fields in the published integration are copied to the subscriber. Any changes made to the published integration’s business identifiers after copying are not reflected in the subscriber. The publisher and subscribers participating in this integration pattern can be activated and deactivated independently of each other.

See Creating an Integration to Subscribe to Oracle

Integration Cloud Service

See

Oracle Integration Cloud Service Messaging

Importing a Prebuilt Integration

You can import prebuilt integrations into your Oracle Integration Cloud Service environment.

There are two types of prebuilt integrations:

• User-created integrations. These are integrations that you or another user created.

• Oracle-created integrations from the Oracle Marketplace. You import integrations from the Oracle Marketplace as part of a package. These integrations are designated with a BUILT BY ORACLE message that is displayed next to the integration name on the Integrations page. You cannot edit these integrations, but you can view their contents, including mappings and business identifiers. You must edit the connections in these integrations to include endpoint credentials relevant to your business requirements. You can also clone these integrations, which enables you to edit the cloned version of the integration.

Importing a User-Created Integration

To import a user-created integration:

In the Oracle Integration Cloud Service home page, click Integrations.

In the upper right corner, click Import.

Click Browse to select the file to import. If you are importing a single integration, select the JAR file to import. If you are importing a package of integrations, select the PAR file to import.

Importing a Prebuilt Integration from Oracle Marketplace

To import a prebuilt integration from Oracle Marketplace.

In the upper right corner of the page, click the Oracle Marketplace icon.

The Oracle Marketplace is displayed.

2-16

Chapter 2

Creating Integrations

Click Applications.

Browse through the list of applications and select the prebuilt integration package to import.

When prompted, select the server to which to upload the prebuilt integration file.

The prebuilt integration is imported as a package file that is visible on the

Packages page in Oracle Integration Cloud Service. If you go to the Integrations page, the individual integrations of that imported package file are designated with a BUILT BY ORACLE message to the right of the integration name.

You can customize the mappings in the prebuilt integrations imported from Oracle

Marketplace. See

Adding Customized Mappings to Prebuilt Integrations

Adding a Trigger (Source) Connection

The trigger (source) connection sends requests to Oracle Integration Cloud Service.

The information required to connect to the application is already defined in the connection. However, you still must specify certain information, such as the business object and operation to use for the request and how to process the incoming data.

To add a trigger connection:

In the Integration Designer, drag a connection from the Connections or

Technologies panel on the right to the Trigger (source) area on the canvas.

The Adapter Endpoint Configuration Wizard for the selected connection is displayed.

See the following guides for instructions:

Adapter

DB2 Adapter

For Information

Using the DB2 Adapter

File Adapter

Using the File Adapter

FTP Adapter

Using the FTP Adapter

Oracle JD Edwards EnterpriseOne Adapter

Using the JD Edwards EnterpriseOne

Adapter

MySQL Adapter

Using the MySQL Adapter

Oracle Advanced Queuing (AQ) Adapter

Using the Oracle Advanced Queuing (AQ)

Adapter

Oracle Commerce Cloud Adapter

Oracle CPQ Cloud Adapter

Using the Oracle Commerce Cloud Adapter

Using the Oracle CPQ Adapter

2-17

Chapter 2

Creating Integrations

Adapter

Oracle Database Adapter

Oracle E-Business Suite Adapter

Oracle Eloqua Cloud Adapter

Oracle ERP Cloud Adapter

Oracle HCM Cloud Adapter

Oracle Logistics Adapter

Oracle Messaging Cloud Service Adapter

Oracle RightNow Cloud Adapter

Oracle Sales Cloud Adapter

Oracle Siebel Adapter

Oracle Utilities Adapter

REST Adapter

Salesforce Adapter

SAP Adapter

ServiceNow Adapter

Oracle SOAP Adapter

For Information

Using the Oracle Database Adapter

Using Oracle E-Business Suite Adapter

Using the Oracle Eloqua Cloud Adapter

Using the Oracle ERP Cloud Adapter

Using the Oracle HCM Cloud Adapter

Oracle Logistics Cloud Adapter

Using the Oracle Messaging Cloud Service

Adapter

Using the Oracle RightNow Cloud Adapter

Using the Oracle Sales Cloud Adapter

Using the Oracle Siebel Adapter

Using the Oracle Utilities Adapter

Using the REST Adapter

Using the Salesforce Adapter

Using the SAP Adapter

Using the ServiceNow Adapter

Using the SOAP Adapter

Adding an Invoke (Target) Connection

Oracle Integration Cloud Service sends requests or information to the invoke (target) connection. The information required to connect to the application is already defined in the connection. However, you still must specify certain information, such as the business object and operation to use for the request and how to process the data.

To add an invoke (target) connection:

In the Integration Designer, drag a connection from the Connections or

Technologies panel on the right to the Invoke (target) area on the canvas.

The Adapter Endpoint Configuration Wizard for the selected connection is displayed.

See the following guides for instructions:

Adapter

Adobe eSign Adapter

Concur Adapter

For Information

Using the Adobe eSign Adapter

Using the Concur Adapter

2-18

Chapter 2

Creating Integrations

Adapter For Information

DB2 Adapter

Using the DB2 Adapter

DocuSign Adapter

Eventbrite Adapter

Evernote Adapter

Facebook Adapter

File Adapter

FTP Adapter

Gmail Adapter

Google Calendar Adapter

Google Task Adapter

JMS Adapter

LinkedIn Adapter

MailChimp Adapter

Microsoft Calendar Adapter

Using the DocuSign Adapter

Using the Eventbrite Adapter

Using the Evernote Adapter

Using the Facebook Adapter

Using the File Adapter

Using the FTP Adapter

Using the Concur Adapter

Using the Google Calendar Adapter

Using the Google Task Adapter

Using the JMS Adapter

Using the LinkedIn Adapter

Using the MailChimp Adapter

Using the Microsoft Calendar Adapter

Microsoft Contact Adapter

Microsoft Email Adapter

Microsoft SQL Server Adapter

MySQL Adapter

Oracle Commerce Cloud Adapter

Oracle CPQ Cloud Adapter

Oracle Database Adapter

Oracle Eloqua Cloud Adapter

Oracle E-Business Suite Adapter

Oracle ERP Cloud Adapter

Using the Microsoft Contact Adapter

Using the Microsoft Email Adapter

Using the Microsoft SQL Server Adapter

Using the MySQL Adapter

Using the Oracle Commerce Cloud Adapter

Using the Oracle CPQ Adapter

Using the Oracle Database Adapter

Using the Oracle Eloqua Cloud Adapter

Using Oracle E-Business Suite Adapter

Using the Oracle ERP Cloud Adapter

Oracle Field Service Adapter

Oracle HCM Cloud Adapter

Oracle JD Edwards EnterpriseOne Adapter

Using the JD Edwards EnterpriseOne

Adapter

Oracle Logistics Adapter

Oracle Messaging Cloud Service Adapter

Using the Oracle Field Service Cloud

Adapter

Using the Oracle HCM Cloud Adapter

Using the Oracle Logistics Cloud Adapter

Using the Oracle Messaging Cloud Service

Adapter

Oracle NetSuite Adapter

Oracle Responsys Adapter

Oracle RightNow Cloud Adapter

Using the Oracle NetSuite Adapter

Using the Oracle Responsys Adapter

Using the Oracle RightNow Cloud Adapter

Oracle Sales Cloud Adapter

Oracle Siebel Adapter

Oracle Utilities Adapter

REST Adapter

Using the Oracle Sales Cloud Adapter

Using the Oracle Siebel Adapter

Using the Oracle Utilities Adapter

Using the REST Adapter

Salesforce Adapter

SAP Adapter

SAP Ariba Adapter

ServiceNow Adapter

Oracle SOAP Adapter

SuccessFactors Adapter

SurveyMonkey Adapter

Trello Adapter

Using the Salesforce Adapter

Using the SAP Adapter

Using the SAP Ariba Adapter

Using the ServiceNow Adapter

Using the SOAP Adapter

Using the SuccessFactors Adapter

Using the SurveyMonkey Adapter

Using the Trello Adapter

2-19

Chapter 2

Creating Integrations

Adapter

Twilio Adapter

Twitter Adapter

For Information

Using the Twilio Adapter

Using the Twitter Adapter

After you configure the connection, the Summary page appears.

Click Done, then click Save.

The connection information appears on the canvas, along with arrows depicting the configured operations. Because of space limitations on the canvas, names of connections that are more than 15 characters are truncated and ellipses are added. If you hover over a name, the complete name is displayed in a tool tip.

Creating Orchestrated Integrations

You can create orchestrated integrations in Oracle Integration Cloud Service that use

Oracle BPEL Process Manager capabilities. Oracle BPEL Process Manager enables you to define how a business process that involves web services is executed. BPEL messages invoke remote services and orchestrate process execution. When designing your integration, you can add switch activities in your integration to create multiple routing expressions. You can create ad-hoc mappings on switch branches. You can also add callback activities (to end an integration and respond back to the sender) and end activities (to end an integration without responding back to the sender) in asynchronous integrations.

•

Creating an Orchestrated Integration

•

Defining Inbound Triggers and Outbound Invokes

•

Defining Ad-Hoc Mappings

•

Importing a Map File into an Orchestrated Integration

•

Adding Actions to an Orchestrated Integration

•

Using XPath Axis and Wildcard Expressions in the Expression Builder

•

Using Lookups in Variable Assignments

•

Defining Fault Aggregation in Parallel Processing Scenarios

•

Assigning Business Identifiers for Tracking Fields

•

Displaying Errors and Warnings in an Integration

2-20

Chapter 2

Creating Integrations

Creating an Orchestrated Integration

This section describes how to create an orchestrated integration. It also provides an overview of the orchestrated integration canvas.

To create an orchestrated integration:

On the Oracle Integration Cloud Service home page, click Integrations.

On the Integrations page, click Create.

The Create Integration — Select a Style/Pattern dialog is displayed.

Select the Orchestration integration pattern.

The Create New Integration dialog is displayed.

Select how you want to trigger the integration. See Understanding Integration

Patterns for details.

•

Application event or business object

•

Schedule

For this example, Application event or business object is selected. See

Scheduling Integration Runs

for details about creating scheduled integrations.

Complete the fields in this dialog, and click Create.

An empty integration canvas with the following sections is displayed:

• The Triggers section in the upper right corner is automatically open to display the available adapters (for example, Oracle RightNow Adapter). Click an adapter to display the number of configured adapters available for adding to an integration. A trigger enables you to create an inbound connection in an integration.

• The empty integration is identified by a START label in which you drag the trigger to define the inbound part of the integration.

• Several icons are provided in the upper left corner of the integration for working with the integration.

– Select:

– Reposition: Select to enter reposition mode, then select the action or invoke in the integration and drag it to a different part of the integration.

You can reposition invokes and assign, function call, map, notification, and

2-21

Chapter 2

Creating Integrations wait actions. You cannot reposition scope actions; stop, return, or error hospital elements; and repeat elements such as for-each, while, switch, and stage file actions. For this example, Assign1 is being moved below

Assign2.

When the action or invoke is moved, the integration design is refreshed.

Any validation errors or warnings caused by the move are displayed in the

Errors palette and on the individual actions or invokes. The Errors palette displays the element name and error/warning count. Hover your cursor or click the high level error warning in the palette. Click Reposition again to return to edit mode to resolve any errors.

– Reset: Click to reset the integration to its normal size and place it on the left side of the page.

• Several icons are provided in the upper right corner of the integration for adjusting the size of the integration.

– Zoom Out: Click to decrease the size of the integration.

– Zoom In: Click to increase the size of the integration.

– Zoom To Fit: Click to make the entire integration visible on the page.

– Home: Click to align the integration in normal size in the upper left corner of the page.

2-22

Chapter 2

Creating Integrations

– Start: Click to reset the integration to its normal size and place it in the middle of the page.

– Multiple Select: Click and then drag the cursor around parts of the integration to select them. This action highlights the selected sections in blue.

– Maximize / Minimize: Click to maximize the size of the orchestration.

Click again to minimize the size of the orchestration.

– A box below these icons shows a scale model of the undefined integration. You can place you cursor within the box or anywhere in the canvas to move your integration. You can also drag parts of the integration (such as switch actions) around the canvas to redraw the integration. However, the order of the integration does not change.

Video Video

Defining Inbound Triggers and Outbound Invokes

To define inbound triggers and outbound invokes:

On the right side of the canvas, click Triggers to expand the panel.

Click the adapter type to display the specific type and number of configured adapters. Synchronous, asynchronous, and fire-and-forget (no response) triggers are supported.

Drag the configured adapter to the large + section within the circle in the integration canvas.

This invokes the Adapter Endpoint Configuration Wizard.

Complete the pages of the wizard to configure the selected adapter. For this example, an Oracle RightNow adapter is selected in which a request opportunity business object and an immediate response are configured.

When complete, a configured trigger is displayed in the canvas. An unconfigured mapper icon is displayed in the middle. Because this trigger was configured to send a response, a return icon is displayed in green in the integration canvas.

Green indicates that design is complete.

2-23

Chapter 2

Creating Integrations

Note:

Asynchronous responses are also supported. You can select the Delayed

(asynchronous) option on the Response page in the Adapter Endpoint

Configuration Wizard for the Oracle RightNow Cloud Adapter. Creating an asynchronous response creates a return (Receive) activity in the integration.

On the right side, the Triggers section is replaced by an Invokes section that enables you to add multiple outbound invoke connections to the integration.

An Actions section is now displayed below Invokes. When expanded, this section displays the following options:

• Assign: Enables you to assign variables to integrations.

• Function Call: Enables you to add JavaScript functions to the integration.

• Logger: Enables you to add log messages to the activity stream and diagnostic logs.

• Map: Enables you to add ad-hoc mappers to the integration.

• Notification: Enables you to send a notification email to relevant users at specific points in the execution of an integration.

• Scope: Enables you to manage a collection of child actions and invokes that can have their own fault handlers.

• Stage File: Enables you to process files in scheduled integrations.

• Switch: Enables you to add a switch activity for defining routing expression branches in the integration.

• For Each: Enables you to loop over a repeating element and execute one or more actions within the scope of the for-each action.

2-24

Chapter 2

Creating Integrations

•

• While: Enables you to loop over actions or invoke connections as long as a specific condition is met.

• Raise Error: Enables you to send failed messages to the error hospital for further analysis.

Fault Return: Enables you to return a fault.

• Callback: Enables you to end a process and return to the trigger. For example, you can add a switch activity and define a branch in which you add a

Callback. If some defined expression logic is not met, this branch is taken.

The integration is stopped and the trigger receives a response indicating that the integration is not continuing.

• Return: Enables you to return an immediate response.

• Stop: Enables you to terminate the integration. No response message is returned to the trigger.

• Wait: Enables you to delay the execution of an integration for a specified period of time.

On the right side of the canvas, click Invokes to expand the panel.

Click the adapter type to display the specific type and number of configured adapters.

Drag the specific configured adapter to the integration canvas. As you do, two large + sections within circles are displayed:

• A section before the request mapper (this is similar to the enrichment feature that you can define in integrations that are not orchestrated).

• A section after the request mapper.

Drop the adapter in the appropriate section. For this example, the invoke is added before the request mapper.

This invokes the Adapter Endpoint Configuration Wizard.

Complete the pages of the wizard to configure the selected adapter. For this example, an Oracle Sales Cloud Adapter named Order with a selected business object is defined for a synchronous response.

When complete, a configured invoke connection is displayed in the canvas.

You can click the trigger and invoke connections to edit or view their contents. If you re-edit the selected connection in the Adapter Endpoint Configuration wizard and click Done (even without making any changes) you are prompted to update the configuration and regenerate the artifacts.

• If you select Yes after making only minor changes, the system validates the flow and displays the warnings and errors (if there are any ) so you can fix any potential problems.

• If you select Yes after making major changes to the trigger connection (for example, changing the message exchange pattern of the trigger from synchronous to asynchronous), all mappings, replies, and stop elements are deleted from the orchestration except for the system-generated reply or stop at the end of the integration. Tracking information is also deleted.

Editing an invoke connection can also result in major change. However, the impact is minimal compared to editing a trigger. Invoke editing does not have flow-wide consequences such as with maps and other nodes being removed.

2-25

Chapter 2

Creating Integrations

You can place your cursor anywhere in the canvas to move the integration as needed. You can also move the integration from within the large box in the upper right corner.

Defining Ad-Hoc Mappings

As you add switches and their associated invoke connections to the switch branches, you can add ad-hoc mappers, as needed. You can also delete the mappers that were automatically created when you added your first trigger to the integration, if they are not needed.

To define ad-hoc mappings:

Delete any mappings that are not needed. For this example, the following mapping is deleted to create two mappings for the defined and otherwise branches that output to the order invoke connection.

On the right side, expand the Actions section.

Drag a Map icon to a branch of the switch activity. For this example, the map is first dragged to the + sign of the defined branch.

The Select Output dialog is displayed.

2-26

Chapter 2

Creating Integrations

Select the endpoint to which to map. For this example, the Order endpoint is selected.

The mapper is displayed.

Map appropriate elements from the source data structure to the target data structure.

When complete, click Close, then click Apply to save your changes.

Drag a Map icon to the otherwise branch of the switch activity.

The Select Output dialog is displayed.

Select the endpoint to which to map, and click Select. For this example, the Order endpoint is also selected.

The mapper is displayed.

Map appropriate elements from the source data structure to the target data structure.

10.

When complete, click Close, then click Apply to save your changes.

Mappings for both branches of the switch activity are now displayed.

• The inbound trigger connection is configured with an opportunity business object.

• A switch activity is defined with two branches:

– If the routing expression for the defined branch resolves to true, the mapping for that data is performed for the outbound invoke connection.

– If the routing expression for the defined branch does not resolve to true, the otherwise branch is taken and the mapping for that data is performed for the outbound invoke connection.

You can click the mappers to display a menu for editing or viewing the mapper. You can also click the invoke connections to edit or view their contents.

2-27

Chapter 2

Creating Integrations

You can make the integration as complex as is required. For example, you can:

• Add additional switches to other parts of the integration.

• Add additional ad-hoc mappings to the branches of the switches.

Importing a Map File into an Orchestrated Integration

You can import an XSL map file that was previously exported from the same integration. This action overwrites the existing mapping file. Once imported, the map file cannot be edited. For example, you can export the map from a specific integration, edit the XSL file as per a user requirement, save it, and import it back into the same integration. You cannot import an XSL map file into an orchestrated integration that was exported from a different integration in Oracle Integration Cloud Service or from an application in Oracle JDeveloper.

Right-click the map in which you want to import an integration, and select More

Actions > Import.

Browse for the map file to import, then click Import. You only import the map file of an exported integration into Oracle Integration Cloud Service. You do not import the entire integration in which the map file is included into Oracle Integration Cloud

Service.

2-28

Chapter 2

Creating Integrations

Adding Actions to an Orchestrated Integration

You can add actions to your integrations.

Topics

•

Looping over Repeating Elements with a For-Each Action

•

Routing Expressions with Switch Branches

•

Managing a Group of Actions and Fault Handlers with a Scope Action

•

Assigning Values to Scalar Variables in an Assign Action

•

Looping Over Actions or Invoke Connections While a Condition is Satisfied with a

While Action

•

Sending Notification Emails During Stages of the Integration with a Notification

Action

•

Delaying Integration Execution for a Specified Time Period with a Wait Action

•

Adding Global Fault Handling to Orchestrated Integrations

•

Catching Faults with a Raise Error Action

•

Processing Files in Scheduled Integrations with a Stage File Action

•

Logging Messages with a Logger Action

•

Adding a Function Call Action

Looping over Repeating Elements with a For-Each Action

The for-each action enables you to loop over a repeating element and execute one or more actions within the scope of the for-each action. The number of loop iterations is based on a user-selected repeating element. For example, you may have an integration in which you have downloaded a number of files and want to loop over the output of the files. The for-each action enables you to perform this task.

Creating a For-Each Action

On the right side of the canvas, click Actions to expand the panel.

Drag the For Each icon to the plus sign where you want to loop over an element.

The For Each dialog is displayed.

Expand the Source tree to select an element.

Drag a repeatable element to the Repeating Element field. This is the element over which to loop.

2-29

Chapter 2

Creating Integrations

Note:

Note the following restrictions:

• The selected element must be repetitive. You can identify repetitive elements by the two-bar icon to the left of the element name.

• Any parent of the selected element must not be repetitive.

• The data type of the selected element must be scalar.

• Global and nonglobal repeated elements can be selected.

• If you have a repeating element within another repeating element (that is, a list within a list), you must first create a for-each action and loop over the parent list. This gives you access to the child list during every iteration.

You can then create a second for-each action within the scope of the first for-each action and loop over the child list.

For this example, the element over which to loop is ICSFile.

Enter a name in the Name field and an optional description of the action in the

Description field.

For every iteration of the loop, there is a single reference to the repeating element

(ICSFile). A current element name file is required for this action to occur.

Enter an alias for the current file of the iteration in the Current Element Name field.

2-30

Chapter 2

Creating Integrations

Note:

If you drag a for-each action into a scheduled integration or the for-each action is not inside a while action, for-each action, scope action, and so on, an additional field called Process items in parallel is visible at the bottom of the dialog. When selected, iterations of the for-each action are run in parallel. For example, if an integration processes a list of files with a for-each loop created over every file, the processing of the entire file is done in parallel for every file.

If a variable is declared outside a for-each loop with Process items in parallel selected and updated within the for-each loop, the last updated value for that variable is available outside of the loop. Also, the degree of parallelism (DOP) is set to

to avoid concurrency issues.

Click Done.

The for-each action is displayed in the canvas. A looping arrow indicates that this action performs repetitive looping.

Drag other actions inside the for-each action to define what should happen during each iteration of the loop. For this example, an assign action is dragged to the

plus sign below the for-each action.

Enter a name for the assign action, and click OK.

Click the Edit icon.

The Expression Builder is displayed. Note that the value you entered in the

Current Element Name field in Step 6 (currentFileName) is displayed as an expandable element in the Source tree.

10.

Expand $currentFileName in the Source tree.

The repeatable element you added in Step 5 (ICSFile) is displayed.

11.

Drag the ICSFile element to the Expression field, and click Close.

2-31

Chapter 2

Creating Integrations

12.

In the Assign dialog, enter a variable name in the Name field, and click Exit

Assignments.

The assign action is added to the scope of the for-each action. After integration activation, the for-each action loops over the assign action for each downloaded file.

Tracking the Status of a For-Each Action During Runtime

You can track the status of the for-each action in the Tracking Details page through the tracking diagram and audit trail for an activated integration. This is only possible if there is a tracking instance.

In the navigation pane, select Monitoring > Tracking.

Click the business identifier value of the integration to track.

The integration flow (including any for-each actions) is displayed. Any for-each action failures are identified by red arrows.

In the upper right corner, click the Actions menu and select View Audit Trail.

Details about processing status (including any for-each actions) are displayed, including any failures. If failures are inside the for-each action, the iteration number and other details are displayed. If processing is successful, no details and counts are displayed.

Routing Expressions with Switch Branches

You can define switch branches to add routing expressions in your integration.

To define switch branches:

On the right side of the canvas, click Actions to expand the panel.

Drag the Switch icon to the integration canvas. As you do, large + sections within circles are displayed that indicate where you can drop the switch activity. For this example, the switch activity is added immediately after the trigger connection.

Note:

Nested switches are supported.

Two branches are automatically created:

• Undefined (first) branch: You must define a routing expression for this branch.

• Otherwise (second) branch: This branch is taken if the routing expression for the initial branch does not resolve to true.

Note:

To add more branches, click the question mark in the switch activity to invoke a menu.

Click the Undefined branch icon.

2-32

Chapter 2

Creating Integrations

Select the Edit icon from the menu that is displayed. This invokes the Expression

Builder.

Define a routing expression, then click Close. XPath version 2.0 functions are supported. Base 64 encode and decode functions that process data confidentially across layers and functions that return boolean results are also supported.

Functions that return nonboolean values are not supported.

For this example, the following expression is defined:

/nssrcmpr:process/nssrcmpr:Contact_CustomObj/rnb_v1_3:LookupName = "Denver"

You can now define different data flows for both the defined and otherwise branches in the switch activity.

Return to the left side of the canvas, and click Invokes to expand the panel.

Drag an adapter to the appropriate + section within the circle. Two are available: one for the defined branch and another for the otherwise branch. For this example, the section for the otherwise branch is selected.

This invokes the Adapter Endpoint Configuration Wizard.

Complete the pages of the wizard to configure the selected adapter.

This creates an extra invoke connection on the otherwise branch. You can use the data from this invoke connection to initiate an order with the endpoint.

2-33

Chapter 2

Creating Integrations

Managing a Group of Actions and Fault Handlers with a Scope Action

You can manage a group of actions with a scope action. The scope action is essentially a collection of child actions and invokes that can have their own fault handlers. The scope action provides the behavior context for the child elements. The elements defined in the parent scope have local visibility inside this scope. Anything that you can do in an integration such as designing invokes, mappings, and actions can be done in a scope action.

Creating a Scope Action

To create a scope action:

On the right side of the canvas, click Actions to expand the panel.

Drag the Scope icon to the appropriate plus sign location in the integration.

Enter a name and optional description when prompted, and click Create.

The action is displayed in the integration.

Drag and design appropriate actions, mappings, and invokes into the scope action.

When you add invokes to a scope, the named faults associated with the invokes are added for selection to the Fault Handler section of the scope. These are faults that the invoke can handle. The uniqueness of the named faults is defined by the

2-34

Chapter 2

Creating Integrations qname of the fault. If there are multiple invokes that define the qname fault, the fault (at runtime) can respond to any invoke. The various invokes cannot be differentiated if their qnames are not unique.

Select appropriate named faults.

You can also define catch all blocks for fault handling through use of the raise error action in the Fault Handler section of the scope action. Catch all blocks are processed if an invoke throws a fault, but there is not a specific catch named for it.

See

Catching Faults with a Raise Error Action

Collapse the scope action by clicking the collapse icon in the upper left corner to condense the view of your integration. You can expand it again by clicking the

expand icon.

Tracking the Status of a Scope Action During Runtime

You can track the status of the scope action in the Tracking Details page through the tracking diagram and audit trail for an activated integration. This is only possible if there is a tracking instance.

In the navigation pane, select Monitoring > Tracking.

Click the business identifier value of the integration to track.

2-35

Chapter 2

Creating Integrations

Depending upon runtime execution, several scope execution states can be displayed in the diagram:

• Scope execution succeeds and is displayed in green. Because the fault handler is not executed, the Fault Handler section of the scope remains hidden.

• Scope execution fails and is displayed in red, but the fault handler succeeds in handling the fault and is displayed in green. Execution continues after the scope. Because the fault handler was executed, the Fault Handler section of the scope is visible.

• Both the scope and fault handler fail. Both are displayed in red. Both the scope and the Fault Handler section are displayed.

In the upper right corner, click the menu and select View Audit Trail. Details about processing status are displayed. For example:

• If scope execution succeeds, details similar to the following are displayed:

Message processed successfully for Trigger GetWeather.

Message entered Scope Scope.

Message processed successfully for Invoke GetOrg.

Message exited Scope Scope.

Message processed successfully for Reply GetWeather.

• If scope execution fails, but the fault handler succeeds in handling the fault, details similar to the following are displayed:

Message processed successfully for Trigger GetWeather.

Message entered Scope Scope.

Error processing message in Invoke GetOrg.

Scope fault handler started.

Scope fault handler ended.

Message exited Scope Scope.

Message processed successfully for Reply GetWeather.

• If both the scope and fault handler fail, details similar to the following are displayed:

Message processed successfully for Trigger GetWeather.

Message entered Scope Scope.

Error processing message in Invoke GetOrg.

Scope fault handler started.

Error processing message in Invoke faultInvoke

OSB-380001: Invoke JCA outbound service failed with application error, except...

See

Tracking Business Identifiers in Integrations During Runtime

for additional details.

Assigning Values to Scalar Variables in an Assign Action

You can assign values to scalar variables in orchestrated integrations using the

Expression Builder.

Note:

Values cannot be assigned to other variable types, such as complex types.

2-36

Chapter 2

Creating Integrations

On the right side of the canvas, click Actions to expand the panel.

Drag the Assign icon to the appropriate plus sign location in the integration canvas.

Enter an assignment name and optional description when prompted by the

Assignments dialog, then click OK.

Enter a name for the assignment in the Name field, then click the Expression

Builder icon at the far right. Assignment names are case sensitive.

Note:

Once you navigate away from the Assign page (for example, go to the

Expression Builder or close the Assign page), you can no longer change the name of the assign variable.

Build an expression, then click Close. See

Creating Routing Expression Logic in

Both Expression Mode and Condition Mode

. The expression is automatically saved in edit mode.

Click Yes when prompted to save your changes.

The expression value is displayed in the Value field.

Click the Add icon to add multiple assignments to the Assign node. You can also define an assignment with a value from a previously defined assignment. In the following example, AccountId (the previously created assignment) is assigned as the value of assignment AccountIdNow.

Click Exit Assignments.

Click Save.

2-37

Chapter 2

Creating Integrations

Variable assignments can be of greater complexity. For example, you can use assignments in switch activities and in maps. For example, in the following orchestration, the next organization ID is assigned.

Click the ASSIGN node. NewOrgID is assigned a value of OrganizationId + 1.0.

OrganizationId is the business object that comes from the trigger element that initiates this orchestration.

View the switch activity in the orchestration. While OrganizationId is less than or equal to 15.0, another assignment is performed in VarNodeInSwitch.

2-38

Chapter 2

Creating Integrations

Click VarNodeInSwitch and note that it reverts to the original value.

You can also map assignment values in the mapper.

If there is an error in your assignments, an identifier is displayed next to the

ASSIGN node and also in the mapper.

You can also configure the primary tracking variable and both custom field tracking variables (update and access values) in the Expression Builder. You can map tracking variables to output variables or create complex expressions for an assign or switch activity. The primary parameter and two custom parameters are available in the From palette, but only the two custom parameters are present on the To palette for the assign activity.

• All tracking variables are of type string (all that assignments support).

• All three tracking variable entries are present even if you choose not to model them. The name and XPath can be empty for tracking.

• Editing or deleting the tracking variables only updates the name and XPath nodes in that particular tracking variable element.

• The tracking variables have static names. Therefore, it is possible to set a tracking variable somewhere in the flow, but not initialize it with a value and a name in the

Tracking dialog.

• The primary tracking variable cannot be assigned any value in between the flow.

2-39

Chapter 2

Creating Integrations

• You cannot create a new variable with the same names as any of the statically name tracking variables.

Looping Over Actions or Invoke Connections While a Condition is Satisfied with a While

Action

The while action enables you to loop over actions or invoke connections as long as a specific condition is met. You define the condition for the while loop in the Expression

Builder. The while action is available in both scheduled and nonscheduled orchestrations.

Creating a While Action

On the right side of the canvas, click Actions to expand the palette.

Drag the While icon to the Plus sign where you want to create a looping condition.

Enter a name and optional description for the while action when prompted, then click OK.

The Expression Builder is displayed.

Expand the Source tree to select an element. You can also add functions and operations.

Drag an element to the New Condition fields. For this example, while the ZIP code equals the value for $result, the integration loops over the condition. As soon as the condition is not met, the looping ends.

Click Exit Condition Builder, then click Yes when prompted to save your changes. The values of the while action are displayed in the canvas.

2-40

Chapter 2

Creating Integrations

If you want to edit the name or expression, click the respective Edit icon.

Otherwise, click to return to the integration canvas.

The while action is displayed in the canvas. A looping arrow indicates that this action performs repetitive looping while the condition is satisfied.

Drag invoke connections or other actions for configuration to the Plus sign that is displayed inside the while action. These invoke connections and actions are executed as long as the condition of the while action is met.

2-41

Chapter 2

Creating Integrations

Note:

Deleting a while action has no impact on downstream processing of the integration because the while action does not have any output. Any changes in the upstream actions in the integration that impact the while condition result in the display of a warning icon on the while action.

Tracking the Status of a While Action During Runtime

During runtime, you can track the status of the while action in the Tracking Details page through the tracking diagram and audit trail for an activated integration. This is only possible if there is a tracking instance.

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Tracking.

Click the business identifier value of the integration to track.

The integration flow (including any while actions) is displayed. Any while action failures are identified by red arrows.

In the upper right corner, click the menu and select View Audit Trail.

Details about processing status (including any while actions) are displayed, including any failures. If failures are inside the while action, the iteration number and other details are displayed. If processing is successful, no details and counts are displayed. Any actions (including any inner while actions) inside the main while action are not recorded.

Message processed successfully for Trigger trigger

Message processed successfully for Assignment init

Message processed successfully for Invoke invoke

Message processing started for While outerwhile

Message processing ended for While outerwhile

Message processed successfully for Reply trigger

Sending Notification Emails During Stages of the Integration with a Notification Action

You can send a notification email to relevant users at specific points in the execution of an integration. You can set the to, from, and subject parts of an email. You can also create the body part of an email using parameters defined in the Expression Builder.

On the right side of the canvas, click Actions to expand the panel.

Drag the Notification icon to the Plus sign where you want to add a notification.

For example, you may define notifications on the two branches of a switch action.

Enter a name and optional description for the notification action when prompted, then click OK.

For the From, To, and Subject fields, click the Expression Builder icons to build the expressions to use. You can also manually enter plain text in the Subject field.

In the Body field, enter a message using plain text, plain HTML formatting that you create in a separate HTML editing tool and paste into this field, or parameters that you create in the table immediately below this field. After creating parameters, enter them inside

{ }

brackets.

2-42

Chapter 2

Creating Integrations

To add a parameter name and value, click the Plus icon in the Parameters section.

Enter a parameter name and description.

Click the Expression Builder icons to define parameter values (for this example,

. and

LookupName

are created).

When complete, the page looks similar to the following:

Click Done.

When the email notification is received during integration runtime, the two parameters of

and

LookupName

are replaced with dynamic values:

All recipients;

This is an automatically generated e-mail from the Complex_Switch_REF_Trigger orchestration.

The ID passed is 20. The corresponding LookupName is TestOrg1.

BR,

Note:

Deleting the notification action does not impact downstream activities because a notification does not have any output. Changes in the upstream activities impact the notification when they are used either in the From, To, or Subject fields or in the body parameters. For example, if the LookupName or ID@id examples used in this section are modified, the parameter assignment become invalid. Or when $lastname or @firstname is deleted, the To field becomes invalid.

Delaying Integration Execution for a Specified Time Period with a Wait Action

The wait action enables you to delay the execution of an integration for a specified period of time. Use this action in scheduled and asynchronous orchestrated

2-43

Chapter 2

Creating Integrations integrations. A typical use for this action is to invoke a specific operation at a certain time. Wait actions are only available in asynchronous and fire-and-forget integrations.

Creating a Wait Action

On the right side of the canvas, click Actions to expand the palette.

Drag the Wait icon to the Plus sign where you want to delay execution of the integration.

Enter the following details when prompted, then click OK.

• Name of the action.

• Optional description of the action.

• Number of hours to wait before executing the integration. Enter a positive integer value, including zero. The maximum value is six hours. This is a required field.

• Number of minutes to wait before executing the integration. Enter a positive integer value between 0 and 59. The hours and minutes values you enter cannot both be zero. This is a required field.

The wait action is added to the integration canvas.

If you want to edit or delete the action, click it and select an option from the menu that is displayed.

Tracking the Status of a Wait Action During Runtime

During runtime, you can track the status of the wait action in the Tracking Details page through the tracking diagram and audit trail for an activated integration. This is only possible if there is a tracking instance.

In the navigation pane, select Monitoring > Tracking.

Click the business identifier value of the integration to track.

2-44

Chapter 2

Creating Integrations

The integration flow (including any wait actions) is displayed.

In the upper right corner, click the menu and select View Audit Trail.

Details about processing status (including any wait actions) are displayed. For example:

Schedule triggered successfully.

Wait one_min triggerd.

Message processed successfully for Invoke weather.

Processing completed successfully.

Adding Global Fault Handling to Orchestrated Integrations

You can add global fault handling to orchestrated integrations. This functionality enables you to direct business faults back to the caller or apply business logic before sending faults to the error handling framework. You can add fault handling to any integration type (for example, asynchronous, synchronous, or scheduled fire-andforget (no response expected)).

Adding a Global Fault

To add a global fault:

Design an orchestrated integration. The integration does not need to be complete.

You can add fault handling at any time. However, the integration must include an invoke connection.

From the menu in the upper right corner, select Global Fault.

The Global Fault Handler page is displayed. The initial trigger in your integration is automatically connected to an initial Error Hospital action that cannot be deleted.

However, you can add and delete other Error Hospital actions. The Error

Hospital action does not respond back to the trigger. Instead, details collected by the Error Hospital action are sent to the error handling framework.

2-45

Chapter 2

Creating Integrations

You can add actions to design specific fault handling logic in the integration. For example, you can add Switch, Stop, or additional Error Hospital actions, as needed.

Select the Actions palette, and drag a Switch action into the integration.

Click the Undefined branch, then select the Edit icon.

The Expression Builder is displayed. In the Source tree, the schedule (trigger) and target fault handling information are both displayed.

2-46

Chapter 2

Creating Integrations

Note:

The Expression Builder includes the following functions under Functions >

ICS for designing fault handling:

• getFaultAsString

(returns the fault as a string value)

• getFaultAsXML

(the fault as an XML element)

• getFaultName

(returns the fault name)

These functions are only available within the Expression Builder in orchestrated integrations.

Build an expression to capture fault handling information. For example:

$TargetApplicationObject1/nssrcmpr:fault/nssrcmpr:details = "ERROR"

Click Close to return to the Global Fault Handler page.

From the Actions palette, drag a Stop action to the Otherwise branch of the switch action.

2-47

Chapter 2

Creating Integrations

The fault handling logic is now complete. For the above example, if an error occurs, error details are captured and sent to the error handling framework (as indicated by the Error Hospital action). If no error occurs, the fault handling stops and nothing is sent to the error handling framework (as indicated by the Stop action).

The Delete icon in the upper right corner of the page enables you to delete the designed faulting handling logic. You can also set integration tracking business identifiers on either the Global Fault Handling page or the integration canvas page.

Click Save.

From the menu in the upper right corner, select Orchestration to return to the integration canvas..

10.

Complete design of the orchestrated integration.

11.

Click Save, then click Close.

12.

Activate the integration.

Tracking the Status of a Global Fault During Runtime

During runtime, you can track the status of global faults in the Tracking Details page through the tracking diagram and audit trail for an activated integration. This is only possible if there is a tracking instance.

In the navigation palette, select Monitoring > Tracking.

Click the business identifier value of the integration to track.

Global fault handling is only invoked if there is a failure in the integration flow.

Failures are identified by red arrows.

2-48

Chapter 2

Creating Integrations

From the menu in the upper right corner, select View Global Fault.

The fault handling logic you designed is displayed in view-only mode.

Click Done.

From the menu in the upper right corner, select View Audit Trail.

Details about where the failure occurred and the global fault handler being triggered are displayed.

Message processed successfully for Trigger trigger.

Message routed through Switch Route Otherwise.

Error processing message in Invoke invoke2

Global fault handler triggered.

In Global Fault Handler Message routed through Switch Route Otherwise

In Global Fault Handler Message processed successfully for Reply trigger

If the global fault handler successfully handled the error, the integration is displayed as COMPLETED on the Tracking page.

Catching Faults with a Raise Error Action

You can send failed messages to the error hospital for further analysis with a raise error action. If the integration contains a defined global fault, the error captured by the raise error action is sent through the global fault and onto the error hospital for analysis. If no global fault is defined, the fault is sent directly to the error hospital for analysis. The raise error action can only be placed inside the fault handler section of a scope action or at the end of a switch action’s condition branch. The raise error action operates as a catch all block and is processed if a fault is thrown by an invoke action in the scope. However, the raise error action does not have a specific catch named for it. The following example describes how to define a raise error action in a scope action.

To catch faults with a raise error action:

Create an integration that includes a scope action. See

Managing a Group of

Actions and Fault Handlers with a Scope Action .

Click Fault Handler on the right side of the scope.

On the right side of the canvas, click Actions to expand the panel.

Drag the Raise Error icon to the plus sign in the scope action.

2-49

Chapter 2

Creating Integrations

Any faults captured by this action are passed to the error hospital for analysis.

Because of this fault, the integration flow is terminated.

Click the < icon to the left of Fault Handler to return to the scope action.

The Raise Error icon is hidden.

Design additional logic in the scope action.

To return to the Raise Error icon, click Fault Handler, then select Default

Handler. The green check mark indicates that this fault handler is defined in the scope action.

Processing Files in Scheduled Integrations with a Stage File Action

You can use the stage file action to process files in scheduled integrations. The stage file action can process each file downloaded by the FTP Adapter. The stage file action can read (and remove any trailer), write, zip, unzip, and list files in a staged location known to Oracle Integration Cloud Service. The stage file action is similar in functionality to adapters. However, unlike adapters, you do not need to create a connection to use the stage file action. The stage file action has no credential

2-50

Chapter 2

Creating Integrations properties and security policies. The stage file action also differs from the File Adapter and FTP Adapter in that it provides the ability to define a file format for read and write operations.

For example, you may include a stage file action in an integration as follows:

• Configure an FTP Adapter with the following settings:

– Download File operation

– Unzip the File option

– Input directory and download directory path

• Because the ZIP file may contain multiple files, configure a for-each action below the FTP Adapter to iterate over repeated elements.

• To read each file from the input directory, configure a stage file action below the for-each action to read each file from the input directory as follows:

– In the Expression Builder, specify the file name and directory from which to read the file.

– Specify the schema file by loading a comma-separated value (CSV) file that contains the data structure.

To configure a stage file action:

On the right side of the canvas, click Actions to expand the panel.

Drag the Stage File icon to the plus sign where you want to perform file actions.

The Configure Stage File Action wizard is displayed.

Complete the fields on the Basic Info page, and click Next.

The Configure Operation page is displayed.

Configuring Stage File Operations

The Configure Operation page enables you to define the file operations to perform.

You can select to list a file, read an entire file, read files in chunked sizes, unzip a file, write a file, or zip a file, You use the Expression Builder to build the specific details of your operation. The Expression Builder shows all upstream sources (including assignments, for-each actions, invoke connections, and so on) for you to specify these details.

From the dropdown list, select the stage file operation to perform. The page refreshes to display fields appropriate to your selection.

• List File (

Table 2-1

)

• Read Entire File (

Table 2-2

)

• Read File in Segments (for chunking files) (

Table 2-3 )

• Unzip File (

Table 2-4

)

•

Write File ( Table 2-5 )

•

Zip File ( Table 2-6 )

2-51

Chapter 2

Creating Integrations

Table 2-1 - List File

Property

Specify the Directory to List Files from

Specify the File Pattern to use

List Files Recursively

Description

Click the Expression Builder icon to build an expression to specify the directory from which to list files.

Specify the pattern of the file name to transfer to the output directory. Click the ? icon for the list of supported patterns.

Select to list the files recursively.

Table 2-2 - Read Entire File

Property

Specify the File Name

Specify the Directory to read from

Remove trailer

Description

Click the Expression Builder icon to build an expression to specify the file name (for example,

/nssrcmpr:schedule/ nssrcmpr:startTime

Note: The file size must be less than 1 MB.

For files greater than 1 MB, use the Read

File in Segments operation.

Click the Expression Builder icon to build an expression to specify the directory from which to read files.

Select to not remove the trailer, to remove the last row, or to remove the last n rows.

Table 2-3 - Read File in Segments

Property

Specify the File Name

Specify the Directory to read from

Segment Size

Remove Trailer

Description

Click the Expression Builder icon to build an expression to specify the file name.

The Read File in Segments option creates a stage file action that includes a scope part.

This enables you to drag actions inside the scope (such as for-each actions, additional stage file actions, and others) for more complex scenarios.

Click the Expression Builder icon to build an expression to specify the directory from which to read.

Specify a file chunking size between 10 and

200 MB.

Chunking files enables large files to be processed, one logical chunk at a time. A logical chunk (segment) is retrieved from a huge file, enabling the file to stay within memory constraints.

Select to not remove the trailer, to remove the last row, or to remove the last n rows.

2-52

Chapter 2

Creating Integrations

Table 2-4 - Unzip File

Property

Specify the Zip File Name

Specify the Zip File Directory

Specify the Directory to Unzip

Description

Click the Expression Builder icon to build an expression to specify the zip file name to read.

Click the Expression Builder icon to build an expression to specify the directory in which to unzip the file.

Click the Expression Builder icon to build an expression to specify the directory in which to unzip files.

Table 2-5 - Write File

Property

Specify the File Name

Specify the Output Directory

Append to Existing File

Description

Click the Expression Builder icon to build an expression to specify the file name.

Click the Expression Builder icon to build an expression to specify the output directory.

Optionally select to append records to the existing file.

Table 2-6 - Zip Files

Property

Specify the File Name

Specify the Directory to zip

Description

Click the Expression Builder icon to build an expression to specify the file name.

Click the Expression Builder icon to build an expression to specify the directory to zip.

When complete, click Next.

The Schema Options page is displayed if you selected a read or write stage file operation.

Defining the Schema File

The Schema Options page enables you to define a schema. This page is displayed if you selected a read or write stage file operation.

Provide the following details.

2-53

Chapter 2

Creating Integrations

Property

Do you want to define a schema for this endpoint?

Do you want to create a new schema or use an existing one?

Description

Select Yes to define a schema format to use for the files to transfer. Select No if a schema is not required and you want to send opaque files (for example, a GIF or

PNG file).

Select an option:

•

Create a new schema from a CSV

file: Select to create a new schema file from a CSV file. On a subsequent page of this wizard, you are prompted to select the CSV file from which to create the schema.

•

Select an existing schema from the

file system: Select an existing schema file. On a subsequent page of this wizard, you are prompted to select the existing schema (XSD) file from the file system.

When complete, click Next.

Defining the Schema Format

Based on your selection on the Schema Options page, the Format Definition page enables you to create a new schema from a comman-separated value (CSV) file or select an existing schema. This page is displayed if you selected a read or write stage file operation.

Follow the instructions below based on the schema option you selected.

•

Create a New Schema from a CSV File ( Table 2-7

)

•

Select an Existing Schema from the File System ( Table 2-8 )

Table 2-7 - Create a New Schema from a CSV File

Element

•

Select the Delimited Data File

•

Enter the Record Name

•

Enter the Recordset Name

Description

Select the delimited comma-separated value

(CSV) file from which to create the schema file. The content of the file is then displayed at the bottom of the page. This field appears if you selected to create a new schema on the

Basic Info page of the wizard.

Enter the record name. This becomes the parent element in the created schema file for the record names selected as column headers from the CSV file.

Enter the recordset name. This becomes the root element of the created schema file.

2-54

Chapter 2

Creating Integrations

Table 2-7 (Cont.) - Create a New Schema from a CSV File

Element

•

Select the Field Delimiter

•

Character Set

•

Optionally Enclosed By

•

Use the First Row as Column

Headers

•

Detach

•

Mark All As Optional

Description

Select one of the following supported file delimiter options:

• Single space

• Comma

• Semicolon

• Tab

• Pipe (for example, Name|City|Country)

Select a character set. The selected value will be used as the encoding format while reading the sample data file.

This value causes occurrences of the selected delimiter to be ignored during processing. For example, when processing the following record:

Fred,"2 Old Street, Old

Town,Manchester",

20-08-1954,0161-499-1718

If the selected Field Delimiter is “,” and the

Optionally Enclosed By value is quot;

(

“

), then the value

2 Old Street, Old

Town,Manchester

is treated as a single record column.

Displays by default the first row of the selected

CSV file as the column headers.

Select to edit the CSV file in a separate window.

Select to mark elements as optional in the schema file. By default, all elements are mandatory. You can also select the data type

(for example, string, byte, integer, and so on) to use for each column in the table and mark specific elements as optional. While this option enables you to select all elements as optional, you must have at least one mandatory element to validate this page. This check box provides a convenient method to select the majority of elements as optional.

Table 2-8 - Select an Existing Schema from the File System

Element

•

Select a New File

•

Selected File Name

•

Select the Schema Element

Description

Select the existing schema file to use. This field appears if you selected an existing schema from the file system.

Displays the selected schema file name.

Select the schema element. This field is displayed after the schema file is selected. The element name is treated as the root element in the uploaded schema file.

2-55

Chapter 2

Creating Integrations

Complete the fields, and click Next.

Review your selections on the Summary page, and click Done.

Reviewing the Stage File Action in the Integration Canvas

Once design is complete, the stage file action is displayed in the integration canvas.

• If you designed a stage file action with a Read File in Segments operation, a scope portion is created. Place your cursor over the icon to display a message indicating that segmentation (chunking) is enabled.

You can drag additional actions into the scope part of the stage file action to perform tasks. For example, you can add a for-each action to the stage file action to process the segmented chunks of large files one record at a time. You can also add child stage file actions to perform further processing on each of the chunks.

However, you cannot configure additional chunking on the child stage file action.

2-56

Chapter 2

Creating Integrations

Note:

If a variable is assigned within the loop of a stage file action that was configured with the Read File in Segments stage file operation (for chunking files), the updated values for that variable are available outside of the loop.

• If you designed a stage file action with an operation other than a Read File in

Segments operation, a scope portion is not included.

Complete your integration design and configure any business identifiers for tracking fields in messages (including file storage-related parameters).

Video

2-57

Chapter 2

Creating Integrations

Logging Messages with a Logger Action

You can log messages to the activity stream and diagnostic logs by adding the logger action at any point in the integration. You create a log message in the logger action that is a static message or variable-populated message in the Expression Builder.

Creating a Logger Action

To create a logger action:

On the right side of the canvas, click Actions to expand the palette.

Drag the Logger icon to the plus sign where you want to begin logging.

Enter a name and optional description, then click OK.

The Logger page is displayed.

Select whether to always log this message or log it only when tracing is enabled.

You can enable tracing when you activate an integration. See

Activating an

Integration .

Specify a static or variable-populated message to be displayed in the activity stream and diagnostic logs. Click the Expression Builder icon to create a message that includes variables. For this example, the logger is being configured to indicate that a specific file name is being read from an FTP server location.

concat(“Filename is: ”,fileName)

Drag and configure additional Logger icons into the integration, as needed. For this example, the another logger is being configured to indicate that a file has been uploaded to a directory location.

concat(“The file ”,fileName, “has been uploaded to “,directory)

When complete, click Close. For this example, two loggers are included in the integration.

Tracking the Status of a Logger Action During Runtime

During runtime, the messages in the loggers are written to the activity stream and diagnostic logs.

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

2-58

Chapter 2

Creating Integrations

Click Activity Stream to view the messages.

FILE_TRANSFER_SAMPLE - LogActivity - Thu May 25 16:03:11 PDT 2017 - The file

1KB170525160309105.zip has been uploaded to /upload 400028

FILE_TRANSFER_SAMPLE - LogActivity - Thu May 25 16:03:07 PDT 2017 - Filename is:

1KB.zip 400028

Click Download Diagnostic Logs to view the messages.

Open the zip file and browser to ics_server1/ics-flow.log

to view the log messages you created.

Adding a Function Call Action

You can add JavaScript functions to the integration.

Creating a Function Call Action

To create a function call action:

Note:

Note the following restrictions when using the function call:

• The function call action has a time out threshold of ten seconds. Any

JavaScript function that executes for more than ten seconds fails with a time out error.

• JavaScript functions are not allowed to make outbound calls to external services. Any outbound calls are blocked and ultimately fail.

• Network, disk access, or thread access functions are not supported.

On the right side of the canvas, click Actions to expand the palette.

Drag the Function Call icon to the Plus sign where you want to add a function.

Enter a name and optional description for the function call action when prompted, then click OK.

You can use the menu to display information about the function call or to delete the function call and return to the Actions palette.

Click the +Function button.

The Select a Function popup appears.

Click a function and click the Select button in the function’s row.

The configuration page is displayed. It shows the details of the selected function including the input and output parameters.

Click the pencil icon in the Value column to use the Expression Builder to configure the input parameters.

Click Validate in the title bar to validate the parameters.

Click Close in the title bar to close the page.

2-59

Chapter 2

Creating Integrations

Tracking the Status of a Function Call Action During Runtime

During runtime, you can track the status of the function call action in the Tracking

Details page through the tracking diagram and audit trail for an activated integration.

This is only possible if there is a tracking instance.

In the navigation pane, select Monitoring > Tracking.

Click the business identifier value of the integration to track.

The integration (including any function call actions) is displayed. Any function call action failures are identified by red arrows.

In the upper right corner, click the menu and select View Audit Trail.

Details about processing status (including any function call actions) are displayed, including any failures.

Message processed successfully for Trigger FF_SOAP

Message processed successfully for Callout callout1

Message processed successfully for Assignment callout_return

Processing completed successfully.

Using XPath Axis and Wildcard Expressions in the Expression Builder

You can include XPath axis and wildcard expressions in actions that support the

Expression Builder (for example, assign and switch actions support the Expression

Builder).

Create an assign action or switch action and navigate to the Expression Builder.

In the Expression field for an assign or switch action, build an expression using either option:

• Wildcard expression:

For this example, a wildcard is entered to select all elements below

Answer

/nssrcmpr:process/nssrcmpr:Answer/*

Or, to select all elements:

• Axis expression:

For this example, descendant

is entered to select all descendants (child, grandchildren, and so on) of the current node. Any descendant with this ID and namespace ( mb_v1_3:ID

) is retrieved by the expression.

/nssrcmpr:process/nssrcmpr:Answer/descendant::mb_v1_3:ID

Axis expressions adhere to the following syntax:

axisname::nodetest[predicate]

The following table provides examples of axis expressions:

2-60

Chapter 2

Creating Integrations

Syntax

child::book attribute::lang child::* attribute::* child::text()

Result

Selects all book

nodes that are children of the current node.

Selects the lang

attribute of the current node.

Selects all element children of the current node.

Selects all attributes of the current node.

Selects all text

node children of the current node.

Selects all children of the current node.

child::node() descendant::book ancestor::book ancestor-or-self::book

Selects all book

descendants of the current node

Selects all book

ancestors of the current node.

Selects all book

ancestors of the current node and the current if it is a book

node.

child::*/child::price

Selects all price

grandchildren of the current node.

Click the Expression Summary icon to validate the expression.

When complete, click Close.

Using Lookups in Variable Assignments

You can create variable assignments that use lookups in the Expression Builder. You must have already created the lookup.

Create a lookup in Oracle Integration Cloud Service. See

Creating Lookups

For this example, a lookup named ZIP_CITY_DVM is created to map the ZIP codes (using a SOAP Adapter) and the city names (using a domain name).

SOAP (Adapter)

80112

85003

80007

80220

SOAPCITY (Domain Name)

Englewood

Phoenix

Arvada

Denver

Create an orchestration into which a SOAP Adapter is added as the trigger.

Drag the Assign icon to the plus sign for the SOAP Adapter in the integration canvas.

Enter an assignment name and optional description when prompted by the

Assignments dialog, then click OK.

2-61

Chapter 2

Creating Integrations

Enter a name for the assignment in the Name field, then click the Expression

Builder icon at the far right.

In the Expression Builder, expand Functions > ICS.

Drag the lookupValue function to the Expression field.

This starts the Build Lookup Function wizard.

Select the lookup table, and click Next. For this example, the lookup created in

Step 1 (ZIP_CITY_DVM) is selected.

Select the source and target columns. For example, select to pass the city to the

ZIP code.

10.

Complete the remaining pages of the wizard, then click Done.

11.

In the Source tree, select the element to map. For this example, ZIP is dragged on top of srcValue in the Expression field.

12.

Click Close.

The completed variable assignment is displayed.

13.

Click Exit Assignments.

14.

In the orchestrated integration, click the mapper icon, then click the Edit icon.

15.

Assign the variable you created to the city, then click Save.

16.

Click Close.

2-62

Chapter 2

Creating Integrations

Defining Fault Aggregation in Parallel Processing Scenarios

Oracle Integration Cloud Service includes a predefined fault object for fault aggregation. This object enables you to catch and aggregate faults in the context of parallel processing in scheduled orchestrated integrations and to send these faults to an external service to define more granular error handling. To define a fault object and aggregate the faults, you must use actions that support looping (for example, for-each loops, while loops, and so on).

Note:

The fault object is only supported with scheduled orchestrated integrations.

Two fault aggregation operations are available for selection in scheduled orchestrated integrations:

• append: Adds a new fault to the end of a fault list.

• clear: Removes all entries in a fault list.

These options are available for selection under the following scenarios:

Location

Top level (that is, outside of any looping actions)

Append Option Allowed?

Yes

Clear Option Allowed?

Yes

2-63

Chapter 2

Creating Integrations

Location

Inside a for-each action with the For Process items in

parallel option selected

Inside a for-each action loop and a while action loop

Inside a stage file action configured with the Read File

in Segments operation

Inside a scope action

Inside a global fault or a named fault (that is, inside a scope fault handler)

Append Option Allowed?

Yes

Clear Option Allowed?

Yes

To configure fault aggregation:

Created a scheduled orchestrated integration.

Create an aggregated fault per the scenarios supported in the above table. For example, create a For-Each action, then drag an Assign action within the loop.

Create an assignment and select faults from the Data Type list.

The page is refreshed to display the Operations list with two options.

Click the Expression Builder icon to build the fault object mapping.

Complete your mapping.

Define an invoke connection to send the aggregated faults to an external service.

2-64

Chapter 2

Creating Integrations

Note:

Changing the name, data type, or both is only allowed during initial creation of the variable while not yet assigned a value.

Assigning Business Identifiers for Tracking Fields

Business identifiers enable you to track payload fields in messages during runtime.

You must assign business identifiers before you can activate an orchestrated integration.

From the menu in the upper right corner, select Tracking to assign business identifiers for tracking fields. See

Assigning Business Identifiers for Tracking Fields in Messages

When complete, click Done.

When the orchestrated integration is complete, click Save, then click Close.

Activate your integration. See Activating an Integration

Manage and monitor your integration. See Monitoring Integrations and

Tracking

Business Identifiers in Integrations During Runtime .

Displaying Errors and Warnings in an Integration

If there are errors or warnings in an integration (for example, an empty or invalid map, a missing tracking attribute, or an invalid assign or switch action), an ERRORS section is displayed on the left side. These errors and warnings prevent you from activating an integration. You must first resolve these issues to activate an integration.

Note:

• For integrations created prior to version 16.4.5, you must first save the integration once to enable error and warning validation functionality.

• Error and warning validation of for-each actions is not supported.

Design an orchestrated integration.

If there are errors or warnings, an Errors section is displayed on the right side.

Click the Errors section to display error and warning details. For this example, an invoke adapter was deleted for which mapping had previously been configured, causing the mapper to be invalidated. In addition, tracking is not configured.

If you return to the Integrations page, note that the status of the integration is

DRAFT. You cannot activate integrations in the DRAFT state.

Return to the integration canvas and resolve any errors and warnings. Once these issues are resolved, the ERRORS section disappears.

2-65

Chapter 2

Creating Integrations

Save the integration and return to the Integrations page. Note that the DRAFT status is replaced with PENDING ACTIVATION. You can now activate the integration.

Creating an Integration to Publish Messages to Oracle Integration

Cloud Service

You can create integrations that enable you to publish messages to Oracle Integration

Cloud Service. Message publishing is accomplished through use of Oracle Integration

Cloud Service Messaging.

To create an integration to publish messages to Oracle Integration Cloud Service:

Note:

Oracle Integration Cloud Service Messaging supports messages of up to 10

MB in size.

Select Publish To ICS in the Create Integration - Select a Style/Pattern dialog, as

described in Creating an Integration .

Complete the fields of the Create New Integration dialog, as described in Creating an Integration .

This creates an integration pattern with a predefined Oracle Integration Cloud

Service Messaging invoke connection that enables you to publish messages to

Oracle Integration Cloud Service.

In the integration designer, drag an adapter from the Connections panel on the right to the trigger (source) area of the canvas. For this example, an Oracle Sales

Cloud Adapter is selected.

The Adapter Endpoint Configuration Wizard is displayed.

On the Basic Info page, enter an endpoint name and optional identifier for this connection.

Click Next.

On the Request page, select a business object (for this example, Account is selected), then click Next.

On the Response page, select None as the response type, then click Next.

On the Summary page, click Done.

The Oracle Sales Cloud Adapter is configured to publish messages to Oracle

Integration Cloud Service through use of Oracle Integration Cloud Service

Messaging. Note that there is no request mapper available with this type of integration pattern.

2-66

Chapter 2

Creating Integrations

Click Save, then click Close.

To subscribe to the message configured in this section, you must now configure

Oracle Integration Cloud Service to act as a publisher. This enables Oracle

Integration Cloud Service to publish the messages to which other adapters can then subscribe. See

Creating an Integration to Subscribe to Oracle Integration

Cloud Service

Creating an Integration to Subscribe to Oracle Integration Cloud

Service

You can create integrations that enable you to subscribe to messages from Oracle

Integration Cloud Service. Message subscription is accomplished through use of

Oracle Integration Cloud Service Messaging.

To create an integration to subscribe to Oracle Integration Cloud Service:

Complete the steps in section

Creating an Integration to Publish Messages to

Oracle Integration Cloud Service to first configure Oracle Integration Cloud Service

as a subscriber to messages from an adapter.

Select Subscribe To ICS in the Create Integration - Select a Style/Pattern dialog,

as described in Creating an Integration .

Complete the fields of the Create New Integration dialog, as described in Creating an Integration . This creates an integration pattern with Oracle Integration Cloud

Service Messaging that enables you to subscribe to messages from Oracle

Integration Cloud Service.

The Select a Publisher dialog is displayed.

Select the integration to which to subscribe, then click Use. For an integration to be displayed for selection, you must first configure Oracle Integration Cloud

Service as a subscriber, as described in Creating an Integration to Publish

Messages to Oracle Integration Cloud Service . Only integrations that are 100%

completed and unlocked are displayed. Integrations that are locked (meaning that they are being edited) are not displayed.

2-67

Chapter 2

Creating Integrations

Drag an adapter to the invoke (target) area of the integration designer. For this example, an Oracle RightNow Cloud Adapter is added.

On the Basic Info page, enter a name and optional identifier for this connection.

Click Next.

On the Operations page, select an appropriate operation and business object, then click Next. For this example, a CRUD Create operation and Organization business object are selected.

On the Summary page, review your changes, then click Done.

The request mapper is available with this type of integration pattern.

10.

Click the Request Mapping icon, then click Create.

2-68

Chapter 2

Creating Integrations

11.

Map source fields to the corresponding target fields. See Mapping Data of Using

the Oracle Mapper.

12.

When complete, click Close, then click Apply to save your changes.

The Oracle RightNow Cloud Adapter is configured to subscribe to messages from

Oracle Integration Cloud Service through use of Oracle Integration Cloud Service

Messaging.

13.

Click Save, then click Close.

14.

Activate the publishing integration described in

Creating an Integration to Publish

Messages to Oracle Integration Cloud Service and the subscribing integration

described in this section. See Activating an Integration

The completed publishing and subscription integrations enable you to:

• Create an object in one application that causes the object to be created in other applications.

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

• Enable additional subscribers to be added or removed without impacting other subscribers or publishers.

Business identifier tracking data is copied when a subscriber is created. If a publishing integration is updated later, you must update the subscribing integration.

For example, assume you create a publishing integration, then create a subscribing integration and select to subscribe to the publishing integration. Select the Tracking icon, and note that the tracking attributes of the selected publishing integration are displayed. Assume you then edit the publishing integration and change the operation of the trigger adapter (as an example), save, and exit the canvas. If you then edit the subscribing integration and click the Tracking icon, note that the business identifier tracking attributes of the publishing integration that are displayed are those that existed before the updates were made. The tracking fields are not updated as per the updated publisher integration. This is the expected behavior.

Adding Request and Response Enrichments

When you create an integration, you also have the option of adding both request and response message enrichment points to the overall integration flow. Enrichments participate in the overall integration flow and can be used in the request and/or response payloads between the trigger and invoke.

To add request and response enrichments:

Design an integration with trigger and invoke connections and request and response mappings. For this example, the integration looks as follows when complete. Note the two enrichment point circles in the design; one appears on the inbound (request) side and the other appears on the outbound (response) side.

2-69

Chapter 2

Creating Integrations

The request and response mappings for this example are as follows:

Mapping

Request

Response

Source

HelloRequest/FirstName sayHelloResponse/ sayHelloReturn

Target

sayHello/name

HelloResponse/Greeting

You are now ready to add enrichments to the integration. For this example, a response message enrichment is added to the Drag and drop an enrichment

source for the response message area. You can also add request message enrichments on the request (inbound) side.

From the Connections panel on the right, drag an adapter to the enrichment area on the response message shown below.

For this example, a SOAP Adapter is dragged to the Drag and drop an

enrichment source for the response message area. This action invokes the wizard for configuring the SOAP Adapter.

Complete the pages of the wizard to configure the SOAP Adapter, then click

Done. For this configuration, a different operation for selecting timestamp details is chosen.

2-70

Chapter 2

Creating Integrations

You are prompted with a dialog to delete any impacted response mappings that you previously configured for the response mapper. The response mapper requires updates because of the enrichment response adapter configuration you just performed.

Click Yes. You recreate the response mappings later in these steps.

Click Save.

A SOAP Adapter icon and response enrichment mapper are added to the response side of the integration. Note that because you deleted the response mappings in the previous step, that icon is no longer shaded in green. This indicates that the response mapper requires configuration.

Click the Response Enrichment Mapping icon between the trigger and invoke.

Click the Create icon that is displayed. This invokes the mapper.

Map source elements to target elements to include a timestamp with the response, then click Save when complete.

The response enrichment mappings are as follows:

Mapping

Response Enrichment

Source

sayHelloResponse/ sayHelloReturn

Target

visitTimestampReq > reqMsg

The Response Mapping icon is displayed in green, indicating that it has been configured.

Click the Response Mapping icon to invoke the mapper again. This mapper requires updates because of the enrichment response mapping you performed.

2-71

Chapter 2

Creating Integrations

10.

Remap the source elements to target elements in the response mapper.

The response mappings are updated. Note that a different source is now mapped to the original target of HelloResponse/Greeting.

Mapping

Response

Source

$ResponseEnrichmentApplic ationObject > visitTimestampResp > respMsg

Target

HelloResponse/Greeting

The Response Enrichment Mapping icon is displayed in green, indicating that it has been reconfigured.

11.

Click Close, then click Apply when complete.

The integration with response enrichments added to the invoke (target) area looks as follows:

12.

Click Save, then click Close when complete.

You are ready to activate the integration. While not demonstrated in this example, you can also configure the enrichment area on the request message shown below by dragging and dropping an adapter to the Drag and drop an enrichment

source for the request message area. This invokes the adapter configuration wizard.

You can also update existing enrichments at a later time, such as the objects selected in the adapter configuration wizard and the enrichment mappings.

See

About Oracle Integration Cloud Service Enrichments .

2-72

Chapter 2

Creating Integrations

Deleting Request and Response Enrichments

You can delete the request and response message enrichment point mappings added to an integration. After deleting the enrichment point mappings, the integration is returned to its original pre-enrichment state.

To delete request and response enrichments:

On the Integration page, select the integration. The integration must not be active.

Click the enrichment area on the request message or response message to delete.

Select the Delete icon that is displayed.

This deletes the mappings.

Click Yes when prompted to confirm.

Click Save, then click Close.

See

About Oracle Integration Cloud Service Enrichments .

Creating Routing Paths for Two Different Invoke Endpoints in

Integrations

You can create an integration in which you define routing paths for two different invoke endpoints. During runtime, the expression filtering logic for the routing paths is evaluated and, based on the results, the path to one of the invoke endpoints is taken.

If the filtering logic for neither routing path is satisfied, then neither invoke endpoint is contacted.

The expression logic works as follows:

• You define an expression filter on the first (upper) invoke endpoint.

• You define either an ELSE condition or an expression filter on the second (lower) invoke endpoint.

During runtime, if the expression filtering logic for the first (upper) invoke endpoint evaluates to true, then the path to that invoke endpoint is taken. If the expression evaluates to false, then that invoke endpoint is skipped, and the path to the second

(lower) invoke endpoint is taken through either an ELSE condition or an expression filter.

In addition to creating routing paths, you also define request and response (and optionally, enrichment) mappings on both invoke endpoints.

To create routing paths for two different invoke endpoints in integrations:

On the Integrations page, select the integration in which to define a routing filter.

Ensure that the integration is fully defined with trigger and invoke connections, business identifier tracking, and mappings.

Click the Filter icon on the trigger side of the integration to create a filtering expression. Routing is created after any defined request enrichment and before the initial request mapping.

2-73

Chapter 2

Creating Integrations

Click the Routing icon in the menu that is displayed.

The Expression Builder is displayed for building routing expressions. The

Expression Builder supports multiple source structures. You can create OR expressions using both source structures. You can also name expressions and calculate expression summaries with the Expression Summary icon. Elements and attributes with and without namespace prefixes are also supported.

You can filter the display of source structures by clicking the Filter link. This enables you to filter on whether or not fields are used and on the type of field

(required fields, custom fields, or all fields). You can also select to filter both required and custom fields together.

Drag an element from the Source area to the Expression field.

Define a value.

For this example, the ClassificationCode element is defined as equal to

Org

. This means that

Org

is retrieved when this expression evaluates to true.

If you want to calculate the expression, click the Expression Summary icon. This shows the summary of the expression and defines a more user-friendly, readable version of the expression you just created.

If that name is not sufficiently user-friendly, copy and paste the expression to the

Expression Name field for additional editing.

Click Close to save your changes.

The defined expression is displayed above the integration. The Filter icon has now changed to indicate that an expression is defined.

2-74

Chapter 2

Creating Integrations

On the right side of the integration, click the Routing Drawer icon to display a graphical routing diagram with two potential paths. The first route that you just defined (the upper trigger and invoke) shows the defined expression above the line. The second route (the lower trigger and invoke) is displayed as a dotted line because it is not yet defined.

You can activate the integration now if additional filtering is not required or define an additional routing filter. For this example, a second route is defined.

10.

Click the bull’s eye icon in the lower trigger icon to define routing on the second trigger and invoke route.

This refreshes the integration to display the lower trigger and invoke route in the integration. The trigger side remains as defined for the first route, but the invoke route is undefined.

11.

Click Show Palette to display the list of available connections and technologies.

12.

Drag an adapter to the invoke (target) area of the integration (for this example, an

Oracle RightNow adapter is added).

The Adapter Configuration Wizard is invoked.

13.

Configure the pages of the wizard for the Oracle RightNow adapter. For this example, the Get operation and Account business object are selected on the

Operations page.

2-75

Chapter 2

Creating Integrations

The integration is now defined for the second invoke. You now need to create a filtering expression for the second invoke.

14.

Click the Filter icon to create a filtering expression.

15.

If no additional expression is required, click the E icon (to create an ELSE condition).

This defines an ELSE condition for the second trigger and invoke. The ELSE condition is taken if the first route evaluates to false (that is ClassificationCode does not equal Org). You can toggle back and forth between the two trigger routes by clicking the adapter icon on the individual line. The line in blue is the currently visible invoke in the integration.

16.

If you want to define your own expression filter for the second route instead of using the ELSE condition, perform the following steps:

Click the Filter icon.

Select Clear Expression to remove the ELSE condition.

2-76

Chapter 2

Creating Integrations

Click Yes when prompted to confirm.

Click the Filter icon again and select the Edit icon to invoke the Expression

Builder as you did in Step 3.

Define an expression.

Click Close to save your changes.

Request and response mappings must now be defined.

17.

Click the Request Mapper icon to define the mapping.

For this example, the following mapping is defined.

Source

process > Organization > Organizationid

Target

Get > Account > ID > id

18.

Click the Response Mapper icon to define the mapping.

For this example, the following mapping is defined.

Source

process > GetResponse > Account > ID >

LookupName

Target

processResponse > Organization > Name

Integration design in now 100% complete.

19.

Activate the integration.

Creating Routing Expression Logic in Both Expression Mode and

Condition Mode

You can create XPath expressions for routing conditions in two different user interface modes:

• Expression mode: This mode provides an interface for creating and viewing the entire XPath expression.

• Condition mode: This mode provides an easier-to-read interface to create and view XPath condition expressions. This mode is useful for business analysts who may be less experienced with XPath expressions.

You can toggle between expression mode and condition mode when creating and viewing your expressions. Elements and attributes for which mapping is required are identified by a blue asterisk (*) to the left of their names. 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 creating an expression, note the following functionality in the tree:

2-77

Chapter 2

Creating Integrations

• Three levels of elements are loaded by default in the tree in the Source area.

When you reach the third level, a Load more link is displayed. Click this link to display all the direct children of that element. Only base types are loaded automatically. To load the extended types of the base type, click the base type, which is identified by a unique icon. This invokes a menu of extended types that you can select to load one by one into the tree.

• Elements in the tree in the Source area that you have already dragged to an expression are identified by green checkboxes. These elements are displayed even if they are deeper than three levels in the tree.

• You can search for an element that is not yet loaded in the tree by entering the name in the Find field and clicking the Search icon. This action loads that specific element into the tree.

This section provides an example of building an expression using both modes.

To create routing expressions in both expression mode and condition mode:

Click the Filter icon on the source side of an integration to create a filtering expression.

Click the Routing icon in the menu that is displayed.

The Expression Builder is displayed for building routing expressions. Expression mode is the default mode.

In the field immediately below Expression Name, optionally enter a short description about the expression you want to build.

Add an element from the Source area on the left side to the expression field immediately below the short description field. If needed, you can also add functions from the Components section.

There are two ways to add an element to the expression field:

2-78

Chapter 2

Creating Integrations

Drag the element from the Source area.

Select the row of the element in the Source area, then click the Move icon in the middle of the page to move the element.

The expression for the selected element is displayed in the expression field

(for this example, the expression for the Country element was added). The selected element is identified by green checkbox in the Source area.

To the right of the added expression, define an operator and a value within single or double quotes (for this example,

= “USA”

is defined).

Click the Expression Summary icon to view a simplified, user-friendly version of the expression. Easy-to-read output is displayed.

2-79

Chapter 2

Creating Integrations

Note:

• To add additional elements to the expression, you can place your cursor in the exact location of the expression, select the row of an element in the

Source area, and click the Move icon. These actions add that element to the exact location of your cursor.

• You can drag an element to the exact location of your cursor in the expression, and the expression of the element is added to the cursor location, and not the location in which you drop the element.

• You can drag an element on top of an existing expression element to replace it.

In the upper right corner, click Condition Mode to view the expression you created in condition mode. Condition mode provides an easy-to-read interface for creating and viewing your expressions.

Note the following details about accessing condition mode:

• Condition mode can only be accessed if the expression field is empty or completely defined with an expression that returns true or false. If you only partially define an expression (for example, you drag an element to the expression field, but forget to define expression logic and a value such as

“USA”

), you receive an error saying that you must provide a valid condition to access condition mode.

• The Condition Mode button toggles to Expression Mode.

Note:

At any time, you can click Expression Mode to view the entire XPath expression.

Click the expression.

This refreshes the page to display icons for adding additional conditions and conditions groups. Groups enable you to combine multiple conditions into a single logical expression.

2-80

Chapter 2

Creating Integrations

Click the Add Condition icon (first icon) to add additional condition expressions.

This creates an additional field for entering additional expression logic. The message Drag and drop or type here is displayed in this field.

10.

Drag an element from the Source area to the first Drag and drop or type here field (for this example, the Country element is again added).

11.

Select an operator (for example, =, >,!=, and so on) and enter a value (for this example,

“Mexico”

is added).

12.

From the Match list, select an option. This list is hidden until at least two conditions are defined.

• Any of: Select if any of the added expressions must be true. This equates to an OR condition in the entire XPath expression shown in expression mode.

• All of: Select if all expressions must be true. This equates to an AND condition in the entire XPath expression shown in expression mode.

2-81

Chapter 2

Creating Integrations

13.

Select the Add Group icon (second icon) to group a series of conditions. This option enables you to build a number of conditions within a single group. The group is identified by the gray outline and the indentation.

14.

Add an element from the Source area.

For this example:

• The DisplayName element is added to the first Drag and drop or type here field.

• The not equal operator (!=) is selected.

• The Country element is added to the second Drag and drop or type here field.

15.

Click the Add Condition icon (first icon) to add an additional condition expression within the group.

For this example:

• The DisplayOrder element is added to the first Drag and drop or type here field.

• The less than operator (<) is selected.

• A value of

is entered in the second Drag and drop or type here field.

16.

Continue building your group condition, as necessary.

2-82

Chapter 2

Creating Integrations

When complete, the expression is displayed. For this example, there are the conditions: if Country is USA OR Country is Mexico OR DisplayName does not equal country and DisplayCount is less than 10, the integration continues.

17.

Click Expression Mode.

Note the entire XPath expression and the expression summary at the bottom. The selected elements are displayed (no matter their level of depth in the tree) and identified by green checkboxes in the Source area.

18.

If you want, you can place your cursor in the XPath expression and edit it as necessary (for example, change

USA

Canada

), then click the Expression

Summary icon to refresh the calculation. If you make an error when editing the

XPath expression (for example, forget to add a double quote to a value), an error message is displayed.

19.

Click Save to view the expression in read-only mode. You can also click Done

Editing at any time during the creation process to view the expression in read-only mode.

20.

Click Close to return to the integration. The user-friendly expression is displayed in the blue banner above the integration.

2-83

Chapter 2

Creating Integrations

Deleting Routing Paths

You can delete routing paths that have been created on different target endpoints in an integration.

There are two methods for deleting routing paths:

• Delete the routing path and expression filter.

• Delete the endpoint and routing path, but retain the expression filter.

Deleting the Routing Path and Expression Filter

To delete the routing path and expression filter:

In the Integrations page, select the integration in which to delete a routing path.

Expand the Routing Drawer icon to display the diagram of routing paths.

Above the integration, select the routing path to delete.

Click the Filter icon.

Select Delete Route from the menu that is displayed.

2-84

Chapter 2

Creating Integrations

Click Yes when prompted to confirm.

This action deletes the routing path, including the expression filter and the request mapping for the selected path. The diagram above the integration shows that the routing path is deleted.

Deleting the Endpoint and Routing Path

To delete the endpoint and routing path:

In the integration, click the target endpoint to delete.

Click Delete in the menu that is displayed.

Click Yes when prompted to confirm.

This action deletes the target endpoint and routing path. The diagram above the integration shows that the routing path is deleted. Within the integration, only the expression remains defined in the integration because it is not using anything from the deleted target endpoint.

Editing the Endpoint Information in an Integration

You can edit the endpoint information in an integration that is not active. The changes that you make can impact your mappings. For example, minor edits such as changing

2-85

Chapter 2

Mapping Data the endpoint description do not delete the existing mappings. Major edits such as changing the selected business objects or operations delete the mappings. In these cases, you must recreate your mappings. Before you save your updates, you are prompted to confirm your changes.

The impact of major and minor endpoint changes on an integration are as follows:

• If a minor change is detected, for example:

– If a map is using either the request or response of the application as a primary input, output, or secondary input, the map is validated.

– If a map is using a fault of the application as a primary input or output, the map is deleted.

– If a map is only using a fault of the application as a secondary input, the secondary input is removed.

• If a major change is detected, for example:

– If a map is using a request, response, or fault of the application as a primary input or output, the map is deleted.

– If a map is only using a request, response, or fault of the application as a secondary input, the secondary input is removed.

The following are examples of major endpoint changes:

• If the application message exchange pattern changes (for example, from synchronous to asynchronous).

• If a root element name or root element namespace of the input request changes.

• If a root element name or root element namespace of the output response changes.

If none of the above changes occur, then the change is considered minor.

On the Oracle Integration Cloud Service home page, click Integrations.

Select the integration to edit.

In the integration, select the trigger or invoke endpoint to edit, then click the Edit icon.

Make appropriate changes in the Adapter Endpoint Configuration Wizard, then click Done.

Select to confirm your changes when prompted. Minor edits do not delete your mappings. Major edits delete your mappings.

Mapping Data

Use the mapper to drag fields from the source structure to the target structure to map elements between the two.

Topics

•

Creating Mappings

•

Modifying Mappings

•

Deleting All Mappings

•

Mapping Faults

2-86

Chapter 2

Mapping Data

•

Adding Customized Mappings to Prebuilt Integrations

•

Removing Customized Mappings from Prebuilt Integrations

•

Regenerating a WSDL File for Integrations

See Mapping Data of Using the Oracle Mapper.

Creating Mappings

You can map fields directly from the source data structure to the target data structure in the mapper.

To create mappings:

In the middle of the integration, click the Mapper icon for the request, response, or fault map to edit.

Click Create.

To map fields directly, perform one of the following steps:

Click a field in the source and drag it to the corresponding field in the target.

Click the source and the target fields, and then click Map+.

The name of the source field appears in the target Mapping column, and a green check mark icon appears next to both fields. The most recently mapped fields are connected by a green line. Click the green check mark of other sources and targets to see their current mappings. You cannot drag and drop onto a target that is already mapped.

Note:

In the mapping summary, the full names of extended elements are not displayed.

2-87

Chapter 2

Mapping Data

Modifying Mappings

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. The integration in which you want to edit the mappings cannot be active.

To modify a data mapping:

In the middle of the integration, click the Mapper icon for the request, response, or fault map to edit.

Click Edit to invoke the mapper.

Make appropriate updates to the mappings.

When complete, click Close, then click Apply to save your changes.

See Mapping Data of Using the Oracle Mapper.

Deleting All Mappings

You can delete all mappings in the mapper. This action deletes all source-to-target mappings in the mapper and all mapper statements created in the Mapping Builder.

Click the Mapper icon in the middle of the integration for the map to delete. For this example, the request mapper is selected, but you can also delete all mappings in another mapper, such as the response mapper, or any request or response enrichment mapping you created.

Click Delete.

Click Yes when prompted to confirm.

The green shading is removed from the mapper, indicating that the mapper is now empty.

See Mapping Data of Using the Oracle Mapper.

Mapping Faults

You can map portions of a message into the fault message to compose a description that helps you understand the fault.

To map a fault:

Click the Fault Mappings icon in an integration.

2-88

Chapter 2

Mapping Data

For each fault type, do the following:

Under Route To, select the type of fault.

Under Map, click the Mapper icon of the fault map to perform mapping.

The mapper appears with the source fault data structure on the left and the target fault data structure on the right. When returning from the mapper, the map icon changes color to indicate it is complete.

Click Close .

Return to the mapping to make any necessary changes to how you mapped your data.

See Mapping Data of Using the Oracle Mapper.

Adding Customized Mappings to Prebuilt Integrations

It is a common practice to customize the application endpoints of the prebuilt integrations that you import into Oracle Integration Cloud Service from the Oracle

Marketplace (for example, adding custom fields). As a result, you must customize the integration mappings to take advantage of these custom fields. Oracle Integration

Cloud Service enables you to customize the mappings in the prebuilt integrations that you import from the Oracle Marketplace. This action creates a customized mapping layer on top of the base mapping file, which is not modified. You can only add customized mappings to prebuilt integrations imported from the Oracle Marketplace, and not to integrations you or another user created.

To add customized mappings to prebuilt integrations:

On the Oracle Integration Cloud Service home page, click Integrations.

The Integrations page is displayed.

Locate the name of the prebuilt integration to customize. Prebuilt integrations are designated with the words BUILT BY ORACLE to the right of the integration name.

From the menu at the far right of the integration name, select Customize.

The message Customizing... is displayed above the integration.

If the existence of more than one customized version of the same prebuilt integration is detected, a dialog is displayed that shows a list of versions from which to copy customizations. You can select a version and click Apply, or select

Skip to bypass the copying of customizations and create your own customizations in the mapper, as described in the steps below.

2-89

Chapter 2

Mapping Data

Click the icon for the type of mapping you want to customize. You can customize request, response, fault, enrichment source, and enrichment response mappings.

An icon for customizing the selected mapper is displayed.

Click Customize.

The mapper is displayed in customization mode.

Drag and drop source fields to target elements.

Blue dots are added to the left of the mapped target elements in the Mapping column to indicate that these are customized mappings. These mappings are added to a customized layer on top of the base mapping file, which is not modified.

This dot differentiates the customized mappings from the regular mappings created as part of the prebuilt integration, which are displayed without a blue dot.

2-90

Chapter 2

Mapping Data

Click Close, then click Apply to save your changes.

A blue dot with the words Customized Response Mapping is displayed in the lower right corner of the icon for the customized mapper (for this example, the response mapper was customized). The other mappers do not have a blue dot because they were not customized (for this example, the request, fault, and request enrichment mappers).

See Mapping Data of Using the Oracle Mapper.

Removing Customized Mappings from Prebuilt Integrations

You can remove the customized mappings that you added to prebuilt integrations that you imported from the Oracle Marketplace. You can remove all customized mappings or specific subsets of mappings (for example, request, response, faults, enrichment source, or enrichment response mappings).

To remove customized mappings from prebuilt integrations:

On the Oracle Integration Cloud Service home page, click Integrations.

The Integrations page is displayed.

Locate the prebuilt integration in which you want to remove the customized mappings. Prebuilt integrations that have been customized are designated with the words BUILT BY ORACLE and Customized to the right of the integration name.

Click the integration name.

You can remove all customized mappings added to the integration or specific subsets of mappings (for example, request, response, fault, request enrichment, or response enrichment mappings).

2-91

Chapter 2

Regenerating a WSDL File for Integrations

To remove all customized mappings from the integration, perform the following step:

Click Remove All Customizations in the upper right corner.

To remove specific subsets of request, response, fault, request enrichment, or response enrichment mappings, perform either of the following steps:

Click the mapper icon, then click Remove Customizations for the customized mapping to delete (for this example, the customized response mapping is selected).

Click the mapper icon, then click Customize to access the specific mapper.

Click Remove Customizations in the upper right corner of the mapper page.

Click Yes when prompted to confirm your selection.

This action removes the specific customized mappings in the integration. Note that the blue dots that previously identified the customized mappings are removed. The existing mappings that are part of the original prebuilt integration are not removed.

Regenerating a WSDL File for Integrations

After you clone an integration, customize a prebuilt integration, or import an existing integration into Oracle Integration Cloud Service, you update the connection information (WSDL, username. and password) according to the requirements of your integration environment. If the connection WSDL you specify contains any custom fields or if the connection WSDL is updated with a different version, they are not displayed in the mapper. To get custom fields or updated fields to appear in the mapper, you must regenerate the endpoint in Oracle Integration Cloud Service.

As an example, you may have a scenario in which the WSDLs with one of your connections (for example, a Salesforce connection) change frequently and you must be able to uptake the latest WSDLs into your integrations. By regenerating the WSDL file, the custom fields of imported mappings are not deleted, and are available for editing, as needed. This eliminates the need for remapping source and target elements completely from scratch in the mapper.

2-92

Chapter 2

Regenerating a WSDL File for Integrations

Restrictions

• There cannot be root level differences between the old and new WSDLs. If there are differences, WSDL regeneration fails. Therefore, you can change the connection information, but must ensure that the new WSDL does not have root element differences from the previous WSDL.

• If you create an integration in which the Oracle RightNow Adapter WSDL is version 1.2 and try to regenerate it with Oracle RightNow Adapter WSDL version

1.3, a mapper error occurs.

• JCA artifacts are not regenerated.

• A new WSDL can have references to a different schema with different data structures (for example, you change the schema by adding, modifying, or deleting a new complex element to the root element), only if the root element within the schema does not get modified, added, or removed. In this situation, the child element within the root element can be changed or refer to any new data structure or data type.

The regeneration logic follows the reference and imports or includes the new data structure to the new WSDL. The root element within the schema is the first level of

<xs:element/>

or type element (

<xs:complexType/>

<xs:simpleType/>

). For the first level of

<xs:element/>

, the following applies:

– Their

QName

cannot be modified.

– A new root element cannot be added.

– The old root element cannot be removed.

For the first level of a type element, the following applies:

– Their

QName

should not get changed.

– The old root type should not be removed.

– A new type element can be introduced by other referencing child elements or types.

For example, one child element or type defined in a root element can refer to a new type element. The regeneration logic imports or includes them into the existing schema if it has the same target namespace as the child element/type or by creating a new schema if it has a different target namespace from the child element/type. The new root level type element must be referenced by another child element/type. If it is a standalone root type element, it does not get imported or included in the final regeneration WSDL.

To regenerate a WSDL file for integrations:

On the Oracle Integration Cloud Service home page, click Integrations.

The Integrations page is displayed.

Click the name of the integration in which to regenerate the WSDL. Customized integrations are designated with the words BUILT BY ORACLE and Customized to the right of the integration name.

You can regenerate the WSDL for an individual endpoint or the WSDLs for all endpoints in an integration.

2-93

Chapter 2

Creating Lookups

To regenerate the WSDL for a single endpoint in the integration, click the appropriate source, target, request enrichment, or response enrichment icon.

Select Regenerate Artifact.

You are prompted with a message indicating that WSDL regeneration impacts the mappings in the integration.

Click Yes.

This regenerates the WSDL and any dependent artifacts so that any custom elements appear during mapping. The imported mappings from any prebuilt integration are not deleted. The maps are validated and any warnings

(identified by yellow icons) or errors (identified by red icons) for the impacted maps are displayed. If warnings and errors both exist for a single mapper, only a single error icon is displayed. Icons indicating that this mapper is customized

(identified by the blue icons) are displayed at the bottom of the mapper.

To regenerate the WSDLs for all endpoints in the integration, select Actions at the top of the page.

Click Regenerate endpoints.

You are prompted with a message indicating that WSDL regeneration impacts the mappings in the integration.

Click Yes.

This regenerates the WSDLs and any dependent artifacts with the same behavior as described in Step 4.

See Mapping Data of Using the Oracle Mapper.

Creating Lookups

A lookup associates values used by one application for a specific field to the values used by other applications for the same field. This provides the capability to map values across vocabularies or systems. For example, you can map country codes, city codes, currency codes, and so on.

Topics

•

Creating a Lookup

•

Adding Adapters or Domain Names to a Lookup

•

Cloning a Lookup

•

Deleting a Lookup

2-94

Chapter 2

Creating Lookups

Creating a Lookup

Create a lookup to map values between applications.

On the Oracle Integration Cloud Service home page, click the Lookups diagram.

Click Create.

The Create New Lookup dialog is displayed.

Enter a name and optional description for the lookup.

Click Create.

The Lookup page is displayed.

Adding Adapters or Domain Names to a Lookup

Add adapters or domain names to a lookup to map values between connections.

Click Domain Name 1.

A menu with options is displayed.

Select the type to create:

• Select Adapter: This selection invokes the Select Adapter dialog for choosing the adapter to use. You can change your selection:

– If you want to change your adapter selection, click the selected adapter type, then choose Select Different Adapter.

– If you want to change from an adapter to a domain name, click the selected adapter type and choose Replace with Domain Name.

• Enter Domain Name: This selection invokes a dialog for entering the domain name to use. There is a 50 character limit. You can change your selection:

– If you want to change from a domain name to an adapter, click the domain name, then choose Replace with Adapter.

– If you want to change the domain name, click the name, then choose Edit

Domain Name.

The adapter or domain name is displayed.

Enter a value in the field below the adapter or domain name. To add more rows for additional values, click the + sign.

Click Domain Name 2.

Repeat Step 2 to add an adapter or domain name.

Enter a value in the field below the adapter or domain name. To add more rows for additional values, click the + sign.

2-95

Chapter 2

Creating the lookupValue Function

If you want to add another column, click +.

Repeat to add more adapters and domain names to the lookup.

Click Save when complete.

Cloning a Lookup

You can clone a copy of an existing lookup. It is a quick way to create a new lookup with similar information. Lookups with adapters and domain names can be cloned.

On the Lookups page, select Clone from the menu.

The Clone Lookup dialog is displayed.

Enter the lookup information.

Click Clone.

Click Edit to further configure your cloned connection.

Deleting a Lookup

You can delete a connection from the Lookup menu.

Select Delete from the menu.

The Delete Lookup dialog is displayed.

Click Yes to confirm deletion.

Creating the lookupValue Function

You can create the parameter values for the lookupValue

function with the Build

Lookup Function wizard. This wizard enables you to define the lookup table, source column, target column, and default value to use in the function. For these parameter values to be selectable in the wizard, you must have already created a lookup on the

Lookups page.

Topics

•

Accessing the Build Lookup Function Wizard

•

Selecting the Lookup Table

•

Selecting the Source and Target Columns

•

Specifying the Default Value

2-96

Chapter 2

Creating the lookupValue Function

•

Reviewing Your Lookup Table Selections

Accessing the Build Lookup Function Wizard

The Build Lookup Function wizard for creating the

lookupValue

function parameter values is accessible from the Expression Builder in Oracle Integration Cloud Service.

To access the Build Lookup Function wizard:

Note:

You must already have created lookups to use this wizard. See

Creating

Lookups .

Go to the Integrations page.

Open an integration.

Invoke the Expression Builder from within the integration. For example:

• In an orchestrated integration, edit a switch activity.

• In a basic integration, click the Filter link.

The Expression Builder is displayed.

Expand Components.

Expand Functions > ICS.

Expand the lookupValue

function to view the available parameters to define in the

Build Lookup Function wizard and Expression Builder.

• dvmLocation

• srcColumn

• srcValue

• targetColumn

• defaultValue

Drag the lookupValue

function into the New Condition field.

The Build Lookup Function wizard is displayed. To create the lookupValue

function

parameter values, see section Selecting the Lookup Table

Selecting the Lookup Table

Select the lookup table to use in the lookupValue

function.

Topics

•

What You Can Do from the Select Lookup Table Page

•

What You See on the Select Lookup Table Page

2-97

Chapter 2

Creating the lookupValue Function

What You Can Do from the Select Lookup Table Page

Select the lookup table to use in the function.

Note:

You must already have created a lookup. Otherwise, no lookups are displayed for selection.

What You See on the Select Lookup Table Page

The following table describes the key information on the page.

Element

Lookup Table

Description

Select the lookup table to use in the function. You can view the lookup description by clicking the information icon in the table. This can guide you in selecting the required lookup table. The number of columns defined in the lookup is also displayed.

Selecting the Source and Target Columns

Select the source and target columns to use in the lookupValue

function.

Topics

•

What You Can Do from the Source and Target Columns Page

•

What You See on the Source and Target Columns Page

What You Can Do from the Source and Target Columns Page

Select the source and target columns to use in the lookupValue

function.

The lookupValue

function requires one source column and one target column.

What You See on the Source and Target Columns Page

The following table describes the key information on the page.

When you select a source and target column, the values available with the columns are displayed.

Element

Select Source Column

Description

Click the source column header to select from a list of available columns for this lookup table. The data included with the selected column is displayed. Both adapter and domain name columns are displayed.

2-98

Chapter 2

Creating the lookupValue Function

Element

Select Target Column

Description

Click the target column header to select from a list of available columns for this lookup table. The data included with the selected column is displayed. Both adapter and domain name columns are displayed.

Specifying the Default Value

Select the default value to use in the lookupValue

function.

Topics

•

What You Can Do from the Default Value Page

•

What You See on the Default Value Page

What You Can Do from the Default Value Page

Enter the default value to use if no match is found. If there is no match that satisfies all the search values, the lookup fails and the default value is returned.

What You See on the Default Value Page

The following table describes the key information on the page.

Element

Default Value

Description

Enter a default value to use if no match is found (for example, an actual default value to use or an error message such as

No Value Found

Reviewing Your Lookup Table Selections

You can review the lookup table values to use in the lookupValue

function on the

Summary page.

Topics

•

What You Can Do from the Lookup Table Summary Page

•

What You See on the Lookup Table Summary Page

What You Can Do from the Lookup Table Summary Page

You can review the lookup table values from the Summary page. The Summary page is the final wizard page after you have completed your configuration.

2-99

Chapter 2

Importing Map Files

What You See on the Lookup Table Summary Page

The following table describes the key information on the page.

Element

Parameter and Value Table

Resulting Expression

Description

Displays a summary of the parameters and values you defined on previous pages of the wizard.

To return to a previous page to update any values, click the appropriate tab in the left panel or click Back.

Displays the expression you defined on the previous pages of the wizard. The lookupValue

function takes the following format:

lookupValue(dvmLocation, srcColumn, srcValue, targetColumn, defaultValue)

Where:

• dvmLocation

: The lookup table selected on the

Select Lookup Table page.

• srcColumn

: The source column selected on the

Select Columns page.

• srcValue

: The source value you enter in the New

Condition field of the Expression Builder after completing this wizard. Click Done to complete this wizard, then define the srcValue

parameter value.

• targetColumn

: The target column selected on the

Select Columns page.

• defaultValue

: The default value entered on the

Default Value page.

For example, a defined lookupValue

function after you have completed the wizard and defined the srcValue parameter value in the Expression Builder can look as follows: dvm:lookupValue('tenant/resources/dvms/

Country','rightnow','US','mysoap','No data found')

Importing Map Files

Review the following topics to learn how to import map files into Oracle JDeveloper and Oracle Integration Cloud Service.

Topics

•

Importing a Map File into Oracle JDeveloper

•

Importing a Map File into Oracle Integration Cloud Service

You can export an integration that includes a map file that you want to edit in Oracle

JDeveloper. See Exporting an Integration

2-100

Chapter 2

Importing Map Files

Importing a Map File into Oracle JDeveloper

You can import an Oracle Integration Cloud Service archive file into an Oracle Service

Bus project in Oracle JDeveloper. The archive file can include a map file that is largely complete in content or a map file that is empty of content. This action enables you to perform advanced XSLT tasks (create variables, use templates, and so on) in Oracle

JDeveloper that you cannot perform in the Oracle Integration Cloud Service mapper.

After you complete these advanced tasks in Oracle JDeveloper, you can save and reimport the map file into Oracle Integration Cloud Service.

See

Exporting an Integration

for instructions on exporting an integration that includes the map file you want to edit in Oracle JDeveloper.

Create an Oracle Service Bus application with a project in Oracle JDeveloper.

In the application navigator, right-click the Oracle Service Bus project and select

Import.

The Import dialog is displayed.

Select Service Bus Resources, and click OK.

The Import Service Bus Resources wizard is displayed.

Select Zipped/Archived Resources, and click Next.

Click the Browse Zip Source icon to the right of the Zip Source field.

The Select ZIP File dialog is displayed.

If using Oracle JDeveloper 12.2.1.x, perform the following steps:

From the File Type menu, select ICS Archive (*.iar).

Browse for and select the Oracle Integration Cloud Service IAR archive file that you previously exported.

2-101

Chapter 2

Importing Map Files

If using Oracle JDeveloper 12.1.3, perform the following steps:

Ensure that you first rename the .iar file extension to

.zip

Browse for and select the ZIP file to import.

Click OK, then click Next on the wizard page.

The contents of the JAR file are displayed and can be selected for import.

10.

Select the resources folder in which to import the archive file. Note that the entire

Resource tree is selected by default, including everything above the hierarchy node that you want to select. Ensure that you deselect the parts above the relevant hierarchy node, then click Finish.

The resources are imported into the Oracle Service Bus project. You can now open the map file for editing with the XSLT Map Editor in Oracle JDeveloper.

Importing a Map File into Oracle Integration Cloud Service

There may be scenarios in which you need to perform an advanced XSLT task (create variables, use templates, and so on) that you cannot perform in the Oracle Integration

Cloud Service mapper. For these cases, you can export the integration, import the integration into Oracle JDeveloper, perform these advanced tasks in the map file in the

XSLT Map Editor in Oracle JDeveloper, and then save and re-import the map file into

2-102

Chapter 2

Importing and Exporting Components

Oracle Integration Cloud Service. The map file must be from an Oracle Service Project in Oracle JDeveloper.

Note:

You cannot edit a map file imported into the mapper.

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

Click the specific integration in which to import the map file.

Click the mapper icon to display a menu.

Click More Actions > Import.

Click Browse to select the map (

.xsl

) file. Note that while you exported the entire integration, you do not import the entire integration back into Oracle Integration

Cloud Service. You only import the map file of the exported integration back into

Oracle Integration Cloud Service.

Click Import.

Importing and Exporting Components

You can import and export both integrations and lookups to share them between

Oracle Integration Cloud Service environments.

See the following topics:

•

Exporting an Integration

•

Importing an Integration

•

Exporting a Lookup

•

Importing a Lookup

Exporting an Integration

Once you create an integration, you can export that integration as a JAR file for use in other Oracle Integration Cloud Service environments or import the integration into

Oracle JDeveloper to perform an advanced XSLT mapper task (for example, creating variables or using templates) that you cannot perform in the mapper. After mapper editing in Oracle JDeveloper is complete, the mapper file can then be imported back into Oracle Integration Cloud Service. You can export an integration from either the

Integration Designer or from the Integrations list. You can also export a locked integration.

To export an integration:

On the Oracle Integration Cloud Service home page, click Integrations.

Find the integration to export in the Integrations list, click the Actions menu, and then select Export.

In the dialog that appears, select Save File, and then click OK.

Save the file to the location you want.

2-103

Chapter 2

Importing and Exporting Components

The file is saved with a name that consists of the identifier plus the version number, and an IAR extension.

You can import the exported integration into the XSL Map Editor in Oracle Service

Bus. See Importing a Map File into Oracle JDeveloper

Note:

Lookups referenced using the lookupValue

function in the Expression Builder are included in the exported integration JAR file. When you import the integration, the referenced lookups are also imported and are visible in the

Expression Builder. See Referencing Lookups.

Importing an Integration

You can import integrations that were previously exported as a JAR file from Oracle

Integration Cloud Service.

To import an integration:

On the Oracle Integration Cloud Service home page, click Integrations.

In the banner, click Import.

In the Import Integration File dialog, click Browse to navigate to and select the file to import.

Click Import.

If an integration already exists with the same identifier and version, you must confirm whether to overwrite the existing integration.

The imported integration appears in the Integrations list and you can customize or activate it.

Note:

Even though the Activate icon is enabled after you import an integration, you must first configure your connection endpoints. If you do not, you receive an error when trying to activate the integration. See

Editing a Connection and

Adapter Configuration Reference

Exporting a Lookup

Once you create a lookup, you can export that lookup for use in other Oracle

Integration Cloud Service environments. You can export a lookup from either the

Lookup Designer or from the Lookups list.

To export a lookup:

On the Oracle Integration Cloud Service home page, click Lookups.

Select the Actions menu to the right in the lookup’s row, then select Export to

CVS.

In the dialog that appears, select Save File, and then click OK.

2-104

Chapter 2

Assigning Business Identifiers for Tracking Fields in Messages

Save the file to the location you want.

The file is saved as a CSV file with the same name as the lookup.

Importing a Lookup

You can import lookups that were previously exported from Oracle Integration Cloud

Service.

The file to import must have the following for the first row, where table_name is the name of the table as you want it to appear in Oracle Integration Cloud Service. This name cannot contain spaces.

DVM,table_name

The second row contains the names of the adapters that are being mapped. Use the following case-sensitive IDs for each adapter:

Adapter Name

Oracle Eloqua Cloud

Oracle Sales Cloud

Oracle Messaging Cloud Service

Oracle RightNow Cloud

Oracle HCM Cloud

Oracle ERP Cloud

Salesforce Cloud

Identifier to Use in the Import File

eloqua osc oms rightnow hcm erp salesforce

To import a lookup:

Locate the CSV file containing the lookup table you want to import.

On the Oracle Integration Cloud Service home page, click Lookups.

In the navigation pane, click Integrations, then click Lookups.

In the banner, click Import.

In the Import Lookup dialog, click Browse to navigate to and select the CSV file to import.

Click Import.

If a lookup already exists with the same identifier and version, you must confirm whether to overwrite the existing lookup.

The imported lookup appears in the Lookups list on the left. You can customize or activate it, if it is ready.

Assigning Business Identifiers for Tracking Fields in

Messages

This section describes how to manage business identifiers that enable you to track fields in messages during runtime.

Topics

•

Assigning Business Identifiers

2-105

Chapter 2

Assigning Business Identifiers for Tracking Fields in Messages

•

Deleting Business Identifiers

Assigning Business Identifiers

Business identifiers enable you to track payload fields in messages during runtime.

You can specify up to three business identifier fields for tracking during design time.

One of these fields must be selected as the primary business identifier field. The primary business identifier enables you to track fields across integration flows during runtime, and is always available. At runtime, the status of business identifiers is visible on the Tracking page and (if integration errors have occurred) the Errors page.

To assign business identifiers:

On the Oracle Integration Cloud Service home page, click Integrations.

Click the specific integration to which to add business identifiers. You can only add business identifiers to integrations that are not active. If an integration is active, you can only view its existing business identifiers.

From the menu, select Tracking.

The Business Identifiers For Tracking dialog is displayed. The source payload for the selected integration is displayed on the left side. You can only assign business identifiers to fields of source payloads. You cannot assign business identifiers to fields of target payloads.

From the Source section, drag the payload field that you want to track to the Drag

a trigger field here section.

You can filter the display of source structures by clicking the Filter link. This enables you to filter on whether or not fields are used and on the type of field

(required fields, custom fields, or all fields).

Select the checkbox if you want to make this the primary business identifier. At least one identifier is required. If you only add one, it is automatically selected as the primary key.

In the Tracking Name field, optionally enter a descriptive name to track during runtime (for example,

OrgId

). The name is displayed when this field is used to filter messages on the Tracking page or (if there is an integration error) the Errors page during runtime.

In the Help Text field, optionally enter instructions to enable users to know what to enter in this field during runtime (for example,

Enter a valid organization number

These instructions are displayed inside the empty field when it is used on the runtime Tracking page to filter messages.

Click Done.

2-106

Chapter 2

Managing Packages

Deleting Business Identifiers

You can delete business identifiers that track fields in messages during runtime.

To delete business identifiers:

On the Oracle Integration Cloud Service home page, click Integrations.

Click the specific integration to which to add a business identifier. You can only add business identifiers to integrations that are not active. If an integration is active, you can view, but not edit, the contents of the Business Identifiers for

Tracking dialog.

From the menu, select Tracking.

The Business Identifiers For Tracking dialog is displayed.

At the far right, click the Delete icon for the business identifier to delete. If you delete the primary business identifier, select a new one. Without a primary identifier, you cannot track fields across integration flows during runtime on the

Tracking page.

Managing Packages

You can group integrations into a package. When you import or export the package to or from Oracle Integration Cloud Service, all integrations in that package are imported or exported.

Topics

•

Viewing the Integrations in a Package

•

•

•

•

When you create an integration, you can also create a package or select an existing package in which to include the integration. See

Creating an Integration

Viewing the Integrations in a Package

You can view the integrations included in a package.

On the Oracle Integration Cloud Service home page, click Packages.

The Packages page is displayed. The package names and the number of integrations included in each package are displayed. You can filter the display of packages by entering the full or partial name (using a wildcard value of

) and clicking the Search icon. If you have not yet created or imported a package into

Oracle Integration Cloud Service, this page is empty.

2-107

Chapter 2

Managing Packages

Click the name of the package or select View Integrations from the menu at the far right.

The integrations included in that package and their current states are displayed

(for example, pending activation or active).

Click Close.

In the navigator pane, click Integrations to access the Integrations page for viewing these integrations.

Importing a Package

You can import a package of integrations into Oracle Integration Cloud Service from the Packages page. The Packages page enables you to import packages that you or other users have created. To import packages that consist of integrations that are prebuilt by Oracle, you must go to Oracle Marketplace.

Note:

You cannot import a package if it contains activated integrations. Ensure that all integrations are deactivated before including them in a packages archive

(PAR) file.

On the Oracle Integration Cloud Service home page, click Packages.

In the banner, click Import.

Browse for and select the PAR file when prompted.

Click Import.

The package is added to the list on the Packages page.

You can import a prebuilt packages from Oracle Marketplace. See

Importing a Prebuilt

Integration .

Exporting a Package

You can export a package of integrations from Oracle Integration Cloud Service on the

Packages page. This action exports all the integrations included in that package.

On the Oracle Integration Cloud Service home page, click Packages.

From the menu at the far right, select Export.

2-108

Chapter 2

Managing Agent Groups and the On-Premises Agent

Save the package (PAR) file of integrations to a file system location when prompted. The individual integrations inside the PAR file are exported as integration archive (IAR) files.

Updating a Package

You can update the package in which your integration is included. For example, you can create a new package for your integration or move your integration to an existing package.

On the Integrations page, find the integration of the package that you want to update. The integration must not be active.

From the menu, select Edit.

The integration is displayed.

From the menu, select Primary Info.

In the Package field, enter a new package name or enter an existing package name (as you type the initial letters, the existing package is displayed) to move your integration to an existing package.

Click Save, then click Close.

In the navigation pane, click Packages.

Click the package name you specified to see your integration.

Deleting a Package

You can delete a package. This action deletes the package and all integrations included in that package.

On the Oracle Integration Cloud Service home page, click Packages.

From the menu at the far right, select Delete.

Click Yes when prompted to confirm your selection. The package and all of its integrations are deleted.

Managing Agent Groups and the On-Premises Agent

You must create an agent group and install the on-premises agent before you can create an integration in which messages are exchanges between your on-premises applications and Oracle Integration Cloud Service.

Topic

•

Creating an Agent Group

•

Downloading and Running the On-Premises Agent Installer

•

Creating a Connection with an Agent Group

•

Viewing and Editing Agent Groups

•

Deleting an Agent Group

2-109

Chapter 2

Managing Agent Groups and the On-Premises Agent

•

Updating Property Values

•

Upgrading the On-Premises Agent to Release 17.4.1

Creating an Agent Group

You must create an agent group in Oracle Integration Cloud Service before you can run the agent installer. When you install the on-premises agent in your environment, you associate the on-premises agent with the agent group identifier. Only one onpremises agent can be associated with an agent group. For a single Oracle Integration

Cloud Service instance, you can create up to five agent groups. Creating the agent group also creates the necessary queues required for message exchange.

To create an agent group:

On the Oracle Integration Cloud Service home page, click Agents.

Click Create Agent Group.

The New Agent Group — Information dialog is displayed.

Enter the following information, then click Create.

Field Description

Agent Group Name

Provide a meaningful name so that others can understand the agent name. The name must be unique among all agent names in the system. The name can consist of the following:

• Letters (A-Z, a-z)

• Numbers (0-9)

• Spaces ( )

• Special characters ( _ - )

The name must not begin or end with a space and cannot be longer than 50 characters.

Identifier

Accept the default identifier value or change it, if necessary. The identifier is initially the same as the agent group name you provided, but in upper case. When you install the on-premises agent, you must specify the identifier value. See

Downloading and

Running the On-Premises Agent Installer .

Agent Type

Description

Connectivity Agent is displayed and cannot be edited. The connectivity agent supports integrating with on-premises systems.

The agent group references only connectivity agents.

Provide a meaningful description so that others can understand the responsibilities of the agent group.

Downloading and Running the On-Premises Agent Installer

You must download the agent installer from Oracle Integration Cloud Service and run the installer to install the on-premises agent in your local environment. During installation, you associate the agent with the agent group identifier you generated when creating an agent group in Oracle Integration Cloud Service.

To upgrade the on-premises agent to the latest release, see

Upgrading the On-

Premises Agent to Release 17.4.1

. To learn more about on-premises agent concepts,

see About Agents and Integrations Between On-Premises Applications and Oracle

Integration Cloud Service

2-110

Chapter 2

Managing Agent Groups and the On-Premises Agent

•

System Requirements and Restrictions

•

Installing the On-Premises Agent

•

Troubleshooting Issues

•

Deinstalling the On-Premises Agent

System Requirements and Restrictions

You must satisfy the following prerequisites on your on-premises host before running the agent installer in a production environment:

• Do not make any custom configuration changes to the agent installed in your environment using the Oracle WebLogic Server Administration Console. These changes may cause issues during agent upgrade and are not supported. Oracle is not responsible for any custom changes that you may make.

• Do not have two on-premises agents running on the same host.

• If you have other Oracle WebLogic Server domains running on the host, they must not interfere with the Derby database used by the on-premises agent.

• You cannot copy the agent directory hierarchy that is installed on one host to another host. You must directly install the connectivity agent on your host using the connectivity agent installer described in this section.

• Ensure that you have created the agent group. You must specify the agent group identifier when installing the on-premises agent. See

Creating an Agent Group .

• Install only Oracle JDK version 1.7 or 1.8. Other JDKs such as Open JDK are not supported.

• Set the

JAVA_HOME

property to the location of the JDK installation. For example:

JAVA_HOME=/usr/java/jdk1.7.0_79

• Set the

PATH

property. For example:

PATH=/usr/java/jdk1.7.0_79/bin:$PATH

• Install the on-premises agent on one of the following supported operating systems:

– Linux OEL version 6 or 7

– Red Hat Enterprise Linux Server release 6.6 (Santiago)

– SUSE Linux Enterprise Server 12 SP1

• Provide a minimum of 8 GB memory with 4 GB of heap size dedicated for the agent JVM. If you want to include any other processes on that host besides the on-premises agent, it is strongly recommended that you increase physical memory to a value greater than 8 GB.

• Ensure that a Derby database is not running. See the Troubleshooting section below for details.

Installing the On-Premises Agent

To download and run the on-premises agent installer:

2-111

Chapter 2

Managing Agent Groups and the On-Premises Agent

Note:

It is recommended that you retain a copy of the cloud-connectivity-agentinstaller.bsx

agent installer file after completing installation.

On the Oracle Integration Cloud Service home page, click Agents.

The Agent Groups page is displayed. This page shows any current agent groups and on-premises agents associated with the agent groups.

Click Download.

Select Connectivity Agent.

This selection enables you to integrate Oracle Integration Cloud Service with onpremises environments.

Select Save File when prompted to save the file to a directory location on your onpremises host.

Unzip the downloaded file.

Locate the cloud-connectivity-agent-installer.bsx

agent installer file.

Change the file permissions to be executable.

chmod +x cloud-connectivity-agent-installer.bsx

Execute the file with the following properties.

Note:

Ensure that you understand the following issues:

• Do not forget the agent username (

-au

) and agent password (

-ap

) if you specify them during installation. The same values are required when upgrading the on-premises agent to newer versions. If you forget the supplied parameters, a re-installation of the on-premises agent may be required because upgrading the on-premises agent is not possible.

However, if these parameters are not supplied during installation, the default username is weblogic

. Contact Oracle Support Services to obtain the default password for weblogic

• Do not install the on-premises agent in a directory path that includes

/tmp

• Note the use of the dash (

) when specifying the property value.

• The output of this command is displayed on-screen. For troubleshooting purposes, the installation logs are generated and available at the same location as the

BSX

file. You can also redirect the output to an output file.

./cloud-connectivity-agent-installer.bsx —h=https://ICS_host.us.oracle.com:port — u=username —p=my_password —ad=agent_group_identifier -au=agent_username ap=agent_password where:

2-112

Chapter 2

Managing Agent Groups and the On-Premises Agent

-u

-p

Paramete r

-h

Status

Required

Description Additional Notes

Specify the Oracle

Integration Cloud

Service hostname and port. As an example, when installing from your Oracle Integration

Cloud Service POD, the host and port you specify are typically the

Oracle Integration

Cloud Service URL (for example, https:// icsapps.integ.dc4.c1

234.oraclecorp.com:

443

Note the following issues:

• Do not specify

/ics

after the port number.

• If you forget to specify a port, you receive the following error:

Numberformat Exception

• If you specify port

with the https

protocol, you can receive the following error:

Outbound ProxyHost and

ProxyPort as not provided certPath ---

/home/oracle/host/downloads/ ics_conn_agent_installer_151

110.1158/keystore.jks java.net.SocketTimeoutExcept

ion: Read timed out

at java.net.SocketInputStream.s

ocketRead0(Native

Method)

at java.net.SocketInputStream.s

ocketRead(SocketInputStream.

java:116)

at java.net.SocketInputStream.r

ead(SocketInputStream.java:

170)

. . .

Specify the Oracle

Integration Cloud

Service user name.

Specify the Oracle

Integration Cloud

Service password.

Note:

• Some special characters must be properly escaped with a backslash (\) character. For example, if your password includes an exclamation character, you must enter the backslash character before the exclamation character (\!).

• If the password contains a dollar sign (

) character (for example,

W$lcome11

), the complete password value must be contained in single quotes

(for example,

-p='W$lcome11'

Otherwise, you receive an

Undefined variable

error when you run the agent installer command.

2-113

Chapter 2

Managing Agent Groups and the On-Premises Agent

Paramete r

-ad

Status

Required

-au

-ap

—aport

Optional

Description

Specify the agent group identifier that was generated in the

Identifier field when you created the agent group in the New Agent

Group - Information dialog in

Creating an

Agent Group

. You must create the agent group before you can install the on-premises agent.

Specify a new agent username. This is a new username used to initialize the local installation of the onpremises agent. If not specified, the default username of weblogic is used.

Specify a password for the new agent username. If not specified, the default password is used. You may need to contact

Oracle Support

Services to obtain the default password for the default user weblogic

Specify the agent port

(for example,

9002

This enables you to specify any available port outside of the default value of

7001

. If not specified, it defaults to

7001

. Any free port can be used.

Additional Notes

2-114

Chapter 2

Managing Agent Groups and the On-Premises Agent

Paramete r

-ph

Status

Optional

-pp

-pu

Optional

-ppw

—nphosts

Optional

Description Additional Notes

Specify the hostname, or address, of the proxy server.

A proxy server allows indirect connection to network services and is used mainly for security

(to get through firewalls) and performance reasons (proxies often provide caching mechanisms). The

-ph and

-pp

properties are only required if your onpremises environment is set up with a proxy server mandating that all connections be routed through it.

Specify the port number of the proxy server.

If your on-premises host includes a proxy server, you must specify this property. The agent can work with any proxy in the DMZ.

If your on-premises host includes a proxy server, you must specify this parameter.

Specify the proxy server user.

Specify the proxy server user password.

Specify the nonproxy hosts:

nphosts=NONPROXYHOST

. You can specify a single host or multiple hosts separated by a

-nphosts=abc.com| xyz.com

2-115

Chapter 2

Managing Agent Groups and the On-Premises Agent

Paramete r

Status

-profile

Optional

Description Additional Notes

Set the number of worker threads to a value appropriate to your environment.

•

PROD

: When

profile PROD

is specified, the agentWorkerThrea ds

property value is set to

in the

CpiAgent.propert

ies

file. This setting is optimal for high-load environments.

When

-profile —

PROD

is not specified, the agentWorkerThrea ds

property value also defaults to

•

DEMO

: When

profile DEMO

is specified, the agentWorkerThrea ds

property is set to

A value of

may be sufficient for some low-load environments and most demo environments. However, for high-load environments, the agent instance may need additional tuning. Increase concurrency on the on-premises agent host by specifying the

-profile PROD property during installation. This automatically sets the number of worker threads to

(the recommended value for high-load environments).

You can also specify this value in the

CpiAgent.properties

file after installation. This change requires an agent restart.

agentWorkerThreads=40

See Updating Property Values

During installation, the following tasks are performed:

• All on-premises adapters are registered.

• A Java database is installed.

• The JRF domain is created.

• The on-premises agent is deployed.

Once installation is complete, an agent instance is created for interacting with

Oracle Integration Cloud Service. You can verify that the agent instance was created by going to the Agent Groups page and noting that the agent count was increased by one. If you click the number, details about the agent are displayed.

See

Viewing and Editing Agent Groups

You are now ready to create an adapter connection in Oracle Integration Cloud

Service that uses the on-premises agent. See

Creating a Connection with an Agent

Group .

Note:

Do not use startWeblogic.sh

and stopWeblogic.sh

to start and stop the onpremises agent. Instead, use startAgent.sh

and stopAgent.sh

2-116

Chapter 2

Managing Agent Groups and the On-Premises Agent

Troubleshooting Issues

• If there is a Derby database (DB) already in use on the host on which the agent is being installed, you receive the following error:

2016-01-27 20:48:51,714 FINE [47] com.oracle.cie.domain.jdbc.DatasourceXBeanAspectHelper - prop str: user=dummy;portNumber=1527;databaseName=dummy;create=true;serverName=localhost url: jdbc:derby://localhost:1527/dummy;ServerName=localhost;databaseName=dummy

2016-01-27 20:48:51,714 FINE [47] com.oracle.cie.domain.jdbc.DatasourceXBeanAspectHelper -

Selected DB ID/CAT: DerbyDerby's Driver (Type 4) Versions:Any 2016-01-27

20:48:51,714 FINE

[47] com.oracle.cie.domain.jdbc.DatasourceXBeanAspectHelper - Selected DB vendor: Derby

2016-01-27 20:48:51,714 FINE [47] com.oracle.cie.domain.jdbc.DatasourceXBeanAspectHelper - adding normal datasource: opss-data-source 2016-01-27 20:48:51,714 FINE [47] com.oracle.cie.domain.jdbc.DatasourceXBeanAspectHelper - datasource: opss-datasource component name: OPSS Schema

. . .

Perform the following steps:

Check if the Derby database is running.

ps -ef | grep "derby"

If any processes are displayed, run the following command to terminate them: ps -ef | grep "derby" | awk '{print $2}' | xargs kill -9

Deinstalling the On-Premises Agent

If you need to reinstall the on-premises agent, you must first deinstall it. Follow these instructions in the order specified.

Stop the on-premises agent:

./stopAgent.sh

Delete the directory in which the on-premises agent is installed.

Go to the Oracle Integration Cloud Service home page.

Click Agents.

Find the agent group.

Click the number representing the agent count. The Agents in this Agent Group dialog is displayed.

Find the agent to delete, and click X to delete the agent registration.

Reinstall the on-premises agent with the agent group specified in the installation

parameters, as described in Installing the On-Premises Agent .

2-117

Chapter 2

Managing Agent Groups and the On-Premises Agent

Creating a Connection with an Agent Group

After you have installed the on-premises agent, you can create a connection that uses the agent group and its associated on-premises agent. Only agent groups whose monitoring status is green on the Agent Monitoring page and which have not yet been associated with an adapter can be selected.

To create a connection with an agent group:

On the Oracle Integration Cloud Service home page, click Connections.

Click Create.

See

Creating Connections

Select the adapter to configure as a target endpoint. See About Agents and

Integrations Between On-Premises Applications and Oracle Integration Cloud

Service

Configure the connection properties and security.

In the Agent Group section, click Configure Agents to select the agent group to associate with the adapter. This enables you to access your on-premises applications.

Select the agent group to use with this adapter, and click Use.

Click Test. This test executes the ping command on the on-premises instance when the connection is associated with an agent.

Click Save, then click Close.

Create an integration in which you use the adapter.

10.

Activate the integration. See

Activating an Integration .

11.

Invoke the integration.

Note:

If you receive the following error, a connection time out has occurred. The request may be slow, in which case the request must be executed again. You can also view the agent logs to see what may be causing the request to not process.

CASDK-0005 A connector specific exception was raised by the application. oracle.cloud.cpi.omcs.api.CpiOmcsException.

No response received within response time out window of 60000.

Viewing and Editing Agent Groups

You can view details about agent groups and their associated on-premises agents and edit the agent group name.

To view agent group details.

On the Oracle Integration Cloud Service home page, click Agents.

2-118

Chapter 2

Managing Agent Groups and the On-Premises Agent

Click the number above the Agents label to show the associated on-premises agent.

Click Done when complete.

If you want to edit the agent group name, click the menu icon at the far right.

Select Edit.

Update the name, then click OK. Changing the agent group name does not impact the association with the on-premises agent.

Deleting an Agent Group

You can delete an agent group that is not currently associated with a running onpremises agent instance. Deleting the agent group also deletes the queues that were created when the agent group was created.

To delete an agent group:

Note:

Before deleting an agent group, ensure that you stop the agent on the onpremises host with either of the following commands:

• Stop the on-premises agent:

./stopAgent.sh

• Kill the running agent at the operating system command prompt: kill -e agent_PID_number

On the Oracle Integration Cloud Service home page, click Agents.

Find the agent group to delete.

From the menu, select Delete.

Select Yes when prompted to confirm.

Updating Property Values

If you need to change values for properties, edit the

CpiAgent.properties

file on your on-premises host.

To update property values:

Stop the on-premises agent by executing the following command in the

AGENT_INSTALL_DIR

directory.

./stopAgent.sh

Open the agent-domain/agent/config/CpiAgent.properties

file.

Change property values, as necessary.

Save your changes and exit the file.

2-119

Chapter 2

Managing Agent Groups and the On-Premises Agent

Restart the on-premises agent.

./startAgent.sh -u=Integration_Cloud_Username -p=Integration_Cloud_Password

Note:

If the value of the username or password is provided in double quotes (for example,

-u=”my_username”

-p=”my_password”

) and the username or password contains special characters, the characters must be proceeded with a backslash (

). For example:

./startAgent.sh -u="ICS_USER" -p="ICS_PAs\$"

However, if the value of the username or password is provided in single quotes, no change is needed. For example:

./startAgent.sh -u='ICS_USER' -p='ICS_PAs$'

To troubleshoot errors, you can also redirect the output of startAgent.sh

to a file.

For example,

./startAgent.sh >& wls.out

Upgrading the On-Premises Agent to Release 17.4.1

If you previously installed the on-premises agent on your local host, you must upgrade to release 17.4.1 to communicate with Oracle Integration Cloud Service 17.4.1.

To upgrade the on–premises agent to release 17.4.1:

Note:

• For the on-premises agent upgrade to work, you must set the

JAVA_HOME and

PATH

parameters. Only Oracle JDK version 1.7 and 1.8 are supported.

Any other JDK such as Open JDK does not work. If not set, on-premises agent upgrade fails. See

Downloading and Running the On-Premises

Agent Installer .

• You can run the following command to obtain online help for upgrading the on-premises agent. This file is available in step 1g below.

./cloud-connectivity-agent-patcher.sh -help

Download the latest agent installer ZIP file and perform the following steps. The

ZIP file is required to extract the patcher. To upgrade to 17.4.1, you can only use the patcher from the 17.4.1 ZIP file.

On the Oracle Integration Cloud Service home page, click the Agents diagram.

Click Download to download the 17.4.1 ZIP file.

Select Connectivity Agent. This initiates the patch ZIP file download.

Save the ZIP file to the file system.

2-120

Chapter 2

Managing Agent Groups and the On-Premises Agent

Unzip the ZIP file and note the following files.

• cloud-connectivity-agent-installer.bsx

• cloud-connectivity-agent-patcher.zip

Extract the cloud-connectivity-agent-patcher.zip

and notice the following files.

• cloud-connectivity-agent-ics.properties

• cloud-connectivity-agent-patcher.jar

• cloud-connectivity-agent-patcher.sh

• cloud-connectivity-agent-patching-scripts.zip

Run cloud-connectivity-agent-patcher.sh

Note:

• Ensure that you specify

(shorter hyphen) in front of each parameter and not

—

(longer hyphen). For example,

-au

and not

—au

• If specifying the

-patchZipFile

, ensure that you supply the file with pattern ics_conn_agent_installer_XXXXXX.YYYY.zip

. This is the actual zip file of the connectivity agent installer downloaded from Oracle Integration Cloud

Service.

During upgrade, use the

-patchZipFile

parameter to specify the complete path of the patch zip file that includes the

BSX

file.

./cloud-connectivity-agent-patcher.sh -agentInstallDir=AGENT_INSTALL_DIR icsUn=ICS_username -icsPwd=ICS_password -patchZipFile=file_name.zip

Where:

Parameter Stat us

Description

agentInsta llDir

–icsUn

–icsPwd

patchZipFi le

Man dato ry

Opti onal

The installation directory of the existing agent (

AGENT_INSTALL_DIR

under which agenthome

should be present).

The Oracle Integration Cloud Service username for running the upgrade (for example, weblogic

The password of the Oracle Integration Cloud Service username for running the upgrade.

The complete path of the already downloaded patch ZIP file in which the

BSX

file is available. If you do not specify this parameter, a smaller-sized version of the ZIP file for exclusively upgrading the on-premises agent is automatically downloaded from Oracle

Integration Cloud Service.

For example, in the following command, the

/scratch/myuser/agents/agent1 directory includes the agenthome

directory and the

/scratch/myname/agents/patch/

2-121

Chapter 2

Scheduling Integration Runs directory includes the ZIP file that contains the cloud-connectivity-agentinstaller.bsx

file.

./cloud-connectivity-agent-patcher.sh -agentInstallDir=/scratch/myuser/agents/ agent1 –icsUn=weblogic -icsPwd=mypassword -patchZipFile=/scratch/myname/agents/ patch/cloud-connectivity-agent-installer-1234.5678.zip

For this example, the patch ZIP file was manually downloaded from Oracle

Integration Cloud Service. Therefore, it is good to use that same patch file. If the

patchZipFile

parameter is not specified, the application connects to Oracle

Integration Cloud Service and downloads a smaller-sized version of the ZIP file for exclusively upgrading the premise agent, and proceeds with patching.

The patching process begins. The security certificate is downloaded if not already available and added to the keystore. If you go to the Agent Groups page in Oracle

Integration Cloud Service during the upgrade process and expand the agent group name, various messages are displayed, including

Upgrade in Progress

Restart

Pending

, and

Up to Date

. The on-premises agent is automatically restarted after the patch is applied. Once the patch ZIP file is available for extraction (either through the

-patchZipFile

parameter or through download from Oracle Integration Cloud

Service), the remaining process takes around 10 to 15 minutes to complete. This time period includes restarting the on-premise agent.

Verify that upgrade is complete by looking under the agenthome

directory. You see that the soa

, osb

, and lib

directories are upgraded and backups of these directories have occurred. The backups are identified by a

_BAK_PRE_NEW-VERSION suffix in the agenthome

directory.

Scheduling Integration Runs

You can schedule the running of integrations. For example, you can create an orchestrated integration that is triggered by a schedule or create a basic map data integration in which a trigger FTP Adapter reads a file and an invoke FTP Adapter writes the file. You can schedule this integration run to copy files at a date and time of your choosing. You can also define the frequency of the integration. When you create either of these types of integrations, a schedule icon is displayed with the integration entry on the Integrations page.

Topics

•

Creating an Integration Schedule

•

Scheduling Integration Runs

•

Starting and Pausing an Integration Schedule

•

Viewing Past and Present Integration Runs

•

Viewing Future Runs

•

Editing an Integration Schedule

•

Deleting an Integration Schedule

•

Monitoring Integration Runs

•

Creating Ad-Hoc Integration Runs Using the REST API

See Getting Started with the FTP Adapter.

2-122

Chapter 2

Scheduling Integration Runs

Creating an Integration Schedule

You can create a schedule for running orchestrated integrations.

To create an integration schedule:

Go to the Integration page.

Find the integration in which trigger and invoke FTP adapter connections have been defined.

These integrations are identified by a Schedule icon that depicts a calendar.

There are several ways in which to create an integration.

If you want to first activate the integration and then create the schedule:

Click the Activate icon.

Click Activate and Schedule.

If you want to first create a schedule for an integration that you activate later:

Select Add Schedule from the dropdown menu at the far right.

In the Schedule Name field, accept the default name or click the Edit icon to enter a new name. When complete, enter an optional description and click the green

checkmark. This action does not save the changes.

Note:

Assume you create a schedule and generate several integration runs, then deactivate and delete the integration. If you then create and activate a new integration with the same name as the deleted integration, and go to the Past

Runs page, the past runs of the deleted integration are displayed. This is by design.

If you want to schedule integration runs with an iCal expression, click Advanced.

Enter an iCal expression, and click Validate Expression. For example:

• The following expression indicates that this integration runs each month on the 1st, 10th, and 15th days of the month at 5:15 AM, 10:15 AM, 3:15

PM, and 8:15 PM.

• You can also define multiple schedule frequencies. The following schedule runs every day between the hours of 5:30 PM – 7:30 PM, and during these hours it executes every 10 minutes. This configuration requires three schedules separated by the

sign:

FREQ=DAILY;BYHOUR=17;BYMINUTE=30,40,50;BYSECOND=0;

FREQ=DAILY;BYHOUR=18;BYMINUTE=0,10,20,30,40,50;BYSECOND=0;

FREQ=DAILY;BYHOUR=19;BYMINUTE=0,10,20,30;BYSECOND=0;

2-123

Chapter 2

Scheduling Integration Runs

If validation is successful, the following message is displayed at the top: iCal expression is valid.

Note:

There is a three minute limitation on how frequently you can run scheduled integrations with an iCal expression. Anything below this limit is not supported.

In the Frequency section, click the icon to display a dropdown list for selecting the frequency with which to run the integration. As you define one frequency, you can specify additional values by clicking the icon to the right of the Frequency section.

• Only Once: This is the default selection. This selection clears all settings except for the From field.

If you select this option, you cannot select When schedule starts as the start date. This option is disabled.

• Hours and Minutes: Specify the hours and minutes at which to run the integration.

• Days: Specify the days on which to run the integration.

• Weeks: Specify the weeks during which to run the integration.

• Months: Specify the months during which to run the integration.

Click the green checkmark icon for each frequency type that you specify.

Click Save to validate your frequency settings.

Your selections are validated. If there are any errors, a validation message is displayed in the upper left corner that describes how to resolve the errors.

10.

In the This schedule is effective section, click the link to the right of From.

A menu is displayed for defining the start date of the schedule.

11.

If you want to start the integration run when the schedule is activated:

Click When schedule starts.

12.

If you want to explicitly set an integration run start date:

Select Modify start date.

Click the Calendar icon to select the month, year, and day and the hour, minute, and second at which to start the integration run.

Click OK.

13.

In the Until section, click the link to the right.

A menu is displayed for defining the expiration date.

14.

If you want the schedule run to never expire:

2-124

Chapter 2

Scheduling Integration Runs

Select Never (repeat indefinitely).

15.

If you want the integration run to have a fixed expiration date:

Select Choose expiry date.

Click the Calendar icon to select the month, year, and day and the hour, minute, and second at which to end the integration run.

Click OK.

16.

Click Save.

If successful, a message is displayed in the upper left corner.

Schedule Run name saved successfully

17.

Click Exit Scheduler.

The Schedule and Future Runs page is displayed and the Monitoring tab is highlighted in the upper right corner.

Details about the integration run schedule are displayed. You can click the Edit icon to update the schedule definition.

18.

If you have already activated the integration, click Submit Now to run the integration or Start Schedule to activate the integration schedule.

Note:

• If you place a file in an input directory and run an integration for the first time, the file is copied to the output directory. If you then run the integration a second time, the same file is not copied again to the output directory, even if you deleted the file from the output directory before rerunning the integration. This is by design. Second integration runs do not copy the same file. However, if a new file is placed in the input folder or the previously-copied file is updated with a newer version in the input directory, both are copied to the output directory.

• If you create a new schedule to repeat every minute and launch the calendar to specify a start time, it shows the current time (for example,

12:41:16). If you update the start time to several minutes later (for example, 12:43:55), save, and start the scheduled integration run, the integration starts running at 12:43:16 instead of 12:43:55. The scheduler does not care about the seconds entered and runs the schedule every minute.

19.

If you have not yet started the integration, return to the Integrations page and click

Activate.

20.

Run the schedule in either of two ways:

From the menu at the far right on the Integrations page, select Submit Now.

Select Schedule from the dropdown menu at the far right to return to the

Schedule and Future Runs page.

Click Submit Now to run the integration or Start Schedule to activate the integration schedule.

2-125

Chapter 2

Scheduling Integration Runs

Creating Parameters in Scheduled Integrations

You can create and update scalar type parameters in scheduled integrations that determine how to batch and read data received from a source location. You then use these parameter values downstream in the integration. You create and assign values to these parameters in the Schedule Parameters page that is available in scheduled orchestrated integrations. You can also assign values to these parameters in assign actions. Up to five parameters are supported in the Schedule Parameters page.

On the Integrations page, click Create.

Select the Orchestration pattern.

For the What triggers this integration option, select Schedule.

Complete the remaining fields, and click Create.

The integration canvas is displayed.

Click the Schedule icon, then select Edit.

In the Parameter Name column, click the plus icon.

Enter a name, an optional description, and a default value in the Value column.

For this example, a parameter of position

and a value of

are entered.

Click the plus icon, and enter a name (for this example, region

is entered) and optional description, but leave the Value column empty.

Click Close to save your changes and exit the page.

A red warning icon is displayed on the Schedule icon. If you place your cursor over the icon, a message indicates that one or more parameters are missing a value.

2-126

Chapter 2

Scheduling Integration Runs

10.

From the Actions section, drag an Assign icon into the integration, enter a name, and then click OK.

11.

In the Name column, click the plus icon, then select the parameter from the dropdown list that you created without a value in the Schedule Parameters page.

12.

Click the Edit icon to invoke the Expression Builder.

13.

Create an expression, then click Close.

14.

In the Assign page, click Close.

You are returned to the integration canvas.

15.

Place your cursor over the Schedule icon, and note that the message about the missing parameter value is gone.

Note:

If you create a for-each action without selecting the Process items in parallel option and then add an assign action within the for-each loop, parameters defined in scheduled integrations are visible for selection in the assign action.

If you later edit the for-each action and select the Process items in parallel option, a red fault icon is displayed on the impacted assign action indicating that a scheduled parameter is being used. You must correct this error for your integration to be valid. You can disable the Process items in parallel option or use the Reposition button to move the assign action outside of the for-each loop.

Starting and Pausing an Integration Schedule

After you define a schedule, you must activate it. You can also pause (deactivate) a schedule, as needed.

To start and pause an integration schedule:

Go to the Integration page.

Find the integration on which the scheduled run is defined.

Select Schedule from the menu at the right.

The Schedule and Future Runs page is displayed.

Click the Start Schedule box.

The following message is displayed at the top of the page:

Schedule is now active.

2-127

Chapter 2

Scheduling Integration Runs

Details about the schedule including the frequency and any expiration date are displayed. The Start Schedule button is changed to Stop Schedule.

If you want to pause the schedule run, click Pause Schedule at the far right.

If you want to resume the schedule run, click Resume Schedule. This toggles the button name to Pause Schedule.

Note:

You can also pause a schedule from the Integrations page available under the

Monitoring tab. See Monitoring Integration Runs .

Viewing Past and Present Integration Runs

You can view the status of past and present scheduled integration runs.

To view past and present integration runs:

Go to the Integration page.

Find the integration on which the scheduled run is defined.

Select Schedule from the menu at the right.

The Schedule and Future Runs page is displayed.

Click View Past Runs.

The Past Runs page is displayed. By default, all integration runs are displayed.

Filter the display of integrations:

Click In Progress to display all integration runs currently in progress.

Click Completed to display all completed integration runs.

Click the dropdown list to filter the display of runs by 1 hour, 6 hours, 1 day, 2 days, or 3 days.

If a schedule run has failed (for example, the target FTP server did not have the correct write permissions), click the Resubmit icon at the far right to resubmit the schedule run.

If you selected the Delete Files After Successful Retrieval checkbox on the

Configure File Read page when configuring the inbound FTP Adapter, the file is deleted from the source directory if the file transfer is successful or unsuccessful this time.

This action creates a RESUBMITTED RUN ID: number message to the right of the schedule name and original run ID. If you resubmit again, you end up with the following messages to the right of the schedule name:

2-128

Chapter 2

Scheduling Integration Runs

• RUN ID: number: The run ID for the first resubmission, which failed.

• RESUBMITTED RUN ID: number: The run ID for the latest submission.

• ORIGINAL RUN ID: number: The run ID for the initial submission.

Click the RESUBMITTED RUN ID: number message link to go to the Tracking page.

Click the file name of the instance.

A graphical view of the integration flow is displayed.

For example, if the resubmission resulted in a failure, details are displayed. For this example, the write portion of the integration failed because of a permissions issue.

Select Actions > Audit Trail to view specific details about the error, such as the target directory not being defined with write permissions.

Viewing Future Runs

You can view the status of future scheduled integration runs.

To view future runs:

Go to the Integration page.

Find the integration on which the scheduled run is defined.

Select Schedule from the menu at the right.

The Schedule and Future Runs page is displayed.

Click the menu to display tasks you can perform.

Click View Past Runs.

Click View Schedule.

Details about the future runs are displayed. You can filter to display all runs, only automatically scheduled runs, or only manually submitted runs. The page only displays manually submitted runs that have a state of blocked, wait, ready, paused, or cancelling.

2-129

Chapter 2

Scheduling Integration Runs

A link is included that shows a dialog describing the reason why a run is in a blocked, wait, ready, paused, or cancelling state, along with a request ID.

See

Running the File Transfer Sample

for a sample of a scheduled orchestrated integration.

Editing an Integration Schedule

You can edit a schedule for an integration run.

To edit an integration schedule:

Go to the Integration page.

Find the integration on which the scheduled run is defined.

Select Schedule from the menu at the right.

The Schedule and Future Runs page is displayed.

On the far right, click the Edit icon.

Edit the schedule. See Creating an Integration Schedule .

Click Save.

2-130

Chapter 2

Scheduling Integration Runs

Deleting an Integration Schedule

You can delete a schedule for an integration run.

To delete an integration schedule:

Go to the Integration page.

Find the integration on which the scheduler run is defined.

Select Schedule from the menu at the right.

The Schedule and Future Runs page is displayed.

Find the schedule in the list that you want to delete.

On the far right, click the Delete icon.

Click Yes when prompted to confirm.

Monitoring Integration Runs

You can pause and resume scheduled runs for an integration from the Monitoring page.

To monitor integration runs:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigator, click Integrations.

For integrations that include source and target FTP adapter connections, the calendar icon is displayed. This page shows only active integrations. Integrations can be of any type (that is, with or without the FTP Adapter).

If you want to resubmit a run of an integration, click Submit Now. This button is available only for integrations that have an FTP Adapter as a trigger.

If you click Push Integrations under Integrations in the navigator, all integrations that cannot be scheduled are displayed (that is, integrations that do not have an

FTP Adapter as a trigger).

If you click Scheduled under Integrations in the navigator, only scheduled integrations are displayed (that is, integrations that have an FTP Adapter as a trigger).

If you want to pause the scheduled runs, click the Pause Schedule button.

2-131

Chapter 2

Scheduling Integration Runs

Creating Ad-Hoc Integration Runs Using the REST API

You can create ad-hoc runs on integrations on which a schedule has been defined from the REST API. This is useful for when you want to test a scheduled integration.

To create ad-hoc integration runs:

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

Find an integration on which a schedule is defined (indicated by the calendar icon).

Click the Integration Details icon at the far right.

Copy the URL from the Submit Now Link into a tool (such as SOAP UI) to test

REST APIs. You can also use CURL commands from a terminal window to invoke the REST APIs.

Invoke the integration run.

2-132

Chapter 2

Using Libraries to Manage Functions for Integrations

Return to the Integrations page, and select Schedule from the list at the far right.

The Schedule and Future Runs page is displayed.

Click the View Past Runs link in the upper right corner.

Details about the ah-hoc integration run are displayed.

Using Libraries to Manage Functions for Integrations

Extension libraries provide a means to register and organize JavaScript for use in integrations. Library functions are automatically available for you to drag from the

Actions palette to your orchestration integrations.

You can use the library functionality to:

• Register a new API library

• See a list of all registered API libraries

• View the details of an API library

• Edit the details of an API library

• Determine which integrations are using library functions

• Delete a registered API library

• Download a library source file to your desktop

• Add library functions to the orchestration Actions palette.

Topics

•

Registering an API Library

•

Viewing Library Details

•

Editing Library Details

•

Determining Which Integrations Use a Library Function

•

Deleting a Library

•

Downloading a Library File

•

Using Library Functions in Orchestrations

Registering an API Library

In order for custom function calls to appear in the integration Actions palette, you must register the libraries that contain them.

Open the Libraries page. In the left Designer navigation bar, click the Libraries item or click the Libraries icon on the Home page.

Click the Register button in the title bar.

In the Register Library dialog box, click Browse to select a JavaScript (

.js

) library file.

Specify a name, identifier, version number and optional description.

2-133

Chapter 2

Using Libraries to Manage Functions for Integrations

Example 2-1 Code Format

Function return parameters must be named like the example below. You should configure the return parameter type in the metadata UI only if the return parameters are named.

Consider the following code: function add ( param1, param2 )

{ return param1 + param2;

}

Although the above syntax is valid, the return parameter will not appear in the metadata UI for configuration. For that to happen, the code must return a named parameter. Create a new variable and assign return values before the variable is returned. For example, like this: function add ( param1, param2 ) {

var retValue = param1 + param2;

return retValue;

}

Example 2-2 Function Within Another Function

Functions defined within another function do not appear in the metadata UI for configuration.

Consider the following code: numeric.parseDate = function parseDate(d) {

function foo(d) {

if(typeof d === 'string') { return Date.parse(d.replace(/-/g,'/'));}

if(!(d instanceof Array)) { throw new Error("parseDate: parameter must be arrays of strings"); }

var ret = [],k;

for(k=0;k<d.length;k++) { ret[k] = foo(d[k]); }

return ret;

}

var retVal = foo(d);

return retVal;

}

In this case foo

is defined within parseDate

. Thus, foo

does not appear in the metadata

UI for configuration.

Viewing Library Details

View details about a library without changing any information.

Open the Libraries page. In the left Designer navigation bar, click the Libraries item or click the Libraries icon on the Home page.

Select View from the menu at the end of the row on which the library is listed.

The files and their constituent functions are displayed. You can expand and contract the list of functions and you can search and filter the list as well. To view information about a function, click on the function. To view the source code, click on the file name and download the code to your desktop. You can also click on the file name to annotate the entry with your comments.

2-134

Chapter 2

Using Libraries to Manage Functions for Integrations

You can use the menu on this page to view primary information about the library and to export XML metadata to your desktop.

When you are done, click Close on the title bar.

Editing Library Details

Edit details about a library.

Open the Libraries page. In the left Designer navigation bar, click the Libraries item or click the Libraries icon on the Home page.

Either click on the library name or select Edit from the menu at the end of the row on which the library is listed.

The files contained in the library and their constituent functions are displayed. You can expand and contract the list of functions, and you can search and filter the list.

To edit information about a function, click on the function. To view the source code, click on the file name and download the code to your desktop. You can also click on the file name to annotate the entry with your comments.

If the function is in use in an integration, you are warned about it and the function is presented in view-only mode.

If the function is available for editing, you are presented with the following options:

• You can set the classification type to be Orchestration, enabling the function to be used in orchestrations.

• You can set the data types of the function’s input and output values, defining them as Boolean, Number or String. You can also add a description.

You can use the menu on this page to:

• View primary information about the library

• Export XML metadata to your desktop

• Delete the library

• Save your changes (the same as clicking Save on the title bar)

When you are done, click Save and Close on the title bar.

Determining Which Integrations Use a Library Function

You can determine which integrations are using functions in a given library.

Open the Libraries page. In the left Designer navigation bar, click the Libraries item or click the Libraries icon on the Home page.

Click the number in Used by Integrations label in the line beneath the library’s name. The number indicates the number of integrations that use functions in the library.

When you click the number, the Library Is In Use popup is invoked. It lists the names of the integrations that use the library’s functions. This popup is also invoked if you attempt to edit or delete a library that is currently in use.

2-135

Chapter 2

Connecting to Oracle Mobile Cloud Service

Deleting a Library

Delete a library.

Open the Libraries page. In the left Designer navigation bar, click the Libraries item or click the Libraries icon on the Home page.

Select Delete from the menu at the end of the row on which the library is listed.

If any of the library’s functions are being used by an integration, the Library Is In

Use popup is invoked and you are prevented from deleting the library. You must remove the functions from the integration before you delete it.

Downloading a Library File

You can download a library to a source file (

.jar

.js

) on your desktop.

Open the Libraries page. In the left Designer navigation bar click the Libraries item or click the Libraries icon on the Home page.

Select Download Library File from the menu at the end of the row on which the library is listed.

A browser popup is invoked to save the file to your desktop.

Using Library Functions in Orchestrations

Library functions are available from the orchestration Actions palette from where you can incorporate them into your orchestrations.

After you register and edit your library functions, they are available from the orchestration Actions palette. You can drag them from the Actions palette to your

orchestrations. See Adding a Function Call Action

Connecting to Oracle Mobile Cloud Service

Oracle Mobile Cloud Service (MCS) enables you to create an Oracle Integration Cloud

Service Connector API to connect to Oracle Integration Cloud Service, which in turn, enables you to connect to, browse, and select services that are defined in on-premises applications and other cloud services.

See Using Oracle Mobile Cloud Service.

Connecting to Oracle API Platform Cloud Service

Connect to Oracle API Platform Cloud Service to manage your integrations as APIs and publish them to the API Platform Cloud Service Developer Portal for consumption.

Before you begin: Ensure that you have a subscription to Oracle API Platform Cloud

Service. You must also have credentials for a user assigned the Administrator or API

Manager role in API Platform Cloud Service.

To connect to an API Platform Cloud Service instance:

2-136

Chapter 2

Connecting to Oracle API Platform Cloud Service

Expand the Navigation Menu. From the Integrations section, click Settings, and then click API Platform.

In the Connection Name field, enter a name for the connection.

In the URL field, enter the URL for the API Platform Cloud Service Management

Portal instance you want to use with Oracle Integration Cloud Service, following this pattern: https://<hostname or IP>:<port>

In the Username and Password fields, enter the credentials for your API Platform

Cloud Service user. This user must be issued the Administrator or API Manager role in API Platform Cloud Service.

Click Save.

If the URL and credentials you entered are valid, the connection is saved and a confirmation message is displayed.

See

Managing an Integration as an API with Oracle API Platform Cloud Service to

manage your integrations as APIs with API Platform Cloud Service.

2-137

Administering Oracle Integration Cloud

Service

The Oracle Integration Cloud Service dashboard provides you with the information and tools to monitor and manage your integrations in the runtime environment.

Administration tasks can also include working outside the dashboard, such as when you activate or deactivate integrations.

Topics

•

Monitoring Integrations

•

Managing Integrations

•

Managing Errors

•

Managing Business Identifiers for Tracking Fields in Messages

•

Viewing Preinstalled Adapters and Registering Custom Adapters

•

Sending Service Failure Alerts, System Status Reports, and Integration Error

Reports by Notification Emails

•

Setting Logging Levels and Downloading Diagnostic Logs

•

Reporting Incidents

•

Purging and Retaining Data in the Database

Monitoring Integrations

Use the Oracle Integration Cloud Service dashboard to see how your integrations are performing. The dashboard provides multiple views for you to check your running services.

Topics

•

Viewing the Dashboard

•

Viewing System Health

•

Viewing Design-Time Metrics

•

Monitoring Integrations

•

Monitoring Agents

Viewing the Dashboard

You can view information about how your integrations are performing on the

Dashboard page.

You can view information about how your integrations are performing. The main page of the integration shows a snapshot of a state of all running integrations.

3-1

Chapter 3

Monitoring Integrations

To view the dashboard:

On the Oracle Integration Cloud Service home page, click Monitoring.

The Dashboard page provides the following details:

• A list for selecting the time period for which to display integration information (for example, one hour, six hours, one day, two days, three days, or since the first activation).

• Success rate for messages (acceptable, adverse, or severe). Click the percentage value or wording to access the Errors by Integration page.

• Number of initiated messages in the last three days. Click the value or wording to access the Tracking page.

• Number of failed messages in the last three days. Click the value or wording to access the Error Message Details page.

• Number and percentage of currently used connections. Click the value, percentage, or wording beneath the percentage to access the Errors by

Connection page.

• Number and percentage of currently active integrations. Click the value, percentage, or wording beneath the percentage to access the Errors by Integration page.

• Number and percentage of scheduled integrations, including those currently paused. Click the value, percentage, or wording beneath the percentage to access the Integrations page listing all scheduled integrations.

• Activity streams link. Click the link to access the Runtime Health page to view the activity stream.

• Download Logs menu. Click the link to show options for downloading the Oracle

Integration Cloud Service logs or diagnostics logs. If you are having problems with an integration, you can attach the diagnostic logs to a service request for help in debugging the issue.

• Download incidents link. Click to download the created incident report. See

Reporting Incidents

• Graphs showing the hourly and daily history of total, successful, and failed messages. You can place your cursor over the bars in each graph to display the total number of successful messages and failed messages.

3-2

Chapter 3

Monitoring Integrations

Viewing the Activity Stream

You can view the activity stream and message activity of invoked integrations.

To view the activity stream:

On the Dashboard page, click the Activity Stream link.

The Activity Stream page shows details about the activity stream of invoked integrations.

From the menu at the far right, click Download to download the activity stream.

From the Activity Stream dropdown list, select Integrations to show the message activity (received, processed, successful, and failed) of integrations.

3-3

Chapter 3

Monitoring Integrations

Viewing System Health

You can view information about the system health of Oracle Integration Cloud Service components. As you navigate around Oracle Integration Cloud Service, you receive a system health state that is not older than five minutes. The only exception is the

Messaging Service state, which may take longer than five minutes to update.

The state of system health is viewable from multiple locations in Oracle Integration

Cloud Service:

• From the main banner of pages

• From the Integrations, Connections, and Lookups pages

• From the mapper or expression builder

• From the System Health selection of the Integration Health menu on the

Dashboards page.

To view system health:

On any page of Oracle Integration Cloud Service or from the Integration page,

Connections page, Lookups page, mapper, or expression builder, click the

System Health icon in the upper right corner to display the status of system health. Green indicates that the service is running as expected. Red indicates that errors are occurring in the service that can impact your active integrations. Gray indicates that no agents are configured. When database space usage reaches

70%, the color changes from green to orange.

You can also view the status of system health from the Monitoring dashboard.

Access the Monitoring dashboard through one of the following methods:

On the Oracle Integration Cloud Service Home page, click the Monitor diagram.

Click in the upper left corner of the page, then select Monitoring > Dashboards.

From the Integration Health menu, select System Health.

View the current status of system services upon which Oracle Integration Cloud

Service relies. A green icon indicates that the service is running as expected. A

3-4

Chapter 3

Monitoring Integrations red icon indicates that errors are occurring that can impact your active integrations. An agent can have three states: available (denoted by a green icon), unavailable (denoted by a red icon), and not configured (denoted by a gray icon).

When database space usage reaches 70%, the color changes to orange in the

RECENT HEALTH CHECKS section.

View the following details about the database:

• The unquiesced or quiesced state of the database. For this example, the database is in an unquiesced state. This means that users can perform the usual Oracle Integration Cloud Service tasks such as creating and updating integrations, connections, lookups; importing and exporting integrations and packages; activating integrations; and so on. For this example, only 1% of the available database space has been used. When database usage reaches

70%, you can receive an email notification if you subscribed to receive system failure notifications. When database space usage reaches 80%, the mode changes to a quiesced state, a red warning sign is displayed, and the color changes to red. When the database enters into a quiesced state, there is a ten minute waiting period after which the runtime does not accept any payloads.

You can also receive an email notification if you subscribed to receive system failure notifications when the database enters into a quiesced state. See

Sending Service Failure Alerts, System Status Reports, and Integration Error

Reports by Notification Emails

Click anywhere in the DATABASE section to access the Database

Configuration page to make changes. See Purging and Retaining Data in the

Database

• The state of the database purge and the data retention period. For this example, the gray color indicates that database purging is not currently running. The current data retention period is also displayed. Click anywhere in the DATABASE section to access the Database Configuration page to make changes. See

Purging and Retaining Data in the Database

View the maximum mount usage in the file system. The warning threshold is 85%, at which time you can receive an email notification if you have configured a

notification email address. The color changes from green to orange. See Sending

Service Failure Alerts, System Status Reports, and Integration Error Reports by

Notification Emails

. When usage reaches 90%, the color changes from orange to red and Oracle Integration Cloud Service enters into a read-only state, as

3-5

Chapter 3

Monitoring Integrations indicated by a message at the top of the Integrations page. During this state, you cannot perform tasks such as the following until you have reduced file system usage below 90%:

• Activating integrations

• Importing and exporting integrations and packages

• Creating or updating any resource (for example, lookups, integrations, connections, and so on)

• Downloading logs

Click the information icon or anywhere in the FILE SYSTEM STATUS section to display the domains on the POD instance server, the mount points, and the disk space usage of each mount point. The maximum usage of any one of the mounts is displayed. For example, if ICS_Data and ICS_Tmp are 73% and

ICS_App is 60%, 73% is displayed.

These numbers represent the used space of the mount points, and not the folder usage. A mount point (like a drive) has used space and total space. A folder does not normally have free space.

Viewing Design-Time Metrics

You can view the design-time metrics of Oracle Integration Cloud Service, including details about packages, integrations, connections, lookups, and agents.

To view the design-time metrics of Oracle Integration Cloud Service:

On the Oracle Integration Cloud Service home page, click the Monitor diagram.

From the Integration Health menu, select Design-Time Metrics.

View details about the following components in Oracle Integration Cloud Service:

• The number of developed and prebuilt packages.

• The state of integrations (draft (under construction), configured, active, and failed).

• The state of connections (draft, configured, and in use).

3-6

• The number of lookups.

• The number of connectivity and execution agents.

Chapter 3

Monitoring Integrations

Click the arrow for Integrations to display details about the number of integrations configured for the following::

• Performing file transfers

• Using the Map Data integration type

• Using undefined integrations

• Using message exchange pattern (MEP) types

Click the arrow for Integrations again to view how many integrations are using each adapter.

Click the arrows for Connections and Agents to view more specific details about those components.

Monitoring Integrations

On the Oracle Integration Cloud Service dashboard, you can see how your running integrations are processing messages, such as how many messages have been received and processed, how many successful messages and errors have occurred, and the overall success rate. Only activated integrations are listed on this page.

To monitor integrations:

On the Oracle Integration Cloud Service home page , click the Monitoring diagram.

The Dashboard is displayed.

In the navigation pane, click Integrations.

A list of running integrations appears, along with processing information about the number of messages received, the number of messages processed, the number of successful messages, and the number of failed messages.

3-7

Chapter 3

Monitoring Integrations

From the In Retention Period list, select the time period for which to display integration information (for example, one hour, six hours, one day, two days, three days, or since the first activation).

From the Integration list, select the Activity Stream to view the activity stream for the integrations.

Monitoring Agents

You can monitor the agent groups and their associated on-premises agents in Oracle

Integration Cloud Service.

To monitor an agent:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation panel on the left, click Agents.

The Agent Monitoring page shows details such as the time at which the agent was last updated and the on-premises agents associated with the agent groups.

Note:

If the agent status is red, you cannot select it in the Select an Agent Group dialog of the Connections page, even though the agent may be up and running.

Click the number above AGENTS or click the agent group name to see the onpremises agent associated with this group.

At the far right, click the information icon to display details about the agent group such as creation date and the last startup date of the on-premises agent.

Note:

When you shut down the agent server, several minutes pass before the agent is displayed as down on the Agent Monitoring page (as indicated by a red thunderbolt).

3-8

Chapter 3

Managing Integrations

When you are ready for your integration to go live, you must activate the integration in

Oracle Integration Cloud Service. You can also deactivate a running activation if you must make changes to it or if it is no longer needed.

Topics

•

Activating an Integration

•

Deactivating an Integration

•

Modifying an Integration

•

Viewing the Trigger, Invoke, and Enrichment Details of an Integration

•

Cloning an Integration

•

Creating a Draft of an Integration

•

Deleting an Integration

•

Unlocking an Integration

•

Downloading Generated Artifacts for an Integration

•

Viewing the Contents of an Incomplete Integration

•

Reactivating Integrations After Instance Upgrade to View the Latest Business

Identifier Tracking Behavior

•

Filtering the Display of Integrations By Type

•

Changing the Time Zone

•

Managing an Integration as an API with Oracle API Platform Cloud Service

Activating an Integration

Once you create an integration and the progress indicator shows 100 percent, you can activate that integration to the runtime environment. An integration shows as 100% and is eligible for activation after you have specified the source connection, the target connection, the data mappings, and the tracking fields.

To activate an integration:

Note:

If you activate a new version of an existing integration, tracking instances or logs of the old version are not deleted. However, related artifacts are deleted and redeployment is performed on the back end. Monitoring data is also removed.

On the Oracle Integration Cloud Service home page, click Integrations.

In the Integrations list, locate the integration you want to activate and go to the far right end.

Click the icon to activate the integration.

3-9

Chapter 3

Managing Integrations

The Confirmation dialog is displayed.

If you want to enable detailed tracing information in the activity stream, click the

Enable tracing checkbox.

When this checkbox is selected, detailed logging information about messages processed by this integration flow at runtime is collected. This can aid in troubleshooting issues. However, detailed tracing may also impact performance.

To disable tracing, you must deactivate the integration, then reactivate it without selecting the Enable tracing checkbox.

If you want to enable payload tracing to log input and output payloads to the activity stream, click the Include payload checkbox.

When this checkbox is selected, information from the payload is also written to the log files, which can be downloaded and viewed. For example, you see more detailed logging information about payload activity at several points in the integration flow, such as the payload prior to data mapping and the payload after data mapping. This action can present a security risk and also impact the performance of your system. This setting is not recommended for a production environment.

Select an activation method:

Click Activate.

Click Activate and Schedule.

The Run integration_name page is displayed. Create a schedule for running this integration, and click Save. See

Creating an Integration Schedule .

An activation progress bar is displayed at the top of the dialog. If activation is successful, the status of the integration changes to ACTIVE in the list. If you selected to enable tracing, the words TRACE ENABLED are displayed under the icon you clicked to activate the integration. If you selected to enable tracing with payloads, the words TRACE WITH PAYLOAD are displayed under the icon. If you click the integration instance on the Tracking page, the menu includes an option called View Activity Stream for viewing payload details.

To access the detailing trace logging information:

In the navigation pane, click the Monitoring tab.

Click Download Diagnostic Logs to download Oracle Integration Cloud

Service logs and diagnostics logs.

Note:

If activation fails, an error message is displayed at the top of the Integrations page. To troubleshoot the activation error, click Download diagnostic logs to download the logs for diagnosing the issue.

3-10

Chapter 3

Managing Integrations

View active integrations by clicking the integration name or selecting View from the menu at the far right of the integration. The active integration is displayed with a message saying Viewing.

Note the following details about read-only mode:

• No Save button and Actions button are displayed.

• There is no Connections Palette for adding adapters.

• You can click through multiple parts of the integration to view configuration details, such viewing the business identifiers under the Tracking tab, viewing the sourceto-target and target-to-source mappings in the mapper, and viewing the configurations on the pages of the connection wizards, but you cannot modify anything.

Deactivating an Integration

You can deactivate an integration to stop it from processing any new messages. If you want to modify an active integration, you need to deactivate it first.

Deactivation is equivalent to undeployment of a project, which means all existing history, monitoring, and runtime data are lost. Oracle Integration Cloud Service does not support the notion of starting and stopping projects. With asynchronous patterns, the queue for the deactivated project is deleted and all messages associated with this queue are also deleted. Therefore, if there are pending requests unprocessed, they are lost after deactivation. The previous version is deactivated and all existing history, monitoring, and runtime data is lost.

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

On the Integrations page, find the integration you want to deactivate.

To view only active integrations, select Active in the Integrations list. You can also filter by integration name or integration type (prebuilt, custom, or developed) to narrow down the list.

In the row containing the integration you want to deactivate, click the Active icon to deactivate the integration.

Click Deactivate on the dialog that appears. A deactivation progress bar is displayed at the top of the dialog.

3-11

Chapter 3

Managing Integrations

Modifying an Integration

You can modify an existing integration, including changing a source or target connection, reconfiguring the connection, and updating the data mapping. Changes to the source or target can cause changes to the existing mappings.

If the integration you want to modify is active, deactivate it first. See Deactivating an

Integration for instructions.

To modify an integration:

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

On the Integrations page, find the integration you want to modify.

You can search by entering a partial or complete integration name in the Search field or filter integrations by selecting an option from the Filter By list. From this list, you can filter by Type (Customized, Developed, and Prebuilt), Pattern

(Schedule, File Schedule, Map Data, Notification, Publish to ICS, Subscribe

To ICS, and Undefined), Status (Draft, Configured, Active, or Failed ), or Style

(Template or Orchestration). Search or filter criteria are displayed in the banner above the returned list of integrations. To remove search or filter criteria, click the

x icon in the banner.

On the row that contains the integration you want to change, click the menu, and select Edit.

To modify the source or target configuration, click the connection on the canvas and click Edit on the menu that is displayed.

Modify any of the open fields in the wizard that appears. See Connection

Configuration Reference for instructions.

To assign a new connection as the source or target, click the connection to delete, then click Delete on the menu that is displayed.

From the right side, drag the new adapter from the panel to the connection on the canvas that you want to replace. Configure the new connection. See

Connection

Configuration Reference for instructions.

To modify a data mapping, click the appropriate map icon and update the mappings. See Mapping Data of Using the Oracle Mapper.

When you are done making changes, click Save and then click Close.

Note:

If you have an integration that is locked and stuck in Draft mode, wait for the lock to expire. Expiration typically occurs within 30 minutes. This situation can occur if your browser crashes while editing an integration.

3-12

Chapter 3

Managing Integrations

Viewing the Trigger, Invoke, and Enrichment Details of an Integration

You can view the details associated with trigger, invoke, and enrichment endpoints of an integration.

To view the trigger, invoke, and enrichment details of an integration:

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

On the Integrations page, find the integration you want to view. You can filter the display of integrations by their current status on the left side of the page.

Click the trigger, invoke, or (if configured) enrichment endpoint of the integration.

Click the View icon.

View the connection name, endpoint name, input payload, and output payload of the integration.

Cloning an Integration

Cloning an integration creates a new copy with identical connections and data mappings. You give the clone a new name, identifier, version number, and package name, but the remaining configuration is the same. You can reconfigure the clone after you create it. You can also clone a locked integration.

Note:

Integration versions follow a formatting convention of xx.yy.zzzz

, where xx

is the major version and yy.zzzz

is the minor version. If you clone an integration

(for example, version

1.00.0000

) and change the minor version of the cloned integration to

1.10.0000

, version

1.00.0000

is deactivated when you activate version to

1.10.0000

. To keep both integrations active, change the major version of the cloned integration to

2.00.0000

. This enables integration versions

1.00.0000

and

2.00.0000

to be active at the same time. See

Creating an Integration .

To clone an integration:

On the Oracle Integration Cloud Service home page, click the Integration diagram.

On the Integrations page, find the integration you want to clone. You can filter the display of integrations by their current status on the left side of the page.

In the row containing the integration you want to clone, click the icon on the far right, then click Clone.

In the dialog that appears, enter a name, unique identifier, version number, package name, and an optional description.

You can include English alphabetic characters, numbers, underscores, and dashes in the identifier. Enter the version using numbers only in this format: xx.xx.xxxx.

3-13

Chapter 3

Managing Integrations

Click Clone.

You can modify the clone in any of the ways described in

Modifying an Integration .

Creating a Draft of an Integration

Creating a draft of an integration creates a new copy with the same integration information. This action represents an easier way to create an integration. During draft creation, you must update the version of the integration and optionally update the package and description. However, unlike a cloned integration, you cannot update the integration name or identifier. You can also create a draft of a locked integration.

To create a draft of an integration:

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

On the Integrations page, find the integration for which you want to create a draft.

You can filter the display of integrations by their current status on the right side of the page.

In the row containing the integration for which you want to create a draft, click the

menu, and select Create Version.

In the dialog that appears, modify the version number. Not modifying this field results in the following error:

The version of Integration "integration_name" you are trying to create already exists in the system.

Optionally modify the package name and description. You cannot modify the integration name or identifier.

Click Create Version.

Deleting an Integration

You can delete an integration that is no longer needed.

Make sure the integration you want to delete is not active. To deactivate the integration, see

Deactivating an Integration

To delete an integration:

On the Oracle Integration Cloud Service home page, click Integrations.

On the Integrations page, find the integration you want to delete. You can filter the display of integrations by their current status on the left side of the page.

In the row containing the integration you want to delete, click the menu on the far right, then click Delete.

Click Yes on the dialog that appears.

3-14

Chapter 3

Managing Integrations

Unlocking an Integration

When an integration is in edit mode and the browser crashes, the integration becomes locked, which prevents it from being edited. There are several ways to unlock the integration.

To unlock the integration:

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

For the integration that is locked, click the menu at the far right, then select

Unlock.

Downloading Generated Artifacts for an Integration

You can download artifacts of an integration as a zip file for viewing and analysis. You can download completed integrations, locked integrations, and active integrations, but not integrations that are in a draft state. The artifacts of active integrations are regenerated when downloaded. However, this action does not fetch the previously deployed artifacts from runtime. Instead, it regenerates and provides artifacts for download only (has no impact on the deployed artifacts). Therefore, these artifacts may not be fully identical with the previously deployed artifacts.

Downloading artifacts differs from exporting an integration. Exporting creates an IAR file that consists of the design time metadata of the integration. The generated artifacts downloaded are the same JAR files that are deployed to runtime through the activation process. Therefore, they are generated from the design time metadata and also contain the runtime metadata.

To download generated artifacts for an integration:

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

On the Integrations page, find the integration for which to download artifacts.

In the row containing the integration, click the menu on the far right, and click

Download Artifacts.

Specify a directory in which to save the zip file when prompted.

Viewing the Contents of an Incomplete Integration

You can open an integration with incomplete connection details on the Integrations page and view its contents. These integrations can only be viewed, and not edited.

To view the contents of an incomplete integration:

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

Open an integration with incomplete connection details (for example, an integration imported from another instance or from the Oracle Marketplace).

3-15

Chapter 3

Managing Integrations

A message is displayed at the top of the page describing why you cannot edit the integration.

Edit is not possible for Integration_Name (version_number) because the connection settings for this integration are incomplete.

Update the configuration information for the connections: Connection_Name.

Integration is displayed in view mode.

Open individual adapters, mappings, actions (for orchestrated integrations), and other components in the integration for viewing.

Go to the Connections page for the adapter connection requiring configuration, and update the necessary credential and security details.

Return to the integration and note that the message is gone.

Reactivating Integrations After Instance Upgrade to View the Latest

Business Identifier Tracking Behavior

After your Oracle Integration Cloud Service instance is upgraded to a newer version, you must reactivate your integrations to view the latest and correct business identifier behavior in the Tracking page.

Filtering the Display of Integrations By Type

You can filter the display of integrations by their type (custom, user-developed, or prebuilt).

To filter the display of integrations by type:

On the Oracle Integration Cloud Service home page, click the Integrations diagram.

Select the Filter by list to filter the display of integrations.

Select the Sort By list to filter the display of integrations by the last update or name.

Changing the Time Zone

You can change the time zone that is displayed in Oracle Integration Cloud Service.

To change the time zone:

In the upper right corner, click the username dropdown list, then select

Preferences.

From the Time Zone Settings list, select the time zone you want to use.

Click Save.

Go to the Integrations page and note that the time zone is changed in the message below the status of the integration and inside the information icon at the far right.

The time zone change is also shown in other parts of Oracle Integration Cloud

Service in which the time is displayed (for example, on the Tracking page).

3-16

Chapter 3

Managing Integrations

Managing an Integration as an API with Oracle API Platform Cloud

Service

You can manage integrations as APIs and group several integrations as a single API using the API Platform Cloud Service integration.

Topics

•

Creating a New API in Oracle API Platform Cloud Service Using an Integration

•

Grouping an Integration in an API in Oracle API Platform Cloud Service

•

Ungrouping an Integration from an API

Creating a New API in Oracle API Platform Cloud Service Using an Integration

You can create APIs in API Platform Cloud Service from your integrations with the API

Platform Cloud Service integration..

Before you begin:

• Connect to an Oracle API Platform Cloud Service instance. See

Connecting to

Oracle API Platform Cloud Service

• The integration you want to create an API for must use a REST endpoint as a trigger and must be activated.

To manage an integration as an API:

If you are not already on the Integrations page, open the Navigation Menu, click

Designer, and then click Integrations.

In the row containing the integration you want to manage with API Platform Cloud

Service, click the Actions icon on the far right and then click Manage API with

APIP CS.

From the Operation list, select. Create New API.

In the API Name field, enter a name for the API.

In the Version field, enter a version for the API.

In the API Endpoint URL field, enter the endpoint you want the API to receive requests at when deployed to an API Platform Cloud Service gateway. The API

Endpoint URL must be unique for each API deployed to an API Platform Cloud

Service gateway.

(Optional) In the API Description field, enter a brief description of your integration. This description is displayed in the API Platform Cloud Service

Management and Developer Portals.

3-17

Chapter 3

Managing Integrations

(Optional) To deploy the API to a gateway, select Deploy API, and then select the gateways you want to deploy the API to. Only gateways the user (specified in

Connecting to Oracle API Platform Cloud Service ) has deployment rights for are

displayed. This option is grayed out if the user doesn’t have the Deploy to

Gateway or Request Deployment to Gateway grant for any gateways.

(Optional) To publish the API to the Developer Portal, select Publish API, and then enter a vanity name into the API Portal URL field. The vanity name must be unique for each API managed by API Platform Cloud Service. This option is grayed out if the user doesn’t have the required grants to publish to the Developer

Portal.

10.

Click Create.

The API is created in the API Platform Cloud Service Management Portal. It is also deployed or published if you chose those options.

After creating the API, you can manage it in the API Platform Cloud Service

Management Portal.

Grouping an Integration in an API in Oracle API Platform Cloud Service

You can group multiple integrations together to manage them as a single API in API

Platform Cloud Service.

This makes it easy for you to combine multiple related integrations into a single API in

API Platform Cloud Service.

Each integration you group adds a condition to a Resource Based Routing Policy applied to the API in API Platform Cloud Service. When a request is sent to a deployed API requesting the resource you specified for your integration, this policy routes the request to your integration’s endpoint (if the request is passed by all policies in the execution flow before the Resource Based Routing policy).

Example: You have two integrations, one for managing orders and another for managing inventory for your pet store. You want to expose these to application developers, but you want to manage who uses them and how many requests are routed to your integrations. To make management and discovery easier, you can group these integrations in a single API in API Platform Cloud Service. When it’s deployed, the API will route requests to each integration based on the resource the client requests.

Before you begin:

• Connect to an Oracle API Platform Cloud Service instance. See

Connecting to

Oracle API Platform Cloud Service

• The integration you want to group must use a REST endpoint as a trigger and must be activated.

•

Create an API in API Platform Cloud Service. See Creating a New API in Oracle

API Platform Cloud Service Using an Integration

in Using Oracle API Platform

Cloud Service.

To group an integration in an API:

If you are not already on the Integrations page, open the Navigation Menu, click

Designer, and then click Integrations.

3-18

Chapter 3

Managing Integrations

In the row containing the integration you want to manage with API Platform Cloud

Service, click the Actions icon on the far right and then click Manage API with

APIP CS.

From the Operation list, select. Add to Existing API.

In the API Name field, enter the name of the API you want to add the integration to.

Tip:

Click the Search: API Name icon to view the APIs you can add the integration to.

(Optional) To deploy the API to a gateway, select Deploy API, and then select the gateways you want to deploy the API to. Only gateways the user (specified in

Connecting to Oracle API Platform Cloud Service ) has deployment rights for are

displayed. This option is grayed out if the user doesn’t have the Deploy to

Gateway or Request Deployment to Gateway grant for any gateways.

(Optional) To publish the API to the Developer Portal, select Publish API, and then enter a vanity name into the API Portal URL field. This option is grayed out if the user doesn’t have the Manage API grant for the API you selected.

Click Create.

The integration is grouped with the API.

After grouping an integration with an API, you can manage it in the API Platform Cloud

Service Management Portal.

Ungrouping an Integration from an API

You can ungroup an integration from an API it was previously grouped in.

When you ungroup an API, the condition for the ungrouped integration is removed from the Resource-Based Routing policy applied to the API. If the API is redeployed if it is deployed to a gateway and republished if it is published to the Developer Portal.

Note:

This task removes an integration that has been grouped with others in an API,

described in Grouping an Integration in an API in Oracle API Platform Cloud

Service

. Don’t use this operation if the integration is the only endpoint added for an API. Delete the API in the API Platform Cloud Service Management

Portal instead.

3-19

Chapter 3

Managing Errors

To ungroup an integration from an API:

If you are not already on the Integrations page, open the Navigation Menu, click

Designer, and then click Integrations.

In the row containing the integration you want to ungroup from an API, click the

Actions icon on the far right and then click Manage API with APIP CS.

The Manage API with APIP CS dialog appears.

In the Operation list, ensure that Remove from Existing API is selected, and then click Remove.

The integration is ungrouped from the API. The condition in the Resource Based

Routing policy for the integration is removed from the API.

Note:

• If the target API has only one integration grouped to it, ungrouping fails with this error:

Remove from existing API failed due to the following reason: Operation failed: Unable to remove from a API which contains a single endpoint

• If the API is removed from API Platform Cloud Service, then ungrouping succeeds. You can then create an API from or group this integration to an

API as usual.

After ungrouping an integration from an API, you can manage the API in the API

Platform Cloud Service Management Portal.

Managing Errors

You can manage errors from the Errors pages in Oracle Integration Cloud Service at the integration level, connection level, or specific integration instance level.

Topics

•

Managing Errors by Integration

•

Managing Errors by Connection

•

Managing Errors by Integration Instance

•

Resubmitting Failed Messages

•

Viewing the Status of Message Recovery

See

About Error Management

3-20

Chapter 3

Managing Errors

Managing Errors by Integration

You can manage errors by the integration in which they occurred. Management tasks consist of viewing the total error count for an integration over a specific time period, discarding (removing) all errors for an integration, and viewing more specific error message details by clicking the integration name or the total error count.

Topics

•

Viewing Errors By Integration Name Over a Specific Time Period

•

Discarding Errors by Integration Name

Viewing Errors By Integration Name Over a Specific Time Period

You can view errors by integration name over a specific time period.

To view errors by integration name or the total number of integration errors that have occurred over a specific time period:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors.

The Errors By Integration page is displayed. Any integration errors that are displayed by default are those that occurred within the selected time period.

From the Errors by Integration menu, select the time period for which to display integration errors.

Any errors that occurred during the selected time period are displayed immediately below the menu. Error details consist of the integration name and the total number of errors that occurred in that integration.

Click the integration name or total error count to access the Error Message Details page. This page provides information about the business identifiers defined in the integration, the instance identifier of the integration, the location of the error, the time at which the error occurred, the audit trail, the message payload, the specific error message, and other information. You can also submit errors for recovery.

See

Managing Errors by Integration Instance .

3-21

Chapter 3

Managing Errors

Discarding Errors by Integration Name

You can discard errors based on the integration in which they occurred. A discarded error message is removed from the Errors By Integration page and can be seen in a discarded state on the Tracking page. You cannot perform any further operations on a discarded message, including recovery. After a certain time period, the error message is permanently deleted from the server.

To discard errors by integration name:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors.

Perform any necessary error filtering by following the instructions in Viewing Errors

By Integration Name Over a Specific Time Period .

For the integration in which to discard errors, click the Discard button at the far right. For synchronous integrations, the Discard button is not visible.

Click Yes when prompted to confirm. This action discards all error messages in all instances of that integration.

Managing Errors by Connection

You can manage errors by the source or target connection in which they occurred.

Management tasks consist of viewing the total error count for a connection over a specific time period, discarding all errors for a connection, and viewing more specific error message details by clicking the connection name or the total error count.

Topics

•

Viewing Errors By Connection Name or the Total Error Count Over a Specific Time

Period

•

Discarding Errors by Connection Name

3-22

Chapter 3

Managing Errors

Viewing Errors By Connection Name or the Total Error Count Over a Specific

Time Period

You can view errors by connection name or the total number of connection errors that have occurred during a specific time period.

To view errors by connection name or the total number of connection errors that have occurred over a specific time period:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors, then click Errors By Connection.

The Errors By Connection page is displayed. Any connection errors that are displayed by default are those that occurred within the selected time period.

From the menu, select the time period for which to display connection errors.

Any errors that occurred during the specified time period are displayed immediately below the menu. Error details consist of the connection name and the total number of errors that occurred in that connection.

Click the connection name or total error count to access the Error Message Details page. This page provides information about the business identifiers defined in the integration, the instance identifier of the integration, the location of the error, the time at which the error occurred, the audit trail, the message payload, the specific error message, and other information. You can also submit errors for recovery.

See

Managing Errors by Integration Instance .

Discarding Errors by Connection Name

You can discard errors based on the connection in which they occurred. A discarded error message is removed from the Errors By Connection page and can be seen in a discarded state on the Tracking page. You cannot perform any further operations on a

3-23

Chapter 3

Managing Errors discarded message, including recovery. After a certain time period, the error message is permanently deleted from the server.

To discard errors by connection name:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors, then click Errors By Connection.

The Errors By Connection page is displayed.

Perform any necessary error filtering by following the instructions in Viewing Errors

By Connection Name or the Total Error Count Over a Specific Time Period

For the connection in which to delete errors, click the Discard button at the far right.

Click Yes when prompted to confirm. This action discards all error messages in that connection.

Managing Errors by Integration Instance

You can manage errors by the specific integration instance in which they occurred.

Management tasks consist of viewing the business identifiers defined for the integration, the instance identifier of the integration, the location of the error, the time at which the error occurred, the audit trail, the message payload, and the specific error message. You can also discard failed messages and resubmit failed messages for recovery.

Topics

•

Viewing Errors by Integration Name, Instance Identifier, Location, or Time of

Occurrence Over a Specific Time Period

•

Viewing the Integration Instance in Which Errors Occurred

•

Discarding Errors by Integration Instance

•

Viewing Specific Error Details

•

Viewing the Audit Trail of a Failed Integration Instance

•

Viewing Business Identifiers in Failed Integration Instances

•

Viewing the Message Payload of a Failed Integration Instance

3-24

Chapter 3

Managing Errors

Viewing Errors by Integration Name, Instance Identifier, Location, or Time of

Occurrence Over a Specific Time Period

You can display errors by integration name, instance identifier, error location, or the time of occurrence over a specific time period. This provides you with a more granular view of integration failure details.

To display errors by integration name, instance identifier, error location, or the time of occurrence over a specific time period:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors, then click Error Message Details.

The Error Message Details page is displayed. Any errors that are displayed by default are those that occurred within the selected time period.

From the menu, select the time period for which to display error information.

Any errors that occurred during the specified time period are displayed immediately below the menu. On the right side, the View Error icon is always visible. The Resubmit and Discard icons are visible based on the type of integration you created (asynchronous or synchronous). You can also see how many times an error has been resubmitted.

Click the primary business identifier name to access a graphical view of the integration instance. This page provides information about the business identifiers defined for an instance, the instance identifier of the integration, the location of the error, the time at which the error occurred, the audit trail, the message payload, a button for discarding the error, and other information.

3-25

Chapter 3

Managing Errors

Note:

The search facility on the Error Message Details page is case sensitive.

Viewing the Integration Instance in Which Errors Occurred

You can view the integration instance in which errors occurred. From the integration instance page, you can perform multiple tasks, including viewing business identifiers in the integration, viewing the audit trail, viewing error messages, and discarding errors.

To view the integration instance in which errors occurred:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors, then click Error Message Details.

Click the business identifier included in the failed integration instance.

The integration is displayed. The direction in which the error occurred is indicated by the color red. The primary business identifier and instance identifier of the integration are displayed above the integration.

You can perform multiple tasks on this page, including viewing all business identifiers and values in the integration, viewing the audit trail, viewing errors, viewing the payload, and discarding errors.

3-26

Chapter 3

Managing Errors

Discarding Errors by Integration Instance

You can discard errors by integration instance in several locations. A discarded error message is removed from the Errors Message Details page and can be seen in a discarded state on the Tracking page. You cannot perform any further operations on a discarded message, including recovery. After a certain time period, the error message is permanently deleted from the server.

To discard errors by integration instance:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors, then click Error Message Details.

The Error Message Details page is displayed. Any errors that are displayed by default are those that occurred within the selected time period.

Select the appropriate method for discarding errors:

To discard all errors, click Select All, then click Discard.

To discard selected errors, select the check boxes for the appropriate errors, then click Discard.

To discard a single error, select the checkbox for the error, then click Discard or simply click Discard at the far right of the error to discard.

You can also view and discard errors on the integration instance page.

Click the business identifier included in the failed instance.

The integration instance is displayed.

To delete the error, click Actions, then click Discard.

3-27

Chapter 3

Managing Errors

Click Yes when prompted to confirm you selection.

Viewing Specific Error Details

You can view specific error details by integration instance.

Error message details can be displayed in two parts: a summarized error message for easy understanding and resolution and, if necessary, a more specific error message if more detailed troubleshooting is required.

To view specific error details:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors, then click Error Message Details.

The Error Message Details page is displayed. Any errors that are displayed by default are those that occurred within the selected time period.

View details about a specific error in either of two ways:

Click View Error in the column at the right.

A summarized version of the error message for easy understanding and resolution is displayed.

If a more detailed description of the error message is required, expand Detail

Error Message.

Click the business identifier included in the failed instance.

The integration instance is displayed.

In the upper right corner, click View Error. A summarized version of the error message for easy understanding and resolution is displayed.

If a more detailed description of the error message is required, expand Detail

Error Message.

3-28

Chapter 3

Managing Errors

If you select View > Audit Trail, the error in the context of the audit trail is displayed to assist in identifying where the error occurred in the overall processing.

Viewing the Audit Trail of a Failed Integration Instance

You can view the audit trail of a failed integration instance. This enables you to see where an integration error occurred in the message flow.

To view the audit trail of a failed integration instance:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors, then click Error Message Details.

Click the business identifier included in the instance you want to view.

The instance integration is displayed. The direction in which the error occurred is indicated by the color red.

In the upper right corner, click Actions, then click View Audit Trail.

The audit trail shows details about the movement of the message through the integration, including where the failure occurred.

3-29

Chapter 3

Managing Errors

Viewing Business Identifiers in Failed Integration Instances

You can view the business identifiers included in failed integration instances.

To view business identifiers in failed integration instances:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors, then click Error Message Details.

The Error Message Details page is displayed. Any errors that are displayed by default are those that occurred within the selected time period.

To search for a specific business identifier, enter the exact business identifier value in the search field, then click Search. For example, if business identifier

OrgId has a value of test2

, enter test2

Any business identifiers with the specified value are displayed.

To view details about the business identifiers included in a failed integration instance, click the business identifier.

The integration instance is displayed.

Click Business Identifiers to display all the defined business identifiers and values in the integration.

See

Assigning Business Identifiers

and Managing Business Identifiers for Tracking

Fields in Messages

3-30

Chapter 3

Managing Errors

Viewing the Message Payload of a Failed Integration Instance

You can view the message payload of a failed integration instance.

To view the message payload of a failed integration instance:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors, then click Error Message Details.

Click the business identifier included in the instance you want to view.

The instance integration is displayed. The direction in which the error occurred is indicated by the color red.

In the upper right corner, click Actions, then click View Payload.

The audit trail shows the message payload of the integration instance.

3-31

Chapter 3

Managing Errors

Resubmitting Failed Messages

You can manually resubmit failed messages. Resubmitting a failed message starts the integration from the beginning.

All faulted instances in asynchronous flows in Oracle Integration Cloud Service are recoverable and can be resubmitted. Synchronous flows cannot be resubmitted. You can resubmit errors in the following ways:

• Single failed message resubmissions

• Bulk failed message resubmissions

Error instances that are resubmitted and successfully resolved are removed from the error list. If an instance is resubmitted and is in progress, a state of

In Progress

is displayed in the list. During this state, additional resubmittals of this error instance are not permitted.

Note:

Do not discard a message that you want to resubmit. A discarded message cannot be resubmitted.

To resubmit failed messages:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors.

From the tabs on the left, select the level of message resubmission to perform, then see below for instructions.

• Errors By Integration: For resubmitting all failed messages in an integration.

• Errors By Connection: For resubmitting failed messages in a connection.

• Error Message Details: For resubmitting failed messages in an integration instance.

Resubmitting All Failed Messages in an Integration

You can resubmit all failed messages that occurred in an integration.

To resubmit failed messages in an integration:

In the navigation pane, click Errors By Integration.

Find the integration in which to resubmit failed messages.

At the far right, click the Resubmit icon (second from the end) to resubmit the messages. The Resubmit icon is not visible for synchronous integrations.

3-32

Chapter 3

Managing Errors

Click Yes when prompted to confirm.

Resubmitting Failed Messages in a Connection

You can resubmit all failed messages that occurred in a connection.

To resubmit failed messages in a connection:

In the navigation pane, click Errors By Connection.

Find the integration in which to resubmit failed messages.

At the far right, click the Resubmit icon (second from the end) to resubmit the messages.

Click Yes when prompted to confirm.

Resubmitting Failed Messages in an Integration Instance

You can resubmit all failed messages that occurred in a specific integration instance.

To resubmit failed messages in an integration instance:

In the navigation pane, click Errors, then click Error Message Details.

The Error Message Details page is displayed. Any integration errors that are displayed by default are those that occurred within the selected time period.

Select the appropriate method for resubmitting errors.

For single instance resubmissions, optionally click the checkbox, then click the

Resubmit icon (middle icon at the far right) to resubmit the message.

3-33

Chapter 3

Managing Errors

For bulk instance resubmissions, click the appropriate checkboxes, then click

Resubmit above the integration instances to resubmit the messages.

Click Yes when prompted to confirm.

Viewing the Status of Message Recovery

You can search for and view the status of failed messages that have been submitted for recovery on the Errors by Integration, Errors by Connection, or Error Message

Details page.

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Errors.

Submit a failed message for recovery on the Errors by Integration, Errors by

Connection, or Error Message Details page.

This submittal creates a unique job ID for the error message recovery process.

Click Error Recovery Jobs.

3-34

Chapter 3

Managing Business Identifiers for Tracking Fields in Messages

In the Search field, enter a partial or complete job ID of the error message recovery process.

View the status of message recovery:

• Received: Recovery is still in progress.

• Success: Recovery succeeded.

• Errors: Recovery failed.

Managing Business Identifiers for Tracking Fields in

Messages

You can view the status of business identifiers included in integrations on the Tracking page.

You can also view the message payload of an instance you are tracking.

Topics

•

Tracking Business Identifiers in Integrations During Runtime

•

Tracking Business Identifiers in Integrations in Which Routing Paths Are Defined

•

Filtering the Display of Business Identifiers in Integrations

See

Assigning Business Identifiers for Tracking Fields in Messages

Tracking Business Identifiers in Integrations During Runtime

You can track fields in messages on which you have defined business identifiers on the Tracking page during runtime. These fields are only available for tracking on the

Tracking page if you defined a primary business identifier in the Business Identifiers for Tracking dialog during design time.

To track business identifiers in integrations during runtime:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Tracking.

The Tracking page is displayed.

From the dropdown list, select the time period during which to search for business identifiers in messages.

Results are displayed for any integration on which a primary business identifier is set, including the business identifier and value, the instance identifier of the

3-35

Chapter 3

Managing Business Identifiers for Tracking Fields in Messages integration, and the state of the integration (for example, completed, failed, or aborted). You can show the name and value of tracking variables.

Click the business identifier to access a graphical display of the integration instance.

This page provides information about the business identifiers and values defined for the integration, the instance identifier of the integration, any error message, the audit trail, the payload message, a button for discarding an error, and other information. The entire message flow is tracked through the integration.

Successful message flows are indicated by green arrows. Any message flow errors that occur are identified by red arrows.

From the menu, select Audit Trail to view the message flow. The audit trail shows details about the movement of the message through the integration, including where any failures occurred. For orchestrated integrations, the message flow through each activity (for example, any defined switch activity branches) is shown.

Select View Activity Stream to view the high level activity stream. If you enabled tracing to include the payload when you activated your integration, more specific payload details are provided.

3-36

Chapter 3

Managing Business Identifiers for Tracking Fields in Messages

Note:

• If you enter a primary business identifier in the Search field, but do not click the Search button, then select a value from the time period dropdown list, note that the instances are filtered considering the string entered in the Search field, even though the Search button was not clicked. This is the expected behavior and is true for other landing pages in Oracle Integration Cloud Service.

• The search facility on the Tracking page is case sensitive.

Tracking Business Identifiers in Integrations in Which Routing Paths

Are Defined

If the integration in which you defined business identifiers also includes definitions for routing paths, you can view the value of the business identifier, the status of the routing path taken based on the business identifier value, the routing expression logic in the blue header above the integration, and the status of the overall integration flow.

The status of the routing path taken and the overall integration flow are indicated by color (green indicates success and red indicates failure).

To track business identifiers in integrations in which routing paths are defined:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Tracking.

The Tracking page is displayed.

From the menu, select the time period during which to search for business identifiers in messages.

Click the business identifier to access a graphical display of the integration instance.

3-37

Chapter 3

Managing Business Identifiers for Tracking Fields in Messages

The page shows (from top to bottom) the value of the business identifier, the status of the routing path taken based on the business identifier value, the routing expression logic in the blue header above the integration, and the status of the overall integration flow.

Filtering the Display of Business Identifiers in Integrations

You can filter the display of business identifiers on the Tracking page during runtime.

To filter the display of business identifiers in integrations:

On the Oracle Integration Cloud Service home page, click the Monitoring diagram.

In the navigation pane, click Tracking.

The Tracking page is displayed.

From the Filter by list, select a display method. The primary identifier is not displayed as a filter. All other identifiers are displayed as filters.

• Message > Additional Business Identifiers

Begin entering the integration name to display names that begin with those letters or select an integration from the dropdown list to see the available tracking fields.

Any business identifiers associated with the integration are displayed.

To filter, enter the exact business value for the business identifier.

Click Set Filter.

•

Integration a.

Begin entering the integration name to display names that begin with those letters or select an integration from the dropdown list to see the available tracking fields.

Click Set Filter.

•

Run id a.

Enter the run ID value for the scheduled integration.

Click Set Filter.

•

Instance id a.

Enter the instance ID value for the scheduled integration.

Click Set Filter.

•

Message State a.

Select to show completed, failed, or aborted integrations.

3-38

Chapter 3

Viewing Preinstalled Adapters and Registering Custom Adapters

Viewing Preinstalled Adapters and Registering Custom

Adapters

You can view the adapters preinstalled with Oracle Integration Cloud Service and register user-created, custom adapters in the Oracle Public Cloud.

Viewing Preinstalled Adapters

On the Oracle Integration Cloud Service home page, click the Adapters diagram.

The Adapters page show the following categories of registered adapters in Oracle

Integration Cloud Service

• Preinstalled: Adapters included with your instance of Oracle Integration Cloud

Service (for example, adapters to which you have subscribed and adapters that are automatically included).

• Private: Custom adapters that you have created and registered.

• Marketplace: Adapters included with the packages imported from the Oracle

Marketplace.

Click the adapter name or select View from the menu at the far right to display information about the adapter.

3-39

Chapter 3

Viewing Preinstalled Adapters and Registering Custom Adapters

If you want to delete an adapter, select Delete from the menu at the far right. You

cannot delete adapters identified as Preinstalled.

Uploading and Registering Custom Adapters

You can upload and register custom cloud adapters that you have designed. During the upload, the adapter is scanned/validated. If there are no issues in white list scanning, then the adapter is deployed to Oracle Integration Cloud Service successfully. If there are errors during white list scanning, those warnings and errors are written to a file and a link to the file is displayed in Oracle Integration Cloud

Service. To design custom cloud adapters, see Developing Custom Oracle Cloud

Adapters.

Click Register.

Click Browse to select the adapter JAR file to upload, then click Register.

3-40

Chapter 3

Sending Service Failure Alerts, System Status Reports, and Integration Error Reports by Notification Emails

During upload, the adapter is deployed to Oracle Integration Cloud Service and validated to ensure security. If the upload is successful, a message is displayed at the top of the page and the adapter is displayed in the list with the words Private.

Though multiple versions of the adapter can be registered, only the latest active version is shown on this page.

If the upload is unsuccessful, possible reasons are as follows:

• Adapter JAR file is invalid (missing the cloud-adapter.xml

file)

• Display name for the adapter is missing

• Adapter has an invalid value for the adapterPlugin ID

(for example, with special characters)

• Adapter has an adapterPlugin ID

similar to any preinstalled adapter

The uploaded adapter JAR is also validated for white listing. In the context of cloud adapters, this refers to the process of scanning the Java

.class

files in the adapter archive and enforcing policies defined in the white list configuration file. When validation fails, along with the failure message, there is a text report link that shows the warnings and errors that caused the adapter upload to fail.

Go to the Connections page to configure the adapter. See

Creating a Connection .

Sending Service Failure Alerts, System Status Reports, and

Integration Error Reports by Notification Emails

You can notify users by email with hourly or daily reports about total messages received, total messages processed, successful messages, failed messages, and successful message rate; with service failure alerts (for example, when a runtime or storage service is down or an agent becomes unavailable); or with a detailed report every five minutes when an integration failure occurs.

Note:

This is a system level setting. Therefore, user A cannot create one notification setup while user B creates another notification setup. User B can see the notification setup created initially by user A and can modify it.

To send service failure alerts, system status reports, and integration error reports by email:

3-41

Chapter 3

Sending Service Failure Alerts, System Status Reports, and Integration Error Reports by Notification Emails

Click

Click Settings > Notifications.

in the upper left corner.

Select when to send an email notification:

• Send an alert when a service failure is detected (for example, when a runtime or storage service is down or an agent becomes unavailable)

– Reports are sent when one or more of the following conditions are detected:

* A change in the status of any components.

* The database quota exceeded the threshold.

* The file system quota exceeded the threshold.

* A quiesced or unquiesced action was performed.

* One or more agent instances become unavailable.

* Oracle Integration Cloud Service entered into read-only mode.

• Send an hourly detailed report

• Send a daily detailed report

• Send a detailed report every five minutes (only if an error occurred)

The report includes the following information:

– POD name (also included in the subject of the email)

– Time period

– Total messages received, processed, succeeded, and failed

– Percentage of successful messages

– Error resubmittal count

– Errors by integration instance and run including messages received, processed, succeeded, and failed, and an instance ID hyperlink that displays audit trail details, integration name, version number, and other information

The email includes a link to the integration instance diagram that appears under the Tracking page for a specific instance. The email also includes a link at the bottom to change the notification settings or completely stop receiving email notifications. Click Oracle Integration Cloud Service to access the

Notifications page to adjust your settings.

In the Distribution list field, enter the email address to which to send the reports and alerts. You can specify multiple email addresses, each separated by commas.

Click Save.

Click Send Now to receive an immediate email about system status.

To stop receiving alerts and reports, clear the checkbox, then click Yes when prompted to confirm.

To revert to your previously saved configuration, click Revert.

3-42

Chapter 3

Setting Logging Levels and Downloading Diagnostic Logs

You can set logging levels and download diagnostic logs in Oracle Integration Cloud

Service. You can also obtain the impacted POD name from the diagnostic logs.

Note:

• Changing logging levels from their default values can fill up disk space and degrade system performance. Ensure that you reset the logger level to the default level when you have completed troubleshooting.

• When you use the search facility, only the first ten results are displayed, even if there are more.

To set logging levels and download diagnostic logs.

On the Oracle Integration Cloud Service home page, click the

menu, then click Settings > Logging Levels.

The loggers available for configuration are displayed. If the logger level is inherited from a parent logger, that information is displayed.

Change the logger level of any logger.

To revert to the previous setting before clicking Save, click Revert.

Click Save.

A message is displayed at the top of the page:

Logger levels updated successfully. Be sure to reset logger level to the default level when troubleshooting has been completed.

Click the icon, then click the Monitoring diagram.

Note:

You can also access the diagnostic logs directly from the Integrations page if your integration activation fails. Click the Download diagnostic logs link at

the top of the page. See Activating an Integration

Click Download Diagnostic Logs.

Note that the downloaded ZIP file name includes the WebLogic Server domain name (the same as your POD name) prepended to the front. For this example, the

POD name of domain_ics_expanded

is prepended to the front: domain_ics_expandeddiagnostic-logs-number.zip

. This enables you to know the POD from which the file is being downloaded.

You can also get the POD name from inside the

AdminServer-diagnostic.log

file that is included in the ZIP file.

3-43

Chapter 3

Reporting Incidents

Unzip the file, and within the expanded directory structure, open

AdminServerdiagnostic.log

If the logger level is set to

NOTIFICATION

, this file also includes the WebLogic Server domain name (the POD name), which is written to the file every 30 minutes (for this example, domain_ics_expanded

is also the name).

[2016-11-09T12:00:00.413-08:00] [AdminServer] [NOTIFICATION] [ICS-10071]

[oracle.ics] [tid: [ACTIVE].ExecuteThread: '5' for queue:

'weblogic.kernel.Default (self-tuning)'] [userId: <anonymous>] [ecid: f1xa8364-21dc-4c08-8843-a57b23b9bde2-000051f5,0] [APP: icswebapp] Weblogic

domain name is "domain_ics_expanded".

An environment.txt

file is part of the downloaded ZIP file. It contains details regarding the Oracle Integration Cloud Service, including the version, mode, and

POD name.

Reporting Incidents

You can report incidents for problematic issues that occur during design time (for example, being unable to open an integration, the failure of connection testing, or the failure of artifact regeneration).

From the username menu in the upper right corner of the page, select Report

Incident.

The Report Incident dialog is displayed.

Enter a meaningful name and description of the incident to help others find and understand this incident.

Click Create.

An incident is created and a message is displayed at the top of the page.

Remember the incident ID number.

Incident report successfully created with ID: "number". You can download it right now or later from the Monitoring dashboard.

Click the icon, then select the Monitoring diagram.

Click Download Incident.

Enter the incident ID number, then click Download.

Save the ZIP file of incident logs to your local drive. The ZIP file includes a readme file with specific details, including the name and description you entered in the

Report Incident dialog. If you open a service request with Oracle Support Services, share this information.

Purging and Retaining Data in the Database

You can determine when to purge the data in your database. You can also view the notification and quiesced thresholds for your database and the percentage of the database that has been used.

3-44

Chapter 3

Purging and Retaining Data in the Database

Click in the upper left corner of the page, then click Settings > Database.

The Database Configuration page is displayed.

Perform the following tasks on this page:

Specify the retention period for purging all instances (payloads, errors) from the system that are older than the retention period. This action reclaims the database space. Every midnight, runtime data older than this retention period is purged. This setting goes into effect when you click Save. The default is three days (in case of a need to revert to the default).

Click Purge Now as a one-off procedure to purge the database. The next nightly purge still runs as scheduled.

View your proximity to the database notification threshold (70% is the threshold at which you can receive a notification alert email), the quiesced mode threshold (80% is the threshold at which you can receive a notification alert email), and the current database space usage. See

Sending Service

Failure Alerts, System Status Reports, and Integration Error Reports by

Notification Emails

3-45

Adapter Configuration Reference

When you add an adapter to a trigger (source) or an invoke (target) in an integration, a wizard prompts you to configure how the data is processed for that connection, including the type of operation to perform, the business objects or fields to use, and so on. The properties you can configure vary by each type of adapter. Click any of the topics below to read more about the properties you can configure for each type of adapter.

Topics

•

Configuring Basic Information Properties

•

Configuring Salesforce Properties

•

Configuring Trigger Oracle Integration Cloud Service Messaging

•

Reviewing Configuration Values on the Summary Page

Configuring Basic Information Properties

You can enter a name and description on the Basic Info page of each adapter in your integration.

Topics

•

What You Can Do from the Basic Info Page

•

What You See on the Basic Info Page

What You Can Do from the Basic Info Page

You can specify the following values on the Basic Info page. The Basic Info page is the initial wizard page that is displayed whenever you drag an adapter to the section of the integration canvas supported by your adapter.

• Specify a meaningful name.

• Specify a description of the responsibilities.

• Select the underlying transport mechanism to use.

4-1

Chapter 4

Configuring Salesforce Properties

What You See on the Basic Info Page

The following table describes the key information on the Basic Info page.

Element

What do you want to call your endpoint?

What does this endpoint do?

Description

Provide a meaningful name so that others can understand the responsibilities of this connection. You can include English alphabetic characters, numbers, underscores, and dashes in the name. You cannot include the following:

• Blank spaces (for example,

My Inbound

Connection

)

• Special characters (for example,

#;83&

or righ(t)now4

)

• Multibyte characters

Enter an optional description of the connection’s responsibilities. For example:

This connection receives an inbound request to synchronize account information with the cloud application.

Configuring Salesforce Properties

The Salesforce Adapter enables you to create integrations with a Salesforce application.

The following sections describe the wizard pages that guide you through configuration of the Salesforce Adapter as a trigger and invoke in an integration. Postconfiguration tasks are also provided.

Topic

•

Understanding Salesforce Constraints

•

Configuring Basic Information Properties

•

Configuring Salesforce Trigger Outbound Messaging Properties

•

Configuring Salesforce Trigger Response Properties

•

Configuring Salesforce Trigger Callback Response Properties

•

Configuring Salesforce Invoke Basic Information Properties

•

Configuring Salesforce Target Operations Properties

•

Configuring Salesforce Target Headers Properties

•

Configuring Salesforce Invoke Custom Operations Properties

•

Reviewing Configuration Values on the Summary Page

•

Performing Salesforce Adapter Postconfiguration Tasks

4-2

Chapter 4

Configuring Salesforce Properties

Understanding Salesforce Constraints

You must be aware of the following constraints before configuring the Salesforce

Adapter.

• The Salesforce Adapter uses the SalesForceDotCom (SFDC) API for all activities.

Therefore, it is subject to any Salesforce API limitations.

• Not all the push topic queries are supported by Salesforce. See Supported Push

Topic Queries and Unsupported PushTopic Queries .

• Client applications must adhere to Salesforce’s SOAP API support policy and backward compatibility terms. These terms are available at SFDC SOAP API

Support Policy .

Configuring Salesforce Trigger Outbound Messaging Properties

Enter the Salesforce trigger outbound messaging values for your integration.

Topics

•

What You Can Do from the Salesforce Trigger Outbound Messaging Page

•

What You See on the Salesforce Trigger Outbound Messaging Page

What You Can Do from the Salesforce Trigger Outbound Messaging Page

You can select the trigger outbound messaging WSDL to use with the Salesforce

Adapter.

You must have already created this WSDL. This process consists of several steps.

What You See on the Salesforce Trigger Outbound Messaging Page

The following table describes the key information on the trigger Outbound Messaging page.

Element

Select the Outbound

Messaging WSDL

Description

Select the invoke Salesforce outbound messaging WSDL to receive outbound message notifications from the Salesforce application.

Note: You must first create a workflow rule and generate an outbound messaging WSDL. Outbound messaging WSDLs associated with approval processes or entitlement processes are also supported and consumed by the adapter.

Browse for and select the invoke Salesforce outbound messaging WSDL

Activate the integration and copy the endpoint URL from the integration information icon.

Go to the Outbound Messaging section at www.salesforce.com

and replace the dummy URL you previously entered with the real endpoint URL.

4-3

Chapter 4

Configuring Salesforce Properties

Configuring Salesforce Trigger Response Properties

Enter the Salesforce trigger response values for your integration.

Topics

•

What You Can Do from the Salesforce Trigger Response Page

•

What You See on the Salesforce Trigger Response Page

What You Can Do from the Salesforce Trigger Response Page

You can configure the response parameters for the Salesforce Adapter.

You can select the type of callback response to send as a response document from the integration flow to the Salesforce Cloud application.

• Configure to send no callback response.

• Configure the operation and business objects to use for a successful callback response.

• Configure the operation and business objects for a callback response for a failed integration flow.

What You See on the Salesforce Trigger Response Page

The following table describes the key information on the trigger Response page.

Element Description

Send a response

Configuration a Successful Callback

Response

Deselect if no callback response is required.

Select Configure to configure the operation and business objects to use for a successful callback response.

Configuration a Failure Callback Response Select Configure to configure the operation and business objects for a callback response for a failed integration flow. The option to configure a failure callback response gets enabled only after the configuration of successful callback response.

Edit

Click to edit the operation or business objects of a successful or failed callback response.

This button is displayed after you configure a successful callback response, a failed callback response, or both.

Header

Click to configure the header properties for the selected operation. The headers available for configuration are based on the type of operation you selected.

This button is displayed after you configure a successful callback response, a failed callback response, or both.

4-4

Chapter 4

Configuring Salesforce Properties

Element

Reset

Description

Click to reset the operation and header configuration to the default values.

This button is displayed after you configure a successful callback response, a failed callback response, or both.

Configuring Salesforce Trigger Callback Response Properties

Enter the Salesforce trigger callback response values for your integration.

Topics

•

What You Can Do from the Salesforce Trigger Callback Response Page

•

What You See on the Salesforce Trigger Callback Response Page

What You Can Do from the Salesforce Trigger Callback Response Page

You can configure the callback response parameters for the Salesforce Adapter.

• Configure the operation and business objects to use for a successful callback response.

• Configure the operation and business objects for a callback response for a failed integration flow.

What You See on the Salesforce Trigger Callback Response Page

The following table describes the key information on the trigger Callback Response page.

Element

Select an Operation Type

Description

Select the type of operation to perform on the business objects in a Salesforce Cloud application:

• CORE: Displays the following selections:

ConvertLead, Merge, Undelete, or

Upsert.

• CRUD: Represents the create, read, update, delete, or destroy operations to perform on Salesforce Cloud business objects. Each letter maps to a standard

SQL statement, HTTP method, or DDS operation. Select the CRUD operation to perform on the business object: Create,

Delete, or Update.

Note: For the Update operation, external

ID cannot be mapped to ID.

• MISC: Represents the set of specialized task operations to perform in the

Salesforce Cloud application.

4-5

Chapter 4

Configuring Salesforce Properties

Element

Filter by object name

Select Business Objects (Salesforce API

version)

Your Selected Business Objects

Description

Enter the initial letters of an object name to display a range of objects. You can also enter an asterisk (

) after the query in the search field (for example, to search for all objects starting with

Acc

, enter

Acc*

). You can also select a filter type:

• All: Displays all objects.

• Custom: Displays objects you created.

The naming convention is a combination of the object name appended with

• Standard: Displays business objects delivered as part of the Salesforce Cloud application.

Select a single business object or multiple business objects from the Salesforce Cloud application. The selected operation acts upon these business objects.

When you complete invoke operation configuration, the selected operation and business objects are defined in the integrationcentric WSDL file.

Displays the business objects you selected.

Configuring Salesforce Invoke Basic Information Properties

You can enter a name and description and select the type of WSDL to use on the

Salesforce invoke Basic Info page.

Topics

•

What You Can Do from the Salesforce Invoke Basic Info Page

•

What You See on the Salesforce Invoke Basic Info Page

What You Can Do from the Salesforce Invoke Basic Info Page

You can specify the following values on the Salesforce Cloud target Basic Info page.

The Salesforce Cloud invoke Basic Info page is the initial wizard page that is displayed whenever you drag an adapter to the invoke area.

• Specify a meaningful name.

• Specify a description of the connection responsibilities.

• Select to use a standard application delivered by salesforce.com

(enterprise

WSDL) or custom application built using Apex classes and hosted on force.com

(custom WSDL).

4-6

Chapter 4

Configuring Salesforce Properties

What You See on the Salesforce Invoke Basic Info Page

The following table describes the key information on the Salesforce Cloud invoke

Basic Info page.

Element

What do you want to call your endpoint?

What does this endpoint do?

Select outbound support option

Description

Provide a meaningful name so that others can understand the connection. For example, if you are creating an invoke

Salesforce Cloud connection, you may want to name it

SalesforceOutboundDirection

. You can include English alphabetic characters, numbers, underscores, and dashes in the name. You cannot include the following:

• Blank spaces (for example,

My Salesforce Connection

)

• Special characters (for example,

#;83&

or righ(t)now4

)

• Multibyte characters

Enter an optional description of the connection’s responsibilities. For example:

This connection receives an outbound request to synchronize account information with the Salesforce Cloud Application.

Select the type of WSDL to use.

• Standard applications delivered by Salesforce.com:

Select this option if you want to use the enterprise WSDL that you specified in the Connection Properties dialog during adapter configuration. If you select this option, you are taken to the Operations page to select an operation type and business object to use.

•

Custom applications built using Apex Classes and

hosted on force.com: Select this option if you want to use a custom WSDL that includes custom Apex classes written on force.com

and exposed as SOAP web services. This enables external applications to access your code and application. If you select this option, you are taken to the

Custom Operations page.

Configuring Salesforce Invoke Operation Properties

Enter the Salesforce invoke operation values for your integration.

Topics

•

What You Can Do from the Salesforce Target Operations Page

•

What You See on the Salesforce Target Operation Page

What You Can Do from the Salesforce Invoke Operations Page

You can configure the following invoke operations values for Salesforce Cloud.

• Select either of the following operation types:

CRUD

Salesforce Object Query Language (SOQL) or Salesforce Object Search

Language (SOSL) query

• Select the business objects.

4-7

• Specify the SOQL/SOSL query.

Chapter 4

Configuring Salesforce Properties

4-8

Chapter 4

Configuring Salesforce Properties

What You See on the Salesforce Invoke Operations Page

The following table describes the key information on the Salesforce Cloud invoke

Operations page.

Element

Select an

Operation

Type

Description

Select the type of operation to perform:

• CORE : Represents all core operations supported by the Salesforce application.

• CRUD: Represents the create, read, update, delete, or destroy operation to perform on Salesforce business objects. Each letter maps to a standard

SQL statement, HTTP method, or DDS operation. Select the CRUD operation to perform: Create, Delete, Retrieve, or Update.

Note: For the Update operation, external ID cannot be mapped to ID.

• MISC: Represents specialized task operations (such as fetching user information associated with the current session) in the Salesforce application.

• SOSL/SOQL: Select to enter a Salesforce Object Query Language

(SOQL) or Salesforce Object Search Language (SOSL) query to send as a request to the Salesforce application. The following operations are available:

– query: Executes a query against specific criteria and returns data matching that criteria. Only records not deleted from your Salesforce application account are returned.

– queryAll: Returns the same data as the query operation, along with deleted records present in the recycle bin.

– search: Returns records from the Salesforce application. You can specify binding parameters to dynamically provide a search string as input to your search operation.

If you select this option, the page is refreshed to display a field for entering an SOQL or SOSL query to send for validation:

– Query Statement: Enter a valid query statement. SOQL statements evaluate to a list of sObjects, a single sObject, or an integer for count method queries. The following examples are provided:

“SELECT Id FROM Contact WHERE Name LIKE 'A%' AND MailingCity

= 'California'”

SELECT COUNT() FROM Contact

SOSL statements evaluate to a list of sObjects, where each list contains the search results for a particular sObject type. For example:

“SELECT a.name, a.id, a.accountNumber, c.name from Contact c, c.Account”

– Binding Parameters: Displays any parameters included in the query.

For example, orgId

is a parameter in the following query:

SELECT a.name, a.id, a.accountNumber, c.name from Contact c, c.Account a WHERE a.name = "&orgId"

This query displays a binding parameters text box in which to enter a test value for orgId

– Test My Query. Click to validate the query against the Salesforce application. Query results are displayed. If errors occur, you receive results about how to correct the query.

4-9

Chapter 4

Configuring Salesforce Properties

Element

Filter By

Object Name

Select

Business

Objects

Description

Type the initial letters to filter the display of business objects. You can also select a filter type:

• All: Displays all objects.

• Custom: Displays objects you created. Custom business objects are appended with “

.”

• Standard: Business objects delivered as part of the Salesforce application.

Select a single or multiple business objects to include in the operation. You can select up to ten objects for one operation.

Configuring Salesforce Invoke Header Properties

Enter the Salesforce invoke header values for your integration.

Topics

•

What You Can Do from the Salesforce Target Headers Page

•

What You See on the Salesforce Target Headers Page

What You Can Do from the Salesforce Invoke Headers Page

You can configure the invoke header properties for Salesforce Cloud.

What You See on the Salesforce Invoke Headers Page

The following table describes the key information on the Salesforce Cloud invoke

Headers page.

The headers available for configuration are based on the operation you selected on the invoke Operations page. There are two types of headers:

• Request headers are sent with the request message to the Salesforce application.

• Response headers are received with the response message sent from the

Salesforce application.

Visit www.salesforce.com

and specify the specific name of the header property in the search utility.

4-10

Chapter 4

Configuring Salesforce Properties

Element Description

AllOrNoneHeader (request header) Specifies the transactional behavior for Salesforce application operations. The behavior of this parameter is based on the version of the integration and is applicable to the create, delete, update, undelete, and upsert operations.

• Integration flows created before version 16.4.1:

– If set to true and the response contains error elements, it maps to

UnexpectedErrorFault

This is also the case if AllOrNoneHeader is set to false (that is, unselected).

• Integration flows created for version 16.4.1 and later:

– If set to true (that is, selected and there are error elements), it maps to

UnexpectedErrorFault

– If set to false (that is, unselected), the adapter returns the whole response even if it contains error elements along with success elements in the response.

If you want integration flows created before 16.4.1 to use the new behavior, edit the Salesforce Adapter in the

Adapter Endpoint Configuration Wizard.

AllowFieldTruncationHeader

(request header)

AssignmentRuleHeader (request header)

Specifies the truncation behavior for the following fields

(each are string data types):

• anyType

• email

• picklist

• encryptedstring

• textarea

• mulitpicklist

• phone

• string

Set allowFieldTruncation to one of the following values:

• True: If you enter a value of 25 characters in a field of 20 characters, the first 20 records are inserted into the field and the transaction is successful.

• False: If you enter a value of 25 characters in a field of 20 characters, an error is thrown and the transaction does not commit.

Specifies the assignment rule to use when creating or updating an account, case, or lead. The assignment rule can be active or inactive. The ID is retrieved by querying the

AssignmentRule

object. If the ID is specified, you do not need to specify the useDefaultRule value.

• assignmentRuleId: The ID of the assignment rule to use. The ID is not validated by the Salesforce

Cloud application, whether or not it exists. Validation occurs during runtime.

• useDefaultRule: If set to true, the default (active) assignment rule is used. If set to false, the default

(active) assignment rule is not used.

4-11

Chapter 4

Configuring Salesforce Properties

Element Description

EmailHeader (request header) Specifies whether or not to send a notification email. You can set the following properties:

•

triggerAutoResponseEmail

– true: Triggers automatic response rules for leads and cases.

– false: Automatic response rules for leads and cases are not triggered.

•

triggerOtherEmail

– true: The email is triggered outside the organization.

– false: The email is not triggered outside the organization.

•

triggerUserEmail

– true: The email is triggered and sent to users in the organization. This email is triggered by a number of events such as adding comments to a case or updating a task.

– false: The email is not triggered and sent to users in the organization.

DebuggingHeader (request header) Specify the debugging log level. The following log levels are supported:

• NONE (least verbose)

•

DEBUGONLY

•

PROFILING

•

CALLOUT

• DETAIL (most verbose)

MruHeader (request header) The Salesforce application shows the most recently used

(MRU) items. In API version 7.0 or later, the list is not updated by itself. Use MruHeader to update the list.

Using this header can negatively impact performance.

Set updateMru to one of the following values:

• true: The list of MRU items is updated in the

Salesforce application.

• false: The list of most recently used items is not updated in the Salesforce application.

PackageVersionHeader (request header)

Specifies the package version for any installed package.

The package version identifies the components in a package. The package version follows the format majorNumber.minorNumber.patchNumber

(for example,

3.4.5

, where

refers to majorNumber

refers to minorNumber

, and

refers to patchNumber

) .

QueryOptions (request header) Specifies the batch size for queries. The default value is

500

, the minimum value is

200

, and the maximum value is

2000

DebuggingInfo (response header) This information is only returned if the debugLevel request header is sent with the request payload to the

Salesforce application.

4-12

Chapter 4

Configuring Salesforce Properties

Element Description

LimitInfoHeader (response header) Provides information about the limitations of API calls on a per-day basis for the organization.

• current:

The number of calls already used in the organization.

• Limit:

The organization’s limit for the specified limit type.

• Type:

The limit information type specified in the header

API REQUESTS

(contains limit information about API calls for the organization).

Configuring Salesforce Invoke Custom Operations Properties

Specify the following values on the Salesforce invoke Custom Operations page.

Topics

•

What You Can Do from the Salesforce Invoke Custom Operations Page

•

What You See on the Salesforce Invoke Custom Operations Page

What You Can Do from the Salesforce Invoke Custom Operations Page

You can specify the following values on the Salesforce Cloud invoke Custom

Operations page.

• Select the custom WSDL.

• Select the operations to perform.

• Optionally select a new custom WSDL to use.

What You See on the Salesforce Invoke Custom Operations Page

The following table describes the key information on the Salesforce Cloud invoke

Custom Operations page.

Element

Select the Custom WSDL

Description

Select the custom WSDL to use.

Operations in Uploaded

WSDL

Displays the list of operations included in the uploaded custom

WSDL. Select the operation to perform in the Salesforce Cloud application.

Select New Custom WSDL

Click Choose File to select the custom WSDL to use. This selection replaces any previously uploaded WSDL file. After selecting the new WSDL, return to the Operations in

Uploaded WSDL list and select the new operation to use.

To use a custom WSDL that includes custom Apex classes written on force.com

and exposed as SOAP web services, see

Exposing Apex Methods as SOAP Web Services .

4-13

Chapter 4

Configuring Trigger Oracle Integration Cloud Service Messaging

Performing Salesforce Adapter Postconfiguration Tasks

After activating your integration, you must update the outbound message for the

Salesforce Adapter to send messages to Oracle Integration Cloud Service. This section describes how to activate a workflow rule.

Open the Salesforce application.

Scroll down and click Workflow Rules.

In the Workflow Rules panel, click the workflow rule.

Scroll down to the Immediate Workflow Actions section and click the outbound message.

In the Outbound Message panel, click Edit.

In the Edit Outbound Message panel, enter the endpoint URL from the

Integration Details icon for the integration.

In the Edit Outbound Message panel, click Save.

The Outbound Message panel is displayed.

In the Outbound Message panel, scroll down and find the Workflow Rules

Using This Outbound Message section.

Click the workflow link.

The Workflow Rule panel is displayed.

10.

In the Workflow Rule panel, click Activate.

Your workflow is activated. The Salesforce application starts sending messages to the integration endpoint URL created when you activated the integration.

Configuring Trigger Oracle Integration Cloud Service

Messaging

Configure trigger Oracle Integration Cloud Service Messaging for your integration. This dialog is displayed when you add Oracle Integration Cloud Service Messaging as a trigger to an integration.

Topics

•

What You Can Do from the Trigger Oracle Integration Cloud Service Messaging

Page

•

What You See on the Trigger Oracle Integration Cloud Service Messaging Page

See

Oracle Integration Cloud Service Messaging

Creating an Integration to Publish

Messages to Oracle Integration Cloud Service , and

Creating an Integration to

Subscribe to Oracle Integration Cloud Service

4-14

Chapter 4

Reviewing Configuration Values on the Summary Page

What You Can Do from the Trigger Oracle Integration Cloud Service

Messaging Page

You can configure the trigger Oracle Integration Cloud Service Messaging. This enables you to subscribe to messages from Oracle Integration Cloud Service.

Message subscription is accomplished through use of Oracle Integration Cloud

Service Messaging.

Select the published integration to which to subscribe.

What You See on the Trigger Oracle Integration Cloud Service

Messaging Page

The following table describes the key information on the trigger Oracle Integration

Cloud Service Messaging page.

Element

Select a Publisher

Description

Select the published integration to which to subscribe.

You must have already created a publisher to which to subscribe. The publisher does not need to be active, but must already be completely configured. After selecting a published integration, you perform the following tasks:

• Add an invoke adapter to the integration to subscribe to the published integration.

• Perform source-to-target mapping between the published integration and the invoke adapter.

• Optionally configure source enrichments between the published integration and the invoke adapter.

Reviewing Configuration Values on the Summary Page

You can review the specified adapter configuration values on the Summary page.

Topics

•

What You Can Do from the Summary Page

•

What You See on the Summary Page

What You Can Do from the Summary Page

You can review configuration details from the Summary page. The Summary page is the final wizard page for each adapter after you have completed your configuration.

• View the configuration details you defined for the adapter. For example, if you have defined an inbound trigger (source) adapter with a request business object and immediate response business object, specific details about this configuration are displayed on the Summary page.

• Click Done if you want to save your configuration details.

4-15

Chapter 4

Reviewing Configuration Values on the Summary Page

• Click a specific tab in the left panel or click Back to access a specific page to update your configuration definitions.

• Click Cancel to cancel your configuration details.

What You See on the Summary Page

The following table describes the key information on the Summary page.

Element

Summary

Description

Displays a summary of the configuration values you defined on previous pages of the wizard.

The information that is displayed can vary by adapter. For some adapters, the selected business objects and operation name are displayed. For adapters for which a generated

XSD file is provided, click the XSD link to view a read-only version of the file.

To return to a previous page to update any values, click the appropriate tab in the left panel or click Back.

4-16

Using On-Premises Oracle Integration

Cloud Service

When you subscribe to Oracle Integration Cloud Service, you also have the option to install an on-premises version of Oracle Integration Cloud Service in your local environment. This installation provides you with an expanded domain that consists of one administration server and one managed server on the same host. This enables you to use on-premises Oracle Integration Cloud Service as a proxy server that sits between your internal company server hidden behind a fire wall and the cloud version of Oracle Integration Cloud Service. After installation, you can create users and assign roles to these users on the Users page of on-premises Oracle Integration Cloud

Service.

On-premises Oracle Integration Cloud Service is highly available. On-premises Oracle

Integration Cloud Service is useful for development and test environments. All messages are processed on-premises. The primary use case is where the application endpoints are both on-premises. Message data remains on-premises, which helps with data sovereignty.

Key differences from the public cloud version are as follows:

• No agent support is provided.

• You must manually upgrade the installation to the latest version.

• An external on-premises database is recommended that requires an additional license.

On-premises Oracle Integration Cloud Service can call external systems. To receive calks from external systems, you must open your company firewall. For bidirectional access to cloud systems, it is recommended that you instead use the public cloud version of Oracle Integration Cloud Service.

Topics

•

Downloading and Running the On-Premises Oracle Integration Cloud Service

Installer

•

Managing Users and Roles

Downloading and Running the On-Premises Oracle

Integration Cloud Service Installer

You must download an execution agent installer from the Agent Groups page of

Oracle Integration Cloud Service to your on-premises host and run the installer to install on-premises Oracle Integration Cloud Service. This installation provides you with an expanded domain that consists of one administration server and up to two

5-1

Chapter 5

Downloading and Running the On-Premises Oracle Integration Cloud Service Installer managed server on the same host. You must install an Oracle Database prior to installing on-premises Oracle Integration Cloud Service.

•

Restrictions

•

System Requirements

•

Downloading and Running the On-Premises Oracle Integration Cloud Installer

•

Starting and Stopping the Administration and Managed Servers

•

Adding Additional Managed Servers to a Cluster

•

Troubleshooting Execution Agent Installation

Restrictions

The File Adapter is not supported with on-premises Oracle Integration Cloud Service.

When creating a connection, do not select this adapter in the Create Connection -

Select Adapter dialog.

Note:

For Oracle CPQ Cloud Adapter to work, you must open up a port for external clients to call the services hosted on on-premises Oracle Integration Cloud

Service.

System Requirements

Ensure that you satisfy the following prerequisites on your on-premises host before installing on-premises Oracle Integration Cloud Service:

• Operating system: Oracle Enterprise Linux 6 UC4 or above

• CPUs: 2

• Physical memory: 8 GB

• Hard disk space: 100 GB

• Database: Oracle Database (XE or Standard).

• Hostname on which to perform the installation must be entered in the

/etc/hosts file. Without this entry, you receive an error during installation.

• User performing the installation must be a member of the sudoers

file. If the user is not, the chef client portion of the on-premises Oracle Integration Cloud Service installation fails.

• The chef client must not already be installed on the host and must not be manually installed.

Note:

If you previously installed and used on-premises Oracle Integration Cloud

Service, you must export your integrations and lookups and import them into

Oracle Integration Cloud Service after completing installation.

5-2

Chapter 5

Downloading and Running the On-Premises Oracle Integration Cloud Service Installer

Downloading and Running the On-Premises Oracle Integration Cloud Service

Installer

If you previously installed on-premises Oracle Integration Cloud Service, you must perform the following steps:

• Stop the Oracle WebLogic Server before installing the execution agent from the agenthome/userprojects/domains/agent-domain/bin

directory.

./stopWebLogic.sh

• Specify a new directory location during installation. The installation must be done in a new location and not over the previous installation.

To download and run the on-premises Oracle Integration Cloud Service installer.

Note:

The user installing the execution agent must be configured for sudo

access to run the rpm

command.

On the Oracle Integration Cloud Service home page, click Agents.

The Agent Groups page is displayed.

Click Download.

Select Execution Agent. The execution agent is used for on-premise installations of Oracle Integration Cloud Service.

Select Save File when prompted to save the ZIP file to a directory location on your on-premises host.

Unzip the ZIP file. The ics-executionagent-installer.bsx

execution agent file is included in the ZIP file.

Change the file permissions of the ics-executionagent-installer.bsx

file to be executable.

chmod 755 ics-executionagent-installer.bsx

Execute the installer.

./ics-executionagent-installer.bsx

This starts the authentication part of the installation. During authentication, you are prompted to specify configuration details.

Enter the following authentication information when prompted:

5-3

Chapter 5

Downloading and Running the On-Premises Oracle Integration Cloud Service Installer

When Prompted With the Following...

Enter your ICS subscription URL for authentication

Enter...

Enter the URL for the Oracle Integration Cloud Service instance to which you are subscribed. For example: https://podserver.us.oracle.com:7002/ics

Ensure that you specify the correct URL. During installation, files are downloaded from this host instance. Specifying an incorrect

URL causes authentication to fail.

Enter ICS subscription

Username

Enter the user name for the Oracle Integration Cloud Service instance to which you are subscribed. For example: weblogic

Enter ICS subscription

Password

Enter HTTPS Proxy

Server Host Name

Enter the password for the user name of the Oracle Integration

Cloud Service instance to which you are subscribed.

If you have a proxy server configured in your local environment, enter the server URL. For example: www-myproxy.us.mycompany.com

Enter HTTPS Proxy

Server Port Number

If you do not have a proxy server, press Enter without entering a value to bypass this step.

If you have a proxy server configured in your host environment, enter the port value. For example:

If you do not have a proxy server, press Enter without entering a value to bypass this step.

If the information you enter is correct, the following message is displayed.

Authentication Successful. Starting ICS On Premise Install!!

If authentication was not successful, review the log file in the directory path shown on-screen to identify which information was incorrect.

10.

Enter the following installation information when prompted:

When Prompted With the Following...

What Do You Want to call this Execution

Agent?

Press enter to accept the default path or enter a new install path

Enter the user name

(cannot be root) to be used for install

Enter...

Enter a name that you want to use for the agent ID.

Ensure that you specify the correct value. Specifying an incorrect value causes installation to fail.

Accept the default path or enter a different directory location in which to install the on-premises Oracle Integration Cloud Server.

If you enter a different directory path, it must already exist.

Enter the UNIX user name to use for performing this installation.

For example: builder

5-4

Chapter 5

Downloading and Running the On-Premises Oracle Integration Cloud Service Installer

When Prompted With the Following...

Enter the group

(groups <user> will list the groups of a user) of the user to be used for install

Press enter to accept the default value or enter a new port number

Enter...

Enter the group of the user who is performing this installation.

For example: dba

Press Enter to accept the default non-SSL port value. Do not enter a new value. By default, the following message is displayed.

Default HTTP Port for ICS Execution Agent: 7001

Press enter to accept the default value or enter a new port number

Enter the password for the default user weblogic

Press Enter to accept the default SSL port value. Do not enter a new value. By default, the following message is displayed.

Default HTTPS Port for ICS Execution Agent: 7002

Enter the password for the weblogic user. After installation, you use this user name and password combination to log in to

Oracle Integration Cloud Service for the first time to create additional users and assign roles to those users under the

Users tab.

11.

Provide the following information for the Oracle Database:

When Prompted With the Following...

Database host name

Database Port

Database user name with the SYSDBA role

Database user password

Password for on-premises schemas

Oracle Integration Cloud Service

Database SID/service name

Enter...

Enter the host name for the server on which the Oracle Database is installed.

Enter the port number of the host.

Enter the database user name. This user is used by the Repository Creation Utility

(RCU) to create the necessary schemas.

Enter the password for the database user name.

Enter the password for the on-premises

Oracle Integration Cloud Service schemas created by the RCU.

Enter the database system identifier (SID)/ service name.

12.

Provide the following information if you want to use a front end host:

When Prompted With the Following...

Enter front end host

Enter front end port

Enter front end ssl port

Enter...

Enter the front end host to use.

Enter the port number of the front end host.

Enter the SSL front end port number.

The installer connects to the Oracle Integration Cloud Server instance you specified during the authentication part of installation to verify installation details, identify heartbeat information, download files, and install components, including

Oracle WebLogic Server and Oracle Integration Cloud Service. Messages are displayed on-screen.

5-5

Chapter 5

Downloading and Running the On-Premises Oracle Integration Cloud Service Installer

If installation is not successful, review the log file in the directory path shown onscreen to identify the issue.

If installation completes successfully, the following message is displayed. The installation log file location is also displayed.

Chef Client finished

The on-premises installation submits a heartbeat message to the cloud version of

Oracle Integration Cloud Service every five minutes to indicate that the onpremises installation is running.

13.

Cloud Service subscription username and password you entered in Step 10 of the installation process.

Note that there is a Users tab on the home page for creating users and assigning

roles to these users. See Creating Users and Assigning Roles

. Unlike the cloud version of Oracle Integration Cloud Service, there is no Agents box for managing agents on the home page. Those management tasks are not required in onpremises Oracle Integration Cloud Service.

14.

Log in to the cloud version of the Oracle Integration Cloud Service that you specified during the authentication part of installation. This is the host from which you downloaded the execution agent at the beginning of these instructions.

15.

Click Agents.

16.

Note that Execution Agent Group is displayed. The number of agents is 1 to identify the on-premises installation of Oracle Integration Cloud Service.

17.

Click the number above Number of Agents to display the agent ID that you specified during installation. This is the agent ID of your on-premises installation.

18.

Click Monitor, then click Agents to also see details about agent health based on the heartbeat.

Starting and Stopping the Administration and Managed Servers

Use the following commands to start and stop the administration and managed servers:

• Start the administration server:

On_Premises_ICS_Install_Path/ICSOP/data/user_projects/domains/expanded_domain/ startWebLogic.sh

• Stop the administration server:

On_Premises_ICS_Install_Path/ICSOP/data/user_projects/domains/ expanded_domain/bin/stopWebLogic.sh

• Start the managed server:

On_Premises_ICS_Install_Path/ICSOP/data/user_projects/domains/ expanded_domain/bin/startManagedWebLogic.sh ics_server1

5-6

Chapter 5

Downloading and Running the On-Premises Oracle Integration Cloud Service Installer

• Stop the managed server:

On_Premises_ICS_Install_Path/ICSOP/data/user_projects/domains/ expanded_domain/bin/stopManagedWebLogic.sh ics_server1

Adding Additional Managed Servers to a Cluster

When you install on-premises Oracle Integration Cloud Service, a cluster consisting of one administration server and one managed server is installed. You can install two additional managed servers in this cluster. These additional managed servers must be installed on a different host. The managed servers must be in the same subnet.

Go to the installer home on the instance on which on-premises Oracle Integration

Cloud Service is installed.

Find and run the

AddNewNode.sh

script.

Enter the following details when prompted:

• New host name on which to install the additional managed server. This host must not have any old Oracle WebLogic Server installations.

• Name for the node manager.

• Name for the managed server (typically named ics_server1, ics_server2, and so on).

• If you have your own load balancer, enter

. It is recommended that you provide your own load balancer for production environments. Configure the load balancer to support SSL. Use the HTTP servlet only for testing environments, and not for a production environment.

– Enter the load balancer server name.

– Enter the ports.

• If you do not have your own load balancer, enter

. This action installs an

HTTP servlet that acts as a load balancer.

The script runs and creates a ZIP file named

AddNode.zip

in the installation home.

Copy the

AddNode.zip

file to the new host on which to install the managed server.

Ensure that the directory path on the new host is the same as on the administration server.

Unzip the file in that directory path.

The

AddNode

folder is created.

Change directories to that folder.

Run the runOnNewNode.sh

script.

This sets up the new node and starts the new managed server.

All managed servers must now be restarted.

Start the node manager on all hosts in the cluster:

./Install_Home/ICSOP/data/user_projects/domains/expanded_domain/bin/ startNodeManager.sh

10.

Start the administration server:

./Install_Home/ICSOP/data/user_projects/domains/expanded_domain/startWeblogic.sh

5-7

Chapter 5

Managing Users and Roles

11.

Start the managed servers. You can start and stop the managed servers from

Oracle WebLogic Server Administration Console if the node manager is running on the respective hosts.

Troubleshooting Execution Agent Installation

• Do not log in as root

• Check if the database is running.

• If setup fails, delete the

ICSOPInstall

folder and start a fresh setup.

• Ensure that the download location has enough space because the installer is 3.1

GB (if it fails the browser does not provide any indication).

• If the following error is displayed when reading any binary files or unzipping files during execution agent installation, you must remove the ics_generic.zip

file from the

ICSOPInstall\tmp

directory and restart the installation.

Error executing action `run` on resource 'execute[Unzipping /<PATH>/ ics_generic.zip to: /<PATH>/ICSOPInstall/tmp]'

Managing Users and Roles

You can create new users and assign roles to these users on the Users page of onpremises Oracle Integration Cloud Service. You can also edit information assigned to users (such as roles and passwords) and delete users.

Topics

•

Creating Users and Assigning Roles

•

Editing On-Premises Users

•

Deleting On-Premises Users

Creating Users and Assigning Roles

On-premises Oracle Integration Cloud Service provides a Users page on which you can create users and assign roles to these users. You can also update the roles, password, and other information assigned to existing users. The Users page is only available with on-premises Oracle Integration Cloud Service.

The Users page is only accessible to administrative users of on-premises Oracle

Integration Cloud Service. The weblogic user for which you provided a password during installation can be used to create users on the Users page. If you create an additional user with the IntegrationServiceAdmin role, they also have access to the

Users page.

Creating New Users and Assigning Roles to New Users

On the Oracle Integration Cloud Service home page, click

The Users page is displayed.

Click Create.

, then click Settings > Users.

5-8

Chapter 5

Managing Users and Roles

Enter the following information, and click Create.

Field Description

User Name

Provide a meaningful name so that others can understand the user name. The name must be unique among all user names in the system. The name can consist of the following:

• Letters (A-Z, a-z)

• Numbers (0-9)

• Spaces ( )

• Special characters ( _ - )

The name must not begin or end with a space and cannot be longer than 50 characters.

Enter a password for the user.

Enter the same password a second time.

Password

Confirm

Password

First Name

Enter the first name of the user.

Last Name

Email Address

Enter the last name of the user.

Enter the email address of the users. When you complete creation of this user, they receive an email with login details.

Provide a meaningful description of the responsibilities of the user.

Description

Available Roles

• IntegrationServiceDeveloper: Enables you to access Oracle

Integration Cloud Service to create, deploy, and monitor integrations. You can access all parts of Oracle Integration Cloud

Service with this role.

• IntegrationServiceMonitor: Enables you to access Oracle

Integration Cloud Service to monitor integrations. Only the monitoring dashboard is available with this user role. If you click the Integrations, Connections, Lookups, Packages, or Agents icons on the home page, you receive a

User is not authorized to perform this action

message.

• IntegrationServiceRuntime: Enables you to access runtime services. This role is assigned to a user and uses SOAP/REST to communicate with services at runtime. This role only has privileges to execute a flow. You can pass the username/ password with this role to invoke SOAP/REST APIs. A user with this role can log in, but cannot perform any action and receives a

User is not authorized to perform this action

message on the home page.

• IntegrationServiceEMMonitor: Used for REST API calls into

Oracle Integration Cloud Service. This is an infrastructure role that an on-premises Oracle Integration Cloud Service user does not need to be assigned.

• IntegrationServiceAdmin: Enables you to access Oracle

Integration Cloud Service to create, deploy, and monitor integrations. You can access all parts of Oracle Integration Cloud

Service, including the Users tab for managing users.

• IntegrationServiceMarketplace: Enables you to access the

Oracle Marketplace link in the upper right corner to import marketplace integrations into Oracle Integration Cloud Service.

Selected Roles

Displays the roles assigned to the user.

5-9

Chapter 5

Managing Users and Roles

Updating Roles Assigned to Existing Users

On the Oracle Integration Cloud Service home page, click

, then click Settings > Users.

Find the user to modify.

From the menu icon at the far right, select Manage Roles.

The roles currently assigned to the user are displayed in the Selected Roles section.

Select the roles to add or remove from this user. Descriptions of available roles are provided in the previous steps.

Click OK.

Note:

If you log in with the administrator account (for example, weblogic) and remove all roles from an existing user (for example, named ics_myaccount), then log in immediately with ics_myaccount, note that this user still retains all their roles, even though you had removed them. This is because there is a time delay of 20 to 60 seconds only when all roles of a user are granted or revoked. This time delay does not occur when granting or revoking several roles.

Editing On-Premises Users

You can edit the first name, last name, email address, description, and password of users in on-premises Oracle Integration Cloud Service.

To edit on-premises users:

On the Oracle Integration Cloud Service home page, click

, then click Settings > Users.

The Users page is displayed.

To edit the first name, last name, email address, and description of a user:

Find the user to edit.

From the menu icon at the far right, select Edit.

Edit the first name, last name, email address, or description of the selected user, and click OK.

5-10

Chapter 5

Managing Users and Roles

Note:

If you delete the last name of an existing user, click OK, then re-enter this dialog, note that the user’s login name is added to this field in place of the deleted last name. This is the expected behavior.

To edit the password of a user:

Find the user to edit.

From the menu icon at the far right, select Change Password.

Enter the new password twice, and click OK.

Deleting On-Premises Users

You can delete users in on-premises Oracle Integration Cloud Service.

To delete on-premises users:

On the Oracle Integration Cloud Service home page, click

, then click Settings > Users.

The Users page is displayed.

Find the user to delete.

From the menu icon at the far right, select Delete.

Click Yes when prompted to confirm.

5-11

Oracle® Cloud

Using Oracle Integration Cloud Service

Contents

Preface

Getting Started with Oracle Integration Cloud Service

Developing Integrations with Oracle Integration Cloud Service

Administering Oracle Integration Cloud Service

Adapter Configuration Reference

Using On-Premises Oracle Integration Cloud Service

Preface

Audience

Documentation Accessibility

Related Resources

Conventions

Getting Started with Oracle Integration

Cloud Service

Running the Sample Integrations

Running the Echo Sample

Running the Hello World Sample

Running the Hello World Invoke Sample

Running the Hello World Data Map Invoke Sample

Running the File Transfer Sample

Running the Incident Details from Service Cloud Sample

About Oracle Integration Cloud Service

About Oracle Integration Cloud Service Concepts

About Oracle Integration Cloud Service Connections

Connection Creation

Oracle Integration Cloud Service Messaging

About Oracle Integration Cloud Service Integrations

Related Topics

About Mappings

Mapping Request Data Between Applications

Mapping Response Data Between Applications

About Mapping Multiple Sources to a Target

About Oracle Integration Cloud Service Enrichments

About Oracle Integration Cloud Service Lookups

About Oracle Integration Cloud Service Packages

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

About Monitoring

About Error Management

About Business Identifiers for Tracking Fields in Messages

Starting Oracle Integration Cloud Service

Navigating Oracle Integration Cloud Service

About Oracle Integration Cloud Service Roles and User

Accounts

Developing Integrations with Oracle

Integration Cloud Service

Typical Workflow for Creating Integrations with Oracle

Integration Cloud Service

Creating Connections

Creating a Connection

Adding a Contact Email

Configuring Connection Properties

Configuring Connection Security

Testing the Connection

Editing a Connection

Cloning a Connection

Deleting a Connection

Unlocking a Connection

Refreshing Integration Metadata

Managing Security Certificates

Uploading an SSL Certificate

Updating or Deleting an SSL Certificate

Creating Integrations

Creating an Integration

Understanding Integration Patterns

Importing a Prebuilt Integration

Adding a Trigger (Source) Connection

Adding an Invoke (Target) Connection

Creating Orchestrated Integrations

Creating an Orchestrated Integration

Defining Inbound Triggers and Outbound Invokes

Defining Ad-Hoc Mappings

Importing a Map File into an Orchestrated Integration

Adding Actions to an Orchestrated Integration

Looping over Repeating Elements with a For-Each Action

Routing Expressions with Switch Branches

Managing a Group of Actions and Fault Handlers with a Scope Action

Assigning Values to Scalar Variables in an Assign Action

Looping Over Actions or Invoke Connections While a Condition is Satisfied with a While