Update XStudio Standalone




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 <install directory>/bin/launchers/ folder.

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 <install directory>/export folder.

Your visuals

If you customized your instance 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 <install directory>/visuals/ folder.



Update the fat client


Please click on the appropriate options below:

You just have to execute the setup_xstudio_v<version>_win32.exe program
This program will automatically backup your current configuration settings, install the new version and restore the relevant original settings.

  • Download the version of the XStudio fat client for Windows package you wish to update to (from our download section)

  • Unzip the zip file (i.e. setup_xstudio_v2.3sp2_win32.zip)

  • Execute the extracted setup program (i.e. setup_xstudio_v2.3sp2_win32.exe)
    (you can choose the same installation path where your current version resides - the program will nicely update it with the new version)

You just have to save the original configuration files, unzip the xstudio_v<version>_linux.tar.zip, overwrite the existing install and restore your configuration files.

  • backup all the *.conf files in your existing install at <install directory>/bin/ folder

  • Download the version of the XStudio fat client for Linux/MacOSX package you wish to update to (from our download section)

  • Unzip then untar the downloaded package in the original <install directory> folder
    (this will overwrite all the existing instance files)

  • Restore all the *.conf files you backuped in the <install directory>/bin/ folder


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 (<install directory>/bin/launchers/).

Your custom reports

If you developed some custom XSLT reports, you need to add them in the new <install directory>/export/ folder.

Your visuals

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


Restart the service

Start XStudio a first time as admin

Start normally XStudio from <install directory>/bin/xstudio.exe or <install directory>/bin/xstudio.sh 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.

New mandatory parameters

Also, if some new mandatory parameters are required in *.conf files, a popup will automatically open giving you the opportunity to fill the missing values.
You'll then be able to save the 3 configuration files and upload them to your server.

For instance, if you update from a version <=5 to a version >=6 there will be 3 new parameters to fill in:
  • rest_api.base_url=<REST API server URL> i.e. http://acme-prod1.myxqual.com/xqual/api
  • rest_api.default_username=<XStudio username>
  • rest_api.default_password=<encrypted password>
If some new parameters were required, you'll need to restart Tomcat again so that they are read by the REST API server.

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.