Upgrading installations

Upgrading Servoy Application Server

As Servoy 6 is a major release a fresh Servoy Application Server installation is required.

See Installing the Application Server for more information.

Upgrading Servoy Developer

As Servoy 6 is a major release a fresh Servoy Developer installation is required. 

See Installing Developer for more information.

Upgrading existing Solutions

Upgrading existing Solutions to Servoy 6 is as easy as opening Servoy Developer 6 and getting the Solutions into the workspace. As Solutions that are opened in Servoy Developer 6 are updated automatically to be compatible with Servoy 6, they will stop being compatible with earlier versions of Servoy. It is therefor advised to checkout the solutions into a new workspace or import the solutions into the new workspace.

Once imported, the Solutions can be tested with Servoy 6. Servoy 6 introduces a few minor behavior changes, some of which could potentially break existing code. It should be investigated if the upgraded solutions are affected by these changes. The behavior changes are listed and discussed in the paragraph Behavior Changes.

After taking care of the behavior changes, there are 2 tasks left:

Behavior changes

This paragraph describes the behavior changes that are introduced in Servoy 6.0. There are three categories of behavior changes:

  1. Changes that might break existing code
  2. Real behavior changes
  3. Changes that affect the display of the UI

Changes that might break existing code

Behavior changes

Changes affecting the appearance

Resolving warnings and errors

Servoy 6 features a greatly enhanced build mechanism that checks the validity of the design of a Solution while it is being designed. As a result of this improved build system, existing solutions that get opened in Servoy Developer 6 will most likely contain a lot of Problem markers.

It is important to note that these Problem markers are of the level "warning", meaning that it doesn't necessarily mean something is broken!

The majority of the generated Problem markers are most likely related to the JavaScript code contained in the Solutions, as this is one of the area's where the most improvements were made, but some work is required by the developer to get the best results. More on this is discussed below, in the Improved design-time JavaScript code validation alinea.

Another area where Problem markers are raised that were not raised before is the area of using deprecated scripting API. With every release Servoy improved the capabilities in the scripting API. This sometimes means deprecating parts of the API in favor of new and improved API. Deprecating API means that it is marked as "Should not be used anymore", while it continues to function. In servoy deprecated scripting API is hidden in developer.

As of Servoy 6, Problem markers will be generated on the JavaScript code that accesses deprecated API. The API will still function as before, the Problem markers are just an indication that the used API is marked as "Should not use anymore" and that at one point in time the code ought to be rewritten to utilize the new way of doing things. The Deprecated API alinea below provides an overview of the API that got deprecated in Servoy 6.0 and what the replacement functionality is.

Improved design-time JavaScript code validation 

Servoy 6 features greatly improved design-time JavaScript code validation: the entire code base of a solution will be continuously checked for possible coding mistakes, like accessing or setting non existing variables, calling non-existing methods or calling methods with the wrong number or type of parameters.

While this is great once you get going, if you're upgrading an existing solution to Servoy 6, you will most likely get a lot of warnings on your code. Why is that?

JavaScript, the scripting language used in Servoy to write down the business logic is what they call "weak-typed". This means that a variable can hold any type of value, that a function can return any type of value and that the parameter values that can be send into a method call can be of any type. At least: this hold true for JavaScript in it's core.

The new script validation in Servoy Developer 6 however tries to determine if the the properties you access actually exist, if the method you call exist and if you call them with the right number and type of arguments. The validation mechanism tries to be as clever as possible to determine which code is correct and which code isn't, but due to the weak-typed (and dynamic) nature of JavaScript, sometimes clever logic just isn't enough and the validator requires more input from the developer in order to do proper validation. This developer input is done in the form of JSDoc.

While previous versions of Servoy already had support for JSDoc, in Servoy 6 this support has been extended and improved, in order to better facilitate the validation process. For more information on annotating JavaScript using JSDoc see Annotating JavaScript using JSDoc.

While we advise to solve the warnings, so you can also reliable start using some of the other great features of Servoy 6, like automatic code refactoring or search for references, you can ignore the warnings. It's even possible to turn off all the warnings, see Window > Preferences > JavaScript > Error/Warnings.

(warning)  Do note that automated refactoring, Search for References or JavaScript Search might not be 100% complete if JavaScript is not properly annotated using JSDoc, due to which the JavaScript code cannot be fully analysed automatically. 

Deprecated API

Servoy 6 deprecates parts of the existing API, as it has become obsolete or has been replaced by better alternatives. This section lists the deprecated methods or properties with their replacement where applicable.

Designtime API

The list of deprecated properties in the Designtime API is limited. Except for the deprecation of the "rowBGColorCalculation" on Forms and Portals, the deprecation of the properties require no action on behalf of the developer, as Servoy Developer will automatically handle the changes.


The "rowBGColorCalculation" is replaced by both the ability to style odd/even/selected rows using CSS and additionally the new onRender event to do conditional styling. As the calculation or method used for the rowBGColorCalculation property cannot be used for either CSS Styling or the onRender event, the conversion to the new way of doing things is a manual action for the developer.

Forms that have a value set for the rowBGColorCalculation property will continue to show the property in the Form Editor in Servoy Developer and the rowBGColorCalculation functionality will continue to be applied at Runtime. On new forms and existing forms that don't have a value set for the rowBGColorCalculation property, the property will not be visible anymore.


Deprecated method or property









CSS Row Styling & onRender event





Fix typo



CSS Row Styling & onRender event






Runtime API

The majority of the deprecations in the Runtime API are related to the new windowing API and the refactored HTTP plugin. 


Deprecated method or property










Matching getters or setters added, allowing both getting and setting the value.
Not all mentioned properties are applicable to each mentioned type of object.
Due to a technical issue, Servoy Developer will yield a warning that the old setXxxx/getXxxx is undefined, instead of being deprecated. It will still work however.  




Never worked properly




This function is deprecated in the JavaScript specification



onOpen event handler of the solution

Deeplink arguments are now passed to both the onOpen event handler of the Login and Main solution.
The .getStartupArgument() is therefor no longer required to get access to the startupArguments prior to login




Servoy 6 contains a complete new Windowing API. A window or dialog is now an instance of the JSWindow class to which a lot of the methods have been moved. New methods were added to the application and controller objects to interact with windows




























The method application.createWindow(..) returns an object of type JSWindow, which has an Scripting API to control additional things like the title, resizability, initial bounds and whether or not to show a textToolbar











CSS Row Styling & onRender event





Fix typo



CSS Row Styling & onRender event









Duplicate functionality




never raised




Match naming convention




Match naming convention




The HTTP plugin was refactored to support all types of HTTP Requests and support more finegrained control over the requests. Instead of creating an HttpClient and referencing it by name, the HttpClient is now an object with it's own set of methods, for example methods to create all the different types of HttpRequests. Each XxxxRequest object has a .executeRequest() function that returns a Response object again with it's own methods.




No longer required



.getCookie() on HttpClient object




.getCookies() on HttpClient object




replaced by .getCharset() on Response object returned by the .executeRequest() method on any of the XxxxRequest objects created by the .createXxxRequest() methods on the HttpClient object




.createPostRequest() on HttpClient object




.createPutRequest() on HttpClient object




.setClientProxyCredentials() on HttpClient object




.setCookie() on HttpClient object





Name now matches what the function does




No longer required

Utilizing the new Solution Design features

Servoy 6 introduces many new features for designing solutions. This chapter will only highlight the new features and provide links to extended documentation.

New features

Windowing API

Windows and Dialogs are now instances of JSWindow, that exposes it's own API

Drag 'n' Drop

The Drag 'n' Drop implementation was updated with a onDragEnd event handler that fires with either a drop occured or the drag operation was canceled

The Drag 'n' Drop related event handlers now get passed an JSDNDEvent instead of a regular JSEvent. The JSDNDEvent exposed an extended API compared to the JSEvent API, exposing functions and properties that are relevant only in Drag 'n' Drop operations, for example the recordIndex on which the drop took place.


The inheritance model was improved in the UI inheritance area, to allow overriding the inherited properties on Form, Form Part and element level.


On Forms an encapsulation property was added to make it possible to hide parts of the Forms scripting API. The following objects can be hidden:

Additionally, it's possible to set the Form overall visibility:

On the scripting level, the JSDoc tags @private and @protected are introduced to allow encapsulation on functions and variables:

CSS Row Styling

Servoy 6 supports styling the odd, even and selected rows in grids (Portals and the body of Forms in TableView) using CSS:

odd, even, selected { 
  background-color: #FFF; 
  color: #5C5C5D;
odd { 
  background-color: #F5F7F9;
even {}
selected { 
  background-color: #d4d4d4; 
  color: #FFF;

This functionality is a replacement for the deprecated "rowBGColorCalculation" property on Forms when it comes to plain odd, even & selected row coloring.

onRender event

The new onRender event on Forms, Portals and individual elements allows dynamic conditional styling of the object that is rendered.

See Conditional styling using the onRender event in the Styling Solutions chapter of the Programming Guide  for  more information

SolutionModel extensions

The SolutionModel API has been extended with the following API categories: 

DatabaseManager extensions

Tablefilter changes

The behavior of databaseManager.addTableFilterParam() has been changed, see Changes that might break existing code

visible & enabled Designtime properties

All standard UI components in Servoy were extended with designtime visible & enabled properties.

The visible property can be used 

.border, .font, .titleText, .imageURL properties instead of only a getter or setter

RuntimeXxxx types

Each UI component, including beans are now exposed as Types in the Scripting layer. All standard UI component in Servoy have a type that is prefixed with "Runtime", for example RuntimeForm, RuntimeButton etc.

All standard UI components also extend RuntimeComponent

Extended scripting API for RuntimeGroup

The scripting API of a grouped set of elements has been extended. The RuntimeGroup also extends RuntimeComponent

Solution deeplink normalization

The mechanism of sending arguments into a Solution on startup has been normalized. 

Extended ClientDesign

Through UIProperties the available ClientDesign operations on elements can be restricted. See Client Design mode for more info.

Tooltip display settings

UI Properties have been added to control the show and dismiss delay for ToolTips in both the Smart and Web Client.


i18n additions

The i18n object has been extended with a .setTimeZone(), .getAvailableTimeZoneIDs() & .getCountries() method

HTTP plugin updates

The HTTP plugin is completely overhauled, to support all types for HttpRequest and provide fine-grained control over the request.

Restful plugin updates

File plugin updates

The File plugin is extended with streaming functionality to send files back and forth between a Smart Client and the Servoy Application Server  

(info)  The changes to the File plugin already appeared in maintenance versions of Servoy 5.2, but are mentioned here for completeness.

Maintenance plugin updates

The JSClientInformation object that is part of the Miantenance plugin was extended with a .getLoginTime() and .getIdleTime() method

OpenId plugin

A new OpenID plugin is added to the standard plugin extensions of Servoy. The OpenID plugin allows to implement OpenID authentication in the Web Client