Document Viewer Field

The Document Viewer field adds a document to the form, or lets users upload one of their own. This article covers how to add a Document Viewer field and set it up for either use.

How the Document Viewer field works

A Document Viewer field works in one of two ways:

Show a document: You upload a file, such as a safety manual, and users open it while they work
Collect a document: Users upload their own file from their device, such as a signed permit

For example, a work order can collect a signed permit from the technician before the job starts.

Add a Document Viewer field

In the Form Builder, select Add Fields in the side bar.
Under Reference, select Document Viewer to add it after the selected field. You can also drag it onto the canvas where you want it.

The field appears on the canvas as Document Viewer Field, and its field settings open on the General tab.

Show a document on the form

In Field Label, enter the name users see, for example Safety Manual.
Keep Allow Upload On Device turned off.
Select Upload File, then choose a PDF or Excel file.

After the upload, select View File to check the document, or Delete to remove it. To replace it, select Reupload File.

In the form, users see a View Document button that opens the file.

Tip
To keep reports short, turn on Exclude From Reports on the Behavior tab.

Let users upload a document

In Field Label, enter the name users see, for example Signed Permit.
Turn on Allow Upload On Device.

Users see an Upload Document button in the app, and the file is saved with their submission.

Configure the field

Use the General, Behavior, and Appearance tabs in Field Settings to control how the field works.

Tab	Setting	What it does
General	Field Label	The name users see on the form
General	Field Key	The key that identifies the field in submissions, rules, and calculations
General	Allow Upload On Device	When on, users upload their own file. When off, users view the file you upload
General	Upload File	Uploads the document users view. Shows only when Allow Upload On Device is off
General	Hint Text	Text that helps users know what to do with the field
Behavior	Hide Field	Hides the field in the app
Behavior	Hide Field Label	Shows the field without its label
Behavior	Exclude From Reports	Leaves the field out of reports. It stays in the submission data
Appearance	Background Color	Gives the field a color. Learn more about alert types

Select Save Draft to save your changes. Users see them after you select Publish.

Add the field with the Assistant

You can also ask the Assistant to add a Document Viewer field.

Select Assistant in the side bar.
Describe what you want, for example Add a document viewer field called Safety Manual after Description.
Send the message.

The Assistant can't upload a file for you. Select Upload File in Field Settings to add the document. To collect files from users, turn on Allow Upload On Device yourself.

Note
Assistant changes aren't saved until you select Save Draft.