# Sigma

This document outlines the integration with the Sigma Computing connector, enabling streamlined metadata management through features such as crawling, report preview, and lineage building (both automatic and manual). It also ensures secure authentication via Credential Manager.

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

## Overview

### Connector Details

<table data-header-hidden><thead><tr><th width="385.25"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>Reporting Tools</td></tr><tr><td>Connector Version</td><td>Release6.3.4</td></tr><tr><td>Releases Supported (Available from)</td><td>Release6.1</td></tr><tr><td><p>Connectivity</p><p>[How the connection is established with Sigma]</p></td><td>REST APIs</td></tr><tr><td>Verified Sigma Version</td><td>V2(API)</td></tr></tbody></table>

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

<table><thead><tr><th width="167.75">Sigma Object</th><th width="187.5">Sigma Property</th><th width="200">OvalEdge Attribute</th><th width="181.75">OvalEdge Category</th><th width="181.75">OvalEdge Type</th></tr></thead><tbody><tr><td>Sigma</td><td>Default</td><td>Report Group</td><td>Report Group</td><td>Report Group</td></tr><tr><td>Workbooks</td><td>Name</td><td>Report</td><td>Report</td><td>Report Name</td></tr><tr><td>Workbooks</td><td>Type</td><td>Report Type</td><td>Report</td><td>Workbook</td></tr><tr><td>Workbooks</td><td>Desc</td><td>Source Description</td><td>Report</td><td>Source Description</td></tr><tr><td>Page</td><td>Name</td><td>Report</td><td>Report</td><td>Report Name</td></tr><tr><td>Page</td><td>Type</td><td>Report Type</td><td>Report</td><td>Page</td></tr><tr><td>Elements</td><td>Element Name</td><td>Report</td><td>Report</td><td>Report Name</td></tr><tr><td>Elements</td><td>Type</td><td>Report Type</td><td>Report</td><td>Element</td></tr></tbody></table>

## Set up a Connection

### Prerequisites

The following are 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? These permissions are typically granted by the Sigma Computing administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Objects              | Access Permission |
| -------------------- | ----------------- |
| Connector Validation | Read only         |
| Crawling             | Read only         |
| Lineage              | Read only         |
| Delta Crawl          | Read only         |
| Workbooks            | Read only         |
| Pages                | Read only         |
| Datasets             | Read only         |

### Connection Configuration Steps

{% hint style="info" %}
Users are required to have the Connector Creator role in order to configure a new connection.
{% endhint %}

1. Log into **OvalEdge**, go to **Administration > Connectors**, click **+ (New Connector)**, search for **Sigma**, 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="220.25">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "Sigma Computing" is displayed as the selected connector type.</td></tr><tr><td>Connector Settings</td><td></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 selected option.</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 Ons</td><td><p></p><ul><li>Select the checkbox for Auto Lineage Add-On to build data lineage automatically.</li></ul></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Sigma Computing connection              </p><p>(Example: "Sigmacomputingdb").</p></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 a brief description of the connector.</td></tr><tr><td>Host Name*</td><td>Enter the Sigma IP address or hostname of the source system to establish a connection.</td></tr><tr><td>Connection String</td><td><p>Configure the connection string for the Azure Devops Repo database:</p><ul><li>Automatic mode: The system generates a connection string based on the provided credentials.</li><li>Manual mode: Enter a valid connection string manually.</li></ul><p>Replace placeholders with actual database details.</p><p>{sid} refers to the database name.</p></td></tr><tr><td>Client Id*</td><td>Enter the client ID generated for the service account that has been granted catalog access permissions.</td></tr><tr><td>Client Secret*</td><td>Enter the client secret associated with the specified client ID to authenticate the connection.</td></tr><tr><td>Proxy Enabled*</td><td>Select <strong>Yes</strong> to route API calls through a proxy server. Select <strong>No</strong> to bypass the proxy and connect directly.</td></tr></tbody></table>

#### Default Governance Roles

<table data-header-hidden><thead><tr><th width="220.25"></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><p>Select one or more users from the dropdown list for Integration Admin and Security &#x26; Governance Admin. All users configured</p><p>in the security settings are available for selection.</p></td></tr></tbody></table>

#### No of Archive Objects

<table data-header-hidden><thead><tr><th width="220.25"></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="220.25"></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 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. The saved connection will appear on the Connectors home page.
   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.
3. After entering all connection details, the following actions can be performed:

## Manage Connector Operations

### Crawl

{% 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.&#x20;

1. Navigate to the **Connectors** page and click **Crawl/Profile**.
2. Select the schemas to crawl.
3. The **Crawl** option is selected by default.
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 > Report / Report Column** 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.
  * **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.

***

Copyright © 2025, OvalEdge LLC, Peachtree Corners GA USA