Version upgrade¶
If you have upgraded the HRM in the past, you will know that some steps must be performed in addition to replacing the old HRM code with the new one: some entries might have been added or changed in the configuration files (hrm_{server|client}_config.inc), and the database structure might have been changed.
Update the configuration files¶
3.1 to 3.2¶
In version 3.2 of the HRM, the system users running the Queue Manager and the web server are expected to have direct read-write access to the data folders. If this is not the case for your setup and you rely on adding the web server user to /etc/sudoers, please notice that this behavior is obsoleted in 3.2 but can still be enabled by adding:
$change_ownership=true;
in (hrm_{server|client}_config.inc. The variable $change_ownership defaults to false if not explicitly set to true in the configuration, in compliance to the new behavior. As of HRM 3.3, this variable will be ignored and the new behavior will be enforced.
3.0.x to 3.1¶
No changes in the configuration files.
2.1.x to 3.0¶
From HRM 2.1.x to HRM 3.0, one variable was added in the configuration files.
$omero_transfers={true|false}
1.2.x to 2.0¶
From HRM 1.2.x to HRM 2.0, three variables were added in the configuration files:
[+] max_upload_limit
[+] max_post_limit
[+] email_list_separator
Moreover, three variables were removed:
[-] resultImagesOwnedByUser
[-] resultImagesRenamed
[-] enable_code_for_huygens
If you are upgrading straight from HRM 1.2.x, please notice that as of HRM 2.0 configuration and sample files were moved as per following table.
| Config files (new) | Sample files (new) | Config files (1.x) | Sample files (1.x) |
|---|---|---|---|
| $HRM_HOME/config | $HRM_HOME/config/samples | $HRM_HOME/inc | $HRM_HOME/resources |
Check the configuration files¶
An easy way to check for modifications is by running the $HRM_HOME/resources/checkConfig.php script. From the shell, run:
$ cd $HRM_HOME
$ php resources/checkConfig.php config/hrm_server_config.inc
Replace $HRM_HOME with the hrm root (e.g /var/www/hrm).
Checking the 3.0.x files with the 3.1 checkConfig.php script will result in the following output:
Check against HRM v3.1.x.
Check completed successfully! Your configuration file is valid!
Checking the 2.1.x files with the 3.0 checkConfig.php script will result in the following output:
Check against HRM v3.0.x.
* * * Error: variable omero_transfers not set or empty.
Check completed with errors! Please fix your configuration!
Checking the 1.2.x files with the 2.1.x checkConfig.php script will result in the following output:
Check against HRM v2.1.x.
* * * Error: variable max_upload_limit not set or empty.
* * * Error: variable max_post_limit not set or empty.
* * * Error: variable email_list_separator not set or empty.
* * * Error: variable resultImagesOwnedByUser must be removed from the configuration files!
* * * Error: variable resultImagesRenamed must be removed from the configuration files!
* * * Error: variable enable_code_for_huygens must be removed from the configuration files!
Check completed with errors! Please fix your configuration!
Please make sure to fix all problems. The sample files and the Manual installation instructions will help you set the correct parameters.
Update the database¶
Newer versions of the HRM might use slightly different/updated versions of the database back-end than previous ones.
| HRM version | Database version |
|---|---|
| 1.2.3 | 7 |
| 2.0 | 8 |
| 2.1 | 9 |
| 3.0 | 10 |
| 3.0.3 | 11 |
| 3.1 | 12 |
For this reason, the first time you run the HRM after an update you will be told that the database must be updated and that you are not allowed to continue until this has been done!
Database updates are supported across HRM versions, i.e. it is possible to upgrade the database from revision 7 to 12 in one step.
The following describes two possible ways to update the database.
Although we test this procedure quite carefully, it is highly recommended to backup the database before updating!
Updating from the web interface¶
Login to the HRM as the admin user: you will be brought directly to the Database update page. Click on the update button. If everything works properly (as it should...), the following message should be displayed.
Needed database revision for HRM v3.1 is number 12.
Current database revision is number 11.
Updating...
Database successfully updated to revision 12.
The database is now at the latest revision.
Updating from the console¶
Alternatively, the database can be updated from the console (see create or update database). Please pay attention to what the update process will report! The output should be the same as the one listed in the previous section, but if the update fails, you might want to report it.