...

Section

Column

configuration parameters are located in three places:

frevvo-config.properties - created by the System Administrator to override parameters in a container web.xml file. This is most often used when the container is not tomcat.
See below for details
Info
frevvo only supports/certifies running in the tomcat container. Refer to our Supported Platforms for the list of Application Servers supported/certified by frevvo.
<frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml - recommended file to override context-parameters in the web.xml file when using the tomcat container.
WEB-INF\web.xml - this configuration file is included in the <frevvo-home>\tomcat\webapps\frevvo.war zipfile. Modifications to this file require unzipping/rezipping the frevvo.war file after the modifications have been made. See below for the instructions.

The parameters that are most commonly modified and discussed in the sections below are in frevvo.xml. The less commonly modified parameters are in web.xml. Any parameter in web.xml can be duplicated in frevvo.xml and the value in frevvo.xml takes precedence over the value in web.xml. If you plan to override the web.xml context parameter values and you are using the frevvo Tomcat bundle, we suggest doing so in frevvo.xml. This keeps all your modified parameters in one place and makes it easy to upgrade frevvo to newer releases.

A frevvo-config.properties file in a deployment using tomcat seems redundant since it basically does the same thing as the frevvo.xml file. If it does exist , the configuration parameters in the frevvo-config.properties file will override the frevvo.xml and web.xml files.

Modifying the frevvo.xml file.

Follow these steps to add/modify context parameters in the frevvo.xml file. If you are using tomcat, making your configuration changes here, will make it easier when you upgrade :

Stop if it is running.
Navigate to <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml.
Open the file with a text editor.
The installation tasks listed below will reference the frevvo.xml and web.xml files when appropriate. You can configure anything in frevvo.xml that you can configure in web.xml. When you add parameters to the file, use the same syntax as the ones already there. Here is an example of a parameter to control the Maximum Size of Attachments that users can upload.

Code Block
<Parameter name="frevvo.attachment.maxsize" value="10485760" override="false"/>

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

Modifying the web.xml file

The web.xml file is included in the <frevvo-home>\tomcat\webapps\frevvo.war. The frevvo.war must be unzipped/rezipped after modifications have been made as outlined in the steps below:

Stop if it is running.
Unpack the frevvo.war file to a temporary location of your choice: e.g. c:\tmp\frevvo-war. Change the file extension from .war to .zip if necessary.
Edit c:\tmp\frevvo-war\WEB-INF\web.xml.
Make the desired configuration changes - see appropriate sections of this page for information on specific parameters. Save the changes to the web.xml file.
Rezip all the files in the c:\tmp\frevvo-war directory, even the ones you did not edit — if you change directories or zip them differently, Live Forms may not load correctly:
This is the correct structure for the frevvo.war zipfile.
Make sure you create the zipfile with the directory structure as shown in the image above. It is an easy mistake to include the containing directory in the zipfile. If you do this, Live Forms may not load correctly. Zip will often give your zipfile a .zip extension. Make sure you change this to a .war extension.
Copy the updated frevvo.war file to <frevvo-home>tomcat\webapps.
If you see the folder frevvo in the webbapps directory (<frevvo-home>tomcat\webapps\frevvo), you must delete it for the changes to take effect.
Restart your server.

Column

width	400px

On this page:

Table of Contents

maxLevel	1

...

You can configure your deployment in the frevvo-config.properties, frevvo.xml or web.xml files. Parameters in the frevvo-config.properties will override the frevvo.xml file which will override the web.xml file. Containers ,other than tomcat, may not have a mechanism like the frevvo.xml file where configuration changes can be made without having to manually expand files, change the web.xml and re-war it. Creating the frevvo-config.properties file and making the context-parameter changes there provide a simple way for the System Administrator to mange configuration issues. For example, system administrators might prefer to distribute only one frevvo-config.properties file rather than deal with many different ones for a deployment across across multiple nodes and clusters.

The frevvo-config.properties is a standard java properties file (see some examples here). All of the context-parameters currently found in web.xml or any valid context parameter can be configured in this file.

For example, say you are using the Weblogic Server and you need to set the frevvo.link.default.url to http://mycompany.com and move the Data Sources panel to the top of the designer.

Create the frevvo-config.properties file. Refer to frevvo-config.properties location for information about where the file should reside. The context-parameters follow a simple context-parameter=value syntax (shown below) in the frevvo-config.properties file:

Code Block
frevvo.link.default.url=http://frevvo.com/ frevvo.data.sources.top=true

...

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

...

There are 3 choices for the frevvo-config.properties file location. You can:

Expand the war, edit/create the /WEB-INF/frevvo-config.properties, re-zip the war. This is essentially the same as editing the web.xml directly.
Create the file in the current working directory of the container you are using. will pick it up by default. For example, <frevvo-home>/tomcat is the current working directory for the tomcat container.
Place the frevvo-config.properties somewhere in the file system (outside the frevvo.war) and then add -Dfrevvo.config=file:Drive:/path to frevvo-config.properties in the java executable call. For example, add it to <frevvo-home>\tomcat\bin\setenv.bat, setenv.sh or service.bat if you are using the tomcat container. Here is an example of the <frevvo-home>\tomcat\bin\setenv.bat file with the added parameter:

Code Block

set JAVA_OPTS=-Xms256m -Xmx1024m -XX:MaxPermSize=156m -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled -Dfile.encoding=UTF-8 -Djava.awt.headless=true -Dfrevvo.config=file:C:/frevvo/tomcat/frevvo-config.properties

The value of frevvo.config can be a full path (e.g. Drive:/pathtomyfrevvo-config.properties), a path in the war (e.g. /WEB-INF/myfrevvo-config.properties) or a url (e.g. http://config/cluster1/myfrevvo-config.properties). Be sure to include the frevvo-config.properties file name in the path statement.

Changing the admin password

Login to your server as user "admin", password "admin".
On the page that is displayed, click the "Manage Tenants" link.
Click the Image Removed icon to manage tenant named "d (Default tenant)"
Click "Manage Users"
Click the Image Removed 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 ' smtp component.

Edit <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml
Configure the Mail mail/frevvoDS Resource

Here is a sample mail/frevvoDS resource configuration for Apache Tomcat 6.x:

...

language	html/xml

...

file is specified in the <frevvo-home>\tomcat\bin\sentenv.bat.sh files

Code Block
set CATALINA_OPTS=%CATALINA_OPTS% -Dspring.config.location="file:///%CATALINA_HOME%/conf/,file:///%CATALINA_HOME%/conf/frevvo-config.properties"

Updating the frevvo-config.properties requires server re-start.

Changing the admin password

Login to your server as user "admin@d", password "admin".
On the page that is displayed, click the "Manage Tenants" link.
Click the Image Added icon to manage tenant named "d (Default tenant)"
Click "Manage Users"
Click the Image Added 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 ' smtp component.

Edit <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml
Configure the Mail mail/frevvoDS Resource

Here is a sample mail/frevvoDS resource configuration for Apache Tomcat 6.x:

Code Block

language	html/xml

<Resource 
            auth="Container"
            factory="org.apache.naming.factory.MailSessionFactory"
              auth="Container"
            factory="org.apache.naming.factory.MailSessionFactory"
            type="javax.mail.Session"
            name="mail/frevvoDS" 
            mail.smtp.host="{your.smtp.host}"
            mail.smtp.port="{your.smtp.port}"
            mail.smtp.auth="true"
            mail.smtp.starttls.enable="true"
            mail.smtp.user="{your.smtp.user}"
            mail.smtp.password="{your.smtp.password}"
            mail.debug="false"/>

...

If you enter an email address in the frevvo.xml parameter and leave the Email address fields on the Edit Tenant screen blank - Doc action emails will use the frevvo.xml from email value and task notification will use tenant admin's email address.
If you enter a value into the Email address fields on the Edit tenant page - Doc action and task notification emails will use this value. The value in the frevvo.xml file is overridden.

If you want to use the frevvo.xml value for Doc action emails, leave the tenant from email address blank. This would mean flow task notifications will use tenant admin's email address.

Debug sends more debugging info to the tomcat log files. And bounce.email sets an address to receive emails that cannot be delivered to the to email recipients.

...

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 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.

There are two files where the changes to default the tenant login to your tenant name can be made: web.xml or the frevvo.xml. The recommended approach is to add the configuration parameters to the frevvo.xm;l file as it keeps all your modified parameters in one place and makes it easy to upgrade to newer releases. Since the file is outside the frevvo war, you avoid the unzip/rezip of the of the frevvo.war that is needed if you make the changes in web.xml. Examples containing the context parameters for both files are shown below.To make the changes in . Since the file is outside the frevvo war, you avoid the unzip/rezip of the of the frevvo.war that is needed if you make the changes in web.xml. Examples containing the context parameters for both files are shown below.

To make the changes in <frevvo-home>\tomcat\webapps\frevvo\WEB-INF\web.xml file, follow these steps. At step4, uncomment the frevvo.default.login.tenent.id parameter and set the param-value to the name of your one tenant.

Here is how the parameter appears after editing for a tenant named ssotest:

Code Block
<context-param> <param-name>frevvo.default.login.tenant.id</param-name> <param-value>ssotest</param-value> <description>Default Tenant</description> </context-param>

Restart your server and the next time you login you will only need to enter your username and password.

These config parameters can also be configured in the <frevvo-home>\tomcat\webappsconf\frevvoCatalina\WEB-INF\web.xml file, follow these steps. At step4, uncomment the frevvo.default.login.tenent.id parameter and set the param-value to the name of your one tenant.

Here is how the parameter appears after editing for a tenant named ssotest:

Code Block
<context-param> <param-name>frevvo.default.login.tenant.id</param-name> <param-value>ssotest</param-value> <description>Default Tenant</description> </context-param>

Restart your server and the next time you login you will only need to enter your username and password.

These config parameters can also be configured in the localhost\frevvo.xml instead of web.xml. Add this parameter to the frevvo.xml file (recommended). Be sure to change the "your_tenant_id" to the name of your tenant

Code Block
<Parameter name="frevvo.default.login.tenant.id" value="your_tenant_id" override="false"/>

In-house customers, logging in as the ' 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 tenant to minimize confusion for your users or to remove the @tenant from the placeholder if you have defaulted the tenant login.Image Added

Image Added

In-house customers can change the default placeholder on the login screen by modifying the values for the frevvo.login.username.placeholder context parameter. These context parameters are found in the web.xml file located in the frevvo.war. If you prefer not to unzip the war file you can add them to the frevvo.xml file instead. Making the changes here makes it easier when you are upgrading your version.

Follow these steps to change the placeholder value in the frevvo.xml file:

Stop Live Forms if it is running.
Navigate to <frevvo-home>\tomcat\conf\

...

catalina\localhost\frevvo.xml

...

.
Open the file with a text editor.
Add the parameter(s) shown below with your modified values in between the double quotes to the frevvo war settings section then save the file.
Code Block
<Parameter name="frevvo

...

.login.

...

username.

...

placeholder" value="

...

user@mycompany" override="false"/>

...

In-house customers, logging in as the ' 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 tenant to minimize confusion for your users or to remove the @tenant from the placeholder if you have defaulted the tenant login.Image Removed

Image Removed

In-house customers can change the default placeholder on the login screen by modifying the values for the frevvo.login.username.placeholder context parameter. These context parameters are found in the web.xml file located in the frevvo.war. If you prefer not to unzip the war file you can add them to the frevvo.xml file instead. Making the changes here makes it easier when you are upgrading your version.

Follow these steps to change the placeholder value in the frevvo.xml file:

Stop Live Forms if it is running.
Navigate to <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml.
Open the file with a text editor.
Add the parameter(s) shown below with your modified values in between the double quotes to the frevvo war settings section then save the file.
Code Block
<Parameter name="frevvo.login.username.placeholder" value="user@mycompany" override="false"/>
Restart .

You can unzip the <frevvo-home>\tomcat\webapps\frevvo.war file and add the parameters to web.xml file instead of making the changes in the frevvo.xml file.

...

Restart .

You can unzip the <frevvo-home>\tomcat\webapps\frevvo.war file and add the parameters to web.xml file instead of making the changes in the frevvo.xml file.

Follow the steps listed above to unzip the <frevvo-home>\tomcat\webapps\frevvo.war.
Locate and uncomment the frevvo,login,username,placeholder context parameter in the file.
Edit it with desired placeholder at step 4.
Complete the remainder of the steps listed above.

Code Block

<context-param>
        <description>Value displayed as a place holder in the username control on login pages</description>
	    <param-name>frevvo.login.username.placeholder</param-name>
	    <param-value>user@frevvo.com</param-value>
</context-param>

Administration of reCAPTCHA Keys

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, 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 it to their domain (example.com).

Follow these steps:

You will need a google account.
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.
Copy the site and secret keys from the Registration page for your site

Add the frevvo.reCAPTCHA.sitekey and the frevvo.reCAPTCHA.secretkey parameters to the <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml file.

Code Block

<Parameter name="frevvo.recaptcha.sitekey" value="<your custom site key here>" override="false"/>
<Parameter name="frevvo.recaptcha.secretkey" value="<your custom secret key here>" override="false"/>
<Parameter name="frevvo.recaptcha.hostcheck" value="true or false" override="false"/>

Insight Data Batch Job Configuration Parameters

...

Note

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

...

Using Debug Mode to see logged in users

If the log level is set to DEBUG, then you will see user login and logout information in the <frevvo-home>\frevvo\tomcat\logs\frevvo.log file. Examples of log entries are shown below. Search for “Server num users” in the log file to quickly see the number of currently logged in/out users. Note the first log entry below shows the number of users currently logged in. Showing the list of currently logged in users via the UI to the superuser and tenant admins is planned for a future release.

User login:
10:01:40.813 |-DEBUG [http-nio-8082-exec-1] [       c.f.u.UsersMonitor] - Tenant (qa): login: num users: 1. Server num users: 1
--Number of currently logged in users
10:01:40.816 |-INFO [http-nio-8082-exec-1] [           c.f.b.d.DBUtil] - Getting User info for customer: fd tenant: qa
---User who is logging in

User Logout:
10:02:03.287 |-DEBUG [http-nio-8082-exec-5] [       c.f.u.UsersMonitor] - Tenant (qa): logout: num users: 0. Server num users: 0
10:02:03.287 |-DEBUG [http-nio-8082-exec-5] [f.f.w.SessionFormsListener] - Forcing a Subject qa@fd logout on session expiration ...
---User who is logging out

...

The following screen displays when a user tries to submit a form from a timed out session.

Editing Submissions

Designer users can view/edit submissions by clicking the edit link on the submissions panel. Non designer users can view/edit submissions by clicking on the Shared Items tab if they have been granted permission to do so by the designer via the Access Control feature. The frevvo.submission.edit .link parameter must be set to the default value of true, for the edit link to be visible to any user. To disable the edit link on the submission panel, change the default value of true to false for the frevvo.submissions.edit.link configuration parameter in <frevvo-home>/WEB-INF/web.xml file. The web.xml file must be unzipped from the frevvo.war before it can be edited. Follow the instructions above to unzip, modify and rezip the war file.

...

If the target tenant does not exist, create it by following these steps. For the sake of this document, I will assume the target tenant id to be mytenant.
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.
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.
Move the submissions in the submissions repository. You need to run these steps in the database where you persist the submissions. Please back up your database before moving forward.

Login to your database.

Edit the script shown below to:
1. Replace the word johnwith 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 is called d so if you are moving the user as part of an upgrade from 3.4.x chances are that your source tenant is d.
3. Replace the word mytenant with the name of your target tenant

Login to your database.
Edit the script shown below to:
Run the script shown below in your submissions database.

...

You can configure the palette to display only the controls that you need or to change the position of the controls in the palette by adding the context parameter:frevvo.palette.controls in the <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml file. The Strings must match 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 context paramater. Here is an example showing a designer palette configured with only ten nine controls;

Code Block
<Parameter name="frevvo.palette.controls" value="Dropdown,Radio,Checkbox,Section,Repeat,Tabs,Panel,Table,Message" override="false"/>

...

Info
<context-param> <param-name>frevvo.palette.controls</param-name> <param-value>Dropdown,Radio,Checkbox,Section,Repeat,Tabs,Panel,Table,Message,Link<Message</param-value> <description>Which controls are displayed in the palette</description> </context-param>

This image shows the Data Sources section moved to the top, the "New from XSD" button hidden and the palette configured for only ten controls. Remember any parameter in web.xml can be duplicated in frevvo.xml and the value in frevvo.xml takes precedence over the value in web.xml. If you plan to override the web.xml context parameter values and you are using the frevvo Tomcat bundle, we suggest doing so in frevvo.xml.

Modifying Content Types for the Upload Control

...

Info

If you are using MySQL, and you upload a large image or you are using a workflow that contains a large pdf, , 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.

Code Block
[mysqld] max_allowed_packet = 16M

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.

...

Stop .
Unzip the <frevvo-home>\ext\connectors\pve.war file.

Modify \Web-INF\web.xml, change the value of the frevvo.send.signature.xml context parameter to true.

Code Block
<context-param> <param-name>frevvo.send.signature.xml</param-name> <param-value>false</param-value> </context-param>wwwww

Rezip the pve.war file.
Copy the modified file to <frevvo-home>\ext\connectors.
Start .

...

supports clustered form servers for both high availablity / load balancing and fault tolerance. Please refer to Cluster Configuration for requirements and tasks associated with installation and configuration of clustered form servers.

Customize the Default Reject Email

...

Skew error when logging into an Azure SAML tenant

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

Code Block
Response issue time is either too old or with date in the future, skew 60, time 2016-06-01T05:49:25.330Z

This error is typically caused by a clock synchronization issue between the SP (frevvo) and the Idp (Azure) or a genuine delay in the connection. If you get this error, you can change the value of the context parameter, com.frevvo.security.saml.response.skew, to specify the time in seconds allowed between the request and the response from Azure to a value greater than the default value of 60 seocnds.

If you are using the tomcat bundle, the configuration parameter - com.frevvo.security.saml.response.skew - can be added to the <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml file. This is the recommended location.

...

Changing the Default Task Notification Email Message

If you want to change the default task notification email for your server, add this parameter in your \frevvo\tomcat\conf\Catalina\localhost\frevvo.xml file in the frevvo war section:

Code Block
<Parameter name="frevvo.task.notification.email.message" value="You can access your task list by clicking: {task.list.url}" override="false"/>

Change the value in this parameter to anything you want. The task.list.url template {task.list.url} is a built-in template in and it will always point to your frevvo server's task list URL. 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.

Version	Old Version 16	New Version Current
Changes made by	Former user	Megan Ellis
Saved on	Nov 20, 2017	Apr 22, 2020

Versions Compared

Key

Modifying the frevvo.xml file.

Modifying the web.xml file

frevvo tomcat bundle

Changing the admin password

Email configuration

Changing the admin password

Email configuration

Customizing the placeholder on the login screen

Customizing the placeholder on the login screen

Administration of reCAPTCHA Keys

Insight Data Batch Job Configuration Parameters

Using Debug Mode to see logged in users

Editing Submissions

Modifying Content Types for the Upload Control

Customize the Default Reject Email

Skew error when logging into an Azure SAML tenant

Changing the Default Task Notification Email Message

Connector Logging

Content Comparison

Versions Compared

Key

Modifying the frevvo.xml file.

Modifying the web.xml file

frevvo tomcat bundle

Changing the admin password

Email configuration

Changing the admin password

Email configuration

Customizing the placeholder on the login screen

Customizing the placeholder on the login screen

Administration of reCAPTCHA Keys

Insight Data Batch Job Configuration Parameters

Using Debug Mode to see logged in users

Editing Submissions

Modifying Content Types for the Upload Control

Customize the Default Reject Email

Skew error when logging into an Azure SAML tenant

Changing the Default Task Notification Email Message

Connector Logging