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.

  • Connect to the VM via Putty (or any other ssh client)
    (by default the root password is rootpwd)

    (alternatively, you can simply connect to the VM directly from the VirtualBox window or Console tab of the vSphere Client, quit the control panel by selecting Advanced Menu, Quit and Select)

  • Run the command service mysql stop




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/xqual/visuals/ folder if your current version of XStudio is >=3.1.






Update the server


There are some tools on the VM that are making the update operation very easy, especially if the VM has access to internet.
The internet access is used only to download the new version from our centralized server.


You can test if the VM has access to the internet by doing this:

  • Run the command ping www.xqual.com




If the ping works, then the VM has access to the internet.



Please click on the appropriate option below:

My VM has access to the internet

My VM has no access to the internet





Restore your data

Your custom launchers

If you developed some custom launchers using the SDK, and if you are updating to a major version (with changes in the SDK), you need to recompile all of them from their sources using the new SDK and to copy the binaries in the launchers folder (/var/lib/tomcat7/xqual/xstudio/launchers).
You also need to reference these custom launchers in the /var/lib/tomcat7/xqual/xstudio/launchers/launchers.xml file.


Your custom reports

If you developed some custom XSLT reports, you need to add them in the new /var/www/xstudio/export.zip file.
This means you must pick the new export.zip file, unzip it, copy your custom XSLT files (along with their associated resources i.e. images etc.) in the structure and rezip it.

Your visuals

If you customized your server with custom splash screens, logo and icons, just check they are still in the /var/www/xstudio/visuals folder (if not, copy your backuped files here).





Restart the service

Restart the database server


  • Run the command service mysql start




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.


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.