The Updating to the Latest Version article lists breaking changes that will highlight any actions beyond the normal updating process that are required.
For all releases, the full change log is listed below the installer download on the Support Center.
We recommend using at least three environments when updating, consisting of Development, Quality Assurance (QA), and Production. In the Development environment, a developer would first update Exago on their local machine or a testing server. After testing the new features and verifying issue fixes, they would update a QA environment for more complete testing, likely implementing a User Acceptance Testing (UAT) server. Once the QA team has signed off on testing (more details below) Exago can be upgraded on the production servers.
Tip
In supporting multiple environments, it is recommended to externalize environment-specific configurations to config files like web.config for easy re-deployment without code changes.
Critical files and any files that may have been manually or programmatically changed should be backed up prior to updating. These files include but are not limited to:
Any custom language files, images or CSS files being kept directly within the Exago installation should be backed up as well. Any files added to bin directories should be safe during updates but may still need to be updated.
Report definitions should be backed up. Reports created in the previous version will be updated with changes for the new version and may no longer work in the previous version.
It is safe practice to shut down associated application pools and web sites (IIS), or similar in Apache, as well as associated Scheduler and Monitoring Services in order to relinquish handles on incorporated DLLs before running the installer. There is no added benefit in updating while the service is running.
Note
The update can be installed over the existing version.
If you are using a custom Application Theme, make sure to recreate it in order for it to pick up the latest Exago icons and CSS. In v2020.1.3+, use Admin Console > General > Feature/UI Settings > Update All Application Themes to quickly update all available themes.
If your installation of Exago utilizes the Web Service API, please update this as well.
Important
If you are using the REST Web Service API, make sure to add the REST key back to
appSettings.config
(or restore from your backup in step 2) as it will be overwritten.
Ensure that all the settings in eWebReportsScheduler.xml
are correct.
If applicable, copy any custom language files into the Language
folder of each Scheduler Service installation.
If the new version of Exago has been installed to a different directory than the previous, and the configuration file will be copied from one install to the other, the Admin Console > Storage Management > Assembly Location will need to reference the new location.
Between versions, some changes may be made to the Storage Management database schema. A new Admin Console > Storage Management >Update Reports button will update report content records with the new schema as necessary. This button may also be “clicked programmatically” with the .NET API:
Api api = new Api("appPath");
String updateResults = (new WebReports.Api.ReportMgmt.UpdateReportsUtility(api.PageInfo)).RewriteAllReports();
If upgrading from a previous version of Exago without Storage Management, or there are new element themes, import them to the Storage Management database with one of the transitioning utilities or the Load Themes button in the Admin Console.
For more information about the returned string, refer to Storage Management.
WebReportsApi.dll
ExagoPuppeteerRasterizer.dll
WebReportsAsmi.dll
within the application launching Exago and perform a Rebuild.WebReportsApi.dll
within the application launching Exago and perform a Rebuild. Update the appSettings.config
and web.config
files in Exago if they are utilized by Extensibility.Exago will throw an error as soon as the application is entered if assemblies aren’t re-compiled.
Clients who are utilizing a CData driver to connect to certain data sources and have updated the driver from one major version to another (e.g. from 2018 to 2019) will need to have the license key re-generated. The Exago provided license key is valid only for the major CData driver version that applied when it was issued.
While our QA team does extensive testing and runs automated tests on every released build, we still recommend that your team performs some basic checks as due diligence. Particular areas of focus we suggest include:
It is also recommended to ensure that each instantiated Role’s functionality is still in place, and that Exago is run with the browser’s Developer Tools in order to ensure no JavaScript errors are happening behind the scenes.
Moving to production follows the same process as updating a UAT or staging environment, but involves a few additional steps:
.xml.enc
files into the production environment.A full security checklist can be found here.