14. Connectors : Source and Target Connectors : Source and Target Connectors H-O : Oracle CRM On Demand
 
Share this page                  
Oracle CRM On Demand
 
Add-On Connector
The connector described on this page is not included in the default installation of Actian DataConnect. The connector is available as an add-on from esd.actian.com. To download the connector:
1. Go to esd.actian.com.
2. Under ESD Home, navigate to Actian DataConnect > Connectivity > DataConnect 10.
3. Locate the connector and then click on FTP or HTTP, depending on your preferred method of download.
4. Deploy the connector to your DataConnect server. For more information, see Managing Product Extensions.
Oracle CRM On Demand is a web-based CRM software platform that enables its users to access information using a Web Services interface. The Oracle CRM On Demand connector supports most entities exposed by the Oracle CRM On Demand Web Service, an open XML-based online platform that provides Simple Object Access Protocol (SOAP) access.
SOAP relies on XML for its messaging format. This XML-based protocol consists of three parts: an envelope, which defines what is in the message and how to process it, a set of encoding rules for expressing instances of application-defined data-types, and a convention for representing procedure calls and responses.
This connector allows users to retrieve, insert, update, and delete data from/to Oracle CRM On Demand. To use the Design Studio with Oracle CRM On Demand, the API for your organization must be enabled within Oracle CRM On Demand. Entity names change with each version of the API. Custom entities are also supported.
Supported Versions
Oracle CRM On Demand Release 17
Oracle CRM On Demand Release 18
Oracle CRM On Demand Release 19
Oracle CRM On Demand Release 20
Installation Requirements
User must have read/write access to a fully functional Oracle CRM On Demand account. The Hosting Server name (supplied by Oracle), User Sign In ID (Login ID) , and Password for the account are needed for this connector to log into the Oracle CRM On Demand account. The Default Access Profile name of the logged in user is to be provided. This enables the connector with the ability to dynamically know the child objects to which the user has access.
The Oracle CRM On Demand Integration capability for your company must be enabled (an Oracle CRM On Demand Customer Care representative enables the same, on request, at no additional cost). In addition, the Role Management service should be enabled for the Oracle CRM On Demand account.
Using the Administrator role, the Record Type access and the Access Profile for the user's role should be turned ON (feature available in the administration section) for all parent and child entities to be integrated.
For additional information on the above requirements, please refer to the Oracle CRM On Demand documentation.
Connectivity Requirements
Enter the following to connect to Oracle CRM On Demand:
Server - URL for your Oracle CRM On Demand instance. For example: https://secure-<server name>.crmondemand.com
User ID - User ID for logging on to the Oracle On Demand environment. If you are using the Siebel login invoker, you can replace the User ID with a SessionToken of the form <serverUrl>:jsessionid=<sessionid>. If a SessionToken is provided, then leave the Password empty.
Password - (Optional) Password for logging on to the Oracle On Demand environment.
Property Options
You can set the following source (S) and target (T) properties.
Property
S/T
Description
Query Source
S
Table/View (default option): This option lists all the objects available in Oracle CRM On Demand. After selecting this option, click the arrow Next to Source Table/View, to choose the Table or View that you want to access from the list. You must choose at least one table or view to be able to run a transformation with this connector.
Query Statement: This option will allow you to extract data from Oracle CRM On Demand using a Query written in XML format. After selecting this option, click the ellipsis button to open the Query Statement Box to enter the Query XML. For details on writing Query XML statements, see the Web Services On Demand API Calls > Query Page topic located in the Oracle CRM On Demand Documentation. Note that the XML format for Web Service 1.0 and Web Service 2.0 API calls are different from those provided in the CRMOD documentation. You can identify which version (1.0 or 2.0) to use for a given object by referring to the "Entity Names" section of this document.
Query File: Use this option to extract data using a query stored in a text file. After selecting this option, click the ellipsis button to browse and select your query file. Note that this query file should contain the XML required for the Query Page API call as given in the example below.
Note: The XML should start with <ListOfxxxx> ELEMENT, where xxxx is the Parent Entity's name, as seen in the following example:
<ListOfContact>
    <Contact>
        <ContactFirstName>='John'</ContactFirstName>
        <ContactLastName/>
        <ListOfAddress>
           <Address>
               <Country>='Canada'</Country>
           </Address>
        </ListOfAddress>
    </Contact>
</ListOfContact>
Table
T
Select the Table (Oracle CRM On Demand Object). This should be the transformation target object where the data will be written.
Batch Response
 
Select the file name to which the target operation responses are logged.
Notes:
In delete operations, there is one batch response entry for every delete action.
In Insert, Upsert, and Update operations, there is one batch response entry for every Insert or Update action.
The return Code for a single operation shows the result of the operation execution. If the operation executes successfully, then the return Code is 0.
For failed operations, the error Description tag shows a detailed error message (see below). This includes messages from both Oracle CRM On Demand and PDI.
Note:  When the return Code is 0 (execution was successful), the Description tag will return the Entity's unique ID for which the operation was successful.
For example:
<BatchResponse:batchResult xmlns:BatchResponse="http://www.pervasive.com/BatchResponse">
    <BatchResponse:results>
        <BatchResponse:result>
        <BatchResponse:returnCode>34</BatchResponse:returnCode>
        <BatchResponse:errorDescription>No rows retrieved corresponding to the business component 'Campaign'(SBL-EAI-04378)</BatchResponse:errorDescription>
<BatchResponse:objectContainerName>Campaign</BatchResponse:objectContainerName>
     <BatchResponse:updateOperation>DELETE</BatchResponse:updateOperation>
        </BatchResponse:result>
    </BatchResponse:results>
    
    <BatchResponse:componentInfo>
    <BatchResponse:returnCode>0</BatchResponse:returnCode>
    <BatchResponse:componentName>Oracle CRM On Demand</BatchResponse:componentName>
    </BatchResponse:componentInfo>
</BatchResponse:batchResult>
Batch Size
S
The number of records buffered by PDI before processing them to a map and transfering data to the target.
Page Size
ST
The number of records fetched for each Query Page Web Service call. Max Page Size = 100 (this limit is imposed by Oracle CRM On Demand). Default value is 50.
Use Field Display Names
ST
When set to True, the Display Names of the fields are used as Field Names in the transformation.
Display names are stripped from special characters. If a name is found to be a duplicate for an object, then an integer value is appended to the duplicate.
When this property is set to True, the Field Description column shows the actual Field Name.
The default value is False.
UseChildAnd
S
Sets the UseChildAnd property of the Query Page web service call. Refer to the Oracle CRM On Demand documentation for details. The default value is True.
Default Access Profile Name
ST
The default Access Profile name for the Role assigned to the current logged in user.
To get this value, do the following:
1. Log in to CRM OnDemand.
2. Select Admin > UserManagementAndAccessControls > AccessProfiles > RoleManagement > [Edit] [roleName] > Step3-AccessProfiles > DefaultAccessProfile
RecordsPerReq
T
Allows user to set the number of records inserted/updated during each request between 1-20. For example, if the batch size is set to 20 and the 10th record fails, an attempt will be made to run the operation again one record at a time until all of the records in that batch are processed. As a result, the batch response will have individual record level success/failure entry.
Default value is 20.
Supported Entities
This section lists the different Oracle CRM On Demand entities supported by this connector. The information about the supported operations can be obtained from the following table.
Entity Name
Create
Read
Update
Delete
Account (WebService 1.0 API)
Yes
Yes
Yes
Yes
Activity (WebService 1.0 API)
Yes
Yes
Yes
Yes
Asset (WebService 1.0 API)
No
Yes
No
No
Campaign (WebService 1.0 API)
Yes
Yes
Yes
Yes
Contact (WebService 1.0 API)
Yes
Yes
Yes
Yes
CurrentUser (WebService 1.0 API)
No
Yes
No
No
CustomObject1 (WebService 1.0 API)
Yes
Yes
Yes
Yes
CustomObject2 (WebService 1.0 API)
Yes
Yes
Yes
Yes
CustomObject3 (WebService 1.0 API)
Yes
Yes
Yes
Yes
Lead (WebService 1.0 API)
Yes
Yes
Yes
Yes
Opportunity (WebService 1.0 API)
Yes
Yes
Yes
Yes
Product (WebService 1.0 API)
Yes
Yes
Yes
No
ProductCategory (WebService 1.0 API)
Yes
Yes
Yes
Yes
ServiceRequest (WebService 1.0 API)
Yes
Yes
Yes
Yes
Solution (WebService 1.0 API)
Yes
Yes
Yes
Yes
Territory (WebService 1.0 API)
Yes
Yes
Yes
Yes
User (WebService 1.0 API)
No
Yes
No
No
UserGroup (WebService 1.0 API)
Yes
Yes
Yes
Yes
Application ( WebService 2.0 API)
Yes
Yes
Yes
Yes
BusinessPlan ( WebService 2.0 API)
Yes
Yes
Yes
Yes
Claim ( WebService 2.0 API)
Yes
Yes
Yes
Yes
ContactBestTimes ( WebService 2.0 API)
Yes
Yes
Yes
Yes
Coverage ( WebService 2.0 API)
Yes
Yes
Yes
Yes
CustomObject4 ( WebService 2.0 API)
Yes
Yes
Yes
Yes
CustomObject5 ( WebService 2.0 API)
Yes
Yes
Yes
Yes
CustomObject6 ( WebService 2.0 API)
Yes
Yes
Yes
Yes
CustomObject7 ( WebService 2.0 API)
Yes
Yes
Yes
Yes
CustomObject8 ( WebService 2.0 API)
Yes
Yes
Yes
Yes
CustomObject9 ( WebService 2.0 API)
Yes
Yes
Yes
Yes
CustomObject10 ( WebService 2.0 API)
Yes
Yes
Yes
Yes
CustomObject11 (WebService 2.0 API)
Yes
Yes
Yes
Yes
CustomObject12 (WebService 2.0 API)
Yes
Yes
Yes
Yes
CustomObject13 (WebService 2.0 API)
Yes
Yes
Yes
Yes
CustomObject14 (WebService 2.0 API)
Yes
Yes
Yes
Yes
CustomObject15 (WebService 2.0 API)
Yes
Yes
Yes
Yes
Damage ( WebService 2.0 API)
Yes
Yes
Yes
Yes
DealRegistration ( WebService 2.0 API)
Yes
Yes
Yes
Yes
FinancialAccount ( WebService 2.0 API)
Yes
Yes
Yes
Yes
FinancialAccountHolder ( WebService 2.0 API)
Yes
Yes
Yes
Yes
FinancialAccountHolding ( WebService 2.0 API)
Yes
Yes
Yes
Yes
FinancialPlan ( WebService 2.0 API)
Yes
Yes
Yes
Yes
FinancialProduct ( WebService 2.0 API)
Yes
Yes
Yes
Yes
FinancialTransaction ( WebService 2.0 API)
Yes
Yes
Yes
Yes
Fund ( WebService 2.0 API)
Yes
Yes
Yes
Yes
Household ( WebService 2.0 API)
Yes
Yes
Yes
Yes
InsuranceProperty ( WebService 2.0 API)
Yes
Yes
Yes
Yes
InvolvedParty ( WebService 2.0 API)
Yes
Yes
Yes
Yes
MDFRequest ( WebService 2.0 API)
Yes
Yes
Yes
Yes
MedEd ( WebService 1.0 API)
Yes
Yes
Yes
Yes
Objectives ( WebService 2.0 API)
Yes
Yes
Yes
Yes
Partner ( WebService 2.0 API)
Yes
No
Yes
Yes
PlanAccount ( WebService 2.0 API)
Yes
Yes
Yes
Yes
PlanContact ( WebService 2.0 API)
Yes
Yes
Yes
Yes
PlanOpportunity ( WebService 2.0 API)
Yes
Yes
Yes
Yes
Policy ( WebService 2.0 API)
Yes
Yes
Yes
Yes
PolicyHolder ( WebService 2.0 API)
Yes
Yes
Yes
Yes
Portfolio ( WebService 2.0 API)
Yes
Yes
Yes
Yes
PriceList ( WebService 2.0 API)
Yes
Yes
Yes
Yes
PriceListLineItem ( WebService 2.0 API)
Yes
Yes
Yes
Yes
SPRequest ( WebService 2.0 API)
Yes
Yes
Yes
Yes
SPRequestLineItem ( WebService 2.0 API)
Yes
Yes
Yes
Yes
Vehicle ( WebService 2.0 API)
Yes
Yes
Yes
Yes
Connector Specific Notes
Upsert with Relationships
Upsert is supported only for objects that are covered by Web Services 1.0 API as shown in the entity list. Objects covered by Web Services 2.0 API (for example, Vehicle) are not supported for the Upsert operation.
Attachments
For handling files/documents attached to an Oracle CRM On Demand object, the connector only supports uploading a file as an Attachment to an object (the connector only supports file attachments on the target side). The option to download "Attached files" from Oracle CRM On Demand is not currently supported (the connector does not support reading/downloading the file attachments from Oracle CRM On Demand).
Using Sessions
This connector can be used with the Siebel Login Invoker. When using this invoker, you must replace the Username with the SessionToken and leave the Password field empty. The SessionToken must use the format:
<serverUrl>:jsessionid=<sessionid>
When you use SessionToken, all of the entities are listed in the Tables list; irrespective of whether or not the user has access.
Mapping API
For certain entities, if the mapping API is not supported, then all of the fields are listed irrespective of whether a particular field (custom field ) is enabled for that account or not. Custom fields do support the display name in Map Designer, but only if the Mapping API is supported for that object.
Building Maps
When building maps using Oracle CRM On Demand as a target, refer to the Oracle CRM On Demand help file, "OnDemWebSvcs.pdf," which is at Admin > DownloadDocumentation. This document shows which records you can add as children to other records as well as the supported operations amd Key fields for each entity.
Field Lengths
The field lengths reported in the source schema and Source map tab may be too short for some Oracle CRM On Demand values. If a value such a text string appears to be truncated, you must manually adjust the field length to a larger value.
Non-Accessible Child Entities
If the user does not have access to any child object of a particular entity, they will be unable to see the particular child object displayed in the list of objects available for viewing through the data browser.
Data Type Support
BigDecimal
BigInteger
Boolean
Byte
Bytes
Character
Date
Double
Float
Integer
Record
String
Text
Debugging Tips
Check the Log file and Batch Response File for error messages returned by the Oracle CRM On Demand service.
A "Map . . . Successful" message in the transformation log file means that no serious error occured during the transformation. However, you should also check the batch file for individual record failures.