V4 Installation Instructions

From Frevvodocs

Jump to: navigation, search

Contents

[edit]

Downloading & Installing frevvo Live Forms™ in-house

The following instructions apply to frevvo's downloadable version – V3.3 and higher. If you are using an earlier version, please click V3.2_Installation_Instructions.

[edit]

Prerequisites

The following prerequisites must be satisfied in order to run frevvo in-house.

  • JDK or JRE 1.5 (Update 8 or higher) also JDK or JRE 1.6 are supported.
  • http(s) connectivity to http://www.frevvo.com for licensing and software update.
  • An account with frevvo. If you do not already have an account, you may Sign Up for free.
[edit]

Installation

frevvo provides a bundle that includes Tomcat V6 and has the frevvo web application, the database connector web application and the Google connector web application pre-deployed and pre-configured. The bundle works on Windows, Linux and Mac systems without any further configuration. If you are evaluating frevvo Live Forms, we strongly recommend the bundle.

[edit]

Other Installation Tasks

[edit]

Generating Trial Licenses

  • Login to your frevvo account (on frevvo's server).
  • Click the "my account" link at the top right of the page.
  • Click the "Live Forms In-house Licenses" link.
  • Choose an Edition. Live Forms is available in two editions: Standard & Professional.
  • Click the link to generate a 30-day license. If you have already generated a license previously, it will be displayed.
[edit]

Changing the admin password

  • Login to your frevvo server as user "admin", password "admin".
  • Click the "manage" link in the top right menu.
  • On the page that is displayed, click the "Manage Users" link.
  • Click the Image:Edit.png icon for the admin user. This displays a profile form.
  • Change the password as desired and submit the form.
[edit]

Admin host:port configuration

  • Login to your frevvo server as: user admin , password admin
  • Click on the applications link in the header
  • Edit the Admin application and click on the properties in the header
  • Verify that the Form Action and Doc Action base URLs are correct
    • In particular, you may need to change/add a port number.
    • For example, if your server is named gandalf and is running on port 8000, you will need to change the URLs to http: //gandalf:8000/
    • Note: The trailing / is important.
  • Edit the Add User form
    • Click on the Rules tab and expand the User Exists rule
    • Once again, you will need to set the correct port on which your server is running. You can leave this as localhost.
[edit]

User Path configuration

No configuration is necessary unless you plan to start frevvo as a windows service or to move the users to a non-standard location.

The user path refers to the location of all the users created in your frevvo installation. Depending on where you installed frevvo e.g. c:\frevvo (we'll refer to this directory below as <frevvo-home>) the users directory is located in <frevvo-home>\data\users. By default the frevvo installation contains two users: admin, templates. As you add new users you will see new user sub-folders added here.

You may wish to move your users directory outside of <frevvo-home> to make future upgrades easier. To do this:

  1. Copy the entire <frevvo-home>\data directory to your desired location (not just the data\users folder)
  2. Edit <frevvo-home>\tomcat\conf\Catalina\localhost\context.xml.default
  3. Set frevvo.users.path

Here's an example: <Parameter name="frevvo.users.path" value="c:\frevvo-data\users" override="false"/>

[edit]

Form Databases configuration

No configuration is necessary unless you plan to:

  • start frevvo as a windows service
  • or to move the forms database to a non-standard location
  • or plan to change from the default HSQLDB to a different database such as mySql.
[edit]

Moving the forms database

When using the frevvo tomcat bundle installation and the default configuration settings, the forms database is written to the <frevvo-home>\tomcat\bin directory. You may wish to locate the database outside of <frevvo-home> to make future upgrades easier. To do this:

  1. Edit <frevvo-home>\tomcat\conf\Catalina\localhost\context.xml.default
  2. Configure the HSQLDB jdbc/frevvoDS Resource
  3. Change url="jdbc:hsqldb:file:formsdb" to an absolute directory e.g. url="jdbc:hsqldb:file:c:\tmp\frevvo-data\formsdb"

Image:18px-Attention_niels_epting.svg.png Failure to configure this resource correctly will cause issues trying to create new forms, view submissions and submit forms.

Here is a sample jdbc/frevvoDS resource configuration for Apache Tomcat 6.x connecting to HSQLDB: 

	<Parameter name="hibernate.dialect" value="org.hibernate.dialect.HSQLDialect"/>
	<Resource auth="Container"
		type="javax.sql.DataSource"
		factory="org.apache.commons.dbcp.BasicDataSourceFactory"
		name="jdbc/frevvoDS"
		driverClassName="org.hsqldb.jdbcDriver"
		username="sa"
		password=""
		url="jdbc:hsqldb:file:formsdb"
		maxActive="20"
		maxIdle="3"
		maxWait="10000"
		validationQuery="select 1 from INFORMATION_SCHEMA.SYSTEM_USERS"
		testOnBorrow="true"
		testOnIdle="true"
		timeBetweenEvictionRunsMillis="10000"
		removeAbandoned="true"
		logAbandoned="true"/>
[edit]

Changing from HSQLDB to another database

There are three things to change when changing the underlying database from the default HSQLDB to another database such as mySQL, SQL Server, Oracle, etc...

1. Copy the necessary jdbc driver for your database into tomcat/lib

Edit <frevvo installdir>/frevvo/tomcat/conf/Catalina/localhost/context.xml and

2. Change the parameter hibernate.dialect from value="org.hibernate.dialect.HSQLDialect" to your database

3. Configure the jdbc/frevvoDS Resource (shown above) setting the the url, username and password to those of your database

Here are some of them supported hibernate dialects: 

 * org.hibernate.dialect.HSQLDialect
 * org.hibernate.dialect.MySQL5Dialect
 * org.hibernate.dialect.MySQL5InnoDBDialect
 * org.hibernate.dialect.Oracle9Dialect
 * org.hibernate.dialect.OracleDialect
 * org.hibernate.dialect.PostgreSQLDialect
 * org.hibernate.dialect.SQLServerDialect
 * org.hibernate.dialect.Sybase11Dialect

For example, to use a Postgres database change the parameter as follows: 

<Parameter name="hibernate.dialect" value="org.hibernate.dialect.PostgreSQLDialect" override="false"/>

For additional dialects see Hibernate documentation.

[edit]

Email configuration

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

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

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

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

The configuration.default.xml contains a few other parameters that effect emails sent from frevvo: 

<Parameter name="frevvo.mail.from.email" value="no-reply@frevvo.com" override="false"/>
<Parameter name="frevvo.mail.debug" value="false" override="false"/>
<Parameter name="frevvo.mail.bounce.email" value="support@frevvo.com" override="false"/>

from.email sets the from address in form submission and forgot password emails. debug sends more debugging info to the tomcat log files. And bounce.email set an address to receive emails that cannot be delivered to the to email recipients.

[edit]

Proxy Server configuration

If your company uses a proxy server for internet traffic please see frevvo proxy configuration

[edit]

Default Bundle Port

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

  1. Edit <frevvo install>/tomcat/conf/Catalina/localhost/context.xml.default
  2. Change the frevvo.app.port

<Parameter name="frevvo.app.port" value="8082" override="false"/>

  1. Edit <frevvo install>/tomcat/conf/server.xml
  2. Change the Connector port

<Connector port="8082" protocol="HTTP/1.1"

[edit]

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 installdir>\frevvo\tomcat\conf\tomcat-users.xml.


[edit]

Misc Configuration

[edit]

Session Timeout

frevvo's default web browser session timeout is 8 hrs. If a user is logged into the Live Forms server as a form designer or is using a frevvo form and filling in values but has not yet submit the form, the session will expire after 8 hours of inactivity. When the session expires the designer will have to re-login to Live Forms to continue designing forms and form users will have to get a new form and re-enter the values.

The session timeout can be changed by editing <frevvo installdir>\frevvo\tomcat\webapps\frevvo\WEB-INF\web.xml. The session timeout setting unit is minutes. For example, to change from an 8 hr session timeout to a 1 hour timeout change 480 to 60. 

<session-config>
    <session-timeout>480</session-timeout>
</session-config>
[edit]

Memory Configuration

The Live Forms 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 Live Forms server.

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

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

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

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 frevvo 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=64M

References: Tomcat Windows Service

[edit]

Need Help?

If you need help installing Live Forms please see Installation Help.

Retrieved from "http://docs.frevvo.com/docs/index.php/V4_Installation_Instructions"
Personal tools