Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


Section


Column
width800px

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 home>\tomcat\webapps\frevvo directory 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.

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.

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:

Code Block
titlefrevvo.xml from your previous Live Forms installation
<Parameter name="frevvo.default.login.tenant.id" value="your_tenant_id" override="false"/>
<Parameter name="frevvo.login.username.placeholder" value="user@<your_tenant_name>" override="false"/>

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
Code Block
titlefrevvo-config.properties file in the v7.4.x installation
#Custom Tenant Id and Placeholder
frevvo.default.login.tenant.id=<your_tenant_id>
frevvo.login.username.placeholder=<@<your tenant name>

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.

Code Block
frevvo.box.connector.client.id=bttkldgy9r5td0kdu57v0h6h2gotjf03
frevvo.box.connector.client.secret=EM08T1IjiMFuyCP5OJWm5QPyTz0qcL4A 
frevvo.filesystem.connector.url=http(s)://<your server>:port/filesystem 
insight.enabled=true insight.service.url=http(s)://<your server>:port/insight 
frevvo.sharepoint.connector.url=http(s)://<your server>:port/sharepoint 
logging.level.root=DEBUG

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

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



Column
width400px

On this page:

Table of Contents
maxLevel1


...

  • Login to your  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 Image Removed Image Addededit admin user icon for the admin user. This displays a profile form.
  • Change the password as desired and submit the form.

...

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

    Code Block
    titlefrevvo-config.properties
    frevvo.default.login.tenant.id=<your_tenant_id> 
    


  5. Save the file
  6. Restart .

...

Code Block
titlefrevvo-config.properties
frevvo.deprecated.submissions.view.enabled=<true or false> 

...

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

...

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

Image RemovedImage Added

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

...

Code Block
titlefrevvo-config.properties
frevvo.submission.delete.buttons=<true or false> 

Image RemovedImage Added

...

Code Block
titlefrevvo-config.properties
frevvo.submission.edit.link value=<true or false> 

Image RemovedImage Added

Administration of reCAPTCHA Keys

...

  • 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 Change the <myexternalhost>and <port> to your external server name and the port that you are using for  on this server. 

    Code Block
    titlefrevvo-config.properties
    frevvo.forms.server.external.url=http://<myexternalhost>:<port>>


    Note

    If the frevvo.forms.server.external.url is used with X-forwarded headers, the external.url will always take precedence (so X-forwarded headers will not work.)


  • 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. Code Block
    titlefrevvo-config.properties
    frevvo.internal.baseurl=http://localhost:8082

    in the example. change the value "http://localhost:8082" to the server name and port of your  server.

    Code Block
    titlefrevvo-config.properties
    frevvo.internal.baseurl=http://localhost:8082 


    Warning

    Changing the frevvo internal connector 8081 settings in the server.xml file can cause unexpected changes, and is not advised. Please keep this in mind before changing frevvo.internal.baseurl.


    • If frevvo.internal.url is set to empty, then port 8081 will go unused. In this case you should remove the connector: port=8081 in the server.xml file.
    • If you change frevvo.internal.port to 8082 then in this case also port 8081 will go unused, so you should remove the connector: port=8081 in the server.xml file.

    • If you change frevvo.internal.port to something different from 8082 then in this case user needs to set same port for the internal connector in server.xml file, as in this example:

      Code Block
      <Connector address="127.0.0.1" port="8086" protocol="org.apache.coyote.http11.Http11NioProtocol"
                     connectionTimeout="40000"
                     maxHttpHeaderSize="32768"
                     useBodyEncodingForURI="true" />


Default Port

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

...

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

...

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

Image RemovedImage Added

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

Image Added

Live Forms as a windows service

...

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

...

  1. Image Added

Signature Date/Time

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

...

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

Code Block
 <Valve className="org.apache.catalina.valves.RemoteIpValve"
            internalProxies=".*" 
            remoteIpHeader="x-forwarded-for" 
            proxiesHeader ="x-forwarded-by" 
            protocolHeader="x-forwarded-proto" />

...

  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  submissions. Please back up your database before moving forward
  5. Login to your database.
    1. 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  is called d.
      3. Replace the word mytenant with the name of your target tenant 
      1. Login to your database.
      2. Edit the script shown below to:
      3. Run the script shown below in your  submissions database.

    ...

    Code Block
    titlefrevvo-config.properties
    frevvo.login.forgot.password.enabled=false     


    Image RemovedImage Added

    Moving Data Sources to the Top of the Designer

    ...

    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.

    Image RemovedImage Added

    Modifying Content Types for the Upload Control

    ...

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

    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.   

    ...

    The show/hide pagebreaks icon  Image Removed Image Added 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.

    ...

    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.
    Image RemovedImage Added

    Follow the steps to hide this message:

    ...

    Code Block
    titlefrevvo-config.properties
    frevvo.attachment.maxsize=10485760 -> Replace the default value, 10485760 in this example, with the maximum size of the attachment that you want. The value must be entered in bytes. 

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

    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:

    Image RemovedImage Added

    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.

    ...

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

      Code Block
      com.frevvo.security.saml.response.skew=120


    5. Save the file.

    6. Restart .
    7. Retry the login.

    ...

    In-house customers can change the maximum size for images uploaded to forms/flows using the Image control in the 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.
    Image RemovedImage Added

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

    ...

    Changing the Default Task Notification Email Message

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

    Code Block
    frevvo.task.notification.email.subject=New task
    frevvo.task.notification.email.message=You can access your task list by clicking <a href="{task.perform.url}">this link</a>

    Change the value in this parameter to anything you want. The task.perform.url template {task.perform.url} is a built-in template in  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:

      Code Block
      <Valve className="org.apache.catalina.valves.ErrorReportValve" showServerInfo="false"/>


    • X-Frame-Options

      Header

      Not

      Set

      -

      Resolved

      by

      modification

      at

      the

      tomcat

      level.

      In-house

      customers

      can

      uncomment

      uncomment the

      HttpHeaderSecurityFilter

      provided

      in

      the

      tomcat

      web.xml.

      The

      filter

      is

      documented Apache tomcat website. Specify the appropriate

      documented here. Specify the appropriate X-Frame-Options

      value

      in

      the

      antiClickJackingOption

      parameter

      -

      (SAMEORIGIN

      or

      ALLOW-FROM).

      Warning
      Setting this parameter to SAMEORIGIN may interfere when embedding frevvo forms/flows in your website. Use  ALLOWUse ALLOW-FROM instead.

      Click the appropriate link below for filter examples.

      Code Block
      titleExample of filter with SAMEORIGIN
      collapsetrue
      <filter>
              <filter-name>httpHeaderSecurity</filter-name>
              <filter-class>org.apache.catalina.filters.HttpHeaderSecurityFilter</filter-class>
      		<init-param>
      			<param-name>antiClickJackingOption</param-name>
      			<param-value>SAMEORIGIN</param-value>
      		</init-param>
              <async-supported>true</async-supported>
      </filter>
      
      <filter-mapping>
              <filter-name>httpHeaderSecurity</filter-name>
              <url-pattern>/*</url-pattern>
              <dispatcher>REQUEST</dispatcher>
      </filter-mapping>
      


      Code Block
      themeConfluence
      titleExample of filter with ALLOW-FROM for embedded forms
      collapsetrue
      <filter>
              <filter-name>httpHeaderSecurity</filter-name>
              <filter-class>org.apache.catalina.filters.HttpHeaderSecurityFilter</filter-class>
      		<init-param>
      			<param-name>antiClickJackingOption</param-name>
      			<param-value>ALLOW-FROM</param-value>
      		</init-param>
      		<init-param> 
                  <param-name>antiClickJackingUri</param-name> 
                  <param-value> http://example.com:80/*</param-value> 
              </init-param>
              <async-supported>true</async-supported>
      </filter>
      
      <filter-mapping>
              <filter-name>httpHeaderSecurity</filter-name>
              <url-pattern>/*</url-pattern>
              <dispatcher>REQUEST</dispatcher>
      </filter-mapping> 

    • Admin user name exposure in URLs - Resolved by the feature to not expose the user id in URLs.
    • Tomcat 'Ghostcat' bug (affects  through v9.0.10.) The frevvo Apache Tomcat will be upgraded in a future release. To address this vulnerability in the versions listed, please use the solution listed in this article.

    Geo Location

    On-premise installations planning on using the  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

      Code Block
      frevvo.google.maps.apikey=AIzaSyCa3fRtM53VB1aHZjbCHTh1al7RWo22l78


    6. Start the Insight server then .

    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.

    ...