User Guide > Map Connectors > Source and Target Map Connectors > Oracle CRM On Demand
Was this helpful?
Oracle CRM On Demand
Oracle CRM On Demand is a cloud-based CRM solution designed to help sales, services, and marketing departments to make information-driven decisions, manage costs, and performance.
The Oracle CRM On Demand connector is implemented using REST APIs and supports basic authentication. The connector allows you to retrieve, insert, update, and delete data from/to Oracle CRM On Demand. To use the Design Studio with Oracle CRM On Demand, the REST API for your organization must be enabled within Oracle CRM On Demand. Custom entities are also supported.
Supported Versions
Oracle CRM On Demand Version 28.0 (REST API Release 40)
Prerequisites
Before using the connector, make sure you perform the following:
• Obtain the Oracle CRM On Demand Server URL, User ID, and Password.
• Enable REST API support in Oracle CRM On Demand. To do this:
a. Click Admin > User Management and Access Controls > Role Management.
b. Click Edit Role for the Administrator role, then from Role Management Wizard for the Administrator, click the Step 4 Privileges tab.
c. Enable the Integration: Restful Services category.
• Enable access rights to manipulate objects and child objects in Oracle CRM On Demand. To do this:
a. Click Admin > User Management and Access Controls > Access Profiles.
b. In the Access Profiles window, edit the Full Profile.
c. Click the Step 2 Specify Access Levels tab.
d. Change the access level for each record type you with to interact with.
Connector Parts
Connector parts are the fields you configure to connect with a data source or target. The fields that are available depend on the connector you select.
For a list of all parts for source connectors, see Specifying Source Connector, Parts, and Properties.
For a list of all parts for target connectors, see Specifying Target Connector, Parts, and Properties.
Connector Properties
You can specify the following source (S) and target (T) properties:
Property
S/T
Description
PageSize
S
Maximum number of records that are returned in a QueryPage response. The maximum limit is 100. Default value is 50.
DisplayChildHref
S
If set to True, then display URL for collection of child resource. Default is False.
Flush Frequency
T
Number of records buffered in the memory before being written to the target. Default value is 0 (all records are written at once).
When inserting many records, change the default to a higher value to improve performance.
Batch Response
 
Select the file, where the target operation responses are logged.
For every Insert, Update, or Delete operation, there is one batch response entry.
The return code for a single operation displays the operation execution result:
• If the operation executes successfully, then return code is 0. The Description column in Problems tab returns the entity's unique ID.
• If the operation fails, then a detailed error is displayed in the Problems tab > Description. This includes messages from both Oracle CRM On Demand and Actian DataConnect.
DisplayChild
T
If set to True, then all the child objects are displayed. The default is False.
Note:  Oracle CRM has rules that dictate which fields can be written to (creatable), and which fields are required to contain values when writing or inserting data (Field Required). Actian DataConnect must adhere to these rules. If they are not followed, then appropriate errors/warnings will be generated. Currently, you can view these properties and settings in the field properties on the Mapping tab.
Field Requirements
Many fields within Oracle CRM On Demand have limitations or restrictions. Within Map Designer, visual indicators and tool tips are provided to help identify which fields have specific requirements. For example, when mapping data from a source to a Oracle CRM On Demand target, the Target Field Expression cells on the Mapping tab will be gray if the field is either not updateable, or not creatable and cannot be mapped, and red if the field is required and must be mapped. A cell without color indicates there are no limitations or requirements from Oracle CRM On Demand. These fields can be mapped if desired.
Data Type Support
The following data types are supported:
• Boolean
• Date
• Datetime
• Decimal
• Int
• String
Note:  If you set the data type as date or datetime to empty, then change the data type to String.
Required Fields
The following tables provides the list of required fields for Oracle CRM On Demand.
Object
Required Fields
Accounts
AccountName
Activities
Activity AssignedTo Subject
Assets
Product
Books
BookName
Campaigns
CampaignName SourceCode
Categories
Name
Contacts
ContactFirstName ContactLastName
CustomObjects1
Name
CustomObjects2
Name
CustomObjects3
Name
CustomObjects4
Name
CustomObjects5
Name
CustomObjects6
Name
CustomObjects7
Name
CustomObjects8
Name
CustomObjects9
Name
CustomObjects10
Name
CustomObjects11
Name
CustomObjects12
Name
CustomObjects13
Name
CustomObjects14
Name
CustomObjects15
Name
Dealers
Name
Events
EndDate Name Objective StartDate
Groups
Name
Households
HouseholdName
Leads
LeadFirstName LeadLastName LeadOwner
Notes
Subject
Opportunities
CloseDate OpportunityName SalesStage SalesStageId
Portfolio
AccountNumber
PriceListLineItems
PriceListId PriceListPriceListName ProductId ProductName
PriceLists
EffectiveFrom PriceListName Status Type
Products
Name
ServiceRequests
Status
Solutions
Title
Users
Alias CustomerCodeState EMailAddr FirstName LastName PhoneNumber PrimaryPositionId Role RoleId Status TimeZoneId UserLoginId
Vehicles
Product ProductId VIN VehicleCurrency
Customizing Fields
To customize a field in Oracle CRM On Demand:
1. Go to Admin > Application Customization.
2. Click the required object name.
3. Under Field Management, click <object name> Field Setup.
4. Click New Field to create a field or click Edit to customize an existing field.
Source
This section provides the source operations.
Query Statement
The Oracle CRM On Demand connector supports all the REST API syntax. Each expression is concatenated by &. The max length of a query string is 4170 characters.
objects (required)
objects=<ParentObjects>/<ParentRowId>/child/<ChildObjects>
<ParentObjects> is required. If <ParentObjects> or <ChildObjects> is specified, then the collection of objects are retrieved. Else, a single object is returned.
Following is an example for retrieving child resource:
objects=Accounts/AAPA-1D275FH/child/AccountContacts&fields=Id,AccountId,ContactId,CreatedDate,CreatedByLastName,CreatedByFirstName
fields (optional)
fields= field1, field2, field3 …
If fields is used, then schema only uses field1, field2, field3. Following are the examples:
• Accounts collection instance:
objects=Accounts&fields=Id,AccountName,Location,AnnualRevenues,Reference,NumberEmployees,CreatedDate
• Accounts single Instance:
objects=Accounts/AAPA-O78CJJ&fields=Id,AccountName,Location,AnnualRevenues,Reference,NumberEmployees,CreatedDate
orderBy (optional)
orderBy=field1:asc,field2:asc…
For example:
orderBy=AccountName:asc,AccountLocation:asc
If orderBy is used, then collection resources are sorted in the specified order.
query (optional)
General syntax:
QUERY EXPRESSION = FIELD EXPRESSION [; FIELD EXPRESSION]
[FIELD EXPRESSION] = <Field> <OPERATOR> <VALUE> [ANDOR CLAUSE]
[ANDOR CLAUSE] = <AND/OR> <OPERATOR> <VALUE> [ ANDOR CLAUSE]
For example:
q=AccountName='PSKDemo02' OR 'A.C. Networks';Reference = false
If query is used, then it sets condition to search for specific resources from the collection.
For more information about complete syntax for query, see https://docs.oracle.com/cd/E76107_01/books/OnDemRestAPI/OnDemRestAPI_Ref23.html#wp1035492
finder(optional)
finder=finderName
If a finder is used, then schema uses the fields from the finder. Finders are predefined queries in the server.
For example:
objects=Accounts&finder=My Accounts
onlyData (optional)
onlyData=true
If onlyData is specified, then it retrieves only ID field values.
For example, to retrieve ID for Accounts object:
objects=Accounts&onlyData=true
Target
Target only populates the mapped fields. If the field is set to null or not mapped, then the fields are skipped.
Supported Output Modes
Oracle CRM On Demand connector supports the Multimode output mode. Following are the supported target operations:
• Insert (Create)
• Update (Patch)
• Delete
Parent Objects
• To update or delete object, you must use Id field as key.
• To delete object, only Id field is required.
Child Objects
• Insert
a. Map parent objects with target operation as insert or update.
b. If only Id field for parent objects are mapped for update operation, then the update is skipped.
c. Target child object name is specified as parentObjects/childObjects such as Accounts/Activities.
• Update
a. Map Parent objects with target operation as update.
b. If only Id field for parent objects are mapped, then the update is skipped.
c. Target child object name is specified as parentObjects/childObjects such as Accounts/Activities
• Delete
a. Map Parent objects with target operation as update.
b. If only Id field for parent objects are mapped, then the update is skipped.
c. Target child object name is specified as parentObjects/childObjects such as Accounts/Activities
d. If parent objects are deleted, then all the associated child objects are deleted.
Supported Resource Attachments
The following are the REST API enclosure URL keywords to add, retrieve, update, and remove the attachment information for Custom Objects 1 to 15 resources.
• Add or update an attachment - To add or update an attachment:
– Use update (put) as target operation
– Use Id field as key
– Use CustomOjects1-15/Attachment as target object name
– Map Fields Attachment, AttachFileName, AttachFileExt, and AttachFileFullName (do not map the AttachFileFullName field as this is read-only)
– Map Field Attachment with base64 encoded
• Retrieve Attachments - To retrieve Oracle CRM On Demand attachments, send an HTTP GET request to the resource's URL.
Use the following query statement:
objects=CustomObjects1-15/Id/enclosure/Attachment
such as objects=CustomObjects8/AAPA-PZDODV/enclosure/Attachment
Retrieved attachment field is base64 encoded.
• Delete Attachments - To delete Oracle CRM On Demand attachments, send an HTTP DELETE request to the resource's URL.
– Use delete as target operation
– Map only Id field as key
– Use CustomOjects1-15/Attachment as target object name
Last modified date: 10/22/2024