NFS (Network File System)

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

Overview

Connector Details

Connector Category

File Connectors

Connector Version

Release7.1.1

Releases Supported (Available from)

Release4.0

Connectivity

[How the connection is established with NFS]

NFS JDK

Connector Features

Feature
Availability

Crawling

Delta Crawling

Profiling

Query Sheet

NA

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

NFS Object
NFS 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

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

Operations
Objects
Access Permission

Validate

Connector Validation

Read

Crawling & Profiling

Folder

Read

Crawling & Profiling

Files

Read

Connection Configuration Steps

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

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

Field Name
Description

Connector Type

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

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 NFS connection

(Example: "NFSdb").

Connector Description

Enter a brief description of the connector.

Path*

Provide the path of the location where files or folders are located (Example: E:\NFSPath).

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.

  1. 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.

  2. The saved connection will appear on the Connectors home page.

Manage Connector Operations

Crawl

  1. Navigate to the Connectors page, select the connector, 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> 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, 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.

S.No.
Error Message(s)
Error Description & Resolution

1

Error while validating connection: Please provide valid path

Description: The specified path is invalid or inaccessible. The system could not find the files or folders at the given location. Resolution: Ensure the path provided points to the correct location in the NFS source system where the files or folders reside. Verify the path format and that the system has access permissions to that path. For example, use a path like E:\NFSPath.


Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA

Last updated

Was this helpful?