How it works at runtime
When a user finishes the questionnaire and Gavel generates documents, it reads each PDF field’s tag and substitutes the corresponding questionnaire answer into that field. Fields tagged to a variable receive the variable’s value. Fields tagged with a conditional value receive the text that matches the condition. Fields marked as Untagged are left blank. The result is a filled PDF that looks as though it was completed by hand.Prepare your PDF
Your PDF must have fillable fields before you can tag it in Gavel. If your PDF does not already have fillable fields, you have two options:- Adobe Acrobat Pro — the standard tool for adding text fields, checkboxes, and signature fields to any PDF.
- Gavel PDF Renamer — upload your PDF to the Gavel Document Templates folder first. This unlocks the PDF. Download that version and then use the Gavel PDF Renamer at
start.gavel.io/pdfto add text fields, checkboxes, or signature fields.
Tag PDF fields
Add the PDF to your workflow
Open your workflow and go to the Document Templates tab. Upload your fillable PDF. It will appear in the list of templates attached to the workflow.
Open the PDF Tagger
Click Tag on the right side of the PDF entry. This opens the PDF Tagger, which displays your PDF with all its fillable fields visible and selectable.
Select a field
Click on any fillable field in the PDF. A panel appears with four options for what to put in that field.
Field tagging options
For each fillable field in your PDF, you have four choices:- Insert Variable
- Insert Conditional Value
- Enter Text
- Untagged
Maps the field directly to a workflow variable. When the questionnaire is completed, the field is filled with the answer to that question.How to use: Select the field, choose Insert Variable, pick the variable from the list, and click Save.
Checkboxes
Gavel can check or uncheck PDF checkboxes based on questionnaire answers.Connect a checkbox to a Yes/No variable
Connect a checkbox to a Yes/No variable
To check a box conditionally based on a workflow answer:
- Select the checkbox field in the PDF Tagger.
- Choose Insert Conditional Value.
- Build the condition — for example, “check this box if the variable
hasChildrenequals Yes.” - Click Save.
Set a checkbox to always be checked
Set a checkbox to always be checked
If a box should always be checked regardless of questionnaire answers:
- Select the checkbox field in the PDF Tagger.
- Choose Enter Text.
- Type
Yesin the text field. - Click Save.
Advanced formatting with Enter Text syntax
When you choose Enter Text, you can enter Gavel formatting syntax to apply calculations, transformations, or conditional logic to the field value. PDF syntax is slightly different from Word syntax:| Context | Syntax format |
|---|---|
| Word document | {{ capitalize(TextVariable) }} |
| PDF field | ${ capitalize(TextVariable) } |
- Use the Word add-in or the Learning Center to generate the syntax you need.
- Remove one set of brackets and add a
$before the remaining opening bracket. - Paste the result into the Enter Text field.
Splitting a number across multiple fields
Some forms — such as those with a Social Security Number or phone number — use separate fields for different digit groups. You can split a number variable across fields using slice notation:0 is the start position and 3 is the end position (the first through fourth characters). Adjust the start and end positions for each field to match the digit groupings in your form.
PDF syntax is the same as the syntax used in workflow question logic, so you can reuse the same expressions you use when referencing prior answers in the questionnaire.
Repeating items in PDF fields
If your questionnaire includes a repeating item (for example, a list of parties or assets), you can tag PDF fields to specific instances of those repeating values. Open the PDF Tagger, select the relevant field, and choose the repeating item variable and the instance you want to map to that field.Adding fillable fields to a PDF that has none
If your PDF does not have any fillable fields yet, you need to add them before uploading to Gavel.Upload the PDF to Gavel Document Templates
Go to the Document Templates section of your Gavel dashboard and upload the PDF. Gavel unlocks the PDF structure, making it editable.
Download the unlocked version
After uploading, download the version stored in Gavel. This is the file you will add fields to.
Add fields using the PDF Renamer
Visit
start.gavel.io/pdf and upload the downloaded file. Use the PDF Renamer to add text fields, checkboxes, or signature fields where needed.