frevvo v7.2 contains new features that improve usability and makes designing forms easier. Here are a few of the top reasons to upgrade:
- Visual Rule Builder v1.
URLs no longer include the designer's user id.
- "Lookup" parameter added to the formtype, flowtype, formid and flowid. This is very helpful when troubleshooting.
- Rename attachments uploaded to forms/flows using the Upload control.
On This Page:
We recommend that you read the information below before you begin.
Automatic Upgrade for Live Forms Online (Cloud Hosted) Customers
Live Forms Online cloud hosted customers will be automatically upgraded on April 29,2017. The automatic cloud upgrade will be seamless. Cloud customers should review these topics to prepare for the new version of frevvo.
If you have any questions, please email firstname.lastname@example.org.
Migration Considerations for Cloud and In-house Customers
Visual Rule Builder
frevvo resources, Applications, Forms, Flows, Spaces and more are referenced with opaque URLs. Use of opaque URLs eliminates security issues that may have been present with URLs that exposed a designer user's id. Opaque URLs replace the user id (…/user/user.id/…) that was used in the previous format with a universally unique identifier (uuid) …/u/user.uuid/… The uuid, is a randomly generated value that is stored in frevvo.
The Opaque URL feature provides:
- URLs that do not include a user's id
- Backward compatibility for URLs that contain a user's id - they will continue to work.
- A reverse lookup function of the opaque URL that can be used to locate a form/flow in a user's account for troubleshooting purposes. This capability is only be available to administrators, tenant administrators and users with the designers or publishers roles in the same tenant.
An example of the opaque URL for a frevvo space named mycompany is shown below:
New version of PVE Connector
A new version of the PVE Connector - v5.4 is now included in the frevvo tomcat bundle. Version 5.4 of the connector is primarily a bug-fix release. Refer to the PVE Connector Release Notes for the issues fixed.
The new version of the PVE connector will be installed when the frevvo cloud is upgraded to v7.2. There are no changes to the PVE connector configuration for in-house customers who are upgrading using the v7.2 tomcat bundle. In-house customers using a version of frevvo previous to v7.2 can download the PVE connector from here or download the tomcat bundle to retrieve the v5.4 connector. Simply replace the existing pve.war file with the new one.
New Database Connector version
A new version (v2.5) of the Database Connector is included in the frevvo tomcat bundle. It is also available in a separate download. Cloud customers who are running the Database Connector on an in-house server should review the information below. Refer to the Database Connector documentation for installation and configuration information about the new version.
Change to Doc URI format when initializing a form from submission xml
You may have forms that you want to populate with data from a submission so that your users see the data, edit it if needed and submit again to create new submission. One way to initialize a form from a submission is to use the form submission xml link and the Doc URI wizard. Changes were made to ensure that cookies and secure sessions are used for the http get back to frevvo to obtain the submission data.
The <host:port> section of the form submission xml link must be changed in the Doc URI wizard to "frevvo://" to take advantage of this change. Refer to the example in the Initializing Forms with XML Documents topic for the details.
Change to Rule when using HTTP Get and Task for First Step
It is possible to "kick off" a workflow from a form by using a business rule that performs an http get with the URL to the workflow. The Task for First Step property must be checked in the workflow for this to work. After upgrading to v7.2+, the designer must modify any written rules that contain an http get url call to trigger Task for First Step. The change is described below:
- Cloud customers must change http://app.frevvo.com to frevvo:// in the rule that kicks off the flow.
- In-house customers must change the http:<domain>:<port> to frevvo:// in the rule that kicks off the flow.
A Changing the filename of an uploaded attachment topic for the details.
The original filename will be used as the download name when downloading attachments from upgraded submissions.
Migration Considerations for Live Forms In-house Customers
Changes to Supported Platforms
Java 1.7 and the Java Runtime Environment are no longer supported. In-house customers should upgrade to Java 8 and install the Java Development Kit before upgrading to frevvo v7.2+. Please review Supported Platforms for a complete list.
New version of the Database Connector
The In-house version of frevvo was released on 5/12/17. A new version (v2.5) of the Database Connector will be included in the frevvo tomcat bundle. It is also available in a separate download.
Version 2.5 of the database connector requires frevvo 7.2 and Java 8.
The Database Connector is included in the tomcat bundle and is also available as a separate zipfile. You can download it here.
The database.war does not extract after startup. You will not see a database subfolder in the <frevvo-home>\tomcat\webapps directory if you are using the tomcat bundle as in previous releases.
If you are running the Database Connector on your in-house server, customers must upgrade to frevvo v7.2+ to use the Database Connector v2.5. There are 2 options:
- Copy the configuration from your previous installation and the connector will continue to function as it did before. The DB v2.5 connector runs seamlessly with the DB Connector v2.4 configuration files.
- Read the documentation for new configuration instructions to take advantage of the new features.
Here are a few items that you should be aware of:
- NULL columns and empty strings, which were previously treated as NULLS, are now being sent instead of leaving them out of the JSON/XML returned by the Database Connector. Version 2.5 of the connector explicitly handles NULLs. If this causes issues, it can be turned off by adding the emitNullColumns property to the query/query set in configuration.xml or adding the dbconnector.emitNullColumns property to your dbconnector properties file. This disables this new behavior for the whole db connector and reverts to the old behavior so you can address any issues. The recommended approach moving forward is to add the emitNullColumns=true (the default) to your queryset/queries.
- The database.war is now executable. Version 2.5 of the Database Connector can run in any servlet container, such as tomcat, or in standalone mode. There is also a Kiosk mode for quick demos of the feature
- The date/dateTime/timestamp formats that (almost) all configuration.xml have may be removed in most cases as the defaults now match what frevvo sends to the DBConnector. <queryset name="BIRT" dateFormat="yyyy-MM-dd" xmlDateFormat="yyyy-MM-dd" xmlTimeStampFormat="MM/dd/yyyy">
- Configuration.xml with invalid queries will show warnings when the Database Connector starts and will be disabled automatically.
- In previous releases of the Database Connector, any errors while inserting, updating, selecting row(s) using the DB connector were simply logged and ignored, returning an HTTP 200 status. These errors will come back as 500 errors to frevvo.
Review the DB Connector Release Notes for a complete list of the enhancements to help you decide.
ACL Changes for Confluence Users
Version 7.2 of Live Forms includes some changes when assigning permissions to view/edit submissions and editing forms/flows of other designers via the Access Control List.
The Who can View/Edit Submission Permission:
In previous releases, Confluence users granted permission to View/edit form/flow submissions had to have the frevvo.Designer and frevvo.Editor roles in addition to the Who can view/edit permissions in the Live Forms Access Control list for the form/flow.
The role restrictions has been removed in frevvo v7.2. Permission to edit form/flow submissions is now controlled only by the Live Forms Access Control List.
Be sure that the users/roles that you want to have this permission are listed in the Access Control list for the relevant forms/flows.
The Who can edit a form/flow permission:
The Who can edit a form/flow permission in the ACL gives permission for users to edit forms/flows (including those owned by other designer users) in the Live Forms designers. Non-designers can be given permission to edit forms/flows belonging to other designer users by listing them in the form/flow Access Control list. The form.Editor and form.Designer roles are no longer required in most cases.
There is one exception - If your Confluence plugin is configured with a Forms Designer Group, any user that wants to do any design related functionality must be in this group (must have the frevvo.Designer role). Users that have form/flow edit permission in the ACL, must also belong to the group specified by Forms Designer Group field on the Confluence plugin configuration screen in order to edit the forms/flows of another designer user.
Refer to the Add-on Installation topic for the complete configuration information.
The form.Editor role works as it always did. Users assigned to the Confluence group listed in the Form Editor field on the Confluence configuration screen will be able to edit forms and flows belonging to any designer user.
New version of the .NET API
v7.2 of the .NET API is available as a separate download. The new version contains a bug fix to support URLS that do not expose the user id. Refer to the Data API Client Libraries Release Notes which includes the link to download it,
Just a Reminder for In-house Customers
In-house customers should review the topics below, the instructions in the Upgrade Guide and Supported Platforms before migrating. It is recommended that you perform a full installation of frevvo v7.2.0 when upgrading.
v7 License Key Required if you are upgrading from a version prior to Live Forms v7.x
Request a v7 license by emailing email@example.com BEFORE you begin the upgrade. v5 and v6 licenses will not work.
Hardware and Memory Requirements for your Live Forms Server
The minimum recommended hardware configuration for your Live Forms server is:
- 2 gigahertz (GHz) 64-bit (x64) processor with 4 cores
- 5 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/flows increases so must the system memory. Refer to the memory configuration topic for the details.
Insight Server Memory Requirements
The Insight Server and Service (Batch job) MUST be configured to take full advantage of the Reporting and the v7.2 Submission view and search capability. Do NOT disable it in the <frevvo-home>\tomcat\Catalina\localhost\frevvo.xml file.
It may be necessary to increase heap size for the Insight server, when reporting on/indexing a large number of submissions. Refer to the memory configuration topic for the details.
Database Configuration moved to server.xml file
The database configuration that was done in the <frevvo-home>\tomcat\conf\catalina\localhost\frevvo.xml file has been moved to the <frevvo-home>\tomcat\conf\server.xml file. Also, note that the datasource in the server.xml file has been renamed to jdbc/sharedfrevvoDS so that it can be shared by frevvo and the Insight server.
Configuring the database has not changed. The difference is that it is now done in the server.xml file and not frevvo.xml as in previous releases. When you configure your database, make the changes in the v7.2.0 server.xml file. Do not replace configured sections from a frevvo.xml from a previous release into the v7.2.0 server.xml. file.
Email Configuration and custom configuration parameters are still configured in the frevvo.xml file. frevvo requires Insight software for the Reporting and Submissions View feature. The Insight software is included in the tomcat bundle. The Insight server MUST be started BEFORE starting frevvo. Instructions for Windows and Linux operating systems are listed here: Windows: You will see this message: If you close the Insight server (Solr) startup window, the server will stop running. Leave the window open or set up Live Forms and the Insight Server to run as Windows services. Linux: You do not have to restart the Insight server every time you restart frevvo.
Start the Insight server before Live Forms
chmod +x solr
bin/solr start - this starts the Insight server in the background, listening on the default port 8983.
frevvo requires Insight software for the Reporting and Submissions View feature. The Insight software is included in the tomcat bundle. The Insight server MUST be started BEFORE starting frevvo. Instructions for Windows and Linux operating systems are listed here:
You will see this message:
If you close the Insight server (Solr) startup window, the server will stop running. Leave the window open or set up Live Forms and the Insight Server to run as Windows services.
You do not have to restart the Insight server every time you restart frevvo.