This article lists the messages the XL Docs Configurator shows, grouped by where they appear, with the cause and what to do about each one, followed by other common problems and Frequently asked questions. Messages are quoted as they appear on screen, so you can search this page for the text you see. For messages you see when creating documents, see XL Docs messages and troubleshooting.
Missing fields after installing the Configurator
The Configurator reads and writes specific fields on the Document Templates and Document Subtable Excel tables. If XL Docs was installed in your app some time ago, a field added in a later version may be missing, for example avlist on the Document Subtable Excel table.
When a field is missing, the Configurator stops with a message in a window titled Oops! Something went wrong.:
The Document Templates table is missing the required field: <field name>. (on the XL Docs Configurator screen)
The Subtable table is missing the required field: <field name>. (on the XL Docs Subtable Configurator screen)
On the XL Docs Configurator screen, a field missing from the Document Subtable Excel table doesn't stop the screen. Instead, the Data Tables tab is empty even though the template has data tables.
How to fix it
Run the wizard's upgrade. This adds every missing field for you. In the Extensions Portal, select Setup on the XL Docs tile (or Authorize New App on the XL Docs page), choose your app, check Upgrade Setup, and select Finish. See Wizard upgrade.
Or add the field yourself. Add a field with the name in the message and the type from the tables below. For example, add a field named avlist with the field type Text to the Document Subtable Excel table. Names are matched without regard to capitals or spaces, so EachRecordasNewTab and Each Record as New Tab are the same field.
Close the Configurator and open it again.
If the message keeps appearing, submit a technical support case.
Required Document Templates fields
Field | Type |
|---|---|
Name | Text |
clist | Text |
Master table dbid | Text |
Master table name | Text |
Excel Sheet # | Numeric |
PDF Pages | Text |
Required Document Subtable Excel fields
Field | Type |
|---|---|
dbid, clist, slist, qry, Description, stlist, grouplist, slist Options, avlist | Text |
Is Data Grid?, Each Record as New Tab | Checkbox |
Sheet, Max Line Items, Skip Rows | Numeric |
Related Document Template | Numeric (the relationship to Document Templates) |
Max Lines Type | Text, with choices Insert New Rows and Insert New Tab |
Tab sub report order | Text, with choices 01 to 05 |
Record ID# | Built in |
For what each field holds, see Document Templates table reference and Document Subtable Excel table reference.
Messages when the Configurator opens
These appear in the Oops! Something went wrong. window, followed by Please close this window. The Configurator can't be used until the cause is fixed.
Message | Cause | What to do |
|---|---|---|
Required parameter "tpid" was not provided. | The XL Docs Configurator button doesn't pass the template's Record ID#, or it was opened from a record that hasn't been saved yet. | Save the Document Templates record and open the Configurator from it. If the message continues, check the button formula (see Add the buttons yourself). |
Required parameters "templatedbid" and "subtabledbid" were not provided. | The XL Docs Subtable Configurator button is missing the table IDs. | Check the button formula against Add the buttons yourself. |
Quickbase Application - <app ID> is not authorized to use <extension>. followed by more detail, for example There is no valid authorization record for client id: … or User token ending with <last 5 characters> on the client profile is invalid. Please provide the valid user token. | The authorization check for your account and app failed: the app isn't authorized for XL Docs, the button's qspclientid or appid is wrong, or the user token saved for your account no longer works. | Check qspclientid (your Client ID, the value that starts with Q) and appid in the button formula (see Find your Client ID, table IDs, and field IDs). To authorize the app or choose a working user token, run the installation wizard from the Extensions Portal (Setup on the XL Docs tile). The full list of authorization messages is in XL Docs messages and troubleshooting. |
No tables found for AppID <app ID>. Please verify the parameters. | The button's appid is wrong, or the user token saved for your account can't see the app's tables. | Use AppID() in the formula, and check that the app is authorized in the Extensions Portal. |
Template record with ID <tpid> could not be found. Please verify the tpid parameter. | The template record was deleted, or the button passes the wrong ID. | Open the Configurator from an existing Document Templates record. Check that the button passes [Record ID#] as tpid. |
The Document Templates table is missing the required field: <field name>. / The Subtable table is missing the required field: <field name>. | A field the Configurator needs isn't on the table. | |
An unexpected error occurred. | The screen stopped without a more specific reason. | Close the window and try again. If it keeps happening, submit a technical support case. |
Failed to load settings. / A network error occurred while loading settings: followed by details | The screen couldn't load its settings. | Check your connection, then close and reopen the Configurator. |
Session is invalid. Please refresh the page and try again. | The Configurator session expired or the page was changed. | Close the Configurator and open it again from the button. |
Another message from Quickbase, such as a permission error | Quickbase rejected a request the Configurator made. The message is shown as Quickbase returns it. | Check that the user token saved for your account can read and edit the Document Templates and Document Subtable Excel tables. |
Messages while you work
These appear as a message at the top of the screen. Success messages are green, information messages are blue, and errors are red. Click a message to dismiss it.
Message | Cause | What to do |
|---|---|---|
Settings saved successfully. (success) | The tab was saved to Quickbase. | Nothing. |
Please save the Fields tab first to create a record. (info) | A new data table's other tabs open after its Table/Fields tab has been saved once. | Save the Table/Fields tab. |
Please save or cancel changes before proceeding. (info) | You tried to switch tabs with unsaved changes. | Save or cancel the current tab before switching. |
Name is required. (error) | The template has no name. | Enter a Template Name. |
Description is required. (error) | The data table has no description. It's needed for every save. | Enter a Description on the Table/Fields tab. |
Invalid cell notation for: followed by field names (error) | Those fields' Cell Position isn't valid. | Use a column letter and row number like A1, or a comma-separated list like A1,B3, with no spaces. |
Table changed. Save to confirm selection, or reload to refresh fields. (info) | You changed the master table. | Save, then close and reopen the Configurator to map the new table's fields. |
Could not load table fields. / Could not load fields for the selected table. (error) | The data table's table couldn't be read, for example because it's in another app that the user token can't see. | See Cross-app subtables. |
You cannot sort by the same field twice. (info) | A field can be in Sort Fields only once, ascending or descending. | Remove the duplicate sort field. |
Max Line Items and Max Lines Type must both be set, or both be empty. (error) | Only one of the two was set. | Set both on the Data-Grid Settings tab, or clear both. |
Subtotal settings need a label, a label column (e.g. "A"), and at least one column selected -- or leave all three blank to disable subtotals. (error) | The Subtotals section is only partly filled in. | Complete the Subtotals section, or clear it. The label column must be letters only. |
Average settings need a label, a label column (e.g. "A"), and at least one column selected -- or leave all three blank to disable averages. (error) | The Averages section is only partly filled in. | Complete the Averages section, or clear it. |
Please enter a description for the copied record. (error) | The copy has no description. | Enter a New Description: in the Copy Data Table dialog. |
Data table copied successfully. (success) | The copy was added to the Data Tables grid. | Nothing. |
Copy failed. / Could not copy subtable record. / Source subtable record not found. (error) | The data table couldn't be copied, for example because it was deleted. | Close and reopen the Configurator, then try again. |
Could not refresh subtable list: followed by details / Could not load subtable list. (error) | The Data Tables grid couldn't be refreshed. | Close and reopen the Configurator. |
Please save the Fields tab before saving other settings. (error) | The data table's Table/Fields tab hasn't been saved yet. | Save the Table/Fields tab first. |
Record was saved but no record ID was returned. Please refresh and try again. (error) | The new data table was saved, but the screen didn't get its Record ID#. | Close the pop-up, and open the new data table with Edit from the Data Tables tab. |
Save failed. / An error occurred while saving. / An error occurred while saving field settings. (or query, general, or subtotal settings) (error) | The save didn't reach Quickbase. | Try again; if it keeps failing, submit a technical support case. |
A network error occurred: followed by details (error) | The connection dropped during a save. | Check your connection and save again. |
Other problems
Some problems don't show a message. The screen opens, but part of it is empty.
Problem | Cause | What to do |
|---|---|---|
The Configurator button is missing | The buttons are added by the wizard's Upgrade Setup, or by hand. | Run the upgrade, or add the buttons yourself. See Configurator overview and installation. |
The Field Mapping grid on the Fields tab is empty, although the template has a master table | The master table's fields couldn't be read, for example because the table was deleted, or it's in an app the user token can't see. | Choose the master table again in Table on the Fields tab, save, and reopen the Configurator. Check that the user token saved for your account can see that table. |
The Data Tables tab is empty, although the template has data tables | The Document Subtable Excel table is missing a required field, or it couldn't be read. | |
On the XL Docs Subtable Configurator, the field list is empty | The data table's table couldn't be read, for example because it's in another app. | See Cross-app subtables. |
The Query or Subtotal/Group lists are empty for a new data table | The lists are filled when the data table is opened, after its Table/Fields tab is saved. | Close the pop-up and open the data table again with Edit. See How the tabs work. |
A column is missing from Columns to Total or Columns to Average | These list the columns in the saved field mapping. | Save the Table/Fields tab, then reopen. |
The Subtotal/Group tab is missing | The tab is only shown for data grids. | Check Is Data Grid? on the Data-Grid Settings tab. |
The new master table's fields don't appear | You changed Table on the Fields tab. | Save, close, and reopen the Configurator. |
Frequently asked questions
The Configurator button is missing from my Document Templates table. How do I add it?
Run the wizard's upgrade: in the Extensions Portal, select Setup on the XL Docs tile, choose your app, and check Upgrade Setup. It adds the XL Docs Configurator and XL Docs Subtable Configurator buttons and any missing fields. See Wizard upgrade, or Add the buttons yourself.
The Configurator says a field is missing. What do I do?
Run the wizard's upgrade, or add the field with the name and type shown in Missing fields after installing the Configurator, then reopen the Configurator.
The Configurator says my app is not authorized. Why?
The Configurator uses the same authorization as XL Docs. Check the button's qspclientid and appid, and that the app is authorized for XL Docs in the Extensions Portal. See Messages when the Configurator opens.
The Data Tables tab is empty, but my template has data tables. Why?
The Document Subtable Excel table is usually missing a field that a later version added. See Missing fields after installing the Configurator.
Why are the Query and Subtotal/Group lists empty for my new data table?
Save the Table/Fields tab, close the pop-up, and open the data table again with Edit. The lists fill in when the saved data table is opened.
I changed the master table, and its fields don't appear. What do I do?
Save the Fields tab, then close and reopen the Configurator.
Do I need to save each tab?
Yes. Each tab has its own Save. Save or cancel a tab before you switch to another one; otherwise you see Please save or cancel changes before proceeding.
Can a data table come from another app?
Yes, with a workaround. See Cross-app subtables.
Where is the Subtotal/Group tab?
It appears only when Is Data Grid? is checked on the Data-Grid Settings tab.
Does the Configurator create documents?
No. It saves your settings to the Document Templates and Document Subtable Excel records. Create documents with your XL Docs buttons. If a document then shows an error, see XL Docs messages and troubleshooting.