SharePoint is a file connector that retrieves files and folders from the SharePoint site. OvalEdge provides an interface to connect with SharePoint and perform all standard operations such as crawling and profiling.
Connector Capabilities
The following is the list of objects and data types supported by the SharePoint connector:
Functionality |
Descriptions |
---|---|
Crawling |
Files Folders |
Profiling |
Files (CSV, Parquet, AVRO, Json, XLXS, XLS) |
Prerequisites
This section lists the prerequisites needed to establish a connection between the SharePoint connector and OvalEdge Application.
Service Account with Minimum Permission
The following are the minimum privileges required for a service account to crawl and profile the data:
Operations | Description |
Connection Validation |
Read Permission |
Crawler |
Read Permissions on the Folders or Files that need to be cataloged. |
Establish a Connection
To establish a connection with SharePoint Connection, follow these steps:
- In the OvalEdge application, click on the "Administration" module from the left panel menu.
- Select "Connectors" to display the Connectors page.
- Click on the "+" (New Connector) button at the top right corner of the page. The ‘Add Connector’ pop-up window is displayed.
- Select the connection type as SharePoint. The Add Connector page with SharePoint details is displayed.
Fields |
Details |
---|---|
Connector Type* |
This allows users to select the connector from the drop-down menu. By default, 'SharePoint' is displayed as the selected connection type. |
Authentication* |
User Authentication verifies the identity of individual users attempting to access a system or resource. SharePoint data security supports three forms of authentication mechanisms.
|
License Add-Ons* |
OvalEdge offers a default Base Connector License for all connectors, allowing users to crawl and profile data sources to obtain metadata and statistical information. Additionally, OvalEdge provides various Add-Ons to cater to different connector functionality requirements:
|
Connector Environment |
Select the desired environment for the connector from the dropdown list. The environment field provides information about the specific environment in which the connector is established, such as UAT, NON-PROD, etc. |
Connection Name* |
Provide a connection name for the SharePoint in OvalEdge. This name will serve as a reference to identify the GitHub connection. Example: SharePoint_Connection_DB1 |
SharePoint URI* |
For example http://ovalege.sharepoint.com/sites/ovaledgesite/home.aspx is the URL which you are accessing then http://ovalege.sharepoint.com is URI |
Site* |
We should give OvalEdgesite as a site based on the above example. |
Default Governance Roles* |
Steward*: Select the Steward from the drop-down options. |
Custodian*: Select the Custodian from the drop-down options. |
|
Owner*: Select the Owner from the drop-down options. |
|
Admin Roles |
By selecting the appropriate admin roles, users can ensure that the users associated with the selected role(s) have the required permissions and responsibilities to manage the connector effectively while maintaining security and governance. To assign the necessary admin roles for this connector, follow these steps:
|
No. of archive objects* |
This number represents the most recent modifications made to the metadata of a remote/source (for report connection purposes) and can be set during the crawling connection setup. |
Select Bridge |
The OvalEdge Bridge component enables seamless connectivity between cloud-hosted servers and on-premise or public cloud data sources without requiring modifications to firewall rules. It offers real-time control, simplifying the management of data movement between different sources and destinations. For more information, refer to Bridge Overview |
Note: SharePoint supports three authentication mechanisms. The following screenshots illustrate each type and highlight the required configuration fields.
Authentication - 3 Methods
- Online
Field |
Description |
Client ID |
A unique identifier assigned to a client application for authentication purposes. |
Client Secret |
A confidential key used to authenticate the client application. |
Title |
The title associated with the client application. |
App Domain |
The domain or URL where the client application is hosted. |
Redirect URL |
The destination URL where the user is redirected after authentication. |
- On-Premise-Basic
Field |
Description |
Username |
A unique identifier or name used to identify a user within a system or application. |
Password |
A secret combination of characters that confirms a user's identity and provides access to a system or application. |
- On-Premise-Kerberos
Field |
Description |
Username |
A unique identifier or name used to identify a user within a system or application. |
Password |
A secret combination of characters that confirms a user's identity and provides access to a system or application. |
Domain |
A network boundary that organizes users and resources in a network. |
After entering the required connection details, select the appropriate button based on user preference:
- Validate: Click on the Validate button to verify the connection details. This ensures that the provided information is accurate and enables successful connection establishment.
- Save: Click on the Save button to store the connection details. Once saved, the connection will be added to the Connectors home page for easy access.
Note: * (asterisk) indicates a mandatory field required to establish a connection. Once the connection is validated and saved, it will be displayed on the Connectors home page.
Note: It is optional to save the connection details first or validate the connection and then save it according to personal preference.
Connection Validation Errors
Sl.No |
Error Message(s) |
Description |
1 |
Failed to establish a connection: 401 unauthorized |
Invalid credentials provided or user or role does not have access. |
2 |
Errors while downloading the File. 500 internal error |
If the server is not configured or not running properly, this error occurs. |
Note: In case of any issues while creating a connection, please reach out to the assigned OvalEdge Customer Success Management (CSM) team.
Connector Settings
After validating the connection, access various settings to retrieve and display information from the data source. These settings include Crawler, Access Instruction, and Business Glossary Settings.
Connection Settings |
Description |
---|---|
Crawler |
Crawler settings are configured to connect to a data source and collect and catalog all the data elements in the form of metadata. |
Access Instruction |
This allows the data owner to instruct others on using the objects in the application. |
Business Glossary Settings |
The Business Glossary setting provides flexibility and control over how users view and manage term association within the context of a business glossary at the connector level. |
For more information, refer to the Connector Settings.
The Crawling of File Folders / Buckets
The Crawl/Profile button offers additional configurations, allowing users to select File Folders / Buckets for crawling and profiling across specified connectors.
To use the Crawl/Profile feature, follow these steps:
- Go to the Connectors page.
- Click on the Crawl/Profile button.
- Clicking the "Crawl / Profile" button will initiate the crawling of the entire connector root folder.
- A notification pop-up displays a message indicating either success or failure as shown below.
Copyright © 2023, OvalEdge LLC, Peachtree Corners GA USA