Live Forms Latest - This documentation is for Live Forms 9.0. Not for you? Earlier documentation is available too.

Skip to end of metadata
Go to start of metadata

Live Forms configuration properties are configured in the frevvo-config.properties file in the <frevvo-home>\tomcat\conf directory. The frevvo-config.properties is a standard java properties file. Any valid context parameter can be configured as a property in this file. This file contains properties that define global customizations that apply to the frevvo.war and the frevvo connector warfiles (Database Connector, Filesystem, SharePoint). For example, you can provide the client secret information for the Google Connector with a property in this file. 

The properties that can be added to the frevvo-config.properties file are discussed below. The configuration properties in the frevvo-config.properties file will override the properties configured in <frevvo-home>\tomcat\conf\server.xml file. Parameters, previously configured in the web.xml file included in the frevvo.war must be added to the frevvo-config.properties file as well.

frevvo only supports/certifies Live Forms running in the tomcat container. Refer to our Supported Platforms for the list of Application Servers supported/certified by frevvo.

Converting Context Parameters to Properties  

The configuration properties follow a simple property name=value syntax. Let's say you had context parameters to default the tenant login and customize the placeholder on the login screen in the frevvo.xml file of your previous installation.

 The context parameters in frevvo.xml would look like this:

frevvo.xml from your previous Live Forms installation

The configuration properties follow a simple property name=value syntax. Follow these steps to convert configuration parameters from previous releases to properties in the frevvo-config.properties file.

  1. Navigate to <frevvo-home>/tomcat/conf directory.
  2. Edit the frevvo-config.properties file.

  3. The Parameter name becomes the property name.
  4. Add an equal sign
  5. Add the value after the equal sign
  6. Repeat this for all custom parameters
  7. Save the file
frevvo-config.properties file in the v7.4.x installation

Here is an example of a frevvo-config.properties file that provides the client id and secret for the Box connector, the URL for the Filesystem connector, a property to turn on/off the Insight Server and a property to turn on DEBUG level logging for the frevvo.log and any frevvo connector logfiles.

Updating the frevvo-config.properties requires server re-start. You do not have to restart the Insight server.

frevvo tomcat bundle

In the frevvo tomcat bundle, the frevvo-config.properties file is located in the <frevvo-home>\tomcat\conf directory. The path to the frevvo-config.properties file is specified in the <frevvo-home>\tomcat\bin\sentenv.bat.sh files


On this page:

Changing the admin password

  • Login to your Live Forms server as user admin@d, password admin.
  • On the page that is displayed, click the Manage Tenants link.
  • Click the icon to manage tenant named d (Default tenant)
  • Click Manage Users
  • Click the  edit admin user icon for the admin user. This displays a profile form.
  • Change the password as desired and submit the form.

Email configuration

The forgot password functionality and form submissions sent via email both require proper configuration of Live Forms' smtp component.

  1. Edit <frevvo-home>\tomcat\conf\server.xml
  2. Configure the Mail Resource
  3. Save the file

Here is a sample mail/frevvoDS resource configuration:

server.xml

Additional Email Properties

The additional email properties found in the <frevvo-home>\tomcat\conf\frevvo-config.properties file are shown below. Edit this file and add the # to comment out the properties that you do not want. Properties configured in this file take precedence over the server.xml settings.

  • frevvo.mail.from.email - Although this property can be used to set up a from email address, it is recommended that you use the frevvo UI to set up the from email and display name
  • frevvo.mail.bounce.email - Sets an address to receive emails that cannot be delivered to the to email recipients
  • frevvo.mail.debug - Turning on this property sends more debugging info to the tomcat log files
  • frevvo.actions.debug - This property controls whether or not additional info log messages are included when form actions, DOC URIs and doc actions are performed.

  • frevvo.rule.debug - Turning on this property sends more debugging info about rules to the tomcat log files

frevvo-config.properties

Email log entries

If you are using tomcat, emails sent are tracked in the <frevvo-home>\tomcat\logs\frevvo.log file when the INFO log level is enabled. Look for an entry like "Sending email to <email address> with subject <the subject of your email>. If an error occurs when sending, the message "Could not send email to <email address> with subject <the subject of your email> including the actual exception that caused the problem will be logged.

Email over SSL

If the SMTP server requires traffic to be sent over SSL, add the following properties in the mail resource configuration, and then specify values for them:

frevvo-config.properties

Default the Tenant Login

Live Forms is a multi-tenant application. See the administration section on Manage Tenants. However, it is possible that all you need is a single tenant. If this is your case, it simplifies the Live Forms server login if you default the @<tenantname> so the user only needs to enter their username to login. Customers who default the tenant login normally would also customize the placeholder on the login screen. Please read that topic for details.

  1. Stop Live Forms if it is running.
  2. Navigate to the <frevvo-home>\tomcat\conf directory
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.default.login.tenant.id property to the <frevvo-home>\tomcat\conf\frevvo-config.properties file and set the param-value to the name of your one tenant.

    frevvo-config.properties
  5. Save the file
  6. Restart Live Forms.

In-house customers, logging in as the Live Forms' server superuser admin, must still login with username admin@d.

Customizing the placeholder on the login screen

You may want to customize the user@tenant placeholder on the login screen to reflect the name of your Live Forms tenant to minimize confusion for your users or to remove the @tenant from the placeholder if you have defaulted the tenant login. 


In-house customers can change the default placeholder on the login screen by modifying the values for the frevvo.login.username.placeholder property.

Follow these steps to change the placeholder:

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the property shown below with your modified value then save the file.

    frevvo-config.properties
  5. Restart Live Forms.

Turn on the Unsaved Changes Warning

You may want to to turn on the browser specific warning that displays if your users close their browser/tab before saving or submitting a formflow. A description of the feature can be found here. Here is an example for the Chrome browser:

Add the frevvo.unsaved.warning property to the <frevvo-home>\tomcat\conf\frevvo-config.properties file in the tomcat bundle.The default value is false.

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the the frevvo.unsaved.warning property with a value of true then save the file.

  5. Restart Live Forms

Configure the Insight Server

Configuration properties for the Insight Server are located in the <frevvo-home>\tomcat\conf\frevvo-config.properties file.

The properties in the frevvo-config.properties file are:

frevvo-config.properties
  • The "Insight.enabled" property with a value of true enables Insight Server by default.

    The Insight Server MUST be enabled for submissions, the Task List and Report features to work. Do NOT disable it if you are using any of these features.

  • The "Insight.server-url" property points to the location of the Insight Server. The Insignt Server is included in the tomcat bundIe. In the unlikely scenario where the Insight Server (Solr) is in a different location than Live Forms, the <server:<port>> in this property can be changed to point to the location of the Insight Server (Solr) software.

Refresh Searchable Fields Configuration Parameters

If you are using the frevvo tomcat bundle, the Refresh Searchable Fields process is already configured. The insight.war web app is located in the <frevvo-home>\tomcat\webapps\frevvo.war.  Insight.war is a web app that contains a batch process that extracts all the latest submissions from Live Forms and creates Solr Documents for them. The indexed submission data from the batch is stored in <frevvo-home>\data\solr directory and is used by the Live Forms Reports feature. The batch job is automatically run when you upgrade Live Forms but it can also be run manually if necessary.

If it is determined that the Refresh Searchable Fields process needs to be run for the entire tenant

There are some properties that can be added to the frevvo-config.properties file to override default values. Although, it is recommended to leave these properties with the default values, these properties can be added with different values if requested by frevvo support to troubleshoot an issue.

Submission View configuration

Configuration properties that affect the Live Forms Submission view are discussed below.You can turn off the Legacy Submissions view, hide the Delete submission button and the Edit Submissions link and configure the maximum number of Searchable fields allowed per form/flow.

Follow these steps:

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the properties with your modified values then save the file.

  5. Restart Live Forms

Turn Off the Legacy Submission View

Add this property with a value of false to the <frevvo-home>\tomcat\conf\frevvo-config.properties file to turn off the Legacy Submission view in the designers and when users access submissions using Shared Items. If the Legacy view is disabled, the Saved Fields tab in the Setup Searchable fields wizard is hidden in the designers and the Export of submissions to Excel feature is no longer available. The default value is false.

frevvo-config.properties

Forms Home Page when the Legacy Submissions View is turned off.

If the Legacy view is disabled, the Saved Fields tab in the Setup Searchable fields wizard is hidden in the designers.

Set a Maximum Number for Searchable Fields

Add this property with the value of the maximum number of searchable fields you want to allow per form or flow to the <frevvo-home>\tomcat\conf\frevvo-config.properties file. The default value is 20.

frevvo-config.properties

Designers see a message when an attempt is made to add a searchable field that would exceed this max number.

The message appears on the lower right of the screen and disappears after a short time. Any fields in excess of the max configured will not be allowed.

Show/Hide the Delete Submissions Button

Add this property with a value of false to the <frevvo-home>\tomcat\conf\frevvo-config.properties file to hide the Delete button on the Submission Table. If configured, the Delete button in the Legacy Submission view is also hidden. The default value is true.

frevvo-config.properties

Add this property with a value of false to the <frevvo-home>\tomcat\conf\frevvo-config.properties file to disable the Submission Edit link in the on the submission details popup everywhere it is displayed. If configured, the link is disabled for the Legacy Submission view as well. The default value is true.

frevvo-config.properties

Administration of reCAPTCHA Keys

Live Forms provides a default reCAPTCHA key. No other configuration steps are required for on-premise customers that choose to use the default key. This default reCAPTCHA key is:

  • NOT configured to a particular host/domain server
  • NOT configured for Google to perform any host/domain name checking on the challenge step. However, Live Forms will perform a host/domain verification on the verification step so that any attempts at site key spoofing are blocked.
  • Considered secure.

In-house customers who want the maximum possible protection from form spamming, will need to create their own reCAPTCHA key and configure to their domain (example.com).

Follow these steps:

  1. You will need a google account.
  2. Follow the instructions on this Google site to register your domain and create the site and secret keys.
    1. You can also choose "Domain Name Validation" on this key to have Google check the domain on the challenge step.
  3. Copy the site and secret keys from the Registration page for your site
  4. Add the frevvo.reCAPTCHA.sitekey and the frevvo.reCAPTCHA.secretkey properties to the <frevvo-home>\tomcat\conf\frevvo-config.properties file.

The frevvo.recaptcha.hostcheck property controls the domain/host verification on the verification step that is done by Live Forms. The values for this property can be set to true or false. If you use a custom key with Domain Name Validation configured, add this property to the frevvo-config.properties file with a value of false. Otherwise, add it to frevvo-config.properties with a value of true.

Proxy Server configuration

If your company uses a proxy server for internet traffic please see proxy configuration. This is often the cause of the following error message:

  • Unable to contact license server
  • Unable to renew license. Your license will expire in <n> day(s)

External URLs

Sometimes running Live Forms behind a proxy server can cause unintended changes to the form server's external URLs. The following configuration properties address this issue. Add these properties to the <frevvo-home>\tomcat\conf\frevvo-config.properties file.

  • frevvo.forms.server.external.url - If set, all share dialogs for forms and flows will use this as the external URL. Use the syntax shown in the example. change the <myexternalhost>and <port> to your external server name and the port that you are using for Live Forms on this server. 

    frevvo-config.properties
  • frevvo.internal.baseurl - If set, all URLs used internally by the form server will use this base url. This may be needed when using frevvo.forms.server.external.url if that external url is not also accessible from the form server machine. Use the syntax shown in the example. change the value "http://localhost:8082"  to the server name and port of your Live Forms server.

    frevvo-config.properties

Default Port

By default the Live Forms tomcat bundle is configured to bind to port 8082. You can change the port by:

  1. Editing the  <frevvo-home>/tomcat/conf/server.xml file.
  2. Search for this line in the file:
    <Connector port="8082" protocol="org.apache.coyote.http11.Http11NioProtocol"
  3. Change the Connector port

Browser Support

Live Forms does not support BETA versions of browsers and there is often a delay so that we can test newly released browser versions before they are supported. In previous releases, Live Forms was configured to use a list of supported browsers. An error message and a link to override the error would display if the system was accessed using an unsupported browser. If you want to warn users if they access Live Forms using an uncertified browser, configure a list of allowed browsers using the the frevvo.supported.browsers parameter in the <frevvo-home>\tomcat\conf\frevvo-config.properties file

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the properties with your modified values then save the file.

  5. Restart Live Forms

Add the user agent for the browsers you want to support '''in lower case only'''. For example, to allow all versions of Firefox, add the string 'firefox' (without the quotes) to the property value. It will match all versions of the Firefox browser. Internet Explorer 11 requires the use of the agent identifier, trident/7.  Separate the values with a comma.

frevvo-config.properties

Tomcat Manager

The tomcat manager is accessible in the bundle at  http://<server-name>:8082/manager/html. The default Tomcat Manager user name/password are preset to frevvo/frevvo. If you wish to change the password, you may do so by editing the file <frevvo-home>\tomcat\conf\tomcat-users.xml.

Tomcat SSL

Live Forms can be configured to handle HTTPS connections from users. The Live Forms tomcat bundle you downloaded from www.frevvo.com is pre-configured with a self-signed certificate for development and testing. This self-signed certificate enables Live Forms to handle HTTPS connections out of the box. However before deploying your forms to production you may want to replace this with your own certificate.

The HTTPS connector on port 8443 is enabled by default. If you want to disable it, edit the <frevvo-home>/tomcat/conf/server.xml and comment out the HTTPS connector:

Additional info on how to use SSL on tomcat can be found on the Apache/Tomcat website. Also refer to this article: How to solve javax.net ssl. SSLHandshakeException?

Currently you must not disable Live Forms's http port. In a future release this will be allowed. Disabling Live Forms' http port will cause your form server to malfunction as Live Forms requires this port. For most cases it is sufficient to share the https version of your form/flow's Url and leave http open. However, if you want to force all form usage to be over https and feel it is not enough to simply share the https form Urls (as a user can switch to http as long as that port is open), we recommend that you deploy Live Forms behind an Apache or IIS server. Close the http port on Apache or IIS but leave tomcat's http port open so that Live Forms can POST back to itself when needed over http but no one outside can access it.

Tomcat Logfiles

By default, the Live Forms server writes useful logging information to a daily logging file located here: <frevvo-home>/tomcat/logs. You will see the logfiles listed below in <frevvo-home>/tomcat/logs. The current date appends to the logfile names.

  • catalina.YYYY-MM-DD.log  - this log captures the stderr and stdout of the tomcat process including startup/shutdown messages. This is usually a small file.
  • frevvo_YYYY-MM-DD.log - all Live Forms messages are logged to this file. A new log with the current date appended to it is created daily.
  • localhost.YYYY.MM.DD.log - this tomcat logfile should be empty.
  • localhost_access_log.YYYY - MM - DD.txt - is used to log all HTTP accesses to Tomcat. It is enabled by the following entry in <frevvo-home>/tomcat/conf/server.xml. Comment out the statement below to turn off logging to this file if it is not needed.

  • host-manager.MM-DD-YYYY.log - this logfile is part of the tomcat distribution and is empty by default. It is a log file for the host-manager web application that is used to manage virtual hosts in tomcat. The host manager web-app is typically not needed because Live Forms is preconfigured. Messages are written to this log only if the host-manager web application is being used.
  • manager.MM-DD.YYYY.log - this logfile is part of the tomcat distribution and is empty by default - this is the log file for the tomcat manager web application which is used to check the status of web apps, memory usage etc. Messages are written to this log only if the manager web app is being used.

The Database, Google, Filesystem, and SharePoint connectors will generate their own logs in the <frevvo-home>/tomcat/logs directory when configured. The connector logs capture entries for the respective connectors making troubleshooting issues easier.

  • database.connector.YYYY-MM-DD.log
  • google-connector.YYYY-MM-DD.log
  • file-connector.YYYY-MM-DD.log
  • sharepoint-connector.YYYY-MM-DD.log

  • There will be three additional logfiles when running Tomcat as a Windows service:
    • frevvoforms - stderr.YYYYMMDD and frevvoforms - stdout.YYYYMMDD for standard error messages and standard output stream, respectively. This is the default Tomcat behavior.
    • commons-daemon.YYYY-MM-DD.log for Windows Service errors
  • The Insight server no longer creates a log since the insight.war is integrated into frevvo.war. The messages formerly in the insight logs are now found in the in the <frevvo-home>/tomcat/frevvo_YYYY-MM-DD.log

Refer to the topics below for information about turning on DEBUG level logging.

Loglevels

Loglevels are : TRACE, DEBUG, INFO, WARN, ERROR, OFF, ALL.  They are case sensitive so be sure to type them in upper case.  The logging level is cumulative as shown below. Refer to this stackoverflow website for a description of the loglevels and some guidelines for using them.

  • OFF = turns all logging off
  • ERROR = ERROR 
  • WARN = WARN + ERROR,  
  • INFO = INFO + WARN + ERROR,
  • DEBUG = DEBUG + INFO + WARN + ERROR,  
  • TRACE = DEBUG + INFO + WARN +  ERROR
  • ALL= turns all logging on

Configuring the logging level for catalina.log, localhost.log, host-manager.log, manager.log and local_access.log is done in <frevvo-home>/tomcat/conf/logging.properties

Log Messages in the Live Forms log

frevvo Cloud log messages show session information and the names of the Log Message properties include an _ (underscore). 

Session Information

Messages in the frevvo Cloud log the tenant.idsubject.idcorrelation.idsession.idowner.idapplication.id, and type.id (formtype or flowtype) for all log messages.

This additional information can be extremely helpful when troubleshooting errors particularly in the frevvo cloud environment. The example shows an INFO message that specifies the tenant, mycompany and the userid, max associated with the entry:

Log Message Property Names

Log Message property names that include a . (period) make it difficult to filter these messages using cloud watch filters. Properties have been renamed to include the _ (underscore) instead of the . (period) i.e. tenant.id = tenant_id.

Debugging log file levels

If you want to delete the logs, stop Live Forms then delete the logfiles. They will be recreated on start up.   

Changing the logging level for Live Forms log files

Add the three properties shown below with a value of DEBUG to the <frevvo-home>\tomcat\conf\frevvo-config.properties file to change the loglevel to DEBUG.

  1. Create/Edit the frevvo-config.properties file in <frevvo-home>\tomcat\conf
  2. Add the properties shown below to the file. 
  3. Save the file
  4. Restart Live Forms.

frevvo-config.properties - These properties will turn on DEBUG level logging for the frevvo.log and all connector logfiles.
This property turns on WARN level logging.

Turn on DEBUG for the Database Connector log

It is possible to turn on DEBUG level logging only for the Database Connector. Refer to the Database Connector Logfiles topic for the details.

Viewing the number of logged in users

Tenant, superuser or additional admin(s) can manage user session via the Live Forms UI. Refer to the Manage Logged in User Sessions topic for the details.

JMX Monitoring Enabled

JMX (Java Management Extensions) is enabled by default in the tomcat bundle.The following JMX options were added to the <frevvo-home>\tomcat\bin\setenv.bat,sh files. The <server>:<port> values default to localhost:9010.

Information can be accessed with jConsole, or a similar tool.

Session Timeout

Live Forms's default web browser session timeout is 30 minutes. If a user is logged into the Live Forms server to design forms, or to view their task list, or is using a Live Forms form and filling in values but has not yet submitted the form, the session will expire after 30 minutes of inactivity. When the session expires the designer will have to re-login to Live Forms to continue designing forms and form users will have to get a new instance of the form and re-enter the values.

If the maximum number of concurrent users are logged in simultaneously, and any of them are idle for more than 30 minutes, the next person who tries to log in will be able to do so successfully.

The default Live Forms server session timeout can be overridden for each tenant. The tenant admin can edit the tenant and make the changes there.

When a person is using a form/flow then pauses for longer than the configured <session-timeout>, they will see the Live Forms login screen.

When a person is using a form/flow and then pauses for longer than the configured <session-timeout>, they will see the following error the next time they enter a value into the form or try to submit a form from a timed out session.

Live Forms as a windows service

You will have to edit frevvo/tomcat/bin/service.bat line 123 to increase the Java Heap and Permgen spaces. Here is an example of the line you need to edit in that file:

See the documentation on Tomcat Windows Service for more details.

TIFF Image Generator

All Live Forms connector wizards allow you to select the form image attached to submission to be in TIFF image format. If the TIFF option doesn't appear in the wizard's Send Snapshot dropdown, follow these steps to install the necessary files:

  1. Stop Live Forms
  2. Download the jai-imageio-core-1.3.1.jar here.
  3. Add it to frevvo classpath i.e. tomcat/lib folder
  4. Deploy pve.war (PVE Connector) in tomcat/webapps folder. Download the latest version of the PVE Connector from our frevvo Software Downloads Directory.
  5. Restart the Live Forms server. You will now see the TIFF option in the connector wizards Send Snapshot dropdown. The image shows the TIFF format option for the PaperVision or ImageSilo Connector wizard.

Signature Date/Time

Digital Signatures require no configuration. However you can control the format of the date stamp that appears when forms are signed.

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.signature.date.format property with your modified value then save the file.

  5. Restart Live Forms

This property will change the date format for text signatures to day,month, year

frevvo-config.properties

Timezones

Live Forms concanocolizes all form submission data to UTC. In other words no matter which timezone you are in when you submit a form with a date, date/time, or time control, the form server will convert and store those values in UTC. If your form submission data is not correctly converted and stored in UTC then you likely have to update the timezones in your installed JDK. Oracle provides a timezone update tool. Run the TZUpdater tool with the following command: java -jar tzupdate.jar -u

See Oracle's Timezone Updater Tool for full details. 

Batch User Uploads

Uploading a CSV file to add or edit users normally runs quickly. However, if uploading a file in which the notifyIfNewUser property is TRUE for a large number of rows, this process may slow down on some email servers. Tenant Admins can configure Live Forms to run CSV-file user uploads in batches to improve upload time if needed. To adjust batch load size, configure the following property in <frevvo-home>\tomcat\conf\frevvo-config.properties. 

Using Live Forms with reverse-proxies/SSL-accelerators

If your goal is to use Live Forms  behind a reverse-proxy/load-balancer/SSL-accelerator you need to modify configuration settings to Live Forms/tomcat to make sure Live Forms generate correct external urls.

When using a reverse-proxy, the external host, IP and/or port visible to browsers may be different than the host, IP and/or port seen by Tomcat. This causes a problem since Live Forms will generate urls in pages and forms that are either completely invalid, which is an easy case to spot since forms will not render at all, or valid by bypassing the reverse-proxy altogether, which are harder to identify except for side effects such as forms not resizing properly, or blocked by browser security restrictions.

Live Forms no longer supports the web.xml parameters for frevvo.xforwarded.protocol.header, frevvo.xforwarded.host.header, and frevvo.xforwarded.port.headers. The general recommendation is to rely on the Servlet Container for handling dynamic proxies. A better approach is to use tomcat's RemoteIp Valve instead.  Please see this documentation on the Apache Tomcat website for information about the RemoteIp valve functionality. This tomcat valve has been incorporated into our Live Forms tomcat bundle.

Moving users to a different tenant

This section describes how to move a user to a different tenant. In the steps below, we will move the user john from a source tenant (will use tenant d) to a target tenant (will use mytenant as the target name).

  1. If the target tenant does not exist, create it by following these steps. For the sake of this document, the target tenant id is mytenant
  2. Login to the target tenant as an admin and create a user with the same id as the user in the original tenant. In this example, the user id is john in the tenant mytenant.
  3. Transfer the applications to the new user account in the target tenant
    1. Login to the source tenant as a tenant admin, for instance admin@d
    2. Navigate to Manage > Manage Users.
    3. Login as the user you want to move. 
    4. Navigate to the user's applications page. 
    5. Download each application for that user and save to a folder in your file system. 
    6. Logout
    7. Login as the user in the new tenant: john@mytenannt.
    8. Upload the applications you've downloaded in the previous steps. 
  4. Move the submissions in the submissions repository. You need to run these steps in the database where you persist the Live Forms submissions. Please back up your database before moving forward
    1. Login to your database.
    2. Edit the script shown below to:
      1. Replace the word john with the id of the user you are migrating.
      2. Replace the tenant id d with the id of the source tenant. The default tenant in Live Forms is called d.
      3. Replace the word mytenant with the name of your target tenant 
    3. Run the script shown below in your Live Forms submissions database.

Verification:

  1. Login as the user in the new tenant.
  2. Verify that the submissions are properly being loaded for all forms. In the submissions repository page make sure to adjust the initial and end dates to a window of time that you know have submissions for that specific form.
  3. Update references to the forms. After going trough the steps above, the URL to the forms owned by the user will be different than what they were originally. You need to update all references to the forms in published links and pages where the form should be embedded.

Show/Hide Share Dialog Options

You can customize the options that appear in the Share dialog by adding the frevvo.share.options property with the options that you want to show. Remove any option after the equal sign to hide it from the share dialog.

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.share.options property with your modified values separated by commas then save the file.

  5. Restart Live Forms
frevvo-config.properties

Hide the "forgot password" button on the login screen

Live Forms in-house customers that wish to hide the "forgot password" field on the login screen can do so by adding the frevvo.login.forgot.password.enabled property to the frevvo-config.properties file with a value of false. This is only relevant to tenants using the Live Forms Default Security manager and could be helpful if you are using LDAP without SSO. To hide the field:

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.login.forgot.password.enabled property with a value of false then save the file.

  5. Restart Live Forms

frevvo-config.properties

Moving Data Sources to the Top of the Designer

You can make the Data Sources panel in the Designer appear at the top of the left properties pane by adding the frevvo.data.sources.top property to the frevvo-config.properties file with a value of true.

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.data.sources .top property with a value of true then save the file.

  5. Restart Live Forms

frevvo-config.properties

Show/Hide the "New from XSD" Button 

You can show/hide the "New from XSD" button form designer Data Sources tab via the frevvo.data.sources.add propery. The default is true. Set it to false to hide "New from XSD" button.

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.data.sources.add property with a value of false then save the file.

  5. Restart Live Forms

frevvo-config.properties

Configure Palette Controls in the designer

The frevvo.palette.controls property allows you to configure the palette to display only the controls that you need or change the position of the controls in the palette.  The Strings must match the control name exactly but they can be in any order. Remove the name of any controls that you don't want. In all cases, half of the configured amount of controls will display on the left side of the palette and the remaining controls on the right, based on the order in which they are listed in the property.

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.palette.controls property with the Control Names after the equal sign, separated by commas then save the file.

  5. Restart Live Forms

Here is an example of the property configured to show all the Palette controls.

frevvo-config.properties

Here is an example showing a designer palette configured with only ten controls; 

frevvo-config.properties

This image shows the Data Sources section moved to the top, the "New from XSD" button hidden and the palette configured for only nine controls.

Modifying Content Types for the Upload Control

The content types supported by Live Forms are configured with the frevvo.upload.file.types properties. The default file types are shown below. On-premise customers can override the defaults by adding properties to the frevvo-config.properties file

Default Values

To modify, add the frevvo.upload.file.types property with the allowed file types after the equal sign

frevvo-config.properties

Follow these steps:

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.upload.file.types with the allowed mime types after the equal sign, separated by commas then save the file.

  5. Restart Live Forms

The Upload control provides a list of file type/extensions the designer can use to restrict the type of files uploaded. To add a new file type to this list, add it to the frevvo.upload.file.types values. In addition, there are properties for each supported mime type that corresponds to each context type. For example, the property that has the mime types corresponding to MS Word is: frevvo.upload.file.type.ms_word.mimes. Note the naming convention for the Mime type names part of the property - lower case and spaces replaced with _

frevvo-config.properties

Let's say you wanted to restrict the uploaded files to SWF files only. To add the SWF (Small Web Format Adobe Flash files) extension to the Restricted Content Types list in the designer, add the frevvo.upload.file.types property with swf specified in the content types then add the frevvo.upload.file.type.swf.mimes property with the correct mime type in the frevvo-config.properties file.

frevvo-config.properties

This will add the swf extension to the Restricted Content Types list in the designer.

An easier and preferable alternative, is to type the additional mime type into the Other Mime/Ex field on the Upload control property pane. Refer to Upload control for more information.   

Rule Validation Timeout 

Rule validation is executed in a thread pool with a timeout. You can change the rule validation timeout value by adding the with the frevvo.rule.validation.timeout property to the frevvo-config.properties file. The default value is 2000 milliseconds.

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.rule.validation.timeout property with the timeout value in milliseconds after the equal sign then save the file

  5. Restart Live Forms
frevvo-config.properties

If validation javascript execution exceeds this timeout value, the Rule Validator will show : 

The Rule evaluation timeout property is frevvo.rule.timeout with a default value of 30000 milliseconds. This is the amount of time Live Forms will attempt to run the rule before you see a timeout error in the debug console. Adding this property to the frevvo-config.properties file with a value of 2000 ms will show this error in the Rule debug console - ** Rule execution timed out after (timeout=20000 milliseconds)

Show/Hide PageBreaks

The show/hide pagebreaks icon   on the Form Designer toolbar is a toggle to make PageBreak controls in your form on visible/invisible. When you create or edit a form, PageBreak controls will be visible. When you drag a PageBreak control from the palette onto the canvas it will be visible in the designer. If you save the formr/flow then edit it the PageBreak controls remain visible.  If you want to change the default behavior, i.e. make them invisible by default, add the frevvo.designer.showPageBreaks property to the frevvo-config.properties file. This property defaults to true. Setting it to false will hide the PageBreak control by default in the designer. Clicking the icon will make them visible.

Follow these steps:

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.designer.showPageBreaks property with a value of false after the equal sign then save the file

  5. Restart Live Forms

frevvo-config.properties

Save on Navigation

The Save on Navigation feature saves the latest step in a workflow to the user's task list if they accidentally close the browser when filling in a long form. When this feature is turned on, you will see an entry in the Audit Trail each time the flow navigates to a different step. It will also save the last saved step in a screenflow to the Task List.  This feature can be selected for individual flows or for all flows by adding the frevvo.flows.save.on.navigation property to the frevvo-config.properties file.

  To select this feature for individual flows, check the Save on Navigate property on the Flows Property panel for each one. 

 To configure the Save to Navigation feature for all workflows,  follow these steps:

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf\
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.flows.save.on.navigation property. A true value turns on the Save to Navigation feature for all workflows while a false value turns it off. False is the default.
  5. Save the file after all your changes are made.
  6. Restart Live Forms.
frevvo-config.properties

Disable Form Save in PDF Mapping

The prompt and save of the form prior to additional pdf mapping can be controlled by the frevvo.form.save.on.mapping property. The property defaults to true. If set to false, the designer will not be prompted to save the existing pdf form before continuing pdf mapping and the editing instance will not be saved. This parameter applies only to forms, not flows.

Follow the steps to hide this message:

  1.  Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf\
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.form.save.on.mapping property. A false value does not prompt and save form before beginning/continuing PDF mapping. True is the default.
  5. Save the file after all your changes are made.
  6. Restart Live Forms.

frevvo-config.properties

XSS Cleaning

Live Forms uses a whitelist approach to filter out XSS attacks. Only whitelisted tags will work if you are using HTML in labels, help, hint, etc. Although the whitelist allows a full range of text and structural body HTML, it will restrict you from using some tags like the HTML comment. 

You can optionally turn off XSS (cross site scripting) cleaning for Live Forms by adding one or both of the below properties to frevvo-config.properties. Note: both properties default to true.

  • frevvo.xss.clean=false - this parameter turns XSS cleaning off product wide
  • frevvo.xss.clean.labels=false - this parameter turns XSS cleaning off for control labels only

Customers should carefully consider the ramifications of removing the XSS scrubbing. Harmful markup can potentially be used for XSS attacks.

Follow these steps:  

  • Stop Live Forms
  • Add one or both of the parameters shown below to, <frevvo-home>\tomcat\conf\frevvo-config.properties
  • Save the file
  • Restart Live Forms

frevvo-config.properties

Max Size for Attachments

There are three places to set the maximum size of attachments that can be uploaded to the Upload control in Live Forms.

  • You can set an upper bound limit server wide by adding the frevvo.attachment.maxsize property to the frevvo-config.properties file. If you do not add this property, then the max size for attachments will be 10 MB. This is the built-in default.
  • The tenant admin can set the maximum file size per user by editing their profile
  • Specify the max file size per the Max Size property of individual Upload Controls

The value of the Max size property of individual Upload controls overrides the value per user which overrides the frevvo.attachment.maxsize property in the frevvo-config.properties file. All values must be specified in bytes and cannot exceed the max attachment size configured on the server level.

To configure the max size for attachments on the server level, follow these steps:

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo.attachment.maxsize property with the max size for attachments in bytes as the value then save the file.
  5. Restart Live Forms.

frevvo-config.properties

  When users try to upload a file that exceeds the configured attachment size, this error displays:

If you are using MySQL, and you upload a large image or you are using a workflow that contains a large pdf, Live Forms, you may see this error:

The default value of the max_allowed_packet parameter in your MySQL server may not be large enough. Refer to this website for detailed information about the MySql configuration parameter. Increasing the max_allowed_packet variable setting in your MySQL Server from the default (1M) to something like 16M (16777125) fixes the issue. To fix the issue temporarily, run the following commands:

  • mysql -u root

  • set global max_allowed_packet=16777216

To permanently set it, choose one of the two methods listed below:

  • You can add the parameter  - max_allowed_packet=16M to the mysqld command line or (mysqld_safe command line) as shown: 

 mysqld --max_allowed_packet=16M 

  • Edit the MySql configuration file (my.ini on Windows/ my.cnf on Mac OS) and add max_allowed_packet=16777216 to the [mysqld] section. 

  • Restart MySQL.
  • Restart frevvo. 
  • The setting will permanently take effect.

On Mac OS, you can access the my.cnf file by typing

  • sudo vi /etc/my.cnf

 The location of the my.ini/my.cnf file varies by configuration.

Send Signatures to ImageSilo

The pve connector by default does not send wet signature images to ImageSilo. This can be overridden by adding the frevvo.send.signature.image with a value of true in to the frevvo-config.properties file.

Follow these steps:

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf\
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the  frevvo.send.signature.image property with a value of true to override the default.
  5. Save the file after all your changes are made.
  6. Restart Live Forms.

Refer to the PaperVision or ImageSilo Connector topic for connector installation instructions.

Customize the Default Reject Email

In-house customers can change the default text for the rejection email subject and body by adding the frevvo.task.reject.notification.email subject and frevvo.task.reject.notification.email.message properties with modifed values to the frevvo-config.properties file.

Follow these steps

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the parameter(s) shown below with your modified values, The default subject and message are shown below

  5. Save the file after all your changes are made.
  6. Restart Live Forms.

Skew error when logging into an Azure SAML tenant

Users logging into a Live Forms Azure SAML tenant may encounter the error "Access Denied.  Authorization Required". Examination of the frevvo.log shows the following entry:

This error is typically caused by a clock synchronization issue between the Service Provider (frevvo) and the Identity Provider (Azure) or a genuine delay in the connection. If you get this error, adding the com.frevvo.security.saml.response.skew property can be used to specify the time in seconds allowed between the Live Forms request and the response from Azure to a value greater than the default value of 60 seocnds.

Follow these steps:

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the parameter shown below with a value greater than the default value of 60 seconds. The example shown increases the timer to 120 seconds.


  5. Save the file.

  6. Restart Live Forms.
  7. Retry the login.

Configure the max size for Images in your form/flow

In-house customers can change the maximum size for images uploaded to forms/flows using the Image control in the Live Forms designers by adding the frevvo.asset.maxsize property to the frevvo-config.properties file. The default value is set to 2097152 bytes. Any uploaded file that exceeds the value in this parameter displays an error message to the designer so they can take corrective action.

The error message will not display for video files that exceed the specified limit.

Follow these steps:

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo-asset-maxsize property. Change the value to the maximum allowable image size in bytes.

  5. Save the file.

  6.  Restart Live Forms.  

Changing the Default Task Notification Email Message

If you want to change the default subject and body of the task notification email for your Live Forms server, add these properties to the frevvo-config.properties file.

Change the value in this parameter to anything you want. The task.perform.url template {task.perform.url} is a built-in template in Live Forms and it will always point to the specific task. Refer to the Task Notification Email Link topic for some other options. If you wrap the templates in an HTML <a> tag, it will generate a clickable link in the email.

If you do not want the link in your task notification emails to go there, you can remove it. The default message can include form control templates. 

Security Vulnerabilities

The following security vulnerablities have been addressed as follows:

  • Information Disclosure - resolved with the tomcat upgrade to version 8.5.16
  • Man in the middle - This has to do with executing the CGI Servlet. This servlet is disabled in the frevvo Apache tomcat distribution. Customers who choose to enable the servlet are responsible for ensuring security viz. adding filter etc.
  • Version Disclosures - Resolved by configuring the ErrorReportValve in \frevvo\tomcat\conf\server.xml file (in the Host section) as described in this Apache tomcat website. The parameter that needs to be modified is:

  • X-Frame-Options Header Not Set - Resolved by modification at the tomcat level. In-house customers can uncomment the HttpHeaderSecurityFilter provided in the tomcat web.xml. The filter is documented Apache tomcat website. Specify the appropriate X-Frame-Options value in the antiClickJackingOption parameter - (SAMEORIGIN or ALLOW-FROM). 
    Setting this parameter to SAMEORIGIN may interfere when embedding frevvo forms/flows in your website. Use  ALLOW-FROM instead.

    Click the appropriate link below for filter examples.

    Example of filter with SAMEORIGIN  Expand source
    Example of filter with ALLOW-FROM for embedded forms  Expand source

  • Admin user name exposure in URLs - Resolved by the Live Forms feature to not expose the user id in URLs.

Geo Location

On-premise installations planning on using the Live Forms Geolocation feature must obtain a Google Maps API key. This may involve registering with Google and then creating an application and then a key. Refer to this link for the google API pricing plans.

Follow these Steps to obtain the Google Maps API key:

  1. Go to this Google Maps API website
  2. Login with your google account
  3. Click on Get a Key button
  4. Select project, copy key value
  5. Create/edit the <frevvo-home>\ tomcat\conf\frevvo-config.properties file. Add the frevvo-google.maps.apikey property with your api key as the value

  6. Start the Insight server then Live Forms.

See the Geolocation topic for details about how to display the map in your form/flow and this Rule example if you want to show additional location information.

SSL Certificate Property

When a form's doc action is configured to post to an https endpoint, you can ignore ssl security using the frevvo.certificate.signature property. Services that accept https and do not have a security certificate setup might generate an error like this:

You can tell frevvo to ignore this error using the frevvo.certificate.signature property . This should work with services that have self-signed certificates that aren't installed in the jvm certificate file and with certificates from a security authority.

Follow these steps to add the frevvo.certificate.signature property to the <frevvo-home>\tomcat\conf\frevvo-config.properties file.

  1. Stop Live Forms if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf
  3. Open the frevvo-config.properties file with a text editor.
  4. Add the frevvo-certificate.signature property with a value of true.

  5. Save the file.

  6.  Restart Live Forms.  

 

 

 

 

 

  • No labels