Section | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
Please read the following upgrade steps prior to starting the migration.
Note |
---|
frevvo recommends that you test the upgrade process on your test server before performing it on your production server. Contact your frevvo Account Manager for information if you do not have a test environment. |
Prepare for the upgrade
- Upgrade Resources
- v10 will only allow upgrade of resources that are v9 and later. Each user's account and associated resources is upgraded the first time they log in after each upgrade. Users who never log in (old or stale users, perhaps) may have an account that is several versions behind. This can also happen if you are doing a multi-step upgrade from a version prior to v9.
- To help admins manage this, in v9 the User Upgrade Threshold was introduced in the Configuration Checklist screen. The admin can use the information in this table to either delete the non-upgraded users or login as that user to upgrade them.
You must login-as each user listed in order to upgrade their resources (or remove them if the accounts are old/stale.) If you skip this step and have pre-v9 resources, your v10 upgrade will fail.
Note title LDAP Users LDAP Security Manager tenants may see users listed in the Configuration Checklist - User Upgrade Threshold that no longer exist in the AD, and cannot be deleted or upgraded in the UI. To resolve this, please contact support@frevvo.com.
Please read and understand the Migration Considerations which may require your action before beginning.
- Install OpenJDK (11.x)before beginning.
Stop with one of the methods listed below:
Execute <frevvo-home>\stop-frevvo.[bat,sh] for versions previous to v10.x.
If you are upgrading from v7.x, you will also need to stop the Insight Server by closing the window or if you are using the tomcat bundle by typing these commands in the <frevvo-home>\solr directory of your existing installation.
bin\solr.cmd stop -allStop frevvo and the Insight Server through the Computer Management Services console if they are running as Window's services.
- Backup the forms database from your current installation.
Backup the current server's installation directory so that you have a copy of all custom configuration parameters.
- Request a v10 license if you are upgrading from a version prior to v10.0.x.
...
- Download the latest v10.0.x software. The download is a zip file. Extract the contents to any folder of your choice. This folder will be referred to as <frevvo-home> (note that the zip already contains a top level frevvo folder).
- Install a JDBC Driver.
- If you increased Memory Settings in your previous installation, make those changes to the appropriate files in the new installation. Refer to Hardware and Memory Requirements for the details.
- Navigate to the server.xml file in the <frevvo-home>\tomcat\conf directory of your v10.0.x installation
Configure the Database and Email
...
Expand | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||
The frevvo.xml and insight.xml files are embedded in the frevvo war in v10.0.x. Configuring features is now done by adding properties to the <frevvo-home>\tomcat\frevvo-config.properties file. The properties follow a simple property=value syntax. The frevvo-config.properties file provided in the frevvo tomcat bundle contains default values for the following properties:
Context parameters, previously added to the frevvo.xml or modified in web.xml and insight.xml files, must be converted to the property format. Follow the instructions below.
2. Add properties for any parameters that you added to the frevvo.xml in your previous installation. Refer to Installation Tasks for information about additional configuration properties that can be added to the frevvo-config.properties file to customize features. 3. Any parameter changes that were made to the web.xml file in previous releases must be converted to properties and added to the frevvo-config.properties file.
|
Start the Insight Server
Restore the contents of the <frevvo-home>\data\solr directory from the previous installation directory backup that you made in the Prepare for Your Upgrade section to your latest version's <frevvo-home>\data directory. Then, follow the steps to start the Insight server BEFORE starting .
Info |
---|
You If you do not restore the Insight server index files located in the <frevvo-home>\data\solr directory, you can run the Refresh Searchable Fields process manually once the upgrade is complete. The process should be run after hours when your users are not using your forms/flows. |
Windows:
- Open a command prompt. Navigate to <frevvo-home>\solr. Type bin\solr.cmd start to run the Insight server in the background, listening on the default port 8983.
You will see this message:
Warning If you close the Insight server (Solr) startup window, the server will stop running. Leave the window open or see these instructions to remove existing services and set up frevvo and the Insight Server to run as Windows services:
Browse http://<your server:port>/ solr to verify the Insight server is running. The <server:port> default values are localhost:8983. Change localhost to the server name and 8983 to the port the Insight server is running on if they are different than the defaults. Do not include the angle brackets <>. You will see the Insight server (Solr) dashboard with the current status.
...
- Ensure that the scripts are executable: chmod 755 <frevvo-home>/tomcat/bin/*.sh
- Navigate to <frevvo-home>/solr/bin. Run this command to make the solr startup file executable:
chmod +x solr - Navigate back to the solr directory.
cd .. - Start the Insight server by typing: bin/solr start - this starts the Insight server in the background.
- Browse http:<your server:port>/solr to verify the Insight server is running. The <server:port> default values are localhost:8983. Change localhost to the server name and 8983 to the port the Insight server is running on if they are different than the defaults. Do not include the angle brackets <>. You will see the Insight server (Solr) dashboard with the current status.
...
- Login as a tenant admin
- Click on the Configuration Checklist link to verify that all configurations are complete.
- Click on the Reports link. Click on one of the Reports to verify that submission data is displayed.
- Login as a tenant designer user
- View and edit a form/flow
- Verify that your submissions are displayed when you click the Submissions and Legacy submissions icons.
- Test forms/flows
Login as the superuser admin.
- Verify that the Refresh Searchable Items process ran and completed successfully.
Troubleshooting
It is recommended that you do not change or delete the frevvo.users.schemaName property in the frevvo-config.properties file after the first startup of v10.0.x. If the property is changed or deleted post migration you may see this error:
...
Warning |
---|
If you start before the Insight server, you will see this message when you browse the login URL. Follow these steps to start the servers in the correct order: Navigate to your <frevvo-home> directory. Run the stop-frevvo.bat or stop-frevvo.sh file depending on your Operating system to stop . Open a command prompt. Navigate to <frevvo-home>\solr-6.6.2 Start the Insight server. Refer to Start the Insight Server above for the instructions. Browse http://<your server:port>/solr to verify the Insight server is running. The <server:port> default values are localhost:8983. Change localhost to your server name and 8983 to the port the Insight server is running on if they are different from the defaults.Do not include the angle brackets <>. Start . |
Applying a Minor Patch Update
If you're applying a minor patch update, for example, applying patch 10.0.x to your installed v10.0.0 frevvo server, you can follow these simple steps instead of the more lengthy upgrade steps.
Note |
---|
The latest major version and the compatible frevvo connectors are available from the frevvo Software Downloads Directory. |
...
Stop .
Backup the current server's installation directory so that you have a copy of all custom configuration parameters.
- Install the Upgraded Version.
- Download the latest v10.0.x software. The download is a zip file. Extract the contents to any folder of your choice. This folder will be referred to as <frevvo-home> (note that the zip already contains a top level frevvo folder).
- Install a JDBC Driver.
- If you increased Memory Settings in your previous installation, make those changes to the appropriate files in the new installation. Refer to Hardware and Memory Requirements for the details.
- Navigate to the server.xml file in the <frevvo-home>\tomcat\conf directory of your v10.0.x installation
- Configure the database and email.
- Install any 1063038468 that were installed in your previous version.
Restore the contents of the <frevvo-home>\data\solr directory from the previous installation directory backup that you made in Step 2 to your latest version's <frevvo-home>\data directory. Then, start the Insight Server.
Info If you do not restore the Insight server index files located in the <frevvo-home>\data\solr directory, you can run the Refresh Searchable Fields process manually once the upgrade is complete. The process should be run after hours when your users are not using your forms/flows.
- Start .