User Guide : Map Connectors : Source and Target Map Connectors : Oracle Service Cloud
 
Share this page                  
Oracle Service Cloud
This is an add-on connector and is not included in the default installation of Actian DataConnect Studio IDE. The connector is available at esd.actian.com.
Oracle Service Cloud connector was earlier called as RightNow CX. It is a web-based Customer Relationship Management (CRM) software platform that enables users to access information using a Web Services Interface.
Supported API Version
• Rightnow CX API 1.3
Installation Requirements
The user must have a functional Oracle Service Cloud account. Also, the Web Service API for your organization must be enabled within the Oracle Service Cloud platform.
Property Options
The following source (S) and target (T) properties can be set for Oracle Service Cloud connections.
Property
S/T
Description
URL
ST
URL for the web services. For example:
http://<rightnowinstance>.rightnow.com/cgi-bin/<rightnowinstance>.cfg/services/soap
Username
ST
Username for the Oracle Service Cloud account you are trying to access.
Password
ST
Password for the Oracle Service Cloud account you are trying to access.
Batch Size
S
Number of source records the connector caches before processing them in a map. Default is zero.
Show Children
S
A Boolean variable to control whether sub-objects are shown in metadata and in data.
• True – Show all the sub-object.
• False (default) – Doesn't show any sub-object except ID and Named ID type sub-object.
Flush Frequency
T
Number of operations the connector caches before writing them to the target. Default is zero.
Batch Response
T
Sets the path name for a batch response file, which is a reporting mechanism for the connector. The file provides detailed results for each object in a batch where the batch size is greater than one. Obtaining detailed results is useful for doing the following:
• Capturing system-generated object IDs for use in future updates.
• Correlating an error with its object and having enough information about the error for exception handling and error diagnosis.
A batch response entry is generated only for each top-level record.
Supported Entities
The connector supports both Oracle Service Cloud defined entities and custom entities. It also supports read/write from custom fields in both entity types.
Supported Operations
The Oracle Service Cloud connector supports CRUD operation types on both primary and custom entities.
Data Type Support
The data type in both source and target fields should not be changed. Changing the data type in a target field may cause write failure.
The following data types are used in Oracle Service Cloud:
• Boolean
• Date
• DateTime
• Decimal
• Integer
• Long
• String
Connector Specific Notes
Object ID Ignored in Insert operation
When inserting a new object into Oracle Service Cloud, the ID field is ignored and a new ID will be assigned to this object automatically by Oracle Service Cloud.
File Attachment type sub-objects are not supported
Currently, the File Attachment type sub-objects are not supported. This includes FileAttachment, FileAttachmentAnswer, FileAttachmentCommon, and FileAttachmentShared.
Working with custom objects
The Oracle Service Cloud connector supports custom objects. Working with custom objects is similar to working with primary objects. The only difference is the object name used. Primary objects use the name of the class such as "Contact." Custom objects use a combination of the package name and the custom object name to uniquely identify the custom object. The package name and object name are joined by a dot (.). For example, for a custom object package called CO and a custom object named PurchasedProduct, you would reference this object as CO.PurchasedProduct.
RightNow Object Query Language (ROQL)
In a source connection, you can use a query statement to query for objects or fields. The Oracle Service Cloud connector supports RightNow Object Query Language (ROQL) only.
The RightNow Object Query Language (ROQL, pronounced "Rockwell") provides a query subsystem that allows clients of the API to perform SQL-like queries against the Oracle Service Cloud platform. The query language is based on a subset of Object Query Language (OQL), a text-based SQL-like query language that has been extended to handle object notation.
Syntax
ROQL supports both object query and fields query.
Object query:
SELECT primaryObjectReference FROM primaryObject [WHERE conditionExpression] [LIMIT number_of_rows] [OFFSET start_index]
SELECT <Parent Object>.<Parent to Child Relationship Name> FROM <Parent Object> SELECT <Child Object>.<Child to Parent Relationship Name> FROM <Child Object>
Fields query:
SELECT fieldList from primaryObject [WHERE conditionExpression] [LIMIT number_of_rows] [OFFSET start_index]
Special usage
• LIMIT - Limit can be used to limit the number of rows that will be returned in the query. For example, the following query will return the first 100 Contact objects with the Contact first name populated.
SELECT Contact.Name.First FROM Contact LIMIT 100;
• OFFSET - Offset can be used to specify the offset or start index for the returned results. For example, the following query will return the first 100 contacts beginning at the 101 entry.
Relationship Queries
Relationship queries are defined to help navigate between related objects, serving as a shortcut for performing two selects during query operations. Relationships can chained by adding a dot (.) followed by the appropriate relationship name. For example, the query below starts at Incident, goes to Organization, then goes to Contact to list the last names of all contacts for the organization to which the incident belongs.
Query Custom objects
Custom objects can be queried through Connect Web Services for SOAP in a similar fashion to the primary Oracle Service Cloud objects. The syntax used to query custom object data is as follows: Package.ObjectName in the SELECT clause and Package.ObjectName in the FROM clause. For example, if there were a CO package and an RMA object, the query would be this:
SELECT CO.RMA from CO.RMA;
Examples:
• Search all Contact objects:
SELECT Contact FROM Contact;
• Search an Incident object from incident with 1D=7:
SELECT Incident FROM Incident I WHERE I.ID = 7;
• Search a field in Name sub-object in Contact object:
SELECT C.Name.First FROM Contact C;
• Search a field in Name sub-object in Contact object with WHERE clause:
SELECT C.Name.First FROM Contact C WHERE C.Name.First like 'C%';