# CartoVista

This article outlines the integration with the CartoVista connector, enabling streamlined metadata management through features such as crawling, report preview, and auto-lineage. It also ensures secure authentication via Credential Manager.

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

## Overview

### Connector Details

| Connector Category                                                             | Reporting Tools |
| ------------------------------------------------------------------------------ | --------------- |
| Connector Version                                                              | Release6.3      |
| Releases Supported (Available from)                                            | Release6.3      |
| <p>Connectivity</p><p>\[How the connection is established with CartoVista]</p> | REST APIs       |
| Verified CartoVista Version                                                    | CartoVista 4.0  |

{% hint style="info" %}
The CartoVista connector validates with the listed “Verified CartoVista Version” and supports other compatible CartoVista 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                                  |       ❌      |
| Report 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 CartoVista and mapped to the corresponding UI assets.

<table><thead><tr><th width="174.77777099609375">CartoVista Object</th><th width="182.1112060546875">CartoVista Attribute</th><th width="178">OvalEdge Attribute</th><th width="176.8887939453125">OvalEdge Category</th><th width="155.5555419921875">OvalEdge Type</th></tr></thead><tbody><tr><td>Folders</td><td>Top Level Folder</td><td>Report Group</td><td>Reports</td><td>Folders</td></tr><tr><td>Folders</td><td>Sub Folders</td><td>Report Group</td><td>Reports</td><td>Folders</td></tr><tr><td>Folders</td><td>Folder Descriptions</td><td>Source Description</td><td>Descriptions</td><td>Folders</td></tr><tr><td>Maps</td><td>Map Name</td><td>Report Name</td><td>Reports</td><td>Maps</td></tr><tr><td>Maps</td><td>Map Description</td><td>Source Description</td><td>Description</td><td>Maps</td></tr><tr><td>Maps</td><td>Map type</td><td>Type</td><td>Reports</td><td>Maps</td></tr><tr><td>Layers</td><td>Layer Name</td><td>Report Name</td><td>Reports</td><td>Layers</td></tr><tr><td>Layers</td><td>Layer Description</td><td>Source Description</td><td>Description</td><td>Layers</td></tr><tr><td>Layers</td><td>Layer Type</td><td>Type</td><td>Reports</td><td>Point, Polygon, Line, WMTS Layers, WMS Layers, Grid Layers</td></tr><tr><td>Slides</td><td>Slide Name</td><td>Report Name</td><td>Reports</td><td>Slides</td></tr><tr><td>Slides</td><td>Slide Description</td><td>Source Description</td><td>Reports</td><td>Slides</td></tr><tr><td>Slides</td><td>Slide Type</td><td>Type</td><td>Reports</td><td>Slides</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The prerequisites to establish a connection:

### 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? The CartoVista administrator grants these permissions, since users may not have sufficient access to assign them.
{% endhint %}

| Objects              | Access Permissions |
| -------------------- | ------------------ |
| Connector Validation | Map Gallery User   |
| Crawling             | Map Gallery User   |
| Lineage              | Map Gallery User   |
| Delta Crawl          | Map Gallery User   |
| Maps                 | Map Gallery User   |
| Layers               | Map Gallery User   |

### 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 **CartoVista**, and enter the required parameters.

{% hint style="info" %}
Fields marked with an asterisk (\*) are mandatory for establishing a connection.
{% endhint %}

<table><thead><tr><th width="221.111083984375">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "CartoVista" 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</li><li>Azure Key Vault</li></ul></td></tr><tr><td>License Add-On</td><td><p><br></p><p><br></p><ul><li>Select the Auto Lineage Add-On checkbox to build data lineage automatically.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the CartoVista connection              </p><p>(Example: "CartoVista_Prod").</p></td></tr><tr><td>Connector Environment</td><td>Select the environment (Example: PROD, STG) configured for the connector.</td></tr><tr><td>Tenant*</td><td>Specifies the unique organization or workspace identifier used in CartoVista. It ensures the connector authenticates and accesses data specific to the correct tenant environment during validation.</td></tr><tr><td>Username*</td><td>Enter the username to access the CartoVista server.</td></tr><tr><td>Password*</td><td>Enter the password associated with your CartoVista username.</td></tr><tr><td>Proxy Enabled*</td><td>Specifies whether the connection to the CartoVista server should route through a proxy server. Select Yes if the network requires proxy authentication for external connections; otherwise, select No to connect directly.</td></tr></tbody></table>

**Default Governance Roles**

<table data-header-hidden><thead><tr><th width="220.2222900390625"></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 and teams configured in OvalEdge Security are displayed for selection.</td></tr></tbody></table>

**Admin Roles**

<table data-header-hidden><thead><tr><th width="221.11114501953125"></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 OvalEdge Security are available for selection.</td></tr></tbody></table>

**No of Archive Objects**

<table data-header-hidden><thead><tr><th width="221.11114501953125"></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="221.111083984375"></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 configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering 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

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

The **Crawl/Profile** button allows users to select one or more schemas for crawling.&#x20;

1. Navigate to the **Connectors** page and click **Crawl/Profile**.
2. Select the schemas to crawl.
3. Click **Run** to collect metadata from the connected source and load it into the Data Catalog.
4. After a successful crawl, the information appears in the **Data Catalog > Report / Report Column** tab.

The **Schedule** checkbox allows automated crawling for a selected timeframe, 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 crawl operation at the scheduled time.

### Other Operations

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

**Managing connectors includes:**

* **Connectors 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 Reports, Report Groups, and Report Columns.

**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 integrity of the connection.
* **Settings**: Modify connector settings.
  * **Crawler**: Configure data extraction.
  * **Access Instructions**: Add notes on how data can be accessed.
  * **Lineage**: Select server dialects for parsing and setting connector priority for table lineage.
  * **Business Glossary Settings**: Manage term associations at the connector level.
  * **Others**: Configure notification recipients for metadata changes.
* **Build Lineage**: Automatically build data lineage using source code parsing.
* **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="83.55560302734375">S.No.</th><th width="226.3333740234375">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Error while validating CARTOVISTA connection Error Validating Connection : Error while Validating connection : code: LoginFailed; codeDetails: AccountIsLockout</td><td>Error Description: The CartoVista connection validation failed because the account is locked, preventing successful login.<br><br>Resolution: Unlock the account or reset the password, then retry the connection validation in CartoVista.</td></tr></tbody></table>

***

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