Glossary
Glossary
Array
A PDF array field is a group of similar items. Creating an array allows Anvil to know that you can have many items of the same type and helps Anvil to automatically populate repeated fields. For example, if you are trying to fill in an invoice with multiple line items, you would create an array that groups together all of the item names, another array that groups together all of the item descriptions, and finally an array that groups together item price. Now if you have multiple line items to populate onto a PDF, you would assign the item names (note plural) to the item names array, and Anvil will automatically figure out to put one name per a row.
Most commonly, arrays are mapped to webform list fields to complete tables or lists on a PDF. Learn how to add a list to a webform and map a list to a PDF.
Basic text
Single line text input on a webform. Most commonly mapped to a PDF short text field.
Checkbox
A single box that can be selected on a PDF or webform. Boxes will be filled in with an x
.
Webform checkbox type fields have the following options:
- Box Label: the label that shows up to the right hand side of the box.
- Require this field to be checked to pass: if this option is selected a user is not allowed to proceed to the next page, or submit their information unless the box is checked. This can be useful for consent boxes.
- Default this checkbox to true: if this option is selected, the checkbox will default to being checked.
To limit the selection of checkboxes to one option, use a Radio group.
Combined field
By using the Combine another field into this one
action in the Webform field editor, you can combine two or more fields into a single field. The fields must be of the same type for this to work. By combining fields you can reduce the number of times a user is asked to provide the same information, but still have the information mapped to all of the corresponding PDF fields.
Learn more about combining fields that are the same here.
Date
A PDF field consisting of a day, month, and year. Includes the following common date formats when filling in the blank PDF field.
- MM/DD/YYYY example: 10/10/2020
- MMM DD YYYY example: Oct 10 2020
- MMMM DD, YYYY example: October 10th, 2020
- YYYY-MM-DD example: 2020-10-10
A PDF date field can be connected to a webform date calendar picker or date dropdown field.
Date calendar picker
A webform field with a calendar component for selecting dates, best used for dates that are close to the current date with the following options:
- Disable date: make certain dates not selectable.
- Show button to select today: displays a button in the calendar picker that automatically enters today’s date.
- Default date to today: automatically sets the default value of the date to today.
Learn how to format a date selector in a webform here.
Date dropdown
A webform field that consists of three dropdowns for selecting a date: a month, day and year. Best used for dates that are far away from the current date, such as birthdays. Date dropdown fields have the following options:
- Min year: the minimum year that is displayed in the year dropdown. The year limit is tracked relative to the current year. So if you set the Min year to 1911 and one year passes, the field automatically updates to have the minimum year be 1912.
- Max year: the maximum year that is displayed in the year dropdown. The year limit is tracked relative to the current year. So if you set the Max year to 2021 and one year passes, the field automatically updates to have the maximum year be 2022.
Learn how to format a date selector in a webform here.
Decimal number
A PDF or webform field that accepts a decimal number, with up to two decimal places.
A webform decimal number type field has the following options:
- Number of decimal digits allowed: control the number of digits allowed after the dollar amount. The default is two decimal places.
- Min: the minimum accepted value; can be negative.
- Max: the maximum accepted value; can be negative.
A PDF decimal number type field can be formatted in the following ways:
- With commas & 2 decimals: example 1,234.56
- Without commas & 2 decimals: example 1234.56
Default value
A value that can be preset for the webform field. This can be a static value or a value derived from another field that appears before the field you are configuring.
Description
A longer explanation about the type of information a webform field is requesting that appears below the label.
Dollar
A field for collecting dollar values on a PDF or webform.
A webform dollar type field can have the following options:
- Number of decimal digits allowed: control the number of digits allowed after the dollar amount. The default is two decimal places.
- Min: the minimum accepted value; can be negative.
- Max: the maximum accepted value; can be negative.
A PDF dollar type field can be formatted in the following ways:
- Dollar Sign $ Cents: example $12.34)
- No Dollar Sign $ Cents: example 12.34 - Used if there is already a $ printed on the form.
- Dollar Sign, No Cents: example $12
- No Dollar Sign, No Cents: example 12
Dropdown
A webform field that limits the user to multiple pre-prescribed options from which they can select one.
A webform dropdown type field can have the following options:
- Dropdown options: Add options that will be displayed in the dropdown field. Options can be removed and re-ordered.
- Type to autocomplete: This enables users to type in a dropdown field and filter the dropdown options.
Often, a webform dropdown is mapped to a PDF radio group.
A field for collecting email addresses on a PDF or webform. An email type field automatically validates that the email address is in a proper email address format.
Embedded video
A webform field to show embedded video files to someone completing the webform. Includes the option to change the aspect ratio or allow for full screen video.
Field alias ID
A value used to uniquely identify a webform field within a webform that can be reused across multiple workflows. This Field Alias ID is beneficial for developers integrating workflows via API trying to identify fields across multiple workflows that are the same.
File upload
A webform field that allows users to upload files to the Workflow. If the user is completing the Workflow from a mobile device, they will also have the option to access their camera and take a photo to be uploaded.
A webform file upload type field can have the following options:
- Drop zone text: the text displayed in the area a user can drag and drop their file(s).
- Button text: the text displayed on the upload button.
- Size: control the size of the upload field and the drop zone.
- Acceptable file types: choose between images, PDFs or all files.
- Allow multiple files to be uploaded: allow a user to drag multiple files or a folder into the drop zone. Anvil will upload all of the files at once.
First and last name
A webform name field that allows for one First Name, one Middle Initial, and one Last Name. Note: This may not be a great fit for naming conventions where multiple last names are given to an individual. If you need to offer more flexible webform name entry, consider using a webform list field.
A webform first and last name type field has the following options:
- Show middle initial field: displays a field for collecting the first letter of the middle name.
A webform first and last name field can be mapped to a PDF name field.
Image
A PDF field for placing an image onto a PDF. The image will be scaled to the width of the box.
An image field can be mapped to a File upload field on a webform.
Initial
A PDF field that specifies where a signature initial is needed. An initial field is not mapped to a webform field, but instead marked to be signed by an added signer.
Integer
A field for collecting integer values (whole numbers, positive and negative) on a webform or PDF.
A webform integer type field can have the following options:
- Min: the minimum accepted value; can be negative.
- Max: the maximum accepted value; can be negative.
A PDF integer type field can be formatted in the following ways:
- With commas: example 1,234
- Without commas: example 1234
Label
The bolded name that appears above a field on a webform.
List
A webform list field allows a user to add multiple items of grouped pieces of information, where the total number of items is determined by the user completing the Workflow. Each item in the list can contain multiple input fields of any type except for another list field. For example, a workflow may ask the user to list all of their children, each child’s birthday and upload a photo. Each list item would contain a Name field, Date field and File upload field. The webform list field would allow for the user to keep adding children until all of their children have been listed.
Most commonly, webform list fields are used to complete tables or lists (configured as arrays) on a PDF. Learn how to add a list to a webform and map a list to a PDF.
Logic
AND/OR conditions that allow you to dynamically show or hide fields, pages, or documents depending on whether the specific field is relevant to the user completing the form.
Long text (paragraph)
A large, freeform space for general text input on a PDF or webform. Text will automatically wrap to new lines within this field type.
On a webform long text field, text will wrap and scroll, allowing the user to see everything they enter into the input box. The Number of rows
option controls the size of the long text field box. The more rows, the larger the default size that is displayed. This does not limit the total number of rows a user can input, just the size of the long text field box when it is displayed.
Name
A PDF field for a person's name. Supports First Name, Last Name and Middle Initial. This is a compound PDF field, you can map a name to a single box, or separate boxes for First, Middle and Last names.
A PDF name field supports the following formats.
- All in one field: one field for the entire name.
- First, middle, or last name: Separate fields for each part of a name, with an optional field for a middle name.
A PDF name field can be mapped to a webform First and last name field.
Numeric text
A webform text field that allows for only numeric input with the following field options:
- Min length: the minimum number of characters that is accepted by the field.
- Max length: the maximum number of characters that is accepted by the field.
- Mask Sensitive Info: when checked, the field will display
•
in place of the numbers. This will also encrypt the field information.
Most commonly mapped to a PDF short text field.
Optional field
A webform field that is not required to be filled by checking the Make this field optional
checkbox in the webform field editor.
Learn more about how to make a field optional on a webform here.
Percent
A field for collecting percentage values on a PDF or webform with up to one decimal place.
A webform percent type field has the following options:
- Number of decimal digits allowed: allow up to one decimal place after.
- Min: the minimum accepted value; can be negative.
- Max: the maximum accepted value; can be negative.
A PDF percent field type can be formatted in the following ways:
- Percent sign with decimal: example 35.5%
- Percent sign, no decimal: example 35%
- No sign, with decimal: example 35.5 - Use if the form already has a % printed.
- No sign, no decimal: example 35
Phone
A field for collecting phone numbers on a PDF or webform. International numbers are allowed by starting the phone number with a +
symbol. Phone numbers will be formatted as (xxx) xxx-xxxx.
Placeholder
A suggested value for a webform field meant to help users better understand what type of information is expected for the field that will be visible until a user inputs data into the field.
Radio buttons
A webform field group of options displayed as buttons that allows for a single selection. Defaults to editable "yes " and "no" options and you can add as many options as you need. For single select fields with many options, you may want to use a dropdown.
Often, a webform radio buttons field is mapped to a PDF radio group.
Radio group
A PDF field group of checkboxes where only one can be selected. The selected option will be filled with an x
character.
A PDF radio group can be mapped to webform dropdown or radio buttons field. Learn more about creating a PDF radio group here.
Short text
An open text PDF field, accepts all input, best used for PDF fields that have a short, single-line, pre-defined space for input. A short text field accepts any alphanumeric text, including symbols like "-, *, &, ., ?" as well as emojis "👍, 🎉, etc."
Most commonly a PDF short text field is mapped to a webform basic text field, though any webform field can be mapped to a short text field.
Signature
A PDF field that specifies where a signature is needed. A signature field is not mapped to a webform field, but instead marked to be signed by an added signer.
Signature date
A PDF field that specifies where a date is needed during the e-signing process. A signature date field is not mapped to a webform field, but instead marked to be signed by an added signer.
Social Security Number
An encrypted field for entering social security numbers on a PDF or webform. Numbers will be automatically masked and formatted as xx-xxx-xxxx.
If you need a social security number to be printed as a single number per box, use a PDF text: Boxes per letter field type instead.
Tax ID Number (EIN)
An encrypted field for entering EIN numbers on a PDF or webform. Number will be automatically masked formatted into xx-xxxxxxx.
If you need a Tax ID number to be printed as a single number per box, use a PDF text: Boxes per letter field type instead.
Text: boxes per letter
A PDF field that accommodates forms where a box or space is provided for each character. This format is often used for phone numbers and social security numbers. By default, this type of PDF field is mapped to a Basic text webform field, but can be mapped to any type of webform field.
Learn how to create Text: boxes per letter on a PDF here.
Text: boxes per line
A PDF field that accommodates forms where there is a separate space for each new line within a paragraph. This format is useful when there are pre-printed lines on a form or the space for text to be filled is not a standard retangular shape. By default, This type of PDF field is mapped to a basic text webform field, but can be mapped to any type of webform field.
To learn how to create Text: boxes per line on a PDF, follow the instructions for how to create Text:boxes per letter here.
US address
A field for collecting address information from the following countries: USA, Mexico, Canada on a PDF or webform. Supported addresses can be formatted on the PDF in the following ways:
- All in one field: One box where the entire address is printed.
- Line 1 and Line 2: Two boxes where the first box is the Street Address, and the second box will contain the City, State, and Zip.
- Street, City, State, Zip: Separate boxes for the Street Address, City, two letter State code and Zip code.