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.
Overview
Connector Details
Connector Category
Application
OvalEdge Release Supported
Release6.3.x and later
Connectivity
[How the connection is established with Quickbase]
REST APIs
Verified Quickbase API Version
Quickbase REST API v1 and Legacy XML API
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.
Connector Features
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.
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.
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.
Service Account User Permissions
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.
👨💻 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.
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)
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.
Connection Configuration Steps
Users are required to have the Connector Creator role in order to configure a new connection.
Log into OvalEdge, go to Administration > Connectors, click + (New Connector), search for Quickbase, and complete the required parameters.
Fields marked with an asterisk (*) are mandatory for establishing a connection.
Connector Type
By default, "Quickbase" is displayed as the selected connector type.
Credential Manager*
Select the desired credentials manager from the drop-down list. Relevant parameters will be displayed based on your selection.
Supported Credential Managers:
OE Credential Manager
AWS Secrets Manager
HashiCorp Vault
Azure Key Vault
For more details, click here.
Connector Name*
Enter a unique name for the Quickbase connection
(Example: "Quickbase_Prod").
Connector Environment
Select the environment (Example: PROD, STG) configured for the connector.
For more details, click here.
Connector description
Enter a brief description of the connector.
Server*
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).
Port*
Enter the port number used to communicate with the Quickbase server. Specify the port configured for the Quickbase environment or network configuration.
Application Token
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.
Username*
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.
Password*
Enter the password associated with the specified Quickbase service account. This password is used to authenticate the connection to Quickbase.
Proxy Enabled*
Select Yes to route API calls through a proxy server. Select No to bypass the proxy and connect directly.
Default Governance Roles
Default Governance Roles*
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.
Admin Roles
Admin Roles*
Select one or more users from the dropdown list for Integration Admin and Security & Governance Admin. All users configured in OvalEdge Security are available for selection.
No of Archive Objects
No Of Archive Objects*
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.
Example: Setting it to 4 retrieves the last four changes, displayed in the 'Version' column of the 'Metadata Changes' module.
Bridge
Select Bridge*
If applicable, select the bridge from the drop-down list.
The drop-down list displays all active bridges configured in OvalEdge. These bridges enable communication between data sources and OvalEdge without altering firewall rules.
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.
The saved connection will appear on the Connectors home page.
Manage Connector Operations
Crawl/Profile
To perform crawl and profile operations, users must be assigned the Integration Admin role.
The Crawl/Profile button allows users to select one or more schemas for crawling and profiling.
Navigate to the Connectors page and click Crawl/Profile.
Select the schemas to crawl.
The Crawl option is selected by default. Click the Crawl & Profile radio button to perform both crawling and profiling operations.
Click Run to collect metadata from the connected source and load it into the OvalEdge Data Catalog.
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.
Click the Schedule checkbox to enable the Select Period drop-down.
Select a time period for the operation from the drop-down menu.
Click Schedule to initiate metadata collection from the connected source.
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.
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.
1
Connection validation fails / Failed to connect to QuickBase
The connector is unable to establish a connection with the QuickBase server.
Resolution:
Verify that the QuickBase realm hostname, username, and password are correct.
Ensure the server name does not include the https:// prefix.
Confirm that the QuickBase server is accessible from the OvalEdge server.
2
No applications or schemas returned after connection
The connection is successful, but no QuickBase applications are available for crawling.
Resolution:
Ensure the service account is assigned a role in the required QuickBase applications.
Grant at least Viewer (or higher) access to each target application.
Reconnect and validate the connection after updating the permissions.
3
Tables or columns are missing
Required tables or columns are not displayed during metadata crawling.
Resolution:
Verify that the service account has access to the target application.
Ensure the assigned role has permission to view the required tables and fields.
Run the crawler again after updating the permissions.
4
Profiling or sample data retrieval fails
Profiling or Data Preview cannot retrieve records from the table.
Resolution:
Ensure the service account has View Records permission.
Verify that the role provides View = All Records (or equivalent) access.
Confirm that the profiled fields are accessible to the assigned role.
5
REST API request fails (401/403)
Authentication succeeds, but REST API requests are denied.
Resolution:
Ensure the QuickBase REST API endpoint is accessible from the OvalEdge server.
Verify that the service account has access to the required application and table DBIDs.
Review the proxy configuration if the connector is configured to use a proxy.
6
Relationships are not crawled
Relationship metadata is not retrieved during crawling.
Resolution:
Enable the Relationships option in the crawler settings.
Ensure the service account has permission to view relationship metadata.
Run the crawler again after updating the configuration.
FAQs
Why does a cross-application relationship display a different schema name?
This is expected behavior. For cross-application relationships, the connector dynamically resolves the parent and child application names during metadata crawling.
Why is the Query Sheet feature unavailable for the QuickBase connector?
The Query Sheet feature is not supported by the QuickBase connector. This is expected behavior.
Why do older documents mention Port 80 or MySQL authentication?
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.
Why is view profiling not supported?
The QuickBase connector supports crawling and profiling only for tables and table columns. Profiling of views is not supported.
Copyright © 2026, OvalEdge LLC, Peachtree Corners GA USA
Last updated
Was this helpful?