Knowledge Base

Connectors

File

Box

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

Overview

Connector Details

Connector Category	File System
Connector Version	Release7.2
Releases Supported (Available from)	Release6.1
Connectivity [How the connection is established with Box]	REST APIs
Verified Box Version	4.X

Note: The Box connector has been validated with the mentioned "Verified Box Versions" and is expected to be compatible with other supported Box versions. If there are any issues with validation or metadata crawling, please submit a support ticket for investigation and feedback.

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 Box and mapped to the corresponding UI assets.

Box Object	Box Attribute	OvalEdge Attribute	OvalEdge Category	OvalEdge Type
Bucket	Bucket	Bucket	Bucket	Bucket
Folder	Folder	Folder	Folder	Folder
File	File	File	File	File
XLSX	File	File	File	XLSX
XLS	File	File	File	XLS
CSV	File	File	File	CSV
TXT	File	File	File	TXT
PARQUET	File	File	File	PARQUET
ORC	File	File	File	ORC
JSON	File	File	File	JSON
YAML	File	File	File	YAML
PIP	File	File	File	PIP

Set up a Connection

Prerequisites

The following are the prerequisites to establish a connection.

Service Account User Permissions

Important: 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.

Note:👨‍💻Who can provide these permissions? These permissions are typically granted by the Box administrator, as users may not have the required access to assign them independently.

Operations	Objects	Access Permission
Validate	Connector Validation	Root read-only
Crawling	Crawling	Root read-only
Crawling & Profiling	Buckets	Root read-only
Crawling & Profiling	Folder	Root read-only
Crawling & Profiling	Files	Root read-only

Connection Configuration Steps

Important: Users are required to have the Connector Creator role in order to configure a new connection.

Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Box, and complete the required parameters.

Note: Fields marked with an asterisk (*) are mandatory for establishing a connection.

Field Name

Description

Connector Type

By default, "Box" is displayed as the selected connector type.

Connector Settings

Credential Manager*

Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on the selected option.

Supported Credential Managers:

OE Credential Manager
AWS Secrets Manager
HashiCorp
Azure Key Vault

License Add Ons

Auto Lineage	Not Supported
Data Quality	Supported
Data Access	Not Supported

Select the checkbox for Data Quality Add-On to identify data quality issues using data quality rules and anomaly detection.

Connector Environment

Select the environment (Example: PROD, STG) configured for the connector.

Connector Name*

Enter a unique name for the Box connection

(Example: "Boxdb").

Connector Description

Enter a brief description of the connector.

Client ID*

Enter the unique Client ID provided by the service or application for authentication.

Client Secret*

Enter the Client Secret associated with the Client ID to securely authenticate the connection.

User ID*

Enter the registered User ID used to access the external system or service.

Default Governance Roles
Default Governance Roles*	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.
Admin Roles
Admin Roles*	Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in the security settings are available for selection.
No of Archive Objects
No Of Archive Objects*	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. Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.
Bridge
Select Bridge*	If applicable, select the bridge from the drop-down list. 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.

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

Manage Connector Operations

Crawl

To perform crawl operations, users must be assigned the Integration Admin role.

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

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 to access the data.
- 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.

S.No.	Error Message(s)	Error Description & Resolution
1	Error while validating connection: Exception in validateConnection() : The API returned an error code [400] invalid_client	Description: Connection validation failed due to invalid client credentials.Resolution: Check and re-enter the correct Client ID and Client Secret.