# Capsule CRM

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

<figure><img src="/files/Tk7zLkXh8YLYYTna7nP0" alt=""><figcaption></figcaption></figure>

### Overview

#### Connector Details

| Connector Category                                                              | API Connector |
| ------------------------------------------------------------------------------- | ------------- |
| OvalEdge Releases Supported                                                     | Release8.1    |
| <p>Connectivity</p><p>\[How the connection is established with Capsule CRM]</p> | REST APIs     |

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

<table><thead><tr><th width="188.20001220703125">Capusle CRM Object</th><th width="196.60003662109375">Capsule CRM Attribute</th><th width="171.199951171875">OvalEdge Attribute</th><th width="174.4000244140625">OvalEdge Category</th><th width="150.4000244140625">OvalEdge Type</th></tr></thead><tbody><tr><td>Account Container</td><td>Capsule Account Identifier </td><td>Container Identifier</td><td>Container</td><td>Container</td></tr><tr><td>Parties</td><td>Party Record Identifier and Display Name</td><td>Entity Identifier </td><td>Table / Entity </td><td>Entity</td></tr><tr><td>Opportunities</td><td>Opportunity Record Identifier and Display Name</td><td>Entity Identifier </td><td>Table / Entity </td><td>Entity </td></tr><tr><td>Projects</td><td>Project Record Identifier and Display Name</td><td>Entity Identifier </td><td>Table / Entity </td><td>Entity</td></tr><tr><td>Users </td><td>User Record Identifier and Display Name </td><td>Entity Identifier </td><td>Table / Entity</td><td>Entity</td></tr><tr><td>Milestones</td><td>Milestone Record Identifier and Display Name</td><td>Entity Identified </td><td>Table / Entity </td><td>Entity </td></tr><tr><td>Pipelines</td><td>Pipeline Record Identifier and Display Name</td><td>Entity Identifier </td><td>Table / Entity </td><td>Entity </td></tr><tr><td>Record Attributes and Custom Fields </td><td>Field Schema </td><td>Column Name and Type </td><td>Column </td><td>Column </td></tr></tbody></table>

### Set up a Connection

#### Prerequisites

The following are the prerequisites to establish a connection:

**Network and API access**

The connector calls Capsule CRM over HTTPS. Ensure the OvalEdge environment can reach your Capsule CRM API base URL and that any corporate proxy allows HTTPS access to Capsule API endpoints.

**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 Capsule CRM administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Operation                            | Objects           | System Tables                                        | Access Permission                             |
| ------------------------------------ | ----------------- | ---------------------------------------------------- | --------------------------------------------- |
| Connection Validation                | Current User      | GET/ Users/Current                                   | Token authorized to read current user details |
| Crawling / Discovery - Parties       | Parties           | GET /parties                                         | Read access to parties                        |
| Crawling / Discovery - Opportunities | Oppotunites       | GET /opportunity                                     | Read access to opportunities                  |
| Crawling / Discovery - Projects      | Projects (kases)  | GET /kases                                           | Read access to projects/cases                 |
| Crawling / Discovery - Users         | Users             | GET /users                                           | Read access to users                          |
| Crawling / Discovery - Milestones    | Milestones        | GET /milestones                                      | Read access to milestones                     |
| Crawling / Discovery - Pipelines     | Pipelines         | GET /pipelines                                       | Read access to pipelines                      |
| Field Discovery - Record Fields      | Field Definitions | GET /fields/definitions for the selected record type | Read access to field metadata                 |
| Query Sheet / Data Preview           | Entity Records    | GET /{records}/{id}, endpoints                       | Read access to the selected entity data       |

#### Connection Configuration Steps

{% hint style="warning" %}
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 **Capsule CRM**, 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.39996337890625">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "<strong>Capsule CRM</strong>" 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 your 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><p>Enter a unique name for the Capsule CRM connection              </p><p>(<strong>Example</strong>: "Capsule_CRM").</p></td></tr><tr><td>API base URL</td><td><p>Enter the Capsule API URL </p><p>(<strong>Example:</strong> https://api.capsulecrm.com/api/v2). The default value is pre-configured. </p></td></tr><tr><td>Connector description</td><td>Enter a brief description of the connector.</td></tr><tr><td>API Token*</td><td>Enter the personal API token from Capsule (My Preferences → API Authentication Tokens)</td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="235.60003662109375"></th><th></th></tr></thead><tbody><tr><td><strong>Default Governance Roles</strong></td><td></td></tr><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><tr><td><strong>Admin Roles</strong></td><td></td></tr><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><tr><td><strong>No of Archive Objects</strong></td><td></td></tr><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><tr><td><strong>Bridge</strong></td><td></td></tr><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:
   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. 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.\
For Capsule CRM, the connector provides a single container that represents the Capsule CRM account.
{% 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.&#x20;
4. Click **Run** to collect metadata from the connected source and load it into the OvalEdge **Data Catalog**.
5. After a **successful crawl**, the information appears in the **Data Catalog > APIs/API Attributes** tab.

The **Schedule** checkbox allows automated crawling 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 **crawl** operation 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:**

* **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.&#x20;
  * **Query Policies:** Define query execution rules based on roles.
  * **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.

<table><thead><tr><th width="85.800048828125">S.No.</th><th width="305.4000244140625">Error Message(s)</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Connection config is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>Connection details are missing during validation.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Enter all required fields (API Base URL and API Token) and validate again.</li></ul></td></tr><tr><td>2</td><td>API token is required.</td><td><p><strong>Error Description:</strong> </p><ul><li>API token is missing.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Enter a valid API token and retry.</li></ul></td></tr><tr><td>3</td><td>Invalid or expired API token (401 Unauthorized)</td><td><p><strong>Error Description:</strong> </p><ul><li>The API token is invalid, expired, or not authorized.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Generate a new token or reauthorize the existing one, then validate again.</li></ul></td></tr><tr><td>4</td><td>Insufficient scope (403 Forbidden)</td><td><p><strong>Error Description:</strong> </p><ul><li>The API token does not have the required permissions.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Update token permissions to allow read access to required objects and retry.</li></ul></td></tr><tr><td>5</td><td>Invalid response from Capsule API</td><td><p><strong>Error Description:</strong> </p><ul><li>The API response is not as expected during validation.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Verify the API Base URL and ensure the token is valid.</li></ul></td></tr><tr><td>6</td><td>Connection failed</td><td><p><strong>Error Description:</strong> </p><ul><li>API call failed during validation.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Check network connectivity, proxy settings, and token validity, then retry.</li></ul></td></tr><tr><td>7</td><td>Connection config required</td><td><p><strong>Error Description:</strong> </p><ul><li>Query or data preview was executed without a valid connection.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Ensure the connection is properly configured and selected, then retry.</li></ul></td></tr><tr><td>8</td><td>Entity id required</td><td><p><strong>Error Description:</strong> </p><ul><li>Record identifier is missing for query or preview.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Select a valid entity record and retry.</li></ul></td></tr><tr><td>9</td><td>Unknown entity type</td><td><p><strong>Error Description:</strong> </p><ul><li>Unsupported entity type was used.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Use supported entities such as Parties, Opportunities, Projects, Users, Milestones, and Pipelines.</li></ul></td></tr><tr><td>10</td><td>API error</td><td><p><strong>Error Description:</strong> </p><ul><li>Capsule CRM returned an error while fetching data.</li></ul><p><strong>Resolution:</strong> </p><ul><li>Verify token permissions, object selection, and data availability, then retry.</li></ul></td></tr></tbody></table>

***

Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ovaledge.com/release8.1/connectors/connector-repositories/application/capsule-crm.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.