An Image Upload field lets the client upload a photo or an image, for example a photo of an ID card. At the end of the process, the uploaded image is sent with the results of the transaction, for example to the agent by email and to the archive.
A new Image Upload field can be filled in by the client only, and it isn’t required. For the settings that all fields share, such as the label, permissions, dependencies and style, see Field settings. For other files, such as PDF or Word documents, use a File Upload field. To show an image that you choose, such as a logo, use an Image field.
Add an Image Upload field
Section titled “Add an Image Upload field”- HTML template: drag Image Upload from the palette.
- PDF template: the palette doesn’t include upload fields. Under the palette, in File Uploads, click Add File. Set the Display Name, select Image in Type, and turn on Mandatory if the client must upload an image. To remove the field, click its trash icon.
In a PDF template, an upload field isn’t placed on the page. To show the uploaded image in the result PDF, see Add image to result PDF.
Settings
Section titled “Settings”On the Values & Display tab, enter an Accessibility value: a text that describes the image for screen readers. It is used when the image is added to the result PDF.
The other settings are on the Validation tab:
| Setting | What it does |
|---|---|
| File name | The name of the image at the end of the process. See File names. When empty, a random name is used. |
| Convert image to PDF | The image is converted to a PDF file in the emails and in the archive. |
| Allow upload from clipboard | The client pastes an image (Ctrl+V) instead of selecting a file. The field has no file picker. If the page has more than one such field, the client clicks the field before pasting. |
| Add file to client email at the end of the process | Attaches the image to the email sent to the client at the end of the process, whatever the field’s permissions are. |
| Add image to result PDF | Shown in PDF templates only. Adds the uploaded image to the result PDF. See Add image to result PDF. |
| Error if no value entered | See Validation. |
Add image to result PDF
Section titled “Add image to result PDF”In an HTML template, the uploaded image is shown in the result PDF. In a PDF template, it isn’t, unless you place the field on the page:
- Add an upload field of type Image under File Uploads.
- Open the In Template tab of the palette and drag the image field onto the PDF page.
- Resize the field to the area where the image should appear.
- Select the field. On the Validation tab, turn on Add image to result PDF.
- On the Values & Display tab, enter the Accessibility value.
The image is added to the result PDF only. The client doesn’t see it on the page while filling in the form.
File names
Section titled “File names”In File name, you can combine text with values from the form:
@followed by a field ID adds the value of that field, for exampleID-@id_number. Separate the field reference from the text before and after it with a space, a comma, a semicolon or a hyphen.#timestampadds the date and time of the submission.
For example, ID-card-@first_name-@last_name can become ID-card-Dana-Levi.jpg. The extension of the original file is kept.
On the Style tab, Display button shows the field as a compact button, without a preview or download.
What the client sees
Section titled “What the client sees”- The client clicks the field and selects an image. On phones and tablets, the field usually opens the camera or the photo gallery, depending on the device.
- The image is checked: it must be a JPG or PNG file. Large images are resized to fit 1300 × 1300 pixels before they are uploaded.
- After the upload, the field shows a preview of the image. The client can enlarge the image, and remove it to upload another one.
The orientation of a photo taken with a phone can differ between devices.
Conditions
Section titled “Conditions”In conditions, an Image Upload field supports Empty and Not Empty.