Oracle Service (formerly Oracle Service Cloud), part of the Oracle Advertising and Customer Experience suite, is a cloud-based, omnichannel solution that delivers relevant, connected customer experiences via personalized service interactions with a 360-degree view of the customer. In the OvalEdge application, the Oracle Service Cloud connector allows you to crawl and sample profile the data.
Connector Capabilities
The connectivity to the Oracle Service Cloud connector is performed via the API and the versions used by the API are given below:
Driver/API |
Version |
Details |
API |
V1.4 |
https://hennypenny--tst1.custhelp.com/services/rest/connect/v1.4/tasks |
Technical Specifications
Crawling
Feature |
Supported Objects |
Remarks |
Crawling |
Tables |
- |
Table Columns |
Supported Data Types: BIGINT, String, BOOLEAN, CHARACTER, DATE, DOUBLE, INT, NUMERIC, SMALLINT, TEXT, TIME, TIMESTAMP, UUID |
|
Views |
- |
Profiling
Feature |
Support |
Remarks |
Table Profiling |
Row Count, Columns Count, View Sample Data |
- |
View Profiling |
Row Count, Columns Count, View Sample Data |
- |
Column Profiling |
Min, Max, Null Count, Distinct, Top 50 Values |
- |
Full Profiling |
Supported |
- |
Sample Profiling |
Supported |
- |
Connection Details
Pre-requisites
To use the Oracle Service Cloud Connector, the details specified in the following section should be available.
- By default the service account provided for the connector will be used for any query operations. If the service account has write privileges, then Insert/Update/Delete queries can be executed.
- The minimum privileges required are
Operation |
Access Permission |
Connection Validation |
Access to the Oracle Service Cloud |
Crawling |
Access to the Oracle Service Cloud |
Profiling |
Access to the Oracle Service Cloud |
To connect to the Oracle Service Cloud using the OvalEdge application, complete the following steps.
- Login to the OvalEdge application
- In the left menu, click on the Administration module name, and the sub-modules associated with the Administration are displayed.
- Click on the Connectors sub-module name, and the Connectors Information page is displayed.
- In the Connectors Information page, click on + New Connection. The Manage Connection with Search Connector pop-up window is displayed.
- In the Manage Connection pop-up window, select the connection type as Oracle Service Cloud. The Manage Connection with Oracle Service Cloud specific details pop-up window is displayed.
- The following are the field attributes required for the connection of Oracle Service Cloud.
Property
Mandatory/ Optional
Details
Connection Type
Mandatory
By default the connection type is displayed as the Oracle Service, if needed the connection type can be changed by selecting desired connection type from the Connection Type dropdown, and based on the selection of the connection type, the fields associated with the selected connection type are displayed.
License Type
Mandatory
Select the license type used for the connection, the available option is Standard.
Connection Name
Mandatory
Enter the name of the connection, the connection name specified in the Connection Name textbox will be a reference to the Oracle Service database connection in the OvalEdge application.
Example: Oracle Service Connection
End Point
Mandatory
Enter base endpoint associated with the API
Username
Mandatory
Enter the Username associated with the API authentication.
Password
Mandatory
Enter the Password associated with the API authentication.
Default Governance Roles
Mandatory
Select the required governance roles for the Steward, Custodian, and Owner
Select Bridge
Optional
The Bridge ID will be shown in the Bridge dropdown menu when bridges are configured and added, or it will be displayed as "NO BRIDGE".
- Once after entering the connection details in the required fields, click on the
button the entered connection details are validated the Save and Save & Configure buttons are enabled.
- Click on the
button to establish the connection or you can also directly click on the
button to establish the connection and configure the connection settings. Here when you click on the Save & Configure button, the Connection Settings pop-up window is displayed. Where you can configure the connection settings for the selected Connector. The Save & Configure button is displayed only for the Connectors for which the settings configuration is required.
Error Validations Details
The following are expected errors that can be encountered while establishing the connection.
S.No. |
Error Messages |
Description |
1. |
End Point Incorrect |
The provided API Endpoint is not valid. |
Connector Settings
Once establishing the connection successfully the additional configurations for crawling need to be specified. To configure the Crawler settings for the Oracle Service Cloud Connector, select the Oracle Service Cloud Connection Name from the Crawler Information page and click on the 9 dots buttons and select the Settings options. The Connection Settings pop-up window is displayed.
Crawler Settings
Crawler Configurations Settings |
Details |
---|---|
Tables, Views, and Columns |
Select the checkbox to crawl the tables, views, and columns existing in the Oracle Service Cloud database into the OvalEdge. Note: By default, the checkbox for Tables, Views, and Columns is selected. |
Relationship |
Select the checkbox to determine relationships between the tables for the selected schemas existing in the Oracle Service Cloud database into the OvalEdge. |
Crawler Rules: Include Regex |
Enter the specific schema, table, views, and column names that start with, end with, or have middle characters that are included for crawling. |
Crawler Rules: Exclude Regex |
Enter the specific schema, table, views, and column names that start with, end with, or have middle characters that are excluded for crawling. |
Profiler Settings
Profiler Configurations Settings |
Details |
Tables and Columns |
Select the checkbox to profile the tables and columns that are existing in the Oracle Service Cloud database into the OvalEdge. Note: By default, the checkbox for Tables and Columns is selected. |
Views and Columns |
Select the checkbox to profile the views and columns that are existing in the Oracle Service Cloud database into the OvalEdge. Note: By default, the checkbox for Views and Columns is selected. |
Profile Rules: Include Regex |
Enter the specific table, view, and column names that start with, end with, or have middle characters that are included for profiling. |
Profile Rules: Exclude Regex |
Enter the specific table, view, and column names that start with, end with, or have middle characters that are excluded for profiling. |
To configure the Profile Setting,
Click on the Edit icon that allows the Admin user to configure the profiler setting for the selected data source. There are many attributes you can specify in the profile settings.
The attributes are as follows,
Columns |
Description |
Order |
Order is the sequence in which the profiling is done. |
Day |
Enter the day of the week profiling is set to run. |
Start/End Time |
Enter the start and end time at which profiling is set to perform. |
Number of Threads |
Thread is a process where a query is executed on a database to do single or multiple tasks. The number of threads determines the number of parallel queries executed on the data source. |
Profile Type |
There are four main types of data profiling.
The profiling is performed based on a given Sample Profile Size. The data on columns (like Min, Max, Distinct, Null Count, etc.) will be different compared to full profiles as we calculate them only on sample size. To execute a sample profile, select the profile type as “Sample” and enter a sample profile size(count of records to be profiled).
|
Row Count Constraint |
The Row Count Constraint option is applicable only when the Profile Type is selected as Auto.
|
Row Count Limit |
Enter the maximum number of rows that should be considered for profiling. |
Sample Profile Size |
Enter the total number of rows to be included in profiling. |
Query Timeout |
Enter the length of time in seconds to allow the query to run on a remote database before timing out. |
Data Access Authorization
Remote Access (Data Access Authorization) is included in the crawler-specific connector settings to ensure that the right user is accessing the query sheet and queries in the data catalog. Here the system validates the user credentials and allows that particular user to access the query sheet and queries in the data catalog.
- OvalEdge follows OvalEdge data permissions: When this option is selected, the OvalEdge application uses a service account used for creating the connection in the Query Sheet page, Data Catalog > Table > Data page and Data Catalog > Query page to fetch the required data.
- OvalEdge follows Remote system permissions: When this option is selected, then the users are prompted to enter the remote data source credentials in the Query Sheet page, Data Catalog > Table > Data page, and Data Catalog > Query page, and the submitted credentials are used to establish the connection to fetch the required data. Here, these credentials will be cached and cleared after 7 days of inactivity.
Example: When the Remote system permissions option is selected and the user navigates to the Query Sheet or Data Catalog Queries and selects the Connection (Database), then the Enter User Credentials pop-up window with the Username and Password is displayed, where the user needs to provide the remote data source credentials for accessing the Database.
Query Policies
The Query Policies is included in the crawler-specific connector settings for the connectors, which are supported with Query Sheet functionality. Here the system allows you under the specific role to restrict the usage of the selected query types in the Query Sheet page for fetching the required data.
Access Instruction
It allows the Crawler admin to write the instructions and guide the user to crawl the data source.
- You can provide the instruction in Crawler > Setting page
- Click the Access Instruction tab
- Enter the instructions
- Click the Save Changes button. Once you add the access instruction for a specific connection in the crawler settings, it will appear in the connection hierarchy like a database.
Copyright © 2019, OvalEdge LLC, Peachtree Corners GA USA