Introduction

The Oracle Service Cloud plugins can be used to read one or more objects from your Oracle Service Cloud account. This can allow you to get deeper insights into your customer success by enriching the data with other data sources.

Use case(s)

User Storie(s)

As a pipeline developer, I would like to fetch a single object from Oracle Service Cloud, so that I can get deeper insights into my customer success stories by performing row-by-row ETL.
As a pipeline developer, I would like to fetch multiple objects from Oracle Service Cloud, so that I do not have to create multiple source nodes merely to replicate all objects to a destination.
As a pipeline developer, I would like to fetch all objects apart from a blacklist from Oracle Service Cloud, so that I can skip a few objects, but don't have to specify all the remaining ones explicitly.

Plugin Type

Batch Source
Batch Sink
Real-time Source
Real-time Sink
Action
Post-Run Action
Aggregate
Join
Spark Model
Spark Compute

Configurables

This integration should be built using two plugins:

Oracle Service Cloud single object

Used when you want to pull only a single object from Zendesk

Section	User Facing Name	Type	Description	Optional	Constraints
Basic	Authentication Type	radio button	Specifies the mode of authentication to use. Should be one of Basic, Session, OAuth.	No
	Username	text	The Oracle Service Cloud username. Only used for Basic authentication.	Yes
	Password	password	The Oracle Service Cloud password. Only used for Basic authentication	Yes
	Session	text	Session ID for Oracle Service Cloud. Only used for Session authentication	Yes
	Access token	text area	OAuth access token, generated by an external identity provider.	Yes
	Query Type	radio button	Specifies the type of query. Can be one of Full Object, or ROQL Query	No
	Object to Pull	select	Select an object to pull from Oracle Service Cloud. Only required when Query type is Full Object. Possible values: Accounts, Analytics Report Results, Analytics Reports, Answers, Answer Versions, Assets, Asset Statuses, Campaigns, Channel Types, Chats, Configurations, Contacts, Countries, Event Subscriptions, Holidays, Incidents, Mailboxes, Marketing Mailboxes, Message Bases, Named ID Hierarchies, Named IDs, Opportunities, Opportunity Statuses, Organizations, Purchased Products, Query Results, Sales Products, Sales Territories, Service Categories, Service Dispositions, Service Mailboxes, Service Products, Site Interfaces, SSO Token References, Standard Contents, Tasks, Variables	Yes	Defaults to all.
	ROQL Query	textarea	The ROQL query that specifies the data to import. Only required when Query Type is ROQL.	Yes

Advanced	Sort By	Select	A field in the selected object to sort the results by	Yes
	Sort Direction	Radio Button	Determines the sort direction - Ascending or Descending	Yes
	Start Date	textbox		No
	End Date	textbox		No

Oracle Service Cloud multi-object

Used when you want to pull multiple objects from Oracle Service Cloud

Section	User Facing Name	Type	Description	Optional	Constraints

Basic	Authentication Type	radio button	Specifies the mode of authentication to use. Should be one of Basic, Session, OAuth.	No
	Username	text	The Oracle Service Cloud username. Only used for Basic authentication.	Yes
	Password	password	The Oracle Service Cloud password. Only used for Basic authentication	Yes
	Session	text	Session ID for Oracle Service Cloud. Only used for Session authentication	Yes
	Access token	text area	OAuth access token, generated by an external identity provider.	Yes
	Objects List Type	radio button	Determines whether the user wants to specify a whitelist of objects or a blacklist	No
	Objects to Pull	multi-select	Select objects to pull from Oracle Service Cloud. Only required when Objects List type is Whitelist. Possible values: Accounts, Analytics Report Results, Analytics Reports, Answers, Answer Versions, Assets, Asset Statuses, Campaigns, Channel Types, Chats, Configurations, Contacts, Countries, Event Subscriptions, Holidays, Incidents, Mailboxes, Marketing Mailboxes, Message Bases, Named ID Hierarchies, Named IDs, Opportunities, Opportunity Statuses, Organizations, Purchased Products, Query Results, Sales Products, Sales Territories, Service Categories, Service Dispositions, Service Mailboxes, Service Products, Site Interfaces, SSO Token References, Standard Contents, Tasks, Variables	Yes	Defaults to all.
	Objects to Skip	multi-select	Select objects to skip from Oracle Service Cloud. Only required when Objects List Type is blacklist. Possible values: Accounts, Analytics Report Results, Analytics Reports, Answers, Answer Versions, Assets, Asset Statuses, Campaigns, Channel Types, Chats, Configurations, Contacts, Countries, Event Subscriptions, Holidays, Incidents, Mailboxes, Marketing Mailboxes, Message Bases, Named ID Hierarchies, Named IDs, Opportunities, Opportunity Statuses, Organizations, Purchased Products, Query Results, Sales Products, Sales Territories, Service Categories, Service Dispositions, Service Mailboxes, Service Products, Site Interfaces, SSO Token References, Standard Contents, Tasks, Variables	Yes	Defaults to none

Advanced	Start Date	textbox		No
Advanced	End Date	textbox		No

Design / Implementation Tips

The plugin should output one record per row in Oracle Service Cloud, with an additional field specifying the object where the record came from. Refer to the Salesforce multi-objects plugin for examples

API - https://docs.oracle.com/en/cloud/saas/service/18a/cxsvc/op-services-rest-connect-v1.4-analyticsreports-get.html https://docs.oracle.com/en/cloud/saas/service/18a/cxsvc/index.html

References

Design

Approach(s)

Properties

Security

Limitation(s)

Future Work

Some future work – HYDRATOR-99999
Another future work – HYDRATOR-99999

Test Case(s)

Test case #1
Test case #2

Sample Pipeline

Please attach one or more sample pipeline(s) and associated data.

Pipeline #1

Pipeline #2

Table of Contents

Checklist

User stories documented
User stories reviewed
Design documented
Design reviewed
Feature merged
Examples and guides
Integration tests
Documentation for feature
Short video demonstrating the feature