# Mavenlink

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

<figure><img src="https://1813356899-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FhTnkoJQml0pok9awFDhx%2Fuploads%2FtT1uAtEQxbUT7f3QvKND%2Fimage.png?alt=media&#x26;token=50e1eda4-a5de-4adc-ad11-9580bf96fed0" alt=""><figcaption></figcaption></figure>

## Overview

### Connector Details

<table data-header-hidden><thead><tr><th width="417"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>Application</td></tr><tr><td>OvalEdge Release Supported</td><td>Release6.1 to Release7.2.4</td></tr><tr><td><p>Connectivity</p><p>[How the connection is established with Mavenlink]</p></td><td>REST APIs</td></tr><tr><td>Verified Mavenlink Version</td><td>4.10.0</td></tr></tbody></table>

{% hint style="info" %}
The Mavenlink connector has been validated with the mentioned "Verified Mavenlink Version" and is expected to be compatible with other supported Mavenlink 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 Mavenlink and mapped to the corresponding UI assets.

| Mavenlink Object | Mavenlink Attribute | OvalEdge Attribute | OvalEdge Category | OvalEdge Type      |
| ---------------- | ------------------- | ------------------ | ----------------- | ------------------ |
| Table            | Table Name          | Table              | Tables            | Table              |
| Table            | Table Type          | Type               | Tables            | Table              |
| Table            | Table Comments      | Source Description | Descriptions      | Source Description |
| Columns          | Column Name         | Column             | Table Columns     | Columns            |
| Columns          | Data Type           | Column Type        | Table Columns     | Columns            |
| Columns          | Description         | Source Description | Table Columns     | Columns            |
| Columns          | Ordinal Position    | Column Position    | Table Columns     | Columns            |
| Columns          | Length              | Data Type Size     | Table Columns     | Columns            |
| Views            | View Name           | View               | Tables            | View               |
| Views            | Text                | View Query         | Views             | View               |
| Procedures       | Routine\_Name       | Name               | Procedures        | Procedures         |
| Procedures       | Description         | Source Description | Descriptions      | Procedures         |
| Procedures       | Routine\_Definition | Procedure          | Procedures        | Procedures         |
| Functions        | Routine\_Name       | Name               | Functions         | Functions          |
| Functions        | Routine\_Definition | Function           | Functions         | Functions          |
| Functions        | Description         | Source Description | Descriptions      | Functions          |
| Triggers         | Trigger Name        | Name               | Triggers          | Triggers           |
| Triggers         | Trigger Definition  | Trigger Data       | Triggers          | Triggers           |
| Triggers         | Trigger Type        | Type               | Triggers          | Triggers           |

## 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 Mavenlink administrator grants these permissions, as users may not have the required access to assign them independently.
{% endhint %}

| Objects       | System Tables/Objects                                                                 | Permissions |
| ------------- | ------------------------------------------------------------------------------------- | ----------- |
| Schema        | sys.schema, sys.extended\_properties                                                  | Select      |
| Tables        | Information\_Schema.Tables, fn\_listextendedproperty                                  | Select      |
| Columns       | Information\_Schema.Columns, sys.extended\_properties                                 | Select      |
| Constraints   | Information\_Schema.Table\_Constraints, Information\_Schema.Constraint\_Column\_Usage | Select      |
| Relationships | sys.foreign\_keys, sys.foreign\_key\_columns                                          | Select      |
| Indexes       | sys.indexes, sys.index\_columns                                                       | Select      |
| Views         | Information\_Schema.Views, sys.sql\_modules                                           | Select      |
| Procedures    | Information\_Schema.Routines, sys.sql\_modules                                        | Select      |

## 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 **Mavenlink**, 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="219">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "Mavenlink" 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 Mavenlink connection (Example: "Mavenlink_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>Entity Names*</td><td>Enter the specific Mavenlink entities to be accessed, such as projects, tasks, users. Multiple entity names must be provided as a comma-separated list (,).</td></tr><tr><td>Api Extensions</td><td>Enter the required API extensions that define additional endpoints or functionalities supported by the Mavenlink API. The values must be entered in a key-value format using a colon (:) to separate keys and values, and commas (,) to separate multiple entries.</td></tr><tr><td>Host Name*</td><td>Enter the Mavenlink API base domain in the Host Name field. This should be a fully qualified server name or IP Address.</td></tr><tr><td>Client Id*</td><td>Enter the unique client identifier obtained from the Mavenlink API application registration.</td></tr><tr><td>OAuth Token Key*</td><td>Enter the access token generated from the Mavenlink API for authentication.</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="219"></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="219"></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:
   * Click **Validate** to verify the connection.
   * Click **Save** to store the connection for future use.
   * 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="warning" %}
To perform crawl 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 be crawled.
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, including databases, tables, columns, and views.

**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="85">S.No.</th><th width="260">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Error while validating MAVENLINK connection Error while validateConnection: Error while Validating : Please add api extensions with colon(:) and comma(,) seperated (Eg:- key:value, key2:value2)</td><td><p><strong>Error Description</strong>: The Mavenlink connector validation failed because the API extensions were not entered in the correct key-value format.</p><p><strong>Resolution</strong>: Enter the API extensions using the proper format with colons (:) for key-value pairs and commas (,) to separate multiple entries, for example: key:value, key2:value2.</p></td></tr></tbody></table>

***

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