XL Docs finish

Prev Next

Finish

When the wizard has finished installing, the Finish step shows a confirmation page that lists every field and table it created or updated. It also links to any steps you still need to take—in particular, creating an email notification for automatic or bulk document creation.

The confirmation page shows:

  • Congratulations, you have successfully installed XL Docs in your Quickbase Application!, with a link to the XL Docs documentation.

  • If the setup includes automatic document creation: Your setup for generating documents automatically is not finished! You will need to set up an Email Notification on the table named in the message, and a link to the email notification steps. See Create the email notification.

  • The following changes were made to your application:

    • Selected Table: a link to the table you chose in the XL Docs setup step.

    • Added fields to this table: the fields added to that table (see below).

    • Created Tables: the tables the wizard created.

To close the wizard, select the X in the corner of its window.

What the wizard created

This table lists the main things the wizard creates, and in which setup.

Table/Field

Type

What it's for

Document Templates (single and bulk)

Table

Holds your Excel templates, with the XL Docs Configurator button. Created only if your app doesn't have one yet. See Configurator overview and installation.

Document Subtable Excel (single and bulk)

Table

Holds the related-data subtable configurations for a template, with the XL Docs Subtable Configurator button. Created only if your app doesn't have one yet.

XL Docs Document

File attachment

Where the created document is saved on the record.

XL Docs Date

Date/Time

When the document was last created.

Create XL Sheet (PB) (single)

Formula - Text, with Allow some HTML tags (button)

Creates the document and shows its progress in a pop-up window.

Create XL Sheet (Mobile Friendly) (single)

Formula - URL (button)

Creates the document in a new window and streams it back to the browser. Suited to mobile devices.

Generate XL Sheet (single)

Formula - Text, with Allow some HTML tags (button)

Creates the document and shows it in a pop-up window. See Formula URL parameters for what's behind the buttons.

XL Docs Batch Trigger Field (single)

Text

Updated when you select Execute XL Docs Batch. Your email notification watches this field to start the batch process, and the field shows when the process completed.

XL Docs Batch Processing Arguments

Formula - Text

The parameters for creating documents in the background. Your email notification sends this field's value to the batch email address. It includes the configid of the batch configuration. In single setups it's on the master table; in bulk it's on XL Docs Batch Processing.

Execute XL Docs Batch (single)

Formula - URL (button)

Starts document creation in the background: it sets XL Docs Batch Trigger Field to Batch Execution Requested_ and the date and time, which fires your email notification. The button is hidden while a request is pending.

A single setup doesn't show the Application Token step, so the wizard creates this button with an empty apptoken= in its formula. If your app requires application tokens, add yours to that line of the field's formula, for example & "&apptoken=your_app_token".

XL Docs Batch Email

Formula - Email

The address your email notification sends to: xldocsbatch@xldocsbatch.quickbasetools.com for US realms, or xldocsbatcheu@xldocsbatch.quickbasetools.com for EU realms. In single setups it's on the master table; in bulk it's on XL Docs Batch Processing.

XL Docs Batch Processing (bulk)

Table

The control table. Each record is a bulk run: it holds the filter, the Execute Batch button, and the merged file. See Bulk document generation setup.

XL Docs Batch Processing Logs (bulk)

Table

One record per run, with its status, the number of documents processed, and the start and end times.

Batch configuration

Batch Config Portal configuration

A configuration for your app, of type xldocsbatch (US) or xldocsbatcheu (EU), that holds the settings for background runs. Its key is the configid in XL Docs Batch Processing Arguments. See Batch Config Portal overview.

If you chose Amazon S3 or Dropbox, the wizard also adds a key field (S3 Key or Dropbox Key) and a View File download field, which opens the file with the Extensions Downloader. If the wizard created a repository table, it adds a Repository Files report link to the master table; see Repository table step. The wizard doesn't create the email notification itself.

Next steps

  1. If the confirmation page says your setup isn't finished, create the email notification.

  2. Set up your template: Build a document template.

  3. Learn what XL Docs can do: XL Docs overview.

  4. If you see a message you don't expect, see XL Docs messages and troubleshooting.

  5. If a View File link doesn't open the file, see Extensions Downloader messages and troubleshooting.