Best Practices from Oracle Development's A‑Team

Bulk import of sales transactions into Oracle Sales Cloud Incentive Compensation using Integration Cloud Service


Sales Cloud Incentive Compensation application provides API to import sales transactions in bulk. These could be sales transactions exported out of an ERP system. Integration Cloud Service (ICS) offers extensive data transformation and secure file transfer capabilities that could be used to orchestrate, administer and monitor file transfer jobs. In this post, let’s look at an ICS implementation to transform and load sales transactions into Incentive Compensation. Instructions provided in this post are applicable to Sales Cloud Incentive Compensation R11 and ICS R16.4.1 or higher.

Main Article

Figure 1 provides an overview of the solution described in this post. A text file contains sales transactions, in CSV format, exported out of ERP Cloud. ICS imports the file from a file server using SFTP, transforms the data to a format suitable for Incentive Compensation and submits an import job to Sales Cloud. The data transfer is over encrypted connections end-to-end. ICS is Oracle’s enterprise-grade iPaaS offering, with adapters for Oracle SaaS and other SaaS applications and native adapters that allow connectivity to most cloud and on-premise applications. To learn more about ICS, refer to documentation at this link.


Figure 1 – Overview of the solution

Implementation of the solution requires the following high-level tasks.

For the solution to work, ICS should be able to connect with Sales Cloud and File Server.  ICS agents can easily enable connectivity, if one of these systems are located on-premise, behind a firewall.

Configuring a file server to host ERP export file and enable SFTP

A File Server is an optional component of the solution. If the source ERP system that produces CSV file allows Secure FTP access, ICS could connect to it directly. Otherwise, a file server could host exported files from ERP system. One way to quickly achieve this is to provision a compute note on Oracle Public Cloud and enable SFTP access to a staging folder with read/write access to ERP system and ICS.

Defining data mapping for file-based data import service

File-based data import service requires that each import job specify a data mapping. This data mapping helps the import service assign the fields in input file content to fields in Incentive Compensation Transaction object. There are two ways to define such mapping.

  • Import mapping from a Spreadsheet definition
  • Define a new import by picking and matching fields on UI

Here are the steps to complete import mapping:

  • Navigate to "Setup and Maintenance".


  • Search for "Define File Import" task list.


  • Click on "Manage File Import Mappings" task from list.


  • On next page, there are options to look-up existing mapping or create a new one for specified object type. The two options, import from file or create a new mapping are highlighted.


  • If you have a Excel mapping definition, then click on "Import Mapping" , provide information and click "OK".


  • Otherwise, click a new mapping by clicking on "Actions"->"Create".


  • Next page allows field-by-field mapping, between the CSV file's fields and fields under "Incentive Compensation Transactions".


The new mapping is now ready for use.

Identifying Endpoints

Importing sales transaction require a file import web service and another optional web service to collect transactions.

  • Invoke file-based data import and export service with transformed and encoded file content.
  • Invoke 'Manage Process Submission' service with a date range for transactions.

File-based data import and export service could be used to import and data out of all applications on Sales Cloud. For the solution we'll use "submitImportActivity" operation.  WSDL is typically accessible at this URL for Sales Cloud R11.

https://<Sales Cloud CRM host name>:<CRM port>/mktImport/ImportPublicService

The next task could be performed by logging into Incentive Compensation application or by invoking a web service. 'Manage Process Submission' service is specific to Incentive Compensation application. The file-based import processes input and loads the records into staging tables.  'submitCollectionJob' operation of 'Manage Process Submission' service initiates the processing of the staged records into Incentive Compensation. This service is typically accessible at this URL. Note that this action can also be performed in Incentive Compensation UI, as described in the final testing section of this post.

https://<IC host name>:<IC port number>/publicIncentiveCompensationManageProcessService/ManageProcessSubmissionService

Implementing an ICS Orchestration

An ICS orchestration glues the other components together in a flow. ICS orchestrations provide flexible ways to invoke, such as a scheduled triggers or an API interface. Orchestrations can perform variety of tasks and implement complex integration logic. For the solution described in this post, ICS needs to perform the following tasks:

  • Connect to file server and import files that matches specified filename pattern.
  • Parse through file contents and for each record, transform the record to the format required by Incentive Compensation.
  • Convert the transformed file contents to Base64 format and store in a string variable.
  • Invoke File-based data import web service, with Base64-encoded data.Note this service triggers import process by does not wait for its completion.
  • Optionally, the service could invoke "Manage Submission Service" after a delay to ensure that the file-based import completed in Sales Cloud.

For sake of brevity, only the important parts of the orchestration are addressed in detailhere. Refer to ICS documentation for more information on building orchestrations.


FTP adapter configuration

FTP adapters could be used with 'Basic Map my data' or Orchestration patterns. To create a new FTP connection, navigate to "Connections" tab, click on "New Connection" and choose FTP as type of connection.

Under "Configure Connection" page, set "SFTP" drop down to "Yes". FTP adapter allows login through SSL certificate or username and password.


In "Configure Security" page, provide credentials, such as username password or password for a SSL certificate. FTP adapter also supports PGP encryption of content.


Transforming the source records to destination format

Source data from ERP could be in a different format than the format required by target system. ICS provides a sophisticated mapping editor to map fields of source record to target record. Mapping could be as easy as drag & drop of fields from source to target, or could be set using complex logic using XML style sheet language (XSLT).  Here is a snapshot of the mapping used for transformation, primarily to convert date string from one format to another.


Mapping for SOURCE_EVENT_DATE requires a transformation, which is done using transformation editor, as shown.


Converting file content to a Base64-encoded string

File-based data import service requires the content of a CSV file to be Base64-encoded. This encoding could be done using simple XML schema to be used in the FTP invoke task of the orchestration. Here is the content of the schema.

<schema targetNamespace="http://xmlns.oracle.com/pcbpel/adapter/opaque/" xmlns="http://www.w3.org/2001/XMLSchema"> <element name="opaqueElement" type="base64Binary"/> </schema>

To configure a new FTP connection, drag and drop a connection, configured previously.

Select operations settings as shown.

Choose options to select an existing schema.


Pick the schema file containing the schema.

Figure14The FTP invoke is ready to get a file via SFTP and return the contents to the orchestration as a Base64-encoded string. Map the content as to a field in SOAP message to be sent to Incentive Compensation.

Testing the solution

To test the solution place a CSV formatted file at the stageing folder on file server. Here is sample content from source file.


After ICS fetches this file and transforms content, it invokes file-based data import service, with the payload shown below.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://xmlns.oracle.com/oracle/apps/marketing/commonMarketing/mktImport/model/types/" xmlns:mod="http://xmlns.oracle.com/oracle/apps/marketing/commonMarketing/mktImport/model/">  <soapenv:Header/>  <soapenv:Body>  <typ:submitImportActivity>  <typ:importJobSubmitParam>  <mod:JobDescription>Gartner demo import</mod:JobDescription>  <mod:HeaderRowIncluded>Y</mod:HeaderRowIncluded>  <mod:FileEcodingMode>UTF-8</mod:FileEcodingMode>  <mod:MappingNumber>300000130635953</mod:MappingNumber>  <mod:ImportMode>CREATE_RECORD</mod:ImportMode>  <mod:FileContent>U09VUkNFX1.....JUkVDVCxVUw==</mod:FileContent>  <mod:FileFormat>COMMA_DELIMITER</mod:FileFormat>  </typ:importJobSubmitParam>  </typ:submitImportActivity>  </soapenv:Body> </soapenv:Envelope>

At this point, import job has been submitted to Sales Cloud. Status of file import job could be tracked on Sales Cloud, under 'Set and Maintenance'. by opening "Manage File Import Activities". As shown below, there are several Incentive Compensation file imports have been submitted, in status 'Base table upload in progress'.


Here is a more detailed view of one job, opened by clicking on status column of the job. This job has imported records into a staging table.


To complete the job and see transactions in Incentive Compensation, follow one of the these two methods.

  • Navigate to "Incentive Compensation" -> "Credits and Earnings" and click on "Collect Transactions" to import data
  • OR, Invoke 'Manage Process Submission' service with payload similar to sample snippet below.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://xmlns.oracle.com/apps/incentiveCompensation/cn/processes/manageProcess/manageProcessSubmissionService/types/">    <soapenv:Header/>    <soapenv:Body>       <typ:submitCollectionJob>          <typ:scenarioName>CN_IMPORT_TRANSACTIONS</typ:scenarioName>          <typ:scenarioVersion>001</typ:scenarioVersion>          <typ:sourceOrgName>US1 Business Unit</typ:sourceOrgName>          <typ:startDate>2016-01-01</typ:startDate>          <typ:endDate>2016-01-31</typ:endDate>          <typ:transactionType>Invoice</typ:transactionType>       </typ:submitCollectionJob>    </soapenv:Body> </soapenv:Envelope>

Finally, verify that transactions are visible under Incentive Compensation, by navigating to "Incentive Compensation" -> "Credits and Earnings", from home page and by clicking on "Manage Transactions".



This post explained a solution to import transactions into Incentive Compensation using web services provided by Sales Cloud and Incentive Compensation application. It also explained several features of Integration Cloud Service utilized to orchestrate the import. The solution discussed in this post is suitable for Sales Cloud R11 and ICS R16.4.1. Subsequent releases of these products might offer equivalent or better capabilities out-of-box. Refer to product documentation for later versions before implementing a solution based on this post.



Be the first to comment

Comments ( 0 )
Please enter your name.Please provide a valid email address.Please enter a comment.CAPTCHA challenge response provided was incorrect. Please try again.Captcha