# SharePoint

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

<figure><img src="https://content.gitbook.com/content/ztcvwwOJCeaE1n6oHp4C/blobs/UraIt2yfzOoaNYS7Rlhu/image.png" alt=""><figcaption></figcaption></figure>

## **Overview**

### **Connector Details**

<table data-header-hidden><thead><tr><th width="421.5"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>File Connectors</td></tr><tr><td>Connector Version</td><td>Release7.1.1</td></tr><tr><td>Releases Supported (Available from)</td><td>Relase6.0</td></tr><tr><td><p>Connectivity</p><p>[How the connection is established with SharePoint]</p></td><td>REST APIs</td></tr></tbody></table>

### **Connector Features**

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

### Metadata Mapping

The following objects are crawled from SharePoint and mapped to the corresponding UI assets.

<table><thead><tr><th width="177.75">SharePoint Object</th><th width="187">SharePoint Property</th><th width="178">OvalEdge Attribute</th><th width="170.5">OvalEdge Type</th><th width="176.75">OvalEdge Category</th></tr></thead><tbody><tr><td>Bucket</td><td>Bucket</td><td>Bucket</td><td>Bucket</td><td>Bucket</td></tr><tr><td>Folder</td><td>Folder</td><td>Folder</td><td>Folder</td><td>Folder</td></tr><tr><td>File</td><td>File</td><td>File</td><td>File</td><td>File</td></tr><tr><td>XLSX</td><td>File</td><td>File</td><td>XLSX</td><td>File</td></tr><tr><td>XLS</td><td>File</td><td>File</td><td>XLS</td><td>File</td></tr><tr><td>CSV</td><td>File</td><td>File</td><td>CSV</td><td>File</td></tr><tr><td>TXT</td><td>File</td><td>File</td><td>TXT</td><td>File</td></tr><tr><td>PARQUET</td><td>File</td><td>File</td><td>PARQUET</td><td>File</td></tr><tr><td>ORC</td><td>File</td><td>File</td><td>ORC</td><td>File</td></tr><tr><td>JSON</td><td>File</td><td>File</td><td>JSON</td><td>File</td></tr><tr><td>YAML</td><td>File</td><td>File</td><td>YAML</td><td>File</td></tr><tr><td>PIP</td><td>File</td><td>File</td><td>PIP</td><td>File</td></tr></tbody></table>

### Set up a Connection

#### Prerequisites

The following are the prerequisites to establish a connection.

Ensure that the CSV files follow the required formatting standards for proper data processing and visibility. Refer to [CSV Format Requirements](https://docs.ovaledge.com/release8.0/connectors/additional-requirements/csv-format-requirements-for-file-connectors)**.**

**Service Account User Permissions**

{% hint style="warning" %}
It is recommended to use a separate 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? These permissions are typically granted by the SharePoint administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Objects              | Permission Level        | Access Permission |
| -------------------- | ----------------------- | ----------------- |
| Connector Validation | Application Permissions | Site.Read.All     |
| Sites                | Application Permissions | Site.Read.All     |
| Lineage (Manual)     | Application Permissions | Site.Read.All     |
| Buckets              | Application Permissions | Site.Read.All     |
| Folder               | Application Permissions | Site.Read.All     |
| Files                | Application Permissions | Site.Read.All     |

### Connection Configuration Steps

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

1. Log into **OvalEdge**, go to **Administration > Connectors**, click **+ (New Connector)**, search for **SharePoint**, 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.25">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "SharePoint" is displayed as the selected connector type.</td></tr><tr><td>Authentication*</td><td><p>The following authentication are supported for SharePoint:</p><ul><li>Online</li><li>On-Premise-Basic</li><li>On-Premise-Kerberos</li></ul></td></tr></tbody></table>

{% tabs %}
{% tab title="Online" %}

<table><thead><tr><th width="191.5">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Version*</td><td><p>Select version from the drop down menu.</p><ul><li>SharePoint</li><li>Graph</li></ul></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 selected option.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><ul><li>Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the SharePoint connection              </p><p>(Example: "SharePointdb").</p></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 a brief description of the connector.</td></tr><tr><td>Share point Url*</td><td>Enter the URL or address of the SharePoint site.</td></tr><tr><td>Site*</td><td>Enter the site (URL path) within the SharePoint tenant.</td></tr><tr><td>Client Id*</td><td>Enter the Client ID assigned to the application.</td></tr><tr><td>Client Secret*</td><td>Enter the Client Secret associated with the Client ID for authentication.</td></tr><tr><td>Tenant Id*</td><td>Enter the unique tenant identifier for the SharePoint.<br><strong>Note</strong>: This field is available only when the version is selected as "Graph".</td></tr><tr><td>Sharepoint Path</td><td>Enter the URL path or address to the SharePoint site.<br><strong>Note</strong>: This field is available only when the version is selected as "Graph".</td></tr><tr><td>Title</td><td>Enter the title name for the connector.<br><strong>Note</strong>: This field is available only when the version is selected as "SharePoint".</td></tr><tr><td>App Domain</td><td>Enter the domain name where the client application is hosted.<br><strong>Note</strong>: This field is available only when the version is selected as "SharePoint".</td></tr><tr><td>Redirect URI</td><td>Enter the redirect URI configured in the App registration for authentication.<br><strong>Note</strong>: This field is available only when the version is selected as "SharePoint".</td></tr><tr><td>Proxy Enabled*</td><td>Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.</td></tr></tbody></table>
{% endtab %}

{% tab title="On-Premise-Basic" %}

<table><thead><tr><th width="191.5">Field Name</th><th>Description</th></tr></thead><tbody><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 selected option.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><ul><li>Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the SharePoint connection              </p><p>(Example: "SharePointdb").</p></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 a brief description of the connector.</td></tr><tr><td>Share point Url*</td><td>Enter the URL or address of the SharePoint site.</td></tr><tr><td>Site*</td><td>Enter the URL path or address of the SharePoint site.</td></tr><tr><td>Username*</td><td>Enter the username authorized to access the SharePoint site.</td></tr><tr><td>Password*</td><td>Enter the password associated with the specified username for authentication.</td></tr></tbody></table>
{% endtab %}

{% tab title="On-Premise-Kerberos" %}

<table><thead><tr><th width="191.5">Field Name</th><th>Description</th></tr></thead><tbody><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 selected option.</p><p>Supported Credential Managers:</p><ul><li>OE Credential Manager</li><li>AWS Secrets Manager</li><li>HashiCorp</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add Ons</td><td><p></p><ul><li>Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the SharePoint connection              </p><p>(Example: "SharePointdb").</p></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 a brief description of the connector.</td></tr><tr><td>Share point Url*</td><td>Enter the URL or address of the SharePoint site.</td></tr><tr><td>Site*</td><td>Enter the URL path or address of the SharePoint site.</td></tr><tr><td>Username*</td><td>Enter the username authorized to access the SharePoint site.</td></tr><tr><td>Password*</td><td>Enter the password associated with the specified username for authentication.</td></tr><tr><td>Domain</td><td>Enter the domain name associated with the Sharepoint site.</td></tr></tbody></table>
{% endtab %}
{% endtabs %}

**Default Governance Roles**

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

**No of Archive Objects**

<table data-header-hidden><thead><tr><th width="220.25"></th><th></th></tr></thead><tbody><tr><td>No Of Archive Objects*</td><td><p>This shows the number of recent metadata changes to a dataset at the source. By default, it is off. To enable it, toggle the Archive button and specify the number of objects to archive.</p><p>Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.</p></td></tr></tbody></table>

**Bridge**

<table data-header-hidden><thead><tr><th width="220.25"></th><th></th></tr></thead><tbody><tr><td>Select Bridge*</td><td><p>If applicable, 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

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

1. Navigate to the **Connectors** page and click **Crawl/Profile.**
2. This action initiates the metadata collection process from the data source and loads the retrieved metadata into the **File Manager.**
3. In the File Manager, select the specific **folder(s) or file(s)**, then click **Catalog Files/Folders** from the **Nine Dots** menu.
4. The selected files or folders will be added to the **Data Catalog.**

#### Other Operations

The **Connectors** page provides a centralized view of all configured connectors, along with their health status.

**Managing connectors includes:**

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

**Nine Dots Menu Options:**

To view, edit, validate, build lineage, 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.
  * **Access Instructions**: Add notes on how data can be accessed.
  * **Business Glossary Settings:** Manage term associations at the connector level.
* **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 data-header-hidden><thead><tr><th width="86.5">S.No.</th><th width="242.5">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Error while validating connection: 401 Unauthorized: "-2147024891, System.UnauthorizedAccessExceptionAttempted to perform an unauthorized operation."</td><td><p><strong>Description</strong>:</p><p>The connection validation failed due to unauthorized access, indicating that the credentials or permissions provided are invalid or incomplete.</p><p><strong>Resolution:</strong></p><p>Ensure the correct Client Secret and Tenant ID are provided to authenticate the connection successfully.</p></td></tr><tr><td>2</td><td>Error while validating connection: I/O error on GET request for "https://xxxxxxx.sharepoint.co/sites/xxxx-site/xxxx/xxxx.xxx/": xxxxx.sharepoint.co; nested exception is java.net.UnknownHostException: xxxxxx.sharepoint.co</td><td><p><strong>Description</strong>:</p><p>The connection validation failed due to an invalid or unreachable SharePoint URL, resulting in an UnknownHostException.</p><p><strong>Resolution</strong>:</p><p>Verify and provide a valid SharePoint site URI to ensure the connection can be established successfully.</p></td></tr></tbody></table>

***

Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA