Quickbase Connection Guide¶

Overview¶

This guide describes the system requirements and instructions for connecting Vinyl to a Quickbase database server.

Editing data and record deletions are both supported for Quickbase integration with Vinyl 3.3 and will immediately update Quickbase, when performed from Vinyl. Record creation from Vinyl into Quickbase is not a currently supported option with Vinyl 3.3.

To connect your servers, you must have Vinyl 3.3+ installed.

System Requirements¶

Database Server¶

Quickbase Database Server

Client Web Browser¶

• Chrome: 84+

• Firefox: 73+

• Safari: 13.0.1+

• Edge: 84+

Connection Instructions¶

Configure Quickbase User Token for Vinyl¶

1. Navigate to Quickbase Console. For example: https://example.quickbase.com

2. Click the user dropdown on the Global bar, then click My Preferences

3. Select Manage User Tokens link on My User Information

4. Click the + New User Token button

5. Assign a Name

6. Select the application to grant access under Assign token to apps

   Note

   If you have more than one application it is recommended to create a token by application

7. Click the Save button

8. Copy the Token generated by Quickbase

   

Adding a Server¶

1. Navigate to the App Workbench for your Vinyl application

2. Select the Data Sources tile

3. Click the + Source button

4. Select New Connection for Add a Source to Your Application

5. Click the Next button

6. Search for Quickbase under the Cloud category

7. Select the radio button for Quickbase

8. Click the Next button

   

9. Assign a Name for Server Name on Server Settings

10. Assign the API Key for Security Settings by pasting in the Quickbase Token

11. Assign the Domain Name for Security Settings with the Quickbase URL. For example: https://example.quickbase.com

    

12. Click the Next button

13. Click the Done button

14. Confirm the new Source has been created for Quickbase under Data Sources

Import a Data File¶

1. Navigate to the App Workbench for your Vinyl application

2. Select the Data Sources tile

3. Select the Quickbase Data Source entry under Data Sources

4. Expand Import Capabilities

5. Click the Edit button

6. Populate your Table Name in Import Pattern

   Note

   Clicking Import without providing an Import Pattern will import all tables

7. Click the Save button

8. Click the Import button

9. Click the Proceed button

   Note

   The import process will run in the background

   

Test the Connection¶

1. Click the Logic button

2. Confirm the expected file populated under Tables

3. Click the Results button for your table

4. Confirm the expected information has populated for the table