# Quick Base (v1)

Information note **Quick Base is supported by the Singer community**   
This integration is powered by [Singer's](https://www.singer.io/) Quick Base tap. For support, [visit the GitHub repo](https://github.com/singer-io/tap-quickbase) or [join the Singer Slack](https://singer-slackin.herokuapp.com/).

## Quick Base integration summary

Stitch’s Quick Base integration replicates data using the [Quick Base HTTP API](https://help.quickbase.com/api-guide/intro.html). Refer to the [Schema](https://help.qlik.com/en-US/stitch/integrations/saas/quick-base#schema) section for a list of objects available for replication.

## Quick Base feature snapshot

A high-level look at Stitch's Quick Base (v1) integration, including release status, useful links, and the features supported in Stitch.

| **STITCH** |  |  |  |
| --- | --- | --- | --- |
| **[Release status](https://help.qlik.com/en-US/stitch/integrations/identify-an-integration-version)** | Released on June 27, 2018 | **Supported by**<br><br>the Info icon<br><br>Indicates if the integration is supported by Stitch or the Singer community. | [Singer Community](https://www.singer.io/) |
| **Stitch plan**<br><br>the Info icon<br><br>The type of Stitch plan required to use the integration. | Standard | **[API availability](https://help.qlik.com/en-US/stitch/developers/stitch-connect/guides/source-destination-reference)**<br><br>the Info icon<br><br>Indicates if the integration is available as a source in Stitch Connect. | the Success icon<br><br>This version of the integration is available via the API.<br><br><br>Available |
| **Singer GitHub repository** | [singer-io/tap-quickbase](https://github.com/singer-io/tap-quickbase) |  |  |
| **REPLICATION SETTINGS** |  |  |  |
| **[Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)**<br><br>the Info icon<br><br>A type of replication scheduling where an integration's Replication Frequency is anchored to a time you select. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Advanced Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling)**<br><br>the Info icon<br><br>A type of replication scheduling that allows you to specify granular start times for data extraction using cron expressions. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **Table-level reset**<br><br>the Info icon<br><br>Indicates if data can be reset at the table level. If unsupported, data can only be reset at the integration level. | the Remove icon<br><br>Table-level resets are not supported for this integration. Resets are only supported at the integration level.<br><br><br>Unsupported | **[Configurable Replication Methods](https://help.qlik.com/en-US/stitch/replication/replication-methods)**<br><br>the Info icon<br><br>Indicates if Replication Methods can be defined by you for tables in the integration. | the Remove icon<br><br>Configurable Replication Methods are not supported for this integration. Stitch will use pre-defined replication methods for tables you set to replicate.<br><br><br>Unsupported |
| **DATA SELECTION** |  |  |  |
| **Table selection**<br><br>the Info icon<br><br>The ability to select individual tables for replication in the Stitch interface. If table selection is unavailable, all tables and all the columns they contain will be set to replicate by default. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **Column selection**<br><br>the Info icon<br><br>The ability to select individual columns for replication in the Stitch interface. If column selection is unavailable, all columns will be set to replicate by default. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |
| **Select all**<br><br>the Info icon<br><br>Indicates if the integration supports selecting all available tables and columns. | the Success icon<br><br>Supported<br><br><br>Supported |  |  |
| **TRANSPARENCY** |  |  |  |
| **[Extraction Logs](https://help.qlik.com/en-US/stitch/replication/extractions/integration-extraction-logs)**<br><br>the Info icon<br><br>Logs detailing the Extraction phase of the replication process for a given integration. Includes error info, should an error occur. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported | **[Loading Reports](https://help.qlik.com/en-US/stitch/replication/integration-loading-reports)**<br><br>the Info icon<br><br>Reports detailing the Loading phase of the replication process for a given integration. Includes the number of rows loaded for each table and error info, should an error occur. | the Success icon<br><br>This feature is supported for this version of the integration.<br><br><br>Supported |

## Connecting Quick Base

### Step 1: Retrieve your Quick Base URL and app ID

* [Step 1.1: Retrieve your Quick Base URL](https://help.qlik.com/en-US/stitch/integrations/saas/quick-base#retrieve-quick-base-url)

* [Step 1.2: Retrieve your Quick Base app ID](https://help.qlik.com/en-US/stitch/integrations/saas/quick-base#retrieve-quick-base-app-id)

#### Step 1.1: Retrieve your Quick Base URL

To retrieve your URL, sign into your Quick Base account.

You’ll need to enter the URL that displays in your browser into Stitch. You should include the `https://` portion, and omit anything after `db/`.

For example: Based on the URL in the image below, we’d enter `https://stitchdata.quickbase.com/db/` into Stitch:

![](https://help.qlik.com/en-US/stitch/images/integrations/quick-base-url.png)

#### Step 1.2: Retrieve your Quick Base app ID

Next, you’ll retrieve the ID of the Quick Base app you want to replicate data from.

In Quick Base, click the desired app in the **My Apps** section.

When the app opens, the URL in your browser will now contain the app’s ID. This is the alpha-numeric string after `db/`. In this example, the app ID is `bngf9ix7e`.

![](https://help.qlik.com/en-US/stitch/images/integrations/quick-base-app-id.png)

### Step 2: Create a Quick Base user token

Information note

**QuickBase user tokens**

Quick Base user tokens are linked to the user who creates them. This means that Stitch will only be able to access the same data in Quick Base as the user who creates the token.

Before proceeding, verify that you can access the tables and fields in Quick Base that you want to replicate.

1. In Quick Base, click the user menu (your name) in the top right corner.
2. Click **My preferences**.
3. In the **My User Information** section, click **Manage my user tokens for [company name] realm…**, located next to **Manage User Tokens**.
4. On the **My User Tokens** page, click **+ New user token**.
5. Fill in the following:
   * **Name**: Enter a name for the token. For example: `Stitch`
   * **Description**: If desired, enter a description.
   * **Assign token to apps**: From the dropdown, select the app you want to replicate data from.
6. Click **Save**.

The token will display in the **Token** field of the **My User Tokens** page. Keep this page open for now - you’ll need it to complete the next step.

### Step 3: Add Quick Base as a Stitch data source

1. [Sign into your Stitch account](https://app.stitchdata.com/).

2. On the Stitch Dashboard page, click the **Add Integration** button.

3. Click the **Quick Base** icon.

4. Enter a name for the integration. This is the name that will display on the Stitch Dashboard for the integration; it’ll also be used to create the schema in your destination.

   For example, the name “Stitch Quick Base” would create a schema called `stitch_quick_base` in the destination. **Note**: Schema names cannot be changed after you save the integration.

5. In the **Quick Base API URL** field, enter the Quick Base URL you retrieved in Step 1. For example: `https://stitchdata.quickbase.com/db/`

6. In the **Quick Base APP ID** field, enter the Quick Base app ID you retrieved in Step 1. For example: `bngf9ix7e`

7. In the **Quick Base User Token** field, paste the user token you created in Step 2.

### Step 4: Define the historical replication start date

The Sync Historical Data setting defines the starting date for your Quick Base integration. This means that data **equal to or newer than this date** will be replicated to your data warehouse.

Change this setting if you want to replicate data beyond Quick Base’s default setting of **1 year**. For a detailed look at historical replication jobs, check out the [Syncing Historical SaaS Data](https://help.qlik.com/en-US/stitch/replication/syncing-historical-saas-data-resetting-replication-keys) guide.

### Step 5: Create a replication schedule

Information note Replication schedules affect the time Extraction begins, not the time to data loaded. Refer to the [Replication Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling) documentation for more information.

In the **Replication Frequency** section, you’ll create the integration’s [replication schedule](https://help.qlik.com/en-US/stitch/replication/replication-scheduling). An integration’s replication schedule determines how often Stitch runs a replication job, and the time that job begins.

Quick Base integrations support the following replication scheduling methods:

* [Replication Frequency](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/replication-frequency)

* [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/anchor-scheduling)

* [Advanced Scheduling using Cron](https://help.qlik.com/en-US/stitch/replication/replication-scheduling/advanced-scheduling) (Advanced or Premium plans only)

To keep your row usage low, consider setting the integration to replicate less frequently. See the [Understanding and Reducing Your Row Usage guide](https://help.qlik.com/en-US/stitch/getting-started/understanding-stitch-usage) for tips on reducing your usage.

### Initial and historical replication jobs

After you finish setting up Quick Base, its **Sync Status** may show as **Pending** on either the Stitch Dashboard or in the Integration Details page.

For a new integration, a **Pending** status indicates that Stitch is in the process of scheduling the initial replication job for the integration. **This may take some time to complete.**

Information note

**Initial replication jobs with Anchor Scheduling**

If using Anchor Scheduling, an initial replication job may not kick off immediately. This depends on the selected Replication Frequency and Anchor Time. Refer to the [Anchor Scheduling](https://help.qlik.com/en-US/stitch/replication/replication-scheduling#job-scheduling-and-anchor-times) documentation for more information.

#### Free historical data loads

The first seven days of replication, beginning when data is first replicated, are free. Rows replicated from the new integration during this time won’t count towards your quota. Stitch offers this as a way of testing new integrations, measuring usage, and ensuring historical data volumes don’t quickly consume your quota.

Information note **Replication will continue after the seven days are over**. If you’re no longer interested in this source, be sure to **pause** or **delete** the integration to prevent unwanted usage.

## Quick Base table reference

Information note

**Schemas and versioning**

Schemas and naming conventions can change from version to version, so we recommend verifying your integration’s version before continuing.

The schema and info displayed below is for **version 1** of this integration.

This is the latest version of the Quick Base integration.

Every table in a Quick Base app will display as a selectable table in the Stitch app. Tables are named according to this convention: `[app_name]__[table_name]`.

For example: If an app named `event_handling` contained `customers`, `events`, and `rsvps` tables, you could expect the following tables to be created in your destination:

* `event_handling__customers`
* `event_handling__events`
* `event_handling__rsvps`

### Table attributes

The schema of Quick Base tables will contain the fields the user linked with the [user token](https://help.qlik.com/en-US/stitch/integrations/saas/quick-base#create-quick-base-user-token) has access to, along with a handful of other fields:

| **rid**<br><br>STRING | The unique record ID. **This is the Primary Key for the table.** |
| --- | --- |
| **record\_id**<br><br>STRING | The unique record ID. |
| **date\_created**<br><br>DATE-TIME | The date the record was created. |
| **date\_modified**<br><br>DATE-TIME | The date the record was last modified. This is the column Stitch will use as a [Replication Key](https://help.qlik.com/en-US/stitch/replication/replication-keys). |
| **last\_modified\_by**<br><br>STRING | The ID of the user who last modified the record. |
| **record\_owner**<br><br>STRING | The ID of the user who created the record. |

### Table attribute names

Some destinations restrict the use of special characters and spaces in column names. While Quick Base doesn’t restrict the use of these characters in their app, attempting to load column names as-is from Quick Base may cause issues.

To prevent loading issues, Stitch’s Quick Base will perform the following on column names:

* Replace spaces and hyphens (`-`) with underscores (`_`)
* Remove all other nonalphanumeric characters, such as `!` or `#`
* Lowercase capitalized characters

Below are a handful of examples of how Quick Base column names will appear in Stitch:

| **Column name in Quick Base** | **Column name in Stitch** |
| --- | --- |
| Customer Name | customer\_name |
| Is a VIP? | is\_a\_vip |
| EmAiLAdDrEsS | emailaddress |
| Street!Address | streetaddress |
| Phone #number | phone\_number |