> For the complete documentation index, see [llms.txt](https://docs.ovaledge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ovaledge.com/release8.2/connectors/connector-repositories/application/oracle-service-cloud.md).

# Oracle Service Cloud

This article outlines the integration with the Oracle Service Cloud connector, enabling streamlined metadata management through features such as crawling, profiling, data preview, and manual lineage building. It also ensures secure authentication via Credential Manager.

<figure><img src="/files/PaBXKSTXAdttoKzAzSq1" alt=""><figcaption></figcaption></figure>

### Connector Details

| Connector Category                                                                       | Application  |
| ---------------------------------------------------------------------------------------- | ------------ |
| Connector Version                                                                        | Release7.x   |
| Releases Supported (Available from)                                                      | Release6.x   |
| <p>Connectivity</p><p>\[How the connection is established with Oracle Service Cloud]</p> | REST APIs    |
| Verified Oracle Service Cloud Version                                                    | All Versions |

{% hint style="info" %}
The Oracle Service Cloud connector has been validated and is expected to be compatible with all Oracle Service Cloud versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.
{% endhint %}

### Connector Features

| Feature                                      | Availability |
| -------------------------------------------- | :----------: |
| Crawling                                     |       ✅      |
| Delta Crawling                               |       ❌      |
| Profiling                                    |       ✅      |
| Query Sheet                                  |       ❌      |
| Data Preview                                 |       ✅      |
| Auto Lineage                                 |       ❌      |
| Manual Lineage                               |       ✅      |
| Secure Authentication via Credential Manager |       ✅      |
| Data Quality                                 |       ❌      |
| DAM (Data Access Management)                 |       ❌      |
| Bridge                                       |       ✅      |

### Metadata Mapping

The following objects are crawled from Oracle Service Cloud and mapped to the corresponding UI assets.

<table><thead><tr><th width="235.6666259765625">Oracle Service Cloud Object</th><th width="250.6666259765625">Oracle Service Cloud Attribute</th><th width="177.333251953125">OvalEdge Attribute</th><th width="180">OvalEdge Category</th><th width="148">OvalEdge Type</th></tr></thead><tbody><tr><td>End point: /metadata-catalog</td><td>Name</td><td>Table</td><td>Tables</td><td>Table</td></tr><tr><td>End point: /metadata-catalog</td><td>Label</td><td>Table Title</td><td>Tables</td><td>Table</td></tr><tr><td>End point: /metadata-catalog</td><td>Description</td><td>Source Description</td><td>Descriptions</td><td>Source Description</td></tr><tr><td><p>End point: /metadata-catalog</p><p>inside properties</p></td><td>Property Key</td><td>Column</td><td>Table Columns</td><td>           -</td></tr><tr><td><p>End point: /metadata-catalog</p><p>inside properties</p></td><td>Description</td><td>Source Description</td><td>Table Columns</td><td>            -</td></tr><tr><td><p>End point: /metadata-catalog</p><p>inside properties</p></td><td>Label</td><td>Column Title</td><td>Table Columns</td><td>            -</td></tr><tr><td><p>End point: /metadata-catalog</p><p>inside properties</p></td><td>MaxLength</td><td>Data Type Size</td><td>Table Columns</td><td>            -</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

### **Service Account User Permissions**

{% hint style="warning" %}
Use a dedicated service account to establish the connection to the data source, configured with the following minimum set of permissions.
{% endhint %}

{% hint style="info" %}
**👨‍💻Who can provide these permissions?** The Oracle Service Cloud administrator grants these permissions, as users may not have the required access to assign them independently.
{% endhint %}

| Objects        | Permissions             |
| -------------- | ----------------------- |
| API Level      | Connect REST API Access |
| Endpoint Level | Metadata Catalog Read   |
| Endpoint Level | Query Execution         |
| Resource Level | Resource Read Access    |
| User Level     | Basic Authentication    |

## Connection Configuration Steps

{% hint style="warning" %}
Users must have the Connector Creator role to configure a new connection.
{% endhint %}

1. Log into OvalEdge, go to Administration > Connectors, click + **(New Connector)**, search for **Oracle Service Cloud**, and complete the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="220.6666259765625">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "OracleServiceCloud" is displayed as the selected connector type.</td></tr><tr><td>Credential Manager*</td><td><p>Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selection.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp Vault</li><li>Azure Key Vault</li></ul></td></tr><tr><td>Connector Name*</td><td>Enter a unique name for the Oracle Service Cloud connection (Example: "OracleServiceCloud_Prod").</td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Connector Description</td><td>Enter the description related to the connector.</td></tr><tr><td>End Point*</td><td>Enter the Oracle Service Cloud domain URL in the End Point field.</td></tr><tr><td>Username*</td><td>Enter the Oracle Service Cloud account’s login ID configured for API access.</td></tr><tr><td>Password*</td><td>Enter the password associated with the Oracle Service Cloud Username.</td></tr><tr><td>Proxy Enabled*</td><td>Select Yes to enable proxy settings or No to connect directly without a proxy.</td></tr></tbody></table>

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="220"></th><th></th></tr></thead><tbody><tr><td>Default Governance Roles*</td><td>Select the appropriate users or teams for each governance role from the drop-down list. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="220"></th><th></th></tr></thead><tbody><tr><td>Admin Roles*</td><td>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured in the security settings are available for selection.</td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="220"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>Select the bridge from the drop-down list.</p><p>The drop-down list displays all active bridges that have been configured. These bridges facilitate communication between data sources and the system without requiring changes to firewall rules.</p></td></tr></tbody></table>

2. After entering all connection details, the following actions can be performed:
   1. Click **Validate** to verify the connection.
   2. Click **Save** to store the connection for future use.
   3. Click **Save & Configure** to apply additional settings before saving.
3. The saved connection will appear on the Connectors home page.

## Manage Connector Operations

### Crawl/Profile

{% hint style="info" %}
To perform crawl and Profile operations, users must be assigned the Integration Admin role.
{% endhint %}

The **Crawl/Profile** button allows users to select one or more schemas for crawling and profiling.

1. Navigate to the **Connectors page** and click **Crawl/Profile**.
2. Select the schemas to crawl.
3. The **Crawl** option is selected by default. To perform both operations, select the **Crawl & Profile** radio button.
4. Click **Run** to collect metadata from the connected source and load it into the Data Catalog.
5. After a successful crawl, the information appears in the Data Catalog > Databases tab.

The **Schedule** checkbox allows automated crawling and profiling at defined intervals, from a minute to a year.

1. Click the **Schedule** checkbox to enable the **Select Period** drop-down.
2. Select a time period for the operation from the drop-down menu.
3. Click **Schedule** to initiate metadata collection from the connected source.
4. The system will automatically execute the selected operation (**Crawl** or **Crawl & Profile**) at the scheduled time.

### Other Operations

The **Connectors page** in OvalEdge provides a centralized view of all configured connectors, including their health status.

**Managing connectors includes:**

* **Connector Health**: Displays the current status of each connector, with a **green** icon for active connections and a **red** icon for inactive connections, helping monitor connectivity to data sources.
* **Viewing**: Click the **Eye** icon next to the connector name to view connector details.

**Nine Dots Menu Options:**

To view, edit, validate, configure, or delete connectors, click on the Nine Dots menu.

* **Edit Connector**: Update and revalidate the data source.
* **Validate Connector**: Check the connection's integrity.
* **Settings**: Modify connector settings.
  * **Crawler**: Configure data extraction.
  * **Profiler**: Customize data profiling rules and methods.
  * **Access Instructions**: Add notes on how data can be accessed.
  * **Business Glossary Settings**: Manage term associations at the connector level.
  * **Others**: Configure notification recipients for metadata changes.
* **Delete Connector**: Remove a connector with confirmation.

### Connectivity Troubleshooting

If incorrect parameters are entered, error messages may appear. Ensure all inputs are accurate to resolve these issues. If issues persist, contact the assigned support team.

<table><thead><tr><th width="83">S. No</th><th width="193">Error Message</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td><strong>OSC-CREST-00002</strong>An unsupported HTTP method was used.</td><td><p><strong>Description:</strong> The request was sent using an HTTP method that is not supported by the target REST API endpoint. <strong>Resolution:</strong></p><ul><li>Use a supported HTTP method (for example, GET, POST, or PATCH) for the endpoint.</li><li>Verify that the configured HTTP method matches the operation supported by the target endpoint.</li></ul></td></tr><tr><td>2</td><td><strong>OSC-CREST-00003</strong>An unsupported version of Connect REST API was used.</td><td><p><strong>Description:</strong> The request was made using a Connect REST API version that is not supported.</p><p><strong>Resolution:</strong></p><ul><li>Switch to a supported API version.</li><li>Verify the API version specified in the request URL and headers.</li></ul></td></tr><tr><td>3</td><td><strong>OSC-CREST-00022</strong>The limit parameter value has exceeded the permissible limit.</td><td><p><strong>Description:</strong> The value specified for the <strong>limit</strong> parameter exceeds the maximum allowed value. A maximum of 20,000 rows can be returned in a single request. <strong>Resolution:</strong></p><ul><li>Ensure the <strong>limit</strong> parameter value does not exceed 20,000.</li><li>Use pagination or successive requests to retrieve additional records.</li></ul></td></tr><tr><td>4</td><td><strong>OSC-CREST-00035</strong>The server is busy. Please try again after some time.</td><td><p><strong>Description:</strong> The server is currently busy and unable to process the request.</p><p><strong>Resolution:</strong></p><ul><li>Retry the request after some time.</li><li>Implement retry logic with exponential backoff in the integration.</li></ul></td></tr></tbody></table>

***

Copyright © 2025, OvalEdge LLC, Peachtree Corners, GA, USA.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.ovaledge.com/release8.2/connectors/connector-repositories/application/oracle-service-cloud.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.