> For the complete documentation index, see [llms.txt](https://docs.ovaledge.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ovaledge.com/connectors/connector-repositories/application/quickbase.md).

# Quickbase

This article outlines the integration with the **QuickBase** connector, enabling metadata management through features such as crawling, profiling, sample profiling, data preview, and manual lineage. The connector extracts metadata for applications, tables, fields, and relationships from QuickBase.

The connector establishes connectivity to QuickBase using **REST APIs**, leveraging the **QuickBase REST API v1** and **Legacy XML API** for connection validation and metadata retrieval. Authentication is performed using a QuickBase user account, with an optional application token for applications configured to enforce application token validation. The user account must be provisioned in the QuickBase realm and assigned the required permissions to access metadata and records.

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

## Overview

### Connector Details

<table data-header-hidden><thead><tr><th width="430"></th><th></th></tr></thead><tbody><tr><td>Connector Category</td><td>Application</td></tr><tr><td>OvalEdge Release Supported</td><td>Release6.3.x and later</td></tr><tr><td><p>Connectivity</p><p>[How the connection is established with Quickbase]</p></td><td>REST APIs</td></tr><tr><td>Verified Quickbase API Version</td><td>Quickbase REST API v1 and Legacy XML API</td></tr></tbody></table>

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

| Quickbase Object | Quickbase Attribute             | OvalEdge Attribute | OvalEdge Category | OvalEdge Type   |
| ---------------- | ------------------------------- | ------------------ | ----------------- | --------------- |
| App              | App Name (dbname)               | Schema Name        | Schemas           | schema          |
| App              | App DBID (dbid)                 | Schema ID          | Schemas           | schema id       |
| Table            | Table Name (name)               | Table Name         | Tables            | table           |
| Table            | Table Description               | Table Comment      | Tables            | comment         |
| Table            | Table ID (id)                   | Table ID           | Tables            | table id        |
| Field            | Field Label (label)             | Column Name        | Table Columns     | column          |
| Field            | Field Type (fieldType)          | Column Data Type   | Table Columns     | columntype      |
| Field            | Field ID (id)                   | Column ID          | Table Columns     | column id       |
| Field            | Primary Key (primaryKey)        | PK Indicator       | Table Columns     | ispkorfk        |
| Field            | Foreign Key (foreignKey)        | FK Indicator       | Table Columns     | ispkorfk        |
| Relationship     | Child Table + Foreign Key Field | Left Table/Column  | Relationships     | column relation |
| Relationship     | Parent Table + Record ID#       | Right Table/Column | Relationships     | column relation |

## Set up a Connection

### Prerequisites

The following are the prerequisites to establish a connection:

#### **Whitelisting Ports**

Ensure that the configured port is whitelisted to allow OvalEdge to establish a connection with the Quickbase server.

{% hint style="warning" %}
Enter the port configured for the Quickbase environment during connection setup. Ensure that the port is whitelisted and accessible to allow successful communication between the OvalEdge and the Quickbase server.
{% endhint %}

#### **Service Account User Permissions**

{% hint style="warning" %}
It is recommended to 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?** These permissions are typically granted by the Quickbase administrator, as users may not have the required access to assign them independently.
{% endhint %}

| Operations            | Objects            | Sys Tables                                 | Access Permissions          |
| --------------------- | ------------------ | ------------------------------------------ | --------------------------- |
| Connection Validation | Realm User Account | QuickBase User Account, Application (DBID) | Valid username and password |
| Crawling              | Tables             | Table Metadata                             | View Metadata (Read)        |
| Crawling              | Table Columns      | Field Metadata                             | View Metadata (Read)        |
| Profiling             | Records            | Table Records                              | View Records                |
| Crawling              | Relationships      | Table Relationships                        | View Relationships (Read)   |

{% hint style="info" %}

* The QuickBase user account must be provisioned in the QuickBase realm. Authentication alone does not grant access to QuickBase applications.
* Crawling tables requires an application role with permission to list tables and access field definitions.
* Profiling and Data Preview require View All Records (or equivalent) permission.
* Relationship metadata crawling is optional and requires Relationships to be enabled in the crawler settings. Cross-application relationships are supported.
  {% endhint %}

### 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 **Quickbase**, 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">Field Name</th><th>Description</th></tr></thead><tbody><tr><td>Connector Type</td><td>By default, "Quickbase" 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><p>For more details, click<a href="https://docs.ovaledge.com/connectors/additional-requirements/credential-manager-configuration"> here</a>. </p></td></tr><tr><td>Connector Name*</td><td><p>Enter a unique name for the Quickbase connection              </p><p>(Example: "Quickbase_Prod").</p></td></tr><tr><td>Connector Environment</td><td><p>Select the environment (Example: PROD, STG) configured for the connector.</p><p>For more details, click<a href="https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/prerequisites#connector-environment"> here</a>. </p></td></tr><tr><td>Connector description</td><td>Enter a brief description of the connector.</td></tr><tr><td>Server*</td><td>Enter the fully qualified Server name or IP address of the Quickbase server (Example: xxxx-sqlserver.xxxx4ijtzasl.xx-south-1.rds.amazonaws.com or 1xx.xxx.1.x0).</td></tr><tr><td>Port*</td><td>Enter the port number used to communicate with the Quickbase server. Specify the port configured for the Quickbase environment or network configuration.</td></tr><tr><td>Application Token</td><td>Enter the Quickbase application token generated from the App Manager. This token is required to access table-level APIs when the Quickbase application is configured to enforce application tokens.</td></tr><tr><td>Username*</td><td>Enter the username of the Quickbase service account configured for the connector. Ensure that the account has the required permissions to access the Quickbase applications and metadata.</td></tr><tr><td>Password*</td><td>Enter the password associated with the specified Quickbase service account. This password is used to authenticate the connection to Quickbase.</td></tr><tr><td>Proxy Enabled*</td><td>Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.</td></tr></tbody></table>

<table data-header-hidden><thead><tr><th width="220"></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 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 and profiling.&#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. Click the **Crawl & Profile** radio button to perform both crawling and profiling operations.
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** > **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:**

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

For more details on connector settings, click [here](https://docs.ovaledge.com/connectors/introduction-to-connectors/setup-and-connectivity/connector-settings).

## 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="87">S. No.</th><th width="216">Error Message</th><th>Error Description &#x26; Resolution</th></tr></thead><tbody><tr><td>1</td><td>Connection validation fails / Failed to connect to QuickBase</td><td><p>The connector is unable to establish a connection with the QuickBase server.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the QuickBase realm hostname, username, and password are correct.</li><li>Ensure the server name does not include the https:// prefix.</li><li>Confirm that the QuickBase server is accessible from the OvalEdge server.</li></ul></td></tr><tr><td>2</td><td>No applications or schemas returned after connection</td><td><p>The connection is successful, but no QuickBase applications are available for crawling.</p><p><strong>Resolution</strong>:</p><ul><li>Ensure the service account is assigned a role in the required QuickBase applications.</li><li>Grant at least Viewer (or higher) access to each target application.</li><li>Reconnect and validate the connection after updating the permissions.</li></ul></td></tr><tr><td>3</td><td>Tables or columns are missing</td><td><p>Required tables or columns are not displayed during metadata crawling.</p><p><strong>Resolution</strong>:</p><ul><li>Verify that the service account has access to the target application.</li><li>Ensure the assigned role has permission to view the required tables and fields.</li><li>Run the crawler again after updating the permissions.</li></ul></td></tr><tr><td>4</td><td>Profiling or sample data retrieval fails</td><td><p>Profiling or Data Preview cannot retrieve records from the table.</p><p><strong>Resolution</strong>:</p><ul><li>Ensure the service account has View Records permission.</li><li>Verify that the role provides View = All Records (or equivalent) access.</li><li>Confirm that the profiled fields are accessible to the assigned role.</li></ul></td></tr><tr><td>5</td><td>REST API request fails (401/403)</td><td><p>Authentication succeeds, but REST API requests are denied.</p><p><strong>Resolution</strong>:</p><ul><li>Ensure the QuickBase REST API endpoint is accessible from the OvalEdge server.</li><li>Verify that the service account has access to the required application and table DBIDs.</li><li>Review the proxy configuration if the connector is configured to use a proxy.</li></ul></td></tr><tr><td>6</td><td>Relationships are not crawled</td><td><p>Relationship metadata is not retrieved during crawling.</p><p><strong>Resolution</strong>:</p><ul><li>Enable the Relationships option in the crawler settings.</li><li>Ensure the service account has permission to view relationship metadata.</li><li>Run the crawler again after updating the configuration.</li></ul></td></tr></tbody></table>

## FAQs

<details>

<summary>Why does a cross-application relationship display a different schema name?</summary>

This is expected behavior. For cross-application relationships, the connector dynamically resolves the parent and child application names during metadata crawling.

</details>

<details>

<summary>Why is the Query Sheet feature unavailable for the QuickBase connector?</summary>

The Query Sheet feature is not supported by the QuickBase connector. This is expected behavior.

</details>

<details>

<summary>Why do older documents mention Port 80 or MySQL authentication?</summary>

These references belong to legacy documentation templates and are not applicable to the QuickBase connector. Use the connection settings documented for the current QuickBase connector.

</details>

<details>

<summary>Why is view profiling not supported?</summary>

The QuickBase connector supports crawling and profiling only for tables and table columns. Profiling of views is not supported.

</details>

***

&#x20;Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.ovaledge.com/connectors/connector-repositories/application/quickbase.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.