Please give details of the problem



Web Interface Engine Upgrade

This document helps identify preparation work required before upgrading the Web Interface Engine used by your application.

1 Overview

Upgrades to the Web Interface Engine are made periodically. While it is possible to continue to use a previous version, at some point you may wish to upgrade to the latest version - this may be to take advantage of a new feature or for performance improvement.

This document highlights features that have been introduced or changed as part of various Engine releases; these changes are ones that could impact on the upgrade of a Web Interface. When upgrading from an engine version that is previous to when the feature or change was introduced, you should make any necessary changes to your Web Interface to ensure that it remains compatible.

Please note that if you make a copy of an existing Web Interface, the copied version will be using the most recent Engine which could be a different version to the one the original Web Interface is using. Under these circumstances, you will need to ensure that the copied Web Interface is compatible with the latest Engine, this document will help you determine what changes are necessary.

2 Current Version

The Engine that your Web Interface is currently using is displayed on the Implementation tab of the Web Interface detail page.


3 Features

The following section considers changes introduced as part of Engine releases which will impact on upgrading Web Interfaces to the latest version.

Mogador v1 (June 13th, 2013) - Change to CSS and introduction of JQuery

Web Interfaces using the Mogador engine or later require JQuery in order to work correctly. Please note that if a designer creates a new Web Interface from an existing one by clicking on the copy button and this Web Interface source was created before the Mogador v1 release, the designer will have to add the jQuery framework so that the new Web Interface works properly.

Adding the JQuery library can be done by opening your Web Interface, choosing the Java Script tab and choosing to Add a JS Library.


Please be aware that the look and feel of the upgraded Web Interface will be significantly different as the CSS was re-written as part of this release.

Lifou v2+ (April 15th, 2015) - Escape character in scripts

Web interfaces with an engine version Lifou v2 or more recent use a different escape rule in embedded scripts. In these more recent web interfaces, a simple \ is used to escape special characters instead of a double \\. This applies in all scripted properties of the widgets - scripts, urls, regular expressions and so on. As an example, consider the widget email pattern. An email widget is simply a text input using a regular expression to check if the filled in information is indeed an email.

Before the Lifou v2 release, the pattern was:


After the Lifou v2 release the pattern became:


Lifou v3+ (June 3rd, 2015) - Post loaded script

Web interfaces using engine version Lifou v3 or more recent execute the post loaded script of reports whenever data is loaded into the report (computing a filter, navigating from page to page, refreshing the data via JavaScript or manually). Web Interfaces using engine version Lifou v2 or older, however, execute the post loaded script only after the first load of data.

Java v2+ (November 12th, 2015) - Array

Engine versions more recent than Java v2, support the following syntax in dynamic rules.


Web Interfaces using Java v2 or previous versions will need to be tested following upgrade to ensure that the syntax change has not created any problems.

Wight v1+ (February 3rd, 2016) - JavaScript Report & variable visibility

The scope of variables and functions defined in the Loading data script was reduced with this release, this script is used in JavaScript reports. Variables and functions defined within this script are therefore no longer accessible outside of this script.

When upgrading from a previous engine version, you should ensure that no references are made to the variables and functions from outside the script.

4 Upgrading the Web Interface

To proceed with upgrading your Web Interface to the latest version, click on UpgradeButton which can be found next to the engine version that is currently being used. This can be found on the Implementation tab of the Web Interface detail page.