Stop the service

Preferably, update your server at a day/time where you're sure nobody will connect.

If this is not possible, it's strongly advised to:
  • Notify the users of an interruption of service
  • Stop the database server

Notify the users of an interruption of service

The first thing to do to avoid loosing some data is to ask all the users to save their data and close their XStudio instances and wait until the update procedure is completed.


Stop the database server

When all the users have saved their data and closed their instances, stop the Database Server service.
This will ensure that nobody can connect anymore.

Please refer to your Database Server's documentation about how to stop the service.


Please click on the appropriate option below:

The server is installed on a Linux computer

The server is installed on a Windows computer





Backup your data

The database

Please refer to your Database Server guide for more information or check out the Backup/Restore section of the documentation.

Your custom launchers

If you developed some custom launchers using the SDK, it's advised to backup all your source files, build scripts, binaries etc. before updating.
You can find all your launcher binaries in:
- the /var/www/xstudio/bin/launchers/ folder if your current version of XStudio is <=3.0.
- the /var/lib/tomcat7/webapps/xqual/xstudio/launchers/ folder if your current version of XStudio is >=3.1.


Your custom reports

If you developed some custom XSLT reports, it's advised to backup all these XSLT (along with their associated resources i.e. images etc.) before updating.
You can find all your custom XSLT reports in:
- the /var/www/xstudio/export.zip file if your current version of XStudio is <=3.0.
- the /var/lib/tomcat7/webapps/xqual/export.zip file if your current version of XStudio is >=3.1.
so just backup this file.


Your visuals

If you customized your server with custom splash screens, logo and icons, it's advised to backup all these resources before updating. You can find all your visuals in:
- the /var/www/xstudio/visuals/ folder if your current version of XStudio is <=3.0.
- the /var/lib/tomcat7/webapps/xqual/visuals/ folder if your current version of XStudio is >=3.1.






Update the server


IMPORTANT: If you're updating from XStudio version <=3.0 to a version >=3.1, you must first:
  • Install a servlet container (procedure detailed here)
  • If you installed your servlet container on a Linux server, create an empty folder xqual in /var/lib/tomcat7/webapps/
  • If you installed your servlet container on a Windows server, create an empty folder xqual in C:\Program Files (x86)\Apache Software Fundation\Apache2.2\Tomcat 7.0\webapps\
  • Uninstall you current web server (or just delete the folder where XStudio was previously hosted in it - i.e. /var/www/xstudio).
    Note: This does not erase any data as all your data are in the database.
Indeed, the new versions of XStudio only need a servlet container (i.e. Apache Tomcat).
No dedicated web server (i.e. Apache httpd is necessary anymore).

Once this is done, please continue following the instruction below...



Please click on the appropriate option below:

The server is installed on a Linux computer

The server is installed on a Windows computer





Restore your data

Your custom launchers

If you developed some custom launchers using the SDK, you need to recompile them using the new SDK and to copy the binaries in the launchers folder.

Please click on the appropriate option below:

The server is installed on a Linux computer

The server is installed on a Windows computer



Your custom reports

If you developed some custom XSLT reports, you need to copy them on the server.

Please click on the appropriate option below:

The server is installed on a Linux computer

The server is installed on a Windows computer



Your visuals

If you customized your server with custom splash screens, logo and icons, just check they are still here.

Please click on the appropriate option below:

The server is installed on a Linux computer

The server is installed on a Windows computer





Restart the service

Restart the database server


Please refer to your Database Server's documentation for all the details about how to restart the service.

Please click on the appropriate option below:

The server is installed on a Linux computer

The server is installed on a Windows computer




Start XStudio a first time as admin

Start normally XStudio from your browser (http://<ip_address>:8080/xqual/xstudio) and log in as admin.
If you're updating to a major version, you MAY be asked again for your admin password to confirm you authorize the system to update the schema of the database. Just confirm and continue.

When the migration is completed, XStudio will re-start normally.

If a schema update was necessary, you can use the database integrity checker available from the menu Tools > Check database integrity to ensure everything's fine.


Restart the Servlet Container

To ensure that the Servlet Container and the REST API server took into account the last changes properly, restart the Servlet Container.

If you're using Tomcat:
service tomcat7 restart

If you wish, you can have a look at Tomcat's log to check everything started properly without error. The log file is generally located in /var/lib/tomcat7/logs/catalina.out.

Check the settings and the user profiles

When some new features that need specific rights are added, their associated rights will be missing from the user profiles so these features are disabled "by default".

So when you update, don't forget to check the user profiles to see if you want to add some new rights to some of your profiles.

The same way, in a newer version some of the new features may require some global settings. These settings have all default values but it's a good idea to check those just after an update.

Notify the users the service is back

Inform all the users the service is back.






That's it! your server is now updated and all your users can reconnect from their browser using the same URL.