Versions Compared

Key

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

configuration parameters are located in three places:

  1. 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.
  2. <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml - recommended file to override context-parameters in the web.xml file when using the tomcat container.
  3. 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. OEM partners can use this file to customize the product in many ways. See Installation Customizations for more information.
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.
Section
Column
Section
Column

configuration parameters are located in three places:

  1. 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.
  2. <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml - recommended file to override context-parameters in the web.xml file when using the tomcat container.
  3. 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. OEM partners can use this file to customize the product in many ways. See Installation Customizations for more information.

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 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 config.properties file will override the frevvo.xml and web.xml files.

Modifying the frevvo.xml file.

Follow these steps to modify context parameters in the frevvo.xml file. You can also set up your database in this file as well. If you are using tomcat, making your configuration changes here, will make it easier when you upgrade to :

  1. Stop if it is running.
  2. Navigate to <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml.
  3. Open the file with a text editor.
  4. 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:

  1. Stop  if it is running. 
  2. 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.
  3. Edit c:\tmp\frevvo-war\WEB-INF\web.xml.
  4. Make the desired configuration changes - see appropriate sections of this page for information on specific parameters. Save the changes to the web.xml file. 
  5. 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.

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

  7. Copy the updated frevvo.war file to <frevvo-home>tomcat\webapps.
  8. Restart your  server.
If you accidentally delete <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml, restart tomcat and a new copy will be created from a pristine one stored in frevvo.war!META-INF/context.xml .
Column
width400px

On this page:

Table of Contents
maxLevel1

...

There are 3 choices for the config.properties file location. You can:
  1. Expand the war, edit/create the /WEB-INF/config.properties re-zip the war. This is essentially the same as editing the web.xml directly. 
  2. 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.       
  3. Place the config.properties somewhere in the file system (outside the frevvo.war) and then add  -Dfrevvo.config=file:Drive:/path to 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:/pathtomyconfig.properties), a path in the war (e.g. /WEB-INF/myconfig.properties) or a url (e.g. http://config/cluster1/myconfig.properties). Be sure to include the config.properties file name in the path statement.      

...

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

...

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

External URLs

Sometimes running  behind running  behind a proxy server can cause unintended changes to the form server's external URLs. The following configuration parameters address this issue.

...

 These parameters can be added to frevvo war settings section of the <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml 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. 

    Code Block
    <Parameter name="frevvo.forms.server.external.url" value="http://<myexternalhost>:<port>" override="false"/>
  • 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.

Examples:

...

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

    Code Block
    <Parameter name="frevvo.

...

  • internal.baseurl" value="http://

...

  • localhost:8082" override="false"/>

Default Port

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

...

Add the user agent for the browsers you want to support '''in lower case only'''. For example, to allow Firefox 5 users to access the system, add 'firefox/5' (without the quotes) to the param-value. If you want to allow all versions of Firefox, add the string 'firefox' (without the quotes) to the param-value. It will match all versions of the Firefox browser. Microsoft's IE9 browser update 9.0.8112.16421 Update versions 9.0.3(Kb2586448) will result in an unsupported browser exception even with msie9.0 in the web.xml file. The solution is to add the string 'msie'  without any version number to the support browser list. Internet Explorer 11 requires the use agent identifier , trident/7.

Code Block
languagehtml/xml
<context-param>
   <param-name>frevvo.supported.browsers</param-name>
   <param-value>firefox/2,firefox/3,firefox/4,msie 6.0,msie 7.0,msie 8.0,msie 9.0,trident/7,applewebkit,camino,httpclient,zend_http_client,formsapi</param-value> <description>Supported browsers - array of allowed user agents</description> </context-param>

...

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

...

Note

If you plan to run the  Tomcat bundle on IBM J9 JVM  and you want to have the HTTPS connector enabled, you will need to change the encryption algorithm to IBM's X509 from the default Sun Oracle X509 implementation.

To run HTTPS on IBM J9 JVM, add algorithm="IbmX509" attribute to the HTTPS connector:

...

Tip

Java 7 will throw a "SEVERE: java.net.SocketException: Invalid argument: no further information" error in the <frevvo-home>/tomcat/logs/catalina.YYYY-MM-DD.log when used on a Windows 2003 system with Tomcat version 7.0.29 or earlier and the NIO http connector. If you should encounter this error, check the version of Tomcat. If it is below 7.0.30, upgrade to that version. Run the <frevvo-home>\tomcat\version.bat (Windows) or <frevvo-home>/tomcat/version.sh (UNIX) files to determine the version of Tomcat installed on your system.

...

Tomcat Logfiles

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

...

Code Block
<Valve className="org.apache.catalina.valves.AccessLogValve" directory="${catalina.base}/logs"
               prefix="localhost_access_log." suffix=".txt"
               pattern="%h %l %u %t &quot;%r&quot; %s %b &quot;%{Referer}r&quot; &quot;%{User-Agent}r&quot; [%I %{JSESSIONID}c]" />

 

  • 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. 
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 logging levels used by  can be fine-tuned by editing the <frevvo -home>/tomcat/lib/logback.xml file. By default  log level is set to INFO. The logging infrastructure will scan this file every 60 secs so you can live-change the log level. Here
is more configuration information
.  Stop  to delete the logfiles. They will be recreated on start up.  

...

The  tomcat bundle install will automatically rotate log files daily. The logfile is the only one affected. Let's say the current date is 6 - 19 - 2013. The current days logging is saved to the frevvo.log file located in <frevvo-home>/tomcat/logs.  On the next day, 6 - 20 - 2013,  the log from the previous day is copied to a logfile stamped with the previous day's date. (frevvo_2013-06-19). This date stamped frevvo.log is moved into located in the <frevvo-home>\tomcat\logs\old directory. Logging for 6 - 20 - 2013 is saved in the frevvo.log in <frevvo-home>/tomcat/logs.

...

The default  server session timeout can be overridden for each tenant. See the Edit Tenant topic for more information.

Tip
Tomcat session-config parameters can not be overridden in frevvo.xml.

...

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

Editing Submissions

Submissions can be edited via the Submissions Page. This feature is disabled by default for  in-house users. To enable this feature,  add the 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 to the in <frevvo-home>/WEB-INF/web.xml .  For more
details
on the feature that this parameter controls see Editing Submissions. The web.xml file file. The web.xml file must be unzipped from the frevvo.war before it can be edited. See above for the detailsFollow the instructions above to unzip, modify and rezip the war file 

Hardware Requirements

The minimum recommended hardware configuration for your Live Forms server is:

  • 2 gigahertz (GHz) 32-bit (x86) or 64-bit (x64) processor
  • 4 gigabyte (GB) of system memory
  • 100 GB hard drive

However you must size your hardware platform to your specific form usage characteristics. As the number of concurrent users and forms increases so must the system memory. For a medium use production server consider increasing the JVM RAM allocation to 6 or 8 gigabytes. Refer to the memory configuration topic below.

Memory Configuration

The  Tomcat bundle comes pre-configured with default memory usage settings. While the defaults are sufficient for initial usage, as your forms, business logic and submissions grow, so will the memory needs of the   server.

The first important step is to ensure that  is installed on a machine with sufficient cpu and ram. "Sufficient" depends on your  usage (number of users, number of forms in use, number of submissions per day, etc..).

Tip

After making memory configuration changes you must restart the server.

You will know when you need to increase allocated memory when you see two common errors appear in the Tomcat logfiles <frevvo-home>//tomcat/logs. You can tune the frevvo/tomcat installation by editing <frevvo-home>/tomcat/bin/setenv.bat on windows and setenv.sh on unix.

You'll see something like this in setenv.[bat,sh]:

Code Block
languagebash
set JAVA_OPTS=-Xms128m -Xmx512m -Djava.awt.headless=true
-Dfrevvo.users.path="%CATALINA_HOME%\..\data\users"

OutOfMemoryError: Java heap space

SEVERE: Servlet.service() for servlet jsp threw exception
java.lang.OutOfMemoryError: Java heap space

To solve this edit setenv.[bat,sh] to increase the minimum and maximum heap size via the parameters: -Xmx and -Xms.

For example: -Xmx512m to -Xmx1g. Make sure also that the machine where  is installed has enough memory installed. If you change -Xmx to 1g your machine will need more then 1g ram.

OutOfMemoryError: PermGen space

MemoryError: PermGen space
java.lang.OutOfMemoryError: PermGen space

...

Code Block
<context-param>  
    <param-name>frevvo.submission.edit.link</param-name> 
    <param-value>false</param-value> 
    <description>Show a link to edit the submission.</description> 
</context-param>

You can add the frevvo.submission.edit.link configuration property to the <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml file instead of the web.xml file as discussed above. Here is an example that will disable submission editing when added to the frevvo war settings section of frevvo.xml:  

Code Block
<Parameter name="frevvo.submission.edit.link" value="false" override="false"/>

 When the frevvo.submission.edit.link parameter has a value of false, the edit link is not visible on on form submission panels.  

Image Added  

Hardware Requirements

The minimum recommended hardware configuration for your Live Forms server is:

  • 2 gigahertz (GHz) 32-bit (x86) or 64-bit (x64) processor
  • 4 gigabyte (GB) of system memory
  • 100 GB hard drive

However you must size your hardware platform to your specific form usage characteristics. As the number of concurrent users and forms increases so must the system memory. For a medium use production server consider increasing the JVM RAM allocation to 6 or 8 gigabytes. Refer to the memory configuration topic below.

Memory Configuration

The  Tomcat bundle comes pre-configured with default memory usage settings. While the defaults are sufficient for initial usage, as your forms, business logic and submissions grow, so will the memory needs of the   server.

The first important step is to ensure that  is installed on a machine with sufficient cpu and ram. "Sufficient" depends on your  usage (number of users, number of forms in use, number of submissions per day, etc..).

Tip

After making memory configuration changes you must restart the server.

You will know when you need to increase allocated memory when you see two common errors appear in the Tomcat logfiles <frevvo-home>//tomcat/logs. You can tune the frevvo/tomcat installation by editing <frevvo-home>/tomcat/bin/setenv.bat on windows and setenv.sh on unix.

You'll see something like this in setenv.[bat,sh]:

Code Block
languagebash
set JAVA_OPTS=-Xms128m -Xmx512m -Djava.awt.headless=true
-Dfrevvo.users.path="%CATALINA_HOME%\..\data\users"

OutOfMemoryError: Java heap space

SEVERE: Servlet.service() for servlet jsp threw exception
java.lang.OutOfMemoryError: Java heap space

To solve this edit setenv.[bat,sh] to increase the minimum and maximum perm heap size via the paramenterparameters: -XX:MaxPermSize-Xmx and -Xms.

For example: -XX:MaxPermSize=128M

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:

Code Block
languagebash
"%EXECUTABLE%" //US//%SERVICE_NAME% ++JvmOptions "-XX:MaxPermSize=128m 
-Djava.io.tmpdir=%CATALINA_BASE%\temp;
-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager;
-Djava.util.logging.config.file=%CATALINA_BASE%\conf\logging.properties" 
--JvmMs 128 --JvmMx 512

See the documentation on Tomcat Windows Service for more Xmx512m to -Xmx1g. Make sure also that the machine where  is installed has enough memory installed. If you change -Xmx to 1g your machine will need more then 1g ram.

OutOfMemoryError: PermGen space

MemoryError: PermGen space
java.lang.OutOfMemoryError: PermGen space

Java has a fixed space allocated for classes and other statics that is usually enough in normal cases, but could be quickly filled up if there is on the fly code generation or significant business logic in your forms.

To solve this edit setenv.[bat,sh] increase the maximum perm size via the paramenter: -XX:MaxPermSize

For example: -XX:MaxPermSize=128M

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:

Code Block
languagebash
"%EXECUTABLE%" //US//%SERVICE_NAME% ++JvmOptions "-XX:MaxPermSize=128m 
-Djava.io.tmpdir=%CATALINA_BASE%\temp;
-Djava.util.logging.manager=org.apache.juli.ClassLoaderLogManager;
-Djava.util.logging.config.file=%CATALINA_BASE%\conf\logging.properties" 
--JvmMs 128 --JvmMx 512

See the documentation on Tomcat Windows Service for more details.

TIFF Image Generator

...

  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

...

 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  server login if you hide the tenant input on the  login page.

This can be changed by editing <frevvo-home>\tomcat\webapps\frevvo\WEB-INF\web.xml. Uncomment the frevvo.default.login.tenent.id parameter and set the param-value to the name of your one tenant. Next set the param-value of frevvo.login.show.tenant to false.

Here is how the parameters appear after editing:

...

Share Dialog Options

You can customize the options that appear in the Share dialog by editing the following web.xml parameter or adding it to an override in frevvo.xml. Remove any option from <param-value> that you want to hide from the share dialog.

Code Block
<context-param> 
    <param-name>frevvo.share.options</param-name> 
    <param-value>embed-script,embed-link,link,page,google-gadget,raw-iframe,raw-link</param-value>
    <description>Which share dialog options <description>Defaultto Tenant<show</description>
</context-param>
<context-param>
        <param-name>frevvo.login.show.tenant</param-name>
        <param-value>false</param-value>
        <description>Show Tenant Box on Login Page<

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 via the context parameter: frevvo.data.sources.top. Add the parameter with a value of true, as shown below, to the <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml file. 

Code Block
<Parameter name="frevvo.data.sources.top" value="true" override="false"/>

Here is an example of how to edit the web.xml file to add the configuration parameter. Be sure to rezip the frevvo.war file, as described above, when the changes are complete.

Code Block
<context-param>
    <param-name>frevvo.data.sources.top</param-name>
    <param-value>true</param-value>
    <description>Move Data Source to the top></description>
</context-param>

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

...

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.

Show/Hide the "New from XSD" Button 

You can show/hide the "New from XSD" button form designer Data Sources tab via the context parameter: frevvo.data.sources.add to the <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml

...

file. The default is true. Set it to false to hide "New from XSD" button. Here is an example: 

Code Block
<Parameter name="frevvo.defaultdata.loginsources.tenant.idadd" value="mytenantfalse" override="falsetrue"/>  
Note

If you need to login as the ' server superuser admin you must login with username admin@d.

Show/Hide Share Dialog Options

You can customize the options that appear in the Share dialog by editing the following web.xml parameter or adding it to an override in frevvo.xml. Remove any option from <param-value> that you want to hide from the share dialog.

Code Block
<context-param>

Here is an example of the configuration parameter added to the web.xml file. Be sure to rezip the frevvo.war file, as described above, when the changes are complete. 

Info
<context-param>
<param-name>frevvo.data.sharesources.options<add</param-name>
<param-value>embed-script,embed-link,link,page,google-gadget,raw-iframe,raw-link<value>false</param-value>
<description>Which share<description>Hide dialogNew optionsfrom toXSD show<button></description>
</context-param>

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 via the context parameter: frevvo.data.sources.top. Add the parameter with a value of true, as shown below, to the 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.   

Configure Palette Controls in the Designer

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

Code Block
<Parameter name="frevvo.datapalette.sources.topcontrols" value="trueDropdown,Radio,Checkbox,Section,Repeat,Tabs,Panel,Table,Message" override="false"/>

Here is an example of how to edit  The frevvo.palette.controls parameter exists in the web.xml file to add the configuration parameter. Here is an example of the modified configuration parameter that will display only ten controls. Be sure to unzip/rezip the frevvo.war file, as described above, when the changes are complete.  

Code Blockinfo
<context-param>
<param-name>frevvo.datapalette.sources.top<controls</param-name> <param-value>true</param-value> <description>Move Data Source to the top></description>
<param-value>Dropdown,Radio,Checkbox,Section,Repeat,Tabs,Panel,Table,Message,Link</param-value>
<description>Which controls are displayed in the palette</description>
</context-param>

Remember any parameter in 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.

Show/Hide the "New from XSD" Button 

You can show/hide the "New from XSD" button form designer Data Sources tab via the context

Image Added

Modifying Content Types for the Upload Control

The content types supported by  are configured through web.xml using the context parameter: frevvo.dataupload.file.sources.add to the <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml file. The default is true. Set it to false to hide "New from XSD" button. Here is an example: 

Code Block
<Parameter name="frevvo.data.sources.add" value="false" override="true"/>

Here is an example of the configuration parameter added to the web.xml file. Be sure to rezip the frevvo.war file, as described above, when the changes are complete. 

Info
<context-param>
<param-name>frevvo.data.sources.add</param-name>
<param-value>false</param-value>
<description>Hide New from XSD button></description>
</context-param>

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.   

Configure Palette Controls in the Designer

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

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

 The frevvo.palette.controls parameter exists in the web.xml file. Here is an example of the modified configuration parameter that will display only ten controls. Be sure to unzip/rezip the frevvo.war file, as described above, when the changes are complete.  

Info
<context-param>
<param-name>frevvo.palette.controls</param-name>
<param-value>Dropdown,Radio,Checkbox,Section,Repeat,Tabs,Panel,Table,Message,Link</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.

Image Removed

Modifying Content Types for the Upload Control

The content types supported by  are configured through web.xml using the context parameter: frevvo.upload.file.types. A mime type that is not working for a certain content type can be added to the web.xml file for on-premise customers. Follow the steps above to unzip/rezip the <frevvo-home>/tomcat/webapps/frevvo.war file after the edits to the web.xml file are complete.

The context parameter, frevvo.upload.file.types is located in the <!-- Upload Control File Types and Corresponding Mime Types --> section of the web.xml file.

Code Block
<context-param> <param-name>frevvo.upload.file.types</param-name> <param-value>pdf,MS Word,MS Excel,MS PowerPoint,MS Access,gif,jpeg,png,tiff,rtf,tar,zip,gzip,xml,bmp</param-value> <description>Upload Control File Types for restricting upload by type</description> </context-param>

In addition, there are context parameters for each supported mime type that corresponds to each context type. For example, the context param that has the mime types corresponding to MS Word is: frevvo.upload.file.type.ms_word.mimes. Note the naming convention for the context type part of the parameter - lower case and spaces replaced with _ 

Code Block
<context-param>   <param-name>frevvo.upload.file.type.ms_word.mimes</param-name>   <param-value>application/msword</param-value>   <description>Allowed mimes for this type (comma separated).  Type names is lower cased and spaces replaced with _.</description>  </context-param>

Edits to the <!-- Upload Control File Types and Corresponding Mime Types --> section of the web.xml file should be reported to  customer support to ensure future releases include the added mime type in the web.xml file of future releases.

As a preferable alternative, the additional mime type can be typed 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 with the context param in web.xml - "frevvo.rule.validation.timeout". The default value is 2000 milliseconds. If validation javascript execution exceeds this timeout value, the Rule Validator will show : 

Code Block
Form or Rule Level Validation Issue: Validation Failed Rule validation timed out, possibly due to unparseable rule JavaScript.

 Max Size Attachment

You can set an upper bound limit server wide for the maximum size of an attachment that can be uploaded via the Upload Control by adding the frevvo.attachment.maxsize context parameter in the  web.xml file. See Modifying the web.xml file above for the details. The same result can be accomplished by overriding the property in the container level by modifying the frevvo.xml.file. This is the recommended approach as frevvo.xml is directly editable while the web.xml file is included in the frevvo.war zipfile that has to be extracted, modified and rezipped after the changes are made. To do that:

  1. Stop .
  2. Locate the frevvo.xml file under the frevvo installation. If you are using the tomcat bundle, it will be in <frevvo-home>\tomcat\conf\catalina\localhost.
  3. Add the line:
Code Block
<Parameter name="frevvo.attachment.maxsize" value="10485760" override="false"/>

      3. Replace the value,102400 in this example, with the maximum size of the attachment that you want. The value must be entered in bytes. The default value is 10485760 bytes.

      4. Restart .

IBM J9 JVM

supports IBM's J9 JVM. To use the J9 JVM add the '''algorithm="IbmX509" attribute to the frevvo/tomcat/conf/server.xml's HTTPS <Connector> element. So, instead of this:

Code Block
<!-- HTTPS Connector : add algorithm="IbmX509" when using IBM's J9 JVM --> <Connector port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol" SSLEnabled="true" maxThreads="150" scheme="https" secure="true" clientAuth="false" sslProtocol="TLS" keystoreFile="${catalina.home}/conf/keystore" keystorePass="password" connectionTimeout="20000" maxHttpHeaderSize="32768" useBodyEncodingForURI="true" />

You need this:

Code Block
<!-- HTTPS Connector : add algorithm="IbmX509" when using IBM's J9 JVM --> <Connector port="8443" algorithm="IbmX509" protocol="org.apache.coyote.http11.Http11NioProtocol" SSLEnabled="true" maxThreads="150" scheme="https" secure="true" clientAuth="false" sslProtocol="TLS" keystoreFile="${catalina.home}/conf/keystore" keystorePass="password" connectionTimeout="20000" maxHttpHeaderSize="32768" useBodyEncodingForURI="true" />

Or, of course, comment out the HTTPS connector altogether if it is not needed.types. A mime type that is not working for a certain content type can be added to the web.xml file for on-premise customers. Follow the steps above to unzip/rezip the <frevvo-home>/tomcat/webapps/frevvo.war file after the edits to the web.xml file are complete.

The context parameter, frevvo.upload.file.types is located in the <!-- Upload Control File Types and Corresponding Mime Types --> section of the web.xml file.

Code Block
<context-param> <param-name>frevvo.upload.file.types</param-name> <param-value>pdf,MS Word,MS Excel,MS PowerPoint,MS Access,gif,jpeg,png,tiff,rtf,tar,zip,gzip,xml,bmp</param-value> <description>Upload Control File Types for restricting upload by type</description> </context-param>

In addition, there are context parameters for each supported mime type that corresponds to each context type. For example, the context param that has the mime types corresponding to MS Word is: frevvo.upload.file.type.ms_word.mimes. Note the naming convention for the context type part of the parameter - lower case and spaces replaced with _ 

Code Block
<context-param>   <param-name>frevvo.upload.file.type.ms_word.mimes</param-name>   <param-value>application/msword</param-value>   <description>Allowed mimes for this type (comma separated).  Type names is lower cased and spaces replaced with _.</description>  </context-param>

Edits to the <!-- Upload Control File Types and Corresponding Mime Types --> section of the web.xml file should be reported to  customer support to ensure future releases include the added mime type in the web.xml file of future releases.

As a preferable alternative, the additional mime type can be typed 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 with the context param in web.xml - "frevvo.rule.validation.timeout". The default value is 2000 milliseconds. If validation javascript execution exceeds this timeout value, the Rule Validator will show : 

Code Block
Form or Rule Level Validation Issue: Validation Failed Rule validation timed out, possibly due to unparseable rule JavaScript.

Max Size Attachment

You can set an upper bound limit server wide for the maximum size of an attachment that can be uploaded via the Upload Control by adding the frevvo.attachment.maxsize context parameter in the  web.xml file. See Modifying the web.xml file above for the details. The same result can be accomplished by overriding the property in the container level by modifying the frevvo.xml.file. This is the recommended approach as frevvo.xml is directly editable while the web.xml file is included in the frevvo.war zipfile that has to be extracted, modified and rezipped after the changes are made. To do that:

  1. Stop .
  2. Locate the frevvo.xml file under the frevvo installation. If you are using the tomcat bundle, it will be in <frevvo-home>\tomcat\conf\catalina\localhost.
  3. Add the line:
Code Block
<Parameter name="frevvo.attachment.maxsize" value="10485760" override="false"/>

      3. Replace the value,102400 in this example, with the maximum size of the attachment that you want. The value must be entered in bytes. The default value is 10485760 bytes.

      4. Restart .

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

IBM J9 JVM

supports IBM's J9 JVM. To use the J9 JVM add the '''algorithm="IbmX509" attribute to the frevvo/tomcat/conf/server.xml's HTTPS <Connector> element. So, instead of this:

Code Block
<!-- HTTPS Connector : add algorithm="IbmX509" when using IBM's J9 JVM --> <Connector port="8443" protocol="org.apache.coyote.http11.Http11NioProtocol" SSLEnabled="true" maxThreads="150" scheme="https" secure="true" clientAuth="false" sslProtocol="TLS" keystoreFile="${catalina.home}/conf/keystore" keystorePass="password" connectionTimeout="20000" maxHttpHeaderSize="32768" useBodyEncodingForURI="true" />

You need this:

Code Block
<!-- HTTPS Connector : add algorithm="IbmX509" when using IBM's J9 JVM --> <Connector port="8443" algorithm="IbmX509" protocol="org.apache.coyote.http11.Http11NioProtocol" SSLEnabled="true" maxThreads="150" scheme="https" secure="true" clientAuth="false" sslProtocol="TLS" keystoreFile="${catalina.home}/conf/keystore" keystorePass="password" connectionTimeout="20000" maxHttpHeaderSize="32768" useBodyEncodingForURI="true" />

Or, of course, comment out the HTTPS connector altogether if it is not needed.

Also, to parse license files, the BountyCastle JCE provider should be downloaded and placed in the web container classpath. For the Tomcat servlet, copy the jar into the tomcat/lib folder. Once this jar is there, the provider will be picked up automatically by  through the context parameter in web.xml: frevvo.security.provider shown below. This parameter defaults to org.bouncycastle.jce.provider.BouncyCastleProvider. It is ignored when the jar is not present.

Here is a link to the Bounty Castle download pageThe name of the jar is the JDK 1.5 - JDK 1.7 provider: bcprov-jdk15on-148.jar. You can download it from here.

Code Block
<!-- JSSE Provider -->
<context-param>
         <param-name>frevvo.security.provider</param-name>
         <param-value>org.bouncycastle.jce.provider.BouncyCastleProvider</param-value>
         <description>
         Set the Class name or JCE provider name to use when parsing license files.
         If the class doesnt exist in the ClassPath, it will be ignored.
         This setting is needed when running frevvo on IBM J9 JVM: just add Bounty Castle
         JCE provider to the classpath and restart the server.
         </description>
</context-param>

 

OEM Branding

There are several installation and configuration tasks and consideration that are typically done only by OEM partners embedding into there own product. Please see Installation Customizations for more details.

...