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

  Open

  

  icon to manage tenant named d (Default tenant)

• Click Manage Users

• Click the 

  Open

  

   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 

' 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

 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.

1. Stop frevvo 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

   frevvo.default.login.tenant.id=<your_tenant_id>

5. Save the file

6. Restart

   .
   
   

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.

 

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

   frevvo.login.username.placeholder=user@mycompany

5. Restart

   .
   
   

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

   
   
   
   

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

  , 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 

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

Reports feature. The batch job is automatically run when you upgrade

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

• Cloud customers must contact frevvo to request the batch process for your tenant.

• In-house customers can use the Refresh Searchable Fields function to manually run the batch process.

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

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

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

Disable the Submission Edit Link

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

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

   frevvo.recaptcha.sitekey=<your custom site key here> frevvo.recaptcha.secretkey=<your custom secret key here> frevvo.recaptcha.hostcheck=<true or false>

The frevvo.recaptcha.hostcheck property controls the domain/host verification on the verification step that is done by

. 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 

 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 

   on this server. 

  frevvo-config.properties

  frevvo.forms.server.external.url=http://<myexternalhost>:<port>>

• 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 

   server.

  frevvo-config.properties

  frevvo.internal.baseurl=http://localhost:8082

Default Port

By default the

 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

 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,

 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 

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

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

 can be configured to handle HTTPS connections from users. The

 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 

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:

 recommends reviewing your Certificate Authority's documentation for detailed steps to configure your certificate in Apache Tomcat. Additional info on how to use SSL on tomcat can be found on the Apache/Tomcat website. 

There are multiple ways of configuring certificates depending on their format. For example, a PKCS#12 (pfx or p12) certificate doesn't have to be imported into the keystore. It can be configured directly as:

However, PKCS#7 or P7B formats require importing the certificate chain into the keystore. The Certificate Authority needs to provide all the intermediate certificates to be imported. 

Currently you must not disable 

's http port. In a future release this will be allowed. Disabling 

' http port will cause your form server to malfunction as 

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 

behind an Apache or IIS server. Close the http port on Apache or IIS but leave tomcat's http port open so that 

can POST back to itself when needed over http but no one outside can access it.

sameSiteCookies Attribute

Recent browser versions (especially Chrome v80+), by default, allow cookies to be sent only with top-level navigation and GET request initiated by third party websites. When you need to expose cookies to a third party site, such as using the SAML security manager or embedding in an iframe, you need to use https (Chrome only) and explicitly set the samesite attribute of the cookie to "none". frevvo v9.0.10+ includes a tomcat upgrade that allows configuring the cookie processor with this attribute. This documentation provides more information and details across browsers.

The sameSite value "none" is not supported prior to iOS 13 (macOS before version 10.15). Setting sameSite to "none" in tomcat may require iPhone/iPad to be upgraded.

For third party access, you must use https and update the provided tomcat/conf/context.xml CookieProcessor element to add the sameSiteCookies attribute.

On premise customers who do not want to make these updates need to turn on the legacy behavior in the chrome browser. Please see this Chrome documentation for details.

Tomcat Logfiles

By default, the 

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

   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.

  <Valve className="org.apache.catalina.valves.AccessLogValve" directory="logs" prefix="localhost_access_log" suffix=".txt" pattern="%h %l %u %{begin:dd/MM/yy:H:m:s.S}t &quot;%r&quot; %s %b &quot;%{Referer}r&quot; &quot;%{User-Agent}r&quot; [%I %{JSESSIONID}c %{X-Correlation-Id}o %{Location}o]" />

• 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

   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.

Loglevels for Security Managers

These properties should be used to get DEBUG level logs for specific security managers:

SAML & Azure SAML

logging.level.com.frevvo.security.saml=DEBUG

LDAP
logging.level.org.springframework.ldap=DEBUG

Log Messages in the frevvo 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.id, subject.id, correlation.id, session.id, owner.id, application.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

By default

 log levels are set to INFO.  Loglevels are changed by adding properties to the <frevvo-home>\tomcat\conf\frevvo-config.properties file. Changing the loglevel to DEBUG provides more information when troubleshooting. 

If you want to delete the logs, stop

 then delete the logfiles. They will be recreated on start up.   

Changing the logging level for frevvo 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 

   .
   
   
   

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.

Turn on logging of Email Subject

Email subjects are masked by default for security purposes. You can enable logging of email subject lines by configuring the property in the frevvo-config.properties file in <frevvo-home>\tomcat\conf.:

Viewing the number of logged in users

Tenant, superuser or additional admin(s) can manage user session via the

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

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

Session Timeout

's default web browser session timeout is 30 minutes. If a user is logged into the

 server to design forms, or to view their task list, or is using a

 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

 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

 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

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.

frevvo 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

 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

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 DocuPhase Forms Software Downloads Directory.

5. Restart the

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

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

frevvo-config.properties

Timezones

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