Output Settings
The Output Settings provides custom configuration for the delivery of the submitted documents. Settings are customizable at the account level and at the template level.
If custom settings have been configured for the template, the document will be delivered according to these settings. If the settings are set to Default at the template level, then the account level output settings will be used.
Output Configuration
There are three configurations available for output.
Default: The standard output settings of naturalForms.
Custom – Basic Editor: If you select Custom settings, the fields in the Basic Output Settings will be enabled. This allows you to customize the details of the output delivery.
Custom – Advanced Editor: The Advanced Editor button will replace Basic Output Settings with a box to enter JSON code. This is only visible to Server Administrators and allows for more customized option details.
Output Options
The Email tab provides settings for email delivery of submitted documents.
Enabled: Turns email on or off.
File Naming: Default uses the settings seen in the screen shot below. Custom naming can consist of text and/or variables associated with the submitted document. See list of supported variables at the bottom of this page.
Include: Files that can be included in the output email.
- PDF: Image of the submitted document that including thumbnails of attached photos.
- Attachments: Photos (full size image files) and Voice Memos submitted with the document. Due to the file size, all attachments will be in a zip file.
- Document Data Files: Data from the document fields can be included in three formats (XML, CSV, JSON). You have the option to have these files zipped, if desired. All files chosen to be zipped will be included in one zip file along with the attachments.
- Encoding: The default encoding is set to utf-8, but can be customized to an alternate encoding standard.
The email message is customized in the Delivery section.
Email addresses used as the From, To, CC, or BCC can be either static or variable (such as the submitter email or an email address entered in a field on the document). To enter multiple email addresses, simply separate the entries with semicolons. Please make sure that there are no spaces or return carriages in this field.
The Subject and Body can also be customized using a combination of text and/or variables. The email body is formatted as text. Selecting the HTML checkbox allows you to put in your own HTML to format the message body.
FTP
The FTP tab provides settings for pushing the output files to an FTP server.
Default settings illustrated below.
Enabled: Turns FTP on or off.
File Naming: You have two options to name the email attachments files. Default uses the standard file naming convention as seen in the screen shot above. To create a different naming convention, select Custom. The custom naming can consist of text and/or variables associated with the submitted document. See list of supported variables at the bottom of this page.
Include: You can choose which types of files are pushed to the FTP server.
- PDF: You can select an image file of the document that was submitted. This file will include thumbnails of all photos that were added to the document.
- Attachments: These files consist of both photos and audio recordings that were attached to the document. Due to the size of many photo files, all attachments will be zipped.
- Document Data Files: Data in the forms can be delivered in XML, CSV, and/or JSON formats. You have the option to have these files zipped, if desired. All files chosen to be zipped will be included in one zip file along with the attachments.
- Encoding: The default encoding is set to utf-8, but can be customized to an alternate encoding standard.
Server: This is the URL (or IP address) of the FTP server.
Port: The standard port for FTP is 21, but you can change this to match your server configuration.
Directory: The location where the output files will be written. This can be set up using static names or variables.
Username and Password: The username and password for accessing the FTP server. This account must have write access.
Download
The Download tab provides settings for the files that will be created when the user clicks on the Download Output button on the Dashboard page.
Enabled: Download settings are always enabled for all customer accounts and templates and is not configurable.
File Naming: You have two options to name the email attachments files. Default uses the standard file naming convention as seen in the screen shot above. To create a different naming convention, select Custom. The custom naming can consist of text and/or variables associated with the submitted document. See list of supported variables at the bottom of this page.
Include: You can choose which types of files you would like to have available download from the naturalForms Server Portal.
- PDF: You can select an image file of the document that was submitted. This file will include thumbnails of all photos that were added to the document.
- Attachments: These files consist of both photos and audio recordings that were attached to the document.
- Data Files: Data in the forms can be delivered in XML, CSV, and/or JSON formats
- Encoding: The default encoding is set to utf-8, but can be customized to an alternate encoding standard.
All files that are included will be zipped into one zip file when downloaded.
After all output settings have been entered, select the Save button to save your changes.
List of Supported Variables
To include a variable in the output options it must be surrounded by two open curly brackets and two closed curly brackets. {{Section.Value}}
Section Value Data Output Example
output timestamp 2013-02-21T16:12:48.7060546Z
output timestampFileFormat 20130221161248706
submitter email demo1@expedata.net
submitter firstName John
submitter lastName Doe
device id 6B3GHY09E5WA5F345F123678321G3JJ2
device name John Doe’s iPad
device platformName iPad
customer name ABC Landscaping
customer number 10002
customer address 10 Main Street
customer address2 Suite B
customer city Miamisburg
customer state OH
customer postalCode 45342
customer country United States
template name Capability Tour v3
template id 970000040
document name Demo Capability Document
document number 100000
document isResubmit True
document createdDate 2013-02-21T16:06:33.047
document sourceCreatedDate 2013-02-21T11:03:35
document sourceModifiedDate 2013-02-21T11:09:35-05:00
document fields.xxxx
xxxx represents the field name as defined in the form template (i.e. {{document.fields.email}} - demo2@expedata.net)
attachment name Photo Attachment 1
attachment isAnnotated True
attachment width 500
attachment height 600
attachment extension Png
NOTE: If you are pulling an email address from the document to use as a recipient for an email, you will need to make this field mandatory and add a pattern match validation rule to ensure that the entry is a valid email address. Otherwise, the email delivery will fail if this field is left blank or an invalid email address is entered (i.e. "none").
You could use a company email address as the default for this field. That way, any document that is not sent directly to this user-entered email address can be handled as needed. For example: Customer does not have an email address. Default email is set up as processinvoice@company.com. The person monitoring this email address will know that the invoice will need to be sent through regular mail instead.
Comments