The Quickbase Extensions installation wizard sets up a Quickbase Extension in one of your Quickbase apps. Use it to:
Set up an extension in an app for the first time.
Set up an extension on another table in an app that already uses it.
Authorize an app for an extension without changing the app, for example a copy of an app that already uses the extension.
Upgrade an existing setup (XL Docs and JuicedSign only).
Open the wizard
Sign in to the Extensions Portal, then use one of these buttons:
Button | Where it is | When to use it |
|---|---|---|
Setup | On the extension's tile | Set up the extension in an app. |
Launch Setup Wizard | In the extension's Info window (select Info on the tile) | The same as Setup. |
Authorize New App | On the extension's page, above the list of authorized applications | Set up the extension in an app that isn't authorized for it yet, including a copy of an app. |
Setup Table | On each row of the extension page's list of authorized applications | Set up another table in an app that already uses the extension. See Setup Table. |
The wizard opens in a window over the portal. The window is titled <extension> Set-up, for example XL Docs Set-up. The wizard's steps are listed down the left side, with the current step highlighted. Use Previous and Next at the bottom to move between steps; on the last step the button reads Finish. You can't jump ahead to a later step. If something on a step needs fixing, the wizard stays on that step and shows a message in a red banner. To close the window, select the X in its corner.
The wizard changes your app only when you select Finish. If you close the window before then, your app isn't changed.
How the wizard works
The wizard runs these parts in order. Each extension shows only the parts it needs.
Authorization: choose a saved Quickbase user token, or enter a new one.
Application information: choose the app to set up. This is also where you choose Authorize only or Upgrade Setup.
Extension-specific steps: the extension's own steps, such as Setup Type and <extension> Setup. See Extensions with an extension-specific setup.
Optional steps: added just before Finish when your choices need them:
Amazon S3 Account Setup, when you save files to Amazon S3. See Amazon S3 setup.
Dropbox Account Setup, when you save files to Dropbox. See Dropbox setup.
Egnyte Account Setup, when you save files to Egnyte. See Egnyte setup.
Repository Table Setup, when you check Use a Repository Table. See Repository table step.
Application Token, for bulk document generation and for PDF Merger. See Application Token step.
For an overview of the cloud storage choices, see Cloud providers overview.
Finish: the wizard makes its changes and lists what it changed in your app. Each extension's Finish page describes what its setup creates and what to do next.
Example: set up XL Docs on a Projects table
This example sets up XL Docs on the Projects table of a Project Manager app, so that each project can create an Excel document from a sample template. It uses the defaults wherever it can, so no optional steps are added.
Open the wizard. In the Extensions Portal, select Setup on the XL Docs tile. The XL Docs Set-up window opens at Authorization.
Authorization. Keep Use Existing User Token and select the row for a user who can create tables and fields in the app, for example an app admin. If there's no saved token, paste one into Enter your User Token. Select Next.
Application information. Select the Project Manager row. Leave Authorize Only No Setup Required and Upgrade Setup unchecked. Select Next.
Setup Type. Keep Single Document Generation, which creates a document on one record at a time. Select Next.
XL Docs Setup. In Select a Table, choose Projects. Keep Output File Type at XLSX and Template to Use at Use Standard Sample Template. Leave Advanced Settings closed, so the cloud storage type stays None and no repository table is used. Select Finish.
Finish. The confirmation page reads Congratulations, you have successfully installed XL Docs in your Quickbase Application! and Your setup for generating documents automatically is not finished!, then lists the changes: Selected Table (Projects), Added fields to this table, and Created Tables. Close the window with the X in its corner.
In your app. The Projects table now has the XL Docs fields, including the Generate XL Sheet, Create XL Sheet (PB), and Create XL Sheet (Mobile Friendly) buttons and the XL Docs Document file attachment field. If your app didn't have them yet, it also has a Document Templates table, with a record named Sample Template, and a Document Subtable Excel table. Open a project and select Generate XL Sheet to create a document from the sample template in a pop-up window. If the new buttons aren't on the form, add them.
Next, replace the sample with your own workbook (see Build a document template). The confirmation page's "not finished" message is about creating documents automatically: that needs an email notification, described on XL Docs finish, and in an app that requires application tokens, a token added to the Execute XL Docs Batch formula (see Application Token step).
Authorize only
On Application information, check Authorize Only No Setup Required to authorize the app for the extension without changing the app. The wizard saves the app and the user token with your Extensions account, and Application information becomes the last step. Use this for a copy of an app that already has the extension's tables and fields: the copy is a new app, so it has to be authorized before the extension works in it.
The checkbox appears when you open the wizard from the Extensions Portal for an extension that has extension-specific steps.
Upgrade Setup
On Application information, check Upgrade Setup to add or update the fields of an existing setup without doing a new one. The checkbox appears only for XL Docs and JuicedSign, and the app must already have that extension's tables. For XL Docs, see Wizard upgrade.
Setup Table
Setup Table opens the wizard for an app that's already authorized for the extension. It skips Authorization and Application information, starts at the extension-specific steps, and uses the user token on file for that app.
If the app isn't set up with the extension yet, or the token on file can no longer see the app, the wizard starts at Authorization instead and shows one of these messages:
The app id requested was not set up yet with <extension>. Please select a token and proceed.
The User Token you have for this app does not have access. Please select a different token.
Because Setup Table skips Application information, you can't choose Authorize Only No Setup Required or Upgrade Setup from it. Use Setup or Authorize New App for those.
Who can run the wizard
Any Extensions Portal user in your company can open the wizard.
If your company has an add-on package subscription, Setup and Launch Setup Wizard are dimmed and unavailable for extensions that aren't active on your account.
You need a Quickbase user token for a user who can access the app. For extensions that add tables and fields, that user also needs permission to create tables and fields in the app. See Authorization.
Session timeout
The wizard times out after 20 minutes without activity. Your next click then shows the wizard's error page with error code 900.0. Your app hasn't been changed. Close the window and open the wizard again from the Extensions Portal to start over.
Refreshing the window, or opening the wizard again, also starts over from the first step.
Extensions with an extension-specific setup
In Quickbase packages
These extensions are offered in Quickbase packages.
Extension | Extension-specific steps | Optional steps it can add | Start here |
|---|---|---|---|
Exact Forms Plus | Setup Type, Exact Forms Plus Setup | Amazon S3, Dropbox, or Egnyte; Repository Table (single document generation); Application Token (bulk document generation) | |
XL Docs | Setup Type, XL Docs Setup | Amazon S3 or Dropbox; Repository Table (single document generation); Application Token (bulk document generation) | |
PDF Stamper | Setup Type, PDF Stamper Setup | Amazon S3; Repository Table (single document generation); Application Token (bulk document generation) | |
PDF Merger | PDF Merger Setup | Application Token (always) | |
Package Builder | Package Builder Setup | None | |
JuicedSign | JuicedSign Account Setup (only if your company doesn't have a JuicedSign account yet), JuicedSign Setup, File Locations | Amazon S3 or Dropbox | |
QB Maps | Setup Type, then QB Maps Setup or Distance Calc. Setup | None |
Legacy extensions (not in a Quickbase package)
These extensions aren't offered in a Quickbase package. Customers with a legacy subscription can still set them up with the wizard.
Extension | Extension-specific steps | Optional steps it can add | Start here |
|---|---|---|---|
Docusign for Quickbase | Docusign Setup | None | |
QB Signatures | QB Signatures Setup | None | |
Document Portal | Document Portal Setup | Amazon S3, Dropbox, or Egnyte | |
EZ File Importer | EZ File Importer Setup | None |
Extensions that are authorized only
These extensions have no extension-specific steps. The wizard ends at Application information: select Finish there to authorize the app, then configure the extension as its own help pages describe.
Text My QB
QB Courier
Image Resizer/Rotator (legacy, not in a Quickbase package). See Finish and next steps.
Wizard messages
If something on a step needs fixing, the wizard shows a message in a red banner. If it can't continue, it replaces the step with an error page that shows an error code, for example 900.0 when the session has timed out. Every error code, the messages on Authorization and Application information, and answers to common questions are in Installation wizard messages and troubleshooting.
The messages for other steps are on their own pages: each extension's setup page, and for the optional steps Amazon S3 setup, Dropbox setup, Egnyte setup, and Repository table step.