Before you install an update, make sure you check out the release notes

We recommend you take a backup of the database and all local data before you install the update.

Contents

When updating within a major version of formcycle, it is not necessary to install all intermediate versions.

Step 1: Download the current version

The current version can be downloaded directly from the release notes.

For each version, you can find two different files:

formcycle.war

Contains the master server with the backend and the formcycle  Designer. For the most common use case, you only need this file.

frontend-server.war

The frontend server of formcycle is used to deliver forms.

Whether the inbox is available on the frontend server can now be activated on the configuration page (System settings > Frontend server).

Step 2: Replace the old version

1. Remove the current WAR file on the application server from the Tomcat. In Windows, for example, this is the folder C:\Program Files\Apache\Tomcat 9.0\webapps. The folder formcycle is automatically removed. This folder must be deleted before you continue.
2. Upload or copy the new WAR file to the webapps directory.

It may be necessary to restart the tomcat or application server afterwards. When required, update the configuration file web.xml as well in case you have made any custom changes.

Step 3: Database update

The update can also be run automatically when the system starts, see the system settings > Database.

When you go to the login page, you may get a notifications that a necessary system update is available.

If it does, sign in with a system administrator account and proceed as follows:

1. After signing in as system administrator (sadmin), you will be redirected to the database administration page. Here the settings should be checked again.
2. After clicking the Save and updatebutton, the database and machine are updated.
3. The individual steps are displayed here. When all of them have been completed, the update is finished.

The update is now complete. Further work on the system should now be done with a corresponding normal user account and not as a system administrator.

Please note that updates may also be required for plugins. For this, open the list under System settings > Plugins and under Client > Plugins. You can recognise whether an update is required by the message "Update available".

If you hover over the plugin with the mouse, an update button appears, which then updates to the current version of the plugin. The update is best executed individually and can take a few minutes depending on the size.