Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
frevvo Properties File
The frevvo-config.properties is a standard java properties file (see some examples here). All of the context-parameters currently found in web.xml or any valid context parameter can be configured in this file.
For example, say you are using the Weblogic Server and you need to set the frevvo.link.default.url to http://mycompany.com and move the Data Sources panel to the top of the designer.
- Create the frevvo-config.properties file. Refer to frevvo-config.properties location for information about where the file should reside. The context-parameters follow a simple context-parameter=value syntax (shown below) in the frevvo-config.properties file:
Code Block |
---|
frevvo.link.default.url=http://frevvo.com/
frevvo.data.sources.top=true |
Updating the frevvo-config.properties requires server re-start.
frevvo-config.properties location
- Expand the war, edit/create the /WEB-INF/frevvo-config.properties, re-zip the war. This is essentially the same as editing the web.xml directly.
- Create the file in the current working directory of the container you are using. will pick it up by default. For example, <frevvo-home>/tomcat is the current working directory for the tomcat container.
Place the frevvo-config.properties somewhere in the file system (outside the frevvo.war) and then add -Dfrevvo.config=file:Drive:/path to frevvo-config.properties in the java executable call. For example, add it to <frevvo-home>\tomcat\bin\setenv.bat, setenv.sh or service.bat if you are using the tomcat container. Here is an example of the <frevvo-home>\tomcat\bin\setenv.bat file with the added parameter:
Code Block |
---|
set JAVA_OPTS=-Xms256m -Xmx1024m -XX:MaxPermSize=156m -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled -Dfile.encoding=UTF-8 -Djava.awt.headless=true -Dfrevvo.config=file:C:/frevvo/tomcat/frevvo-config.properties |
The value of frevvo.config can be a full path (e.g. Drive:/pathtomyfrevvo-config.properties), a path in the war (e.g. /WEB-INF/myfrevvo-config.properties) or a url (e.g. http://config/cluster1/myfrevvo-config.properties). Be sure to include the frevvo-config.properties file name in the path statement.
Changing the admin password
- Login to your server as user "admin", password "admin".
- On the page that is displayed, click the "Manage Tenants" link.
- Click the 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.
Email configuration
The forgot password functionality and form submissions sent via email both require proper configuration of ' smtp component.
- Edit <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml
- Configure the Mail mail/frevvoDS Resource
Here is a sample mail/frevvoDS resource configuration for Apache Tomcat 6.x:
Code Block | ||
---|---|---|
| ||
<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 frevvo.xml file contains a few other parameters that effect emails sent from :
Code Block | ||
---|---|---|
| ||
<Parameter name="frevvo.mail.from.email" value="" override="false"/>
<Parameter name="frevvo.mail.debug" value="false" override="false"/>
<Parameter name="frevvo.mail.bounce.email" value="" override="false"/> |
Although there is a parameter 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. Here's how it works:
- If you enter an email address in the frevvo.xml parameter and leave the Email address fields on the Edit Tenant screen blank - Doc action emails will use the frevvo.xml from email value and task notification will use tenant admin's email address.
- If you enter a value into the Email address fields on the Edit tenant page - Doc action and task notification emails will use this value. The value in the frevvo.xml file is overridden.
If you want to use the frevvo.xml value for Doc action emails, leave the tenant from email address blank. This would mean flow task notifications will use tenant admin's email address.
Debug sends more debugging info to the tomcat log files. And bounce.email sets an address to receive emails that cannot be delivered to the to email recipients.
If your email server does not use TLS connection security, change mail.smtp.starttls.enable from true to false.
Code Block | ||
---|---|---|
| ||
mail.smtp.starttls.enable="false" |
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.
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:
Code Block |
---|
mail.smtp.socketFactory.port="465"
mail.smtp.socketFactory.class="javax.net.ssl.SSLSocketFactory"
mail.smtp.socketFactory.fallback="false" |
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.
There are two files where the changes to default the tenant login to your tenant name can be made: web.xml or the frevvo.xml. The recommended approach is to add the configuration parameters to the frevvo.xm;l file as it keeps all your modified parameters in one place and makes it easy to upgrade to newer releases. Since the file is outside the frevvo war, you avoid the unzip/rezip of the of the frevvo.war that is needed if you make the changes in web.xml. Examples containing the context parameters for both files are shown below.
To make the changes in <frevvo-home>\tomcat\webapps\frevvo\WEB-INF\web.xml file, follow these steps. At step4, uncomment the frevvo.default.login.tenent.id parameter and set the param-value to the name of your one tenant.
Here is how the parameter appears after editing for a tenant named ssotest:
Code Block |
---|
<context-param>
<param-name>frevvo.default.login.tenant.id</param-name>
<param-value>ssotest</param-value>
<description>Default Tenant</description>
</context-param>
|
Restart your server and the next time you login you will only need to enter your username and password.
These config parameters can be overridden if you configure them in the <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml instead of web.xml. If you make the changes in the frevvo.xml file (recommended), add this parameter: be sure to change the "your_tenant_id" to the name of your tenant
Code Block |
---|
<Parameter name="frevvo.default.login.tenant.id" value="your_tenant_id" override="false"/>
|
In-house customers, logging in as the ' server superuser admin, must still login with username admin@d.
Customizing the placeholder on the login screen
You may want to customize the user@tenant placeholder on the login screen to reflect the name of your tenant to minimize confusion for your users or to remove the @tenant from the placeholder if you have defaulted the tenant login.
In-house customers can change the default placeholder on the login screen by modifying the values for the frevvo.login.username.placeholder context parameter. These context parameters are found in the web.xml file located in the frevvo.war. If you prefer not to unzip the war file you can add them to the frevvo.xml file instead. Making the changes here makes it easier when you are upgrading your version.
Follow these steps to change the placeholder value in the frevvo.xml file:
- Stop Live Forms if it is running.
- Navigate to <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml.
- Open the file with a text editor.
Add the parameter(s) shown below with your modified values in between the double quotes to the frevvo war settings section then save the file.
Code Block <Parameter name="frevvo.login.username.placeholder" value="user@mycompany" override="false"/>
- Restart .
You can unzip the <frevvo-home>\tomcat\webapps\frevvo.war file and add the parameters to web.xml file instead of making the changes in the frevvo.xml file.
...
Section | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
frevvo Properties File
The frevvo-config.properties is a standard java properties file (see some examples here). All of the context-parameters currently found in web.xml or any valid context parameter can be configured in this file.
For example, say you are using the Weblogic Server and you need to set the frevvo.link.default.url to http://mycompany.com and move the Data Sources panel to the top of the designer.
- Create the frevvo-config.properties file. Refer to frevvo-config.properties location for information about where the file should reside. The context-parameters follow a simple context-parameter=value syntax (shown below) in the frevvo-config.properties file:
Code Block |
---|
frevvo.link.default.url=http://frevvo.com/
frevvo.data.sources.top=true |
Updating the frevvo-config.properties requires server re-start.
frevvo-config.properties location
- Expand the war, edit/create the /WEB-INF/frevvo-config.properties, re-zip the war. This is essentially the same as editing the web.xml directly.
- Create the file in the current working directory of the container you are using. will pick it up by default. For example, <frevvo-home>/tomcat is the current working directory for the tomcat container.
Place the frevvo-config.properties somewhere in the file system (outside the frevvo.war) and then add -Dfrevvo.config=file:Drive:/path to frevvo-config.properties in the java executable call. For example, add it to <frevvo-home>\tomcat\bin\setenv.bat, setenv.sh or service.bat if you are using the tomcat container. Here is an example of the <frevvo-home>\tomcat\bin\setenv.bat file with the added parameter:
Code Block |
---|
set JAVA_OPTS=-Xms256m -Xmx1024m -XX:MaxPermSize=156m -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled -Dfile.encoding=UTF-8 -Djava.awt.headless=true -Dfrevvo.config=file:C:/frevvo/tomcat/frevvo-config.properties |
The value of frevvo.config can be a full path (e.g. Drive:/pathtomyfrevvo-config.properties), a path in the war (e.g. /WEB-INF/myfrevvo-config.properties) or a url (e.g. http://config/cluster1/myfrevvo-config.properties). Be sure to include the frevvo-config.properties file name in the path statement.
Changing the admin password
- Login to your server as user "admin", password "admin".
- On the page that is displayed, click the "Manage Tenants" link.
- Click the 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.
Email configuration
The forgot password functionality and form submissions sent via email both require proper configuration of ' smtp component.
- Edit <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml
- Configure the Mail mail/frevvoDS Resource
Here is a sample mail/frevvoDS resource configuration for Apache Tomcat 6.x:
Code Block | ||
---|---|---|
| ||
<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 frevvo.xml file contains a few other parameters that effect emails sent from :
Code Block | ||
---|---|---|
| ||
<Parameter name="frevvo.mail.from.email" value="" override="false"/>
<Parameter name="frevvo.mail.debug" value="false" override="false"/>
<Parameter name="frevvo.mail.bounce.email" value="" override="false"/> |
Although there is a parameter 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. Here's how it works:
- If you enter an email address in the frevvo.xml parameter and leave the Email address fields on the Edit Tenant screen blank - Doc action emails will use the frevvo.xml from email value and task notification will use tenant admin's email address.
- If you enter a value into the Email address fields on the Edit tenant page - Doc action and task notification emails will use this value. The value in the frevvo.xml file is overridden.
If you want to use the frevvo.xml value for Doc action emails, leave the tenant from email address blank. This would mean flow task notifications will use tenant admin's email address.
Debug sends more debugging info to the tomcat log files. And bounce.email sets an address to receive emails that cannot be delivered to the to email recipients.
If your email server does not use TLS connection security, change mail.smtp.starttls.enable from true to false.
Code Block | ||
---|---|---|
| ||
mail.smtp.starttls.enable="false" |
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.
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:
Code Block |
---|
mail.smtp.socketFactory.port="465"
mail.smtp.socketFactory.class="javax.net.ssl.SSLSocketFactory"
mail.smtp.socketFactory.fallback="false" |
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.
There are two files where the changes to default the tenant login to your tenant name can be made: web.xml or the frevvo.xml. The recommended approach is to add the configuration parameters to the frevvo.xm;l file as it keeps all your modified parameters in one place and makes it easy to upgrade to newer releases. Since the file is outside the frevvo war, you avoid the unzip/rezip of the of the frevvo.war that is needed if you make the changes in web.xml. Examples containing the context parameters for both files are shown below.
To make the changes in <frevvo-home>\tomcat\webapps\frevvo\WEB-INF\web.xml file, follow these steps. At step4, uncomment the frevvo.default.login.tenent.id parameter and set the param-value to the name of your one tenant.
Here is how the parameter appears after editing for a tenant named ssotest:
Code Block |
---|
<context-param>
<param-name>frevvo.default.login.tenant.id</param-name>
<param-value>ssotest</param-value>
<description>Default Tenant</description>
</context-param>
|
Restart your server and the next time you login you will only need to enter your username and password.
These config parameters can be overridden if you configure them in the <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml instead of web.xml. If you make the changes in the frevvo.xml file (recommended), add this parameter: be sure to change the "your_tenant_id" to the name of your tenant
Code Block |
---|
<Parameter name="frevvo.default.login.tenant.id" value="your_tenant_id" override="false"/>
|
In-house customers, logging in as the ' server superuser admin, must still login with username admin@d.
Customizing the placeholder on the login screen
You may want to customize the user@tenant placeholder on the login screen to reflect the name of your tenant to minimize confusion for your users or to remove the @tenant from the placeholder if you have defaulted the tenant login.
In-house customers can change the default placeholder on the login screen by modifying the values for the frevvo.login.username.placeholder context parameter. These context parameters are found in the web.xml file located in the frevvo.war. If you prefer not to unzip the war file you can add them to the frevvo.xml file instead. Making the changes here makes it easier when you are upgrading your version.
Follow these steps to change the placeholder value in the frevvo.xml file:
- Stop Live Forms if it is running.
- Navigate to <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml.
- Open the file with a text editor.
Add the parameter(s) shown below with your modified values in between the double quotes to the frevvo war settings section then save the file.
Code Block <Parameter name="frevvo.login.username.placeholder" value="user@mycompany" override="false"/>
- Restart .
You can unzip the <frevvo-home>\tomcat\webapps\frevvo.war file and add the parameters to web.xml file instead of making the changes in the frevvo.xml file.
- Follow the steps listed above to unzip the <frevvo-home>\tomcat\webapps\frevvo.war.
- Locate and uncomment the frevvo,login,username,placeholder context parameter in the file.
- Edit it with desired placeholder at step 4.
- Complete the remainder of the steps listed above.
Code Block |
---|
<context-param>
<description>Value displayed as a place holder in the username control on login pages</description>
<param-name>frevvo.login.username.placeholder</param-name>
<param-value>user@frevvo.com</param-value>
</context-param> |
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 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. 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:
- Edit <frevvo-home>/tomcat/conf/server.xml
- Change the Connector port
<Connector port="8082" protocol="org.apache.coyote.http11.Http11NioProtocol"
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. Supported Browsers for Version 5.3 can be found here but by default this version will not warn users if they access the system using an uncertified browser. If you want your users to get a warning, you can configure a list of allowed browsers using the the frevvo.supported.browsers parameter in the web.xml or frevvo.xml (recommended) files if you are using in-house.
To do this, you will have to edit the file: <frevvo-home>\tomcat\webapps\frevvo\WEB-INF\web.xml. If you choose to make this change in web.xml, you will have to extract it from the <frevvo-home>\tomcat\webapps\frevvo.war zipfile.
...
The steps to do this are explained here.
Once you have unzipped the frevvo.war file, please find the following context parameter: In version 5.3, this parameter is commented out. Be sure to uncomment the parameter using the <!-- --> comment characters. Here is what it looks like initially:
Code Block |
---|
<context-param> <param-name>frevvo.loginsupported.username.placeholder<browsers</param-name> <param-value>user@frevvo.com<value>*</param-value> <description>Supported browsers - array of allowed user agents</description> </context-param> |
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 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. 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:
- Edit <frevvo-home>/tomcat/conf/server.xml
- Change the Connector port
<Connector port="8082" protocol="org.apache.coyote.http11.Http11NioProtocol"
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. Supported Browsers for Version 5.3 can be found here but by default this version will not warn users if they access the system using an uncertified browser. If you want your users to get a warning, you can configure a list of allowed browsers using the the frevvo.supported.browsers parameter in the web.xml or frevvo.xml (recommended) files if you are using in-house.
To do this, you will have to edit the file: <frevvo-home>\tomcat\webapps\frevvo\WEB-INF\web.xml. If you choose to make this change in web.xml, you will have to extract it from the <frevvo-home>\tomcat\webapps\frevvo.war zipfile. The steps to do this are explained here.
Once you have unzipped the frevvo.war file, please find the following context parameter: In version 5.3, this parameter is commented out. Be sure to uncomment the parameter using the <!-- --> comment characters. Here is what it looks like initially:
Code Block |
---|
<context-param>
<param-name>frevvo.supported.browsers</param-name>
<param-value>*</param-value>
<description>Supported browsers - array of allowed user agents</description>
</context-param> |
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 | ||
---|---|---|
| ||
<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> |
Save the file. Rezip the frevvo.war file as explained here. We recommend restarting the Server if possible. Once the server is restarted, Firefox 5 will now be a supported browser in your deployment along with all the others listed in the example.
You can also configure this parameter in <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml - which is the recommended approach when using the tomcat container. Here is what the parameter looks like in the frevvo.xml file. In this example, only the Internet Explorer browser is allowed. Using any other browser will result in the warning message to the user.
Code Block |
---|
<Parameter name="frevvo.supported.browsers" value="msie, trident/7" override="false"/> |
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 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 | ||
---|---|---|
| ||
<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> |
Save the file. Rezip the frevvo.war file as explained here. We recommend restarting the Server if possible. Once the server is restarted, Firefox 5 will now be a supported browser in your deployment along with all the others listed in the example.
You can also configure this parameter in <frevvo-home>\tomcat\conf\Catalina\localhost\frevvo.xml - which is the recommended approach when using the tomcat container. Here is what the parameter looks like in the frevvo.xml file. In this example, only the Internet Explorer browser is allowed. Using any other browser will result in the warning message to the user.
Code Block |
---|
<Parameter name="frevvo.supported.browsers" value="msie, trident/7" override="false"/> |
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:
Code Block | ||
---|---|---|
| ||
<!-- HTTPS Connector
<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" />
--> |
Note that in case you want to change the default HTTPS port, you not only have to change the Tomcat connector's port above, but you also have to change the '''frevvo.port.ssl''' parameter found in </frevvo/-home>/tomcat/conf/localhost/frevvo.xml:
Code Block | ||
---|---|---|
| ||
<Parameter name="frevvo.port.ssl" value="8443" override="false"/> |
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.
Code Block |
---|
External Access -> Proxy (Apache/IIS...) -> frevvo (tomcat) |
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:
- 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.log - all messages are logged to this file.
- 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
...
language | html/xml |
---|
...
- . Comment out the statement below to turn off logging to this file if it is not needed.
Code Block |
---|
<Valve className="org.apache.coyotecatalina.http11valves.Http11NioProtocolAccessLogValve" SSLEnableddirectory="true${catalina.base}/logs" maxThreads="150" scheme="https" secure="true" clientAuth="false" sslProtocolprefix="TLSlocalhost_access_log." keystoreFilesuffix="${catalina.home}/conf/keystore" keystorePass="password".txt" connectionTimeout="20000" maxHttpHeaderSize="32768" pattern="%h %l %u %t "%r" %s useBodyEncodingForURI="true" /> --> |
Note that in case you want to change the default HTTPS port, you not only have to change the Tomcat connector's port above, but you also have to change the '''frevvo.port.ssl''' parameter found in </frevvo/-home>/tomcat/conf/localhost/frevvo.xml:
Code Block | ||
---|---|---|
| ||
<Parameter name="frevvo.port.ssl" value="8443" override="false"/> |
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.
Code Block |
---|
External Access -> Proxy (Apache/IIS...) -> frevvo (tomcat) |
...
%b "%{Referer}r" "%{User-Agent}r" [%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:
|
...
|
Debugging logfile levels
The logging levels used by can be fine-tuned by editing the <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 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.
You can obtain more debugging information, if needed, by following the steps below to change the loglevel. You will see the results of the changes in <frevvo-home>/tomcat/logs. The current date appends to the logfile name for all the files except the frevvo log:
...
/
...
frevvo.log
...
.
- Go to <frevvo-home>/tomcat/
...
Code Block |
---|
<Valve className="org.apache.catalina.valves.AccessLogValve" directory="${catalina.base}/logs"
prefix="localhost_access_log." suffix=".txt"
pattern="%h %l %u %t "%r" %s %b "%{Referer}r" "%{User-Agent}r" [%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:
|
Debugging logfile levels
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.
You can obtain more debugging information, if needed, by following the steps below to change the loglevel. You will see the results of the changes in <frevvo-home>/tomcat/logs/frevvo.log.
- Go to <frevvo-home>/tomcat/lib
- Open the file logback.xml for editing
- Find <root level="INFO"> and change the word INFO to DEBUG. Save the file.
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 cummulative as shown below. Refer to this 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 Click here for more information.
If you are having issues running the server in an environment with proxy setups, load balancers etc. the forms.ui.filter logger can help. This logger will output additional information to the frevvo.log file to assist in determining what the frevvo servlet is seeing. To enable this logger uncomment the following line in logback.xml:
Code Block | ||
---|---|---|
| ||
<logger name="com.forms.forms.ui.filter" level="DEBUG" /> |
Logfile Rotation
...
- lib
- Open the file logback.xml for editing
- Find <root level="INFO"> and change the word INFO to DEBUG. Save the file.
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 cummulative as shown below. Refer to this 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 Click here for more information.
If you are having issues running the server in an environment with proxy setups, load balancers etc. the forms.ui.filter logger can help. This logger will output additional information to the frevvo.log file to assist in determining what the frevvo servlet is seeing. To enable this logger uncomment the following line in logback.xml:
Code Block | ||
---|---|---|
| ||
<logger name="com.forms.forms.ui.filter" level="DEBUG" /> |
Logfile Rotation
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 the <frevvo-home>\tomcat\logs\old directory. Logging for 6 - 20 - 2013 is saved in the frevvo.log in <frevvo-home>/tomcat/logs.
Using Debug Mode to see logged in users
If the log level is set to DEBUG, then you will see user login and logout information in the <frevvo-home>\frevvo\tomcat\logs\frevvo.log file. Examples of log entries are shown below. Search for “Server num users” in the log file to quickly see the number of currently logged in/out users. Note the first log entry below shows the number of users currently logged in. Showing the list of currently logged in users via the UI to the superuser and tenant admins is planned for a future release.
User login:
10:01:40.813 |-DEBUG [http-nio-8082-exec-1] [ c.f.u.UsersMonitor] - Tenant (qa): login: num users: 1. Server num users: 1
--Number of currently logged in users
10:01:40.816 |-INFO [http-nio-8082-exec-1] [ c.f.b.d.DBUtil] - Getting User info for customer: fd tenant: qa
---User who is logging in
User Logout:
10:02:03.287 |-DEBUG [http-nio-8082-exec-5] [ c.f.u.UsersMonitor] - Tenant (qa): logout: num users: 0. Server num users: 0
10:02:03.287 |-DEBUG [http-nio-8082-exec-5] [f.f.w.SessionFormsListener] - Forcing a Subject qa@fd logout on session expiration ...
---User who is logging out
Session Timeout
's default web browser session timeout is 480 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 480 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.
...
The following screen displays when a user tries to submit a form from a timed out session.
Editing Submissions
Designer users can view/edit submissions by clicking the edit link on the submissions panel. Non designer users can view/edit submissions by clicking on the Shared Items tab if they have been granted permission to do so by the designer via the Access Control feature. The frevvo.submission.edit .link parameter must be set to the default value of true, for the edit link to be visible to any user. To disable the edit link on the submission panel, change the default value of true to false for the frevvo.submissions.edit.link configuration parameter in <frevvo-home>/WEB-INF/web.xml file. The web.xml file must be unzipped from the frevvo.war before it can be edited. Follow the instructions above to unzip, modify and rezip the war file.
...