Finish
When the wizard has completed the installation, the Finish step shows a confirmation page that lists the fields and tables it created or updated. The setup isn't complete yet: you set up where each value is stamped on your PDF, and to create documents automatically (single) or to run bulk generation at all, you also create an email notification yourself. See Next steps.
The confirmation page
The Finish step shows, from top to bottom:
In bold: Congratulations, you have successfully installed PDF Stamper in your Quickbase Application! followed by a link to the documentation on the features and functionality of PDF Stamper.
In bold: Your setup for generating documents automatically is not finished! followed by You will need to set up an Email Notification on the <table> table! <table> is the table you chose in Select a Table.
Click here to view the steps to create an Email Notification to trigger PDF Stamper Batch to run: and an Email Notification Steps link. Those steps are now in PDF Stamper email notification new navigation.
The following changes were made to your application: followed by Selected Table (a link to the table you chose), Added fields to this table, and Created Tables. The changes are listed below.
If you choose Bulk Document Generation for an app that already has the PDF Stamper batch tables, the wizard doesn't install anything. It shows You already have PDF Stamper - Bulk Document Generation installed in this app! and a link for requesting more bulk functionality for the app.
If the wizard isn't open inside the Extensions Portal, a Close button closes the window.
What the wizard created
This table lists the main things the wizard creates, and in which setup. The full field lists follow it.
Table/Field | Type | What it's for |
|---|---|---|
Document Templates (single and bulk) | Table | Holds your PDF templates. Each record has a Template File (the PDF) and an Add New PDF Stamper Subtable button. |
Document Subtables (single and bulk) | Table | The stamping fields for a template: each record says what to stamp (text, a barcode, an image, or HTML), on which page, and where. See Fields on the Document Subtables table. |
Template record (single and bulk) | Record in Document Templates | With Use Standard Sample Template, a record with a sample PDF. With Upload Custom Template, a record named after your file. With Use an Existing Template, no new record; the wizard uses the Record ID# you entered. |
PDF Stamped Document (single) | File attachment | Where the stamped PDF is saved on the record. |
PDF Stamped Date (single) | Date/Time | When the document was last stamped. |
Stamp the Document (single) | Formula - URL (button) | Stamps the record's data onto the template in a new window and saves the PDF to PDF Stamped Document. |
PDF Stamper Batch Trigger Field (single) | Text | Updated when you select Execute PDF Stamper Batch. Your email notification watches this field to start the batch process, and the field shows when the process completed. |
PDF Stamper Batch Processing Arguments (single) | Formula - Text | The parameters for stamping in the background. Your email notification sends this field's value to the batch email address. It includes the configid of the batch configuration. |
PDF Stamper Batch Email | Formula - Email | The address your email notification sends to: pdfstamper@pdfstamper.quickbasetools.com for US realms, or pdfstampereu@pdfstamper.quickbasetools.com for EU realms. In single setups it's on the master table; in bulk it's on PDF Stamper Batch Processing. |
Execute PDF Stamper Batch (single) | Formula - URL (button) | Starts stamping in the background: it sets PDF Stamper 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 |
PDF Stamper 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. |
PDF Stamper 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 pdfstamper (US) or pdfstampereu (EU), that holds the settings for background runs, such as the file attachment field and the Amazon S3 or repository details. Its key is the configid in the batch processing arguments field. See Batch Config Portal overview. |
The wizard doesn't create the email notification itself, and it doesn't create any stamping field records: you add those to Document Subtables for your own template.
Fields on the Document Templates table
The wizard adds each field only if a field with that name doesn't already exist.
Field | Type | What it's for |
|---|---|---|
Name | Text (required) | The name of the template. |
clist | Text | The field IDs of the master-table fields used with the template. |
Template File | File attachment (keeps all versions) | The PDF template. |
Master table dbid, Master table name | Text | The table the template creates documents for. |
MSG_DetailsNotFound | Text | The message shown in the document when no records are found for subtable data. |
appDBID, Document Subtable DBID | Formula - Text | The app ID and the Document Subtables table ID. |
Copy this Document Template | Formula - URL (button) | Copies the template record and its stamping field records. |
Add New PDF Stamper Subtable | Formula - URL (button) | Opens a new Document Subtables record linked to this template, so you can add a stamping field. |
Document Subtables | Report link | Lists the template's stamping field records. |
Fields on the Document Subtables table
Each Document Subtables record is one value stamped onto the PDF. The wizard adds these stamping fields:
Field | Type | What it's for |
|---|---|---|
Type to be stamped | Text - Multiple Choice: Text, Barcode, Image, HTML | Whether to stamp text or an image onto the PDF. A barcode is stamped as an image. |
Page Number | Numeric | The page of the PDF the text or image is stamped on. |
X Position, Y Position | Numeric | The horizontal and vertical offset, in pixels, of the stamped text or image from the top corner of the PDF. |
Associated Field ID | Text | The field ID of the master-table field whose value is stamped. |
Text to be stamped | Text | Fixed text to stamp. If it has a value, it's used instead of the value of the Associated Field ID field. |
Image Width, Image Height | Numeric | The size of a stamped image. |
Downloadimagefromlink | Checkbox | Download the image from a link before stamping it. |
Font Type | Text - Multiple Choice: Arial, Courier, Helvetica, Symbol, TimesRoman, ZapfDingbats | The font of stamped text. |
Font Size | Numeric | The size of stamped text. |
Font Color | Text - Multiple Choice: DarkBlue, White, Black, Brown, Navy, Blue, Pink, Purple, Yellow, Red | The color of stamped text. |
Font Style | Text - Multiple Choice: Bold, Italic, Regular, Strikeout, Underline | The style of stamped text. |
Text Align | Text - Multiple Choice: Left, Right, Center | The alignment of stamped text. |
Label | Text | A label for the stamping field. |
PDF Template Name | Text | The name of the PDF template the field belongs to. |
Is Fillable | Checkbox | Fill a form field in a fillable PDF instead of stamping at a position. |
The table also has Settings, Configuration Name, Template Reference, Notes, the Related Document Template relationship, and lookups of Masterclist, Master table dbid, Document Template Name, and appDBID from the related template.
Amazon S3 and repository fields
Amazon S3: S3 Key (Text) and View File (Formula - URL, Download from S3). In single setups these are on the master table; in bulk they're on PDF Stamper Batch Processing, for the merged file, and the master table also gets PDF Stamper Document S3 Key. View File opens the file with the Extensions Downloader.
Repository table (single only): if the wizard created the repository table, a Repository Files report link on the master table. See Repository table step.
Bulk tables
In bulk setups, the master table gets PDF Stamper Document (File attachment) and PDF Stamper Date (Date/Time) for each record's stamped PDF.
PDF Stamper Batch Processing has these fields:
Field | Type | What it's for |
|---|---|---|
Name | Text (required) | The name of the bulk run. |
Trigger Field | Text | Updated when you select Execute Batch; your email notification watches it. Shows when the process completed. |
Execute Batch | Formula - URL (button) | Starts the run. Refresh the page until Trigger Field shows completed; the logs report then has a new record for the run. |
Records to be Processed | Formula - URL | Opens the records the run will process (your report or query). |
Processing | Formula - Text, with Allow some HTML tags | Tells you to refresh your screen while a run is in progress. |
Refresh | Formula - Text, with Allow some HTML tags (button) | Refreshes the record. |
Merged File, Merged Date | File attachment, Date/Time | The merged PDF, if you checked Merge Output Files, and when it was created. |
PDF Stamper Batch Email | Formula - Email | The batch email address (see above). |
Batch Processing Arguments | Formula - Text | The parameters for the run, including the report or query, the template, and the configid. |
Batch Processing Logs | Report link | The run's logs. |
PDF Stamper Batch Processing Logs has Related Document Generation (the relationship to PDF Stamper Batch Processing), Status, Notes, Documents Processed, Start, End, Run Duration, and the lookup PDF Stamper Batch Processing - Name.
Next steps
Add stamping field records for your template in Document Subtables (use Add New PDF Stamper Subtable on the template record). See PDF Stamper features and functionality.
Create the email notification that triggers stamping: PDF Stamper email notification new navigation (or PDF Stamper Email Notification).
Adjust the button and arguments: PDF Stamper formula URL parameters.
Learn how background runs are configured: Batch Config Portal overview.
See what PDF Stamper can do: PDF Stamper overview.
If a View File link doesn't open the file, see Extensions Downloader messages and troubleshooting.