XL Docs messages and troubleshooting

Progress window (ExcelGen_LP.aspx, for example the Create XL Sheet (PB) button)

The window titled Excel Document Merge with the heading XL Docs. After Processing... and the progress bar, a green line confirms success or red text shows the error. A Close button closes the window.

Error page

Shown when a streaming button (ExcelGen_UA.aspx, for example Generate XL Sheet or Create XL Sheet (Mobile Friendly)) fails, when parameters are missing, or when a preview or download link fails. The heading is XL Docs, followed by the bold text Something Went Wrong, the message, and a Close button. File paths in a message are shortened to the file name. Many messages on this page start with a prefix; see Message prefixes.

API response

JSON with "success": false and the message in errors. See API and Pipelines.

Batch status field and log

The xldbtfld field on the control record the batch run was started from (or the triggerfid field on the record, for a single-record run), and the record added to the logsdbid log table. See Batch processing.

Installation wizard

A message at the top of the XL Docs Setup step when you click Next. See Installation wizard: XL Docs setup step.

We're sorry something went wrong! The following error occurred: followed by the message

Error page (streaming buttons)

The document couldn't be created. The rest of the text is the reason, for example a template or data table message from this article. The progress window shows the same reason without this prefix.

QuickBaseError occured followed by the Quickbase error detail, a hyphen, and the error message

Error page (streaming buttons)

Quickbase rejected a request XL Docs made, for example a read of a field that doesn't exist, or a save the user or token isn't allowed to make. See Storage and Quickbase errors.

Quick Base Error occurred followed by the Quickbase error code and detail

Progress window

The same kind of Quickbase error, shown in the progress window.

Error occurred while generating the document: followed by the detail

Error page, progress window, API, batch

The workbook couldn't be converted to the requested format or saved. The detail says why, for example the PDF Pages message in Template and data table errors.

An error has occurred. Please reach out to your application administrator or contact support.

A general error with no further detail. It also appears when request isn't valid Base64.

Check that request is built with Base64Encode(). If it is, contact your application administrator or submit a technical support case.

Document generation is temporarily unavailable. Please try again in a few minutes, or contact your Quickbase support representative if the issue persists.

XL Docs can't create documents at the moment. No document was created.

Wait a few minutes and try again. If it continues, submit a technical support case.

Quickbase Application - <app ID> is not authorized to use <extension>. followed by There is no valid authorization record for client id: <client ID> application id: <app ID> …

The app in appid isn't authorized for XL Docs on the account in clientid, or one of those two values is wrong.

Check clientid and appid in the button formula (see Find your Client ID, table IDs, and field IDs). To authorize the app, open XL Docs in the Extensions Portal and run the installation wizard (select Setup on the XL Docs tile, or Authorize New App on the XL Docs page). See the installation wizard overview.

Quickbase Application - <app ID> is not authorized to use <extension>. followed by The table passed in ( <table ID>) does not belong to the application passed in ( <app ID> ).

dbid names a table in a different app from appid.

Use Dbid() and AppID() in a formula on the table, or check both IDs.

Quickbase Application - <app ID> is not authorized to use <extension>. followed by User token ending with <last 5 characters> on the client profile is invalid. Please provide the valid user token.

The user token saved for your account was deleted, expired, or no longer has access to the app.

Run the installation wizard again and choose a working user token on the Authorization step, or submit a technical support case.

A user token is required to execute <extension>. We currently do not have a user token on file for your account.

No user token is saved for your account.

Run the installation wizard and add a user token on the Authorization step.

We do not have sufficient permission to execute this add-on with the user token that we have on file ending with <last 5 characters> - followed by the Quickbase detail

The saved user token can't read the app or table.

Give the token's user access to the app and its tables, or choose another token in the installation wizard.

Unable to get authorization details. Quickbase Rate Limit Error Code : 429

Quickbase was handling too many requests from your account at that moment.

Wait a minute and try again.

Another message that starts with Unable to get authorization details.

The authorization check couldn't be completed.

Try again. If it continues, submit a technical support case with the full message.

A temporary authorization token is required for this application. Please check your field settings or contact an App Administrator.

The request didn't include a temporary token. This happens when a button made or edited by hand doesn't send one, for example a Formula - Text button without the POSTTempToken class, or a plain link to the XL Docs address.

Use a button the wizard created, such as Create XL Sheet (PB), Generate XL Sheet, or Create XL Sheet (Mobile Friendly). An app admin can rebuild a hand-made button from the examples in Formula URL parameters.

Your temporary authorization token does not have access to the requested record. Please contact an App Administrator if you believe you should have access to run this tool.

You can't see the record in msid, or no records you can see match msqry. A query that matches no records also shows this message.

Check your role's access to the record and table. For msqry, check that the query matches at least one record (test it as a report filter).

Your temporary authorization token has expired. Please try again or contact an App Administrator.

The temporary token is only valid for a short time, for example when the record page was left open for a long time before you clicked the button.

Reload the record in Quickbase and click the button again.

Your temporary authorization token is not authorized to run this tool. If you believe you should be able to, try again from Quickbase or contact your app administrator.

The token isn't valid for the dbid table. Usually data-temptokendbid names a different table than dbid.

Make data-temptokendbid and dbid name the same table, then click the button again from Quickbase.

Something went wrong when we checked your temporary authorization - followed by the Quickbase detail, or Something went wrong when we checked your temporary authorization. Please try again or contact an App Administrator.

The check couldn't be completed.

Click the button again. If it continues, submit a technical support case with the full message.

Processing...

Progress window

The document is being created. Don't close the window.

1 Document(s) generated and uploaded successfully.

Progress window (green)

The number of documents created and saved. With msqry, it counts every document saved.

Document(s) were created and uploaded successfully.

Result

The documents were created and saved.

Process Complete! / Document(s) were generated successfully.

Completion page (heading XL Docs, Close button)

The run finished.

Batch Execution Requested_<date and time>

Batch trigger field

The Execute Batch or Execute XL Docs Batch button was clicked and the email notification should start the run.

PROCESSING_<date and time>

Status field (triggerfid, single-record batch runs)

The batch run has started.

PROCESS COMPLETED_<date and time>

Batch status field (xldbtfld or triggerfid)

The batch run finished without errors. If it failed, the field shows the error message instead.

Status Completed, Notes Documents Generated Successfully.

Batch log record (logsdbid)

The run succeeded. The record also has Start, End, Related Batch Processing, and Documents Processed. On failure, Status is Error and Notes holds the error.

A required parameter is missing or malformed. Please double-check your request, or contact your Quickbase support representative if the issue persists.

A required parameter is missing or empty (clientid, appid, dbid, tpdbid, tpid, fn), or the request has neither or both of msid and msqry.

Check the button formula against Formula URL parameters. Make sure field values used in the formula (such as the Record ID# or a table alias) aren't empty on this record.

Invalid parameters.

API only. The same problem as above.

Check the query string. Parameters must be in the URL, not the request body.

The '<parameter>' parameter is required., Either the 'msid' or 'msqry' parameter is required., or Supply either 'msid' or 'msqry', not both.

Batch runs. The same problems as the first row, shown in the status field and the log record.

Fix the batch arguments field. Use exactly one of msid and msqry.

A temporary token message

Your account uses enhanced security, and the request didn't pass.

See Temporary token (enhanced security) messages.

A setting has no effect, with no error

Parameter names that XL Docs doesn't recognize are ignored.

Check the spelling of the parameter name. Write docfmt values in lowercase (pdf, csv, xlsx).

The template table was not found. Please make sure that the tpdbid parameter field is correct.

tpdbid doesn't point at your Document Templates table.

Use the table alias, for example [_DBID_DOCUMENT_TEMPLATES].

The template record was not found. Please make sure that the tpid parameter field is correct.

No record with the Record ID# in tpid exists in the Document Templates table.

Check tpid against the template record's Record ID#.

The template record exists but there is no file associated to it. Please make sure that a template file is attached to the template record.

The template record has no Excel file attached.

Attach the template workbook to the template record. See Build a document template.

The template record was found, however the 'Document Subtable Excel DBID' field was missing or blank. Please make sure that the field exists and is set to the DBID of the 'Document Subtable Excel' table.

The template record doesn't say where its data tables are.

Set Document Subtable Excel DBID on the template record. See Document Templates table reference.

This version of Excel Generator only supports .xls, .xlsx, or .xlsm template files. Please open the template file in Word, save it as a .xls, .xlsx, or .xlsm file, reupload to your QB Template table and try again.

The attached template isn't an Excel workbook of a supported type.

Open the template in Excel, save it as .xlsx, .xls, or .xlsm, and attach it again. Use a lowercase file extension.

Something's wrong with the pages you selected. You entered more than the sheets you have in your template.

The template's PDF Pages field lists more worksheets than the template has. It's shown after Error occurred while generating the document:.

Correct PDF Pages (for example 1,3-5) so it only lists sheets that exist.

Clist was empty on related subtable #{RecordID} - please enter in at least one field into the clist for this subtable, or unrelate it from the Document Template.

A Document Subtable Excel record linked to the template has no cell map.

Add at least one field to that record's clist, or remove it from the template. See Document Subtable Excel table reference.

Subtable #{RecordID} references Sheet {Sheet}, but the template only has {n} sheet(s) - please fix the Sheet value on this subtable, or add the missing sheet to the template.

A data table points at a worksheet the template doesn't have.

Fix the record's Sheet value, or add the worksheet to the template.

Image Error in a cell

An image in the cell map couldn't be loaded.

Check that the image field or URL has a value and that the file can be opened. See Build a document template.

Error occurred while generating the document: {detail}

The workbook couldn't be converted to the requested format or saved.

Read the detail. Check docfmt, docpw, and the template. If the template is complex and processing hangs, try parse=y.

You cannot generate more than {N} files. Please open a Quickbase support ticket for further information.

msqry matched more records than you can create in one request (up to 50 by default; your account's limit may differ).

Narrow the query or report, or use batch processing. To discuss a different limit, submit a technical support case.

There no records retrieved form Quickbase based on filter criteria. No, files to generate.

msqry (or the report) matched no records.

Check the query, the field IDs in it, and the values the formula inserts. Test it as a report filter.

Error occurred while adding new tabs for 'Same Workbook' mode.

With sameworkbook=y, a worksheet couldn't be added for a record.

Check the template opens normally in Excel. Try again with fewer records.

Error occurred while naming new tabs for 'Same Workbook' mode.

A tab couldn't be named from the snfid field.

Check that the snfid field has a value on every record and that each record's value is different (Excel tab names must be unique), or leave snfid out.

The 'addfiles'/'prefiles' parameters are only supported when 'docfmt' is 'pdf'.

addfiles or prefiles was used with Excel or CSV output.

Add docfmt=pdf, or remove those parameters.

You cannot merge more than {N} addfiles/prefiles file(s). Please open a Quickbase support ticket for further information.

addfiles and prefiles together list more files than allowed (up to 10 by default; your account's limit may differ).

List fewer files. To discuss a different limit, submit a technical support case.

Invalid parameters in prefiles: … / Invalid parameters in addfiles: …

An item in the list couldn't be read or found.

Check each item's format: a field ID, dbid:recid:faid, S3|<object key>, RID, or FID plus a field ID. See Output and storage.

Failed to download additional file(s): …

A listed file couldn't be downloaded.

Check the file exists in that field, record, or S3 key, and that it's a PDF.

The 'mrgdbid'/'mrgfa'/'mrgrid' parameters are only supported when 'docfmt' is 'pdf'.

Merging many records into one file was requested with Excel or CSV output.

Add docfmt=pdf. Merging works only with PDF output.

Cloud storage upload could not be configured for this request. Please contact support.

amazons3=y or dropbox=y was used, but no credentials for that provider are saved for your account.

Set up the provider (see Amazon S3 setup or Dropbox setup), or submit a technical support case.

A message that starts with QuickBaseError occured or Quick Base Error occurred, or another message that includes a Quickbase error code and detail

Quickbase rejected a read or a save, for example a field ID that doesn't exist or isn't a file attachment field, a missing application token, or a user without permission.

Read the Quickbase error detail. Check faid, rpfafid, mrgfa, swbfaid, apptoken, and the user's permissions on those tables and fields. To check a field ID, see Find your Client ID, table IDs, and field IDs.

Direct Call's URL is invalid.

The preqbaction call doesn't point at your own Quickbase realm.

Build the call with URLRoot() and wrap it in Base64Encode(). See Run a Quickbase API call before generating.

A Quickbase error from the call

Quickbase rejected the preqbaction call, so no document was created.

Check the API call (action, record ID, field IDs) and the user's permission to make that change.

We're sorry but something went wrong previewing the file to the browser! The document reference was invalid.

The link to a streamed PDF isn't valid.

Select the button again to create a new PDF.

We're sorry but something went wrong previewing the file to the browser! The file: {fileName} cannot be found.

The streamed PDF has already been shown and removed from the server. Streamed PDFs can be viewed once.

Select the button again, or open the copy saved on the record. To keep a copy, add faid to the button.

Error downloading file: a required parameter is missing or malformed. Please double-check your request, or contact your Quickbase support representative if the issue persists.

A download link is missing clientid, appid, dbid, or msid.

Check the link formula. See Output and storage.

Error downloading file: no file was specified to download. Please double-check your request, or contact your Quickbase support representative if the issue persists.

The link has no file: neither dropboxfile, nor psu=y with fn.

Add the file's key to the link, and check the key field isn't empty on the record.

Error downloading file: file downloads are not configured for this environment. Please contact your Quickbase support representative.

Download links aren't available on this server.

Submit a technical support case.

A Notification Error when you save the email notification, saying the account may only send email to verified Quickbase users

Your Quickbase account can't send notifications to addresses outside your users, and the batch request address is outside them.

Submit a technical support case to allow your account to send emails to non-registered Quickbase users.

The trigger field still shows Batch Execution Requested_<date and time> and nothing else changes

The run never started, or it stopped before it could write a status. Common causes: the email notification isn't set up or doesn't fire on the trigger field; the notification goes to the wrong address or the arguments have the wrong type; a required parameter is missing; or xldbdbid, xldbrid, or xldbtfld is missing, so there's nowhere to write the status.

Check the notification and the arguments field as described in Batch processing. US accounts use xldocsbatch@xldocsbatch.quickbasetools.com with type=xldocsbatch; EU accounts use xldocsbatcheu@xldocsbatch.quickbasetools.com with type=xldocsbatcheu.

The status field doesn't change, and no log record is added

The authorization check failed (see Authorization messages). A batch run that isn't authorized stops without writing a status.

Check clientid and appid in the arguments, that the app is authorized for XL Docs, and that the saved user token works. Try the same parameters on a button: the button shows the authorization message.

No ConfigID was passed in. This configuration requires a ConfigID.

The arguments have no configid. Every batch run is checked against a batch configuration, so the arguments must name one.

Add the configid the wizard created, or create a configuration. See Use a configuration in batch runs.

Could not find a Config with ConfigID <ID> - this configuration requires a ConfigID.

The configid doesn't match a saved configuration.

Check the ID in the Batch Config Portal. See Use a configuration in batch runs.

The following parameters do not match the configuration: [<parameter names>]

The arguments were changed after the configuration was saved, so the listed values no longer match.

Update the configuration to match the arguments, or change the arguments back. See Batch Config Portal messages and troubleshooting.

Encountered duplicate parameter [<name>]

A parameter appears twice in the arguments.

Remove the duplicate from the arguments field.

No parameters passed in for batch configuration to process.

The run received no arguments to check.

Check that the notification sends the arguments field.

The status field shows another error message

The batch run failed. The same message is in the run's log record (Notes), with Status Error.

Look the message up in this article. Fix the arguments and request the run again.

Please select a table.

No table is chosen in Select a Table.

Choose the table to create documents from in Select a Table.

The usertoken selected does not have permissions to create fields in the <table name> table. XL Docs needs permissions to create fields in order to continue the setup.

The wizard adds fields to the table, but the user token chosen on the Authorization step belongs to a user who can't change the table's fields.

Choose a token that belongs to a user who can change the table's fields, such as an app admin, or give the user that permission.

Please upload a valid file for the custom template.

Upload Custom Template is selected, but no file was chosen, or the file isn't a valid template file.

Choose an Excel file (.xlsx, .xls, or .xlsm).

Must supply a Record ID# for the existing template.

An existing template is selected, but its Record ID# is blank.

Enter the template record's Record ID#.

No filtering mode was selected. Please select a filtering mode.

Bulk setup only. Neither Select a Report nor Filter By Query is chosen.

Choose Select a Report or Filter By Query.

Report-mode selected, but no report chosen. Please choose a report.

Select a Report is chosen, but no report is selected.

Choose a report.

Query-mode selected, but query is blank. Please fill in a query.

Filter By Query is chosen, but the query builder has no filter.

Build at least one filter in the query builder.

Processing hangs on a complex template

The template has broken links or pivot table problems that slow down reading the workbook.

Add parse=y so each worksheet is parsed only when it's needed. Check the template for broken links or pivot table problems.

Excel opens the document in Protected View

That's Excel's own banner for downloaded files.

Select Enable Editing, or see Tips and examples.

A PDF opens as a spreadsheet, or a streamed file has the wrong type

The docfmt value isn't written in lowercase.

Write docfmt in lowercase: pdf, csv, or xlsx.

Nothing is shown after selecting the button

A button using ExcelGen_UA.aspx without stream=y, or with msqry and no sameworkbook=y, saves documents but shows nothing.

Use ExcelGen_LP.aspx to show a result.

The file name is missing characters

XL Docs removes \ / : * < > | ? " and periods from fn.

Leave those characters out of the file name. See Output and storage.