- 05 Mar 2024
- 3 Minutes to read
- Print
- DarkLight
Upgrading ReportWORQ
- Updated on 05 Mar 2024
- 3 Minutes to read
- Print
- DarkLight
Upgrades
This section covers all of the supported upgrade options in ReportWORQ 5:
Upgrading from ReportWORQ 5
There are 2 ways to upgrade ReportWORQ 5 software:
First-time installs or major upgrades
Upgrades or patches to existing ReportWORQ 5 installations
Upgrades to a ReportWORQ 5 release will retain all of the settings and license information so long as the new installation occurs in the same directory where ReportWORQ was previously installed.
Full Installation Upgrades
The following steps are only required when installing to a new machine, or when the core ReportWORQ Boostrapper service is updated in a new release:
Take note of the current Startup settings (Automatic vs. Manual) and the "Logon As" account that the ReportWORQ Bootstrap Service is running before installing any new software.
Backup ReportWORQ data from the Settings screen.
Stop the ReportWORQ Bootstrap Service.
Install the new version of ReportWORQ (to the same installation directory if upgrading an existing installation).
Open the Windows Services console and update the ReportWORQ Bootstrap Service's settings to match those from step 2, if necessary.
Start the ReportWORQ Bootstrap Service.
Log in to ReportWORQ to verify the application is running properly.
Restore the Backup of ReportWORQ data.
In-Application Upgrades
Most ReportWORQ 5 upgrades can be performed without running a full ReportWORQ installation. The in-app upgrade console can be found by clicking the "Software Versions" icon and accessing the list of available versions while logged in as an administrator:
Official releases have been fully regression tested and are recommended unless otherwise instructed by support. Official releases will be highlighted to differentiate them from Preview releases.
The following buttons on each listed version can be used to manage upgrades and select the version that you would like to run:
Button | Action |
---|---|
Download the upgrade package for this release. | |
Select this version for an upgrade, stops the currently running version, and make the selected one the active running version. | |
Delete a downloaded upgrade package. |
Manually Adding Upgrade Packages
If you do not have an internet connection you can alternatively download these upgrade packages. Once downloaded, select "Upload Patch File..." to add the upgrade release to the list of available upgrade packages, using a network location.
Upgrading from ReportWORQ 4.4
ReportWORQ 5 can automatically convert ReportWORQ 4.4 application "data" (jobs, report definitions, recipients, etc...) to the latest-supported format.
The first step in the upgrade process from ReportWORQ 4.4 is to complete the Installation and Configuration of ReportWORQ 5 and to log in to the application as an administrator.
ReportWORQ 4.4 Upgrade Tip
ReportWORQ 4.4 can remain installed and running alongside ReportWORQ 5, providing flexibility and more time to validate a successful upgrade.
The next step in the upgrade process from ReportWORQ 4.4 is to configure the same data source and distributor settings in ReportWORQ 5 since they are not migrated as part of the upgrade. There is an additional requirement to set up Report Providers which are new to ReportWORQ 5. These steps are summarized as follows:
All of these settings are configurable from the Integrations side menu option in ReportWORQ
Click the New Integration... drop-down to set up a new integration:
After configuring all of the prerequisite data source connections and distributors in ReportWORQ 5, you can restore a backup of your ReportWORQ 4.4 content. Once restored, we strongly recommend reviewing and testing all upgraded jobs, recipients, schedules, etc. to make sure all settings and connections are working as expected. Once all upgrade testing is complete you should shut down and uninstall ReportWORQ 4.4.
Upgrading from pre-4.4 Releases
ReportWORQ 5 does not support upgrades from versions before ReportWORQ 4.4. To upgrade from one of these releases you will first need to upgrade to ReportWORQ 4.4, and then upgrade to ReportWORQ 5 using the instructions documented here.