Skip to content

LORIS Release v24.1.2

Compare
Choose a tag to compare
@ridz1208 ridz1208 released this 08 Mar 14:31
· 52 commits to 24.1-release since this release
fc90747

This releases fixes bugs that were discovered since the v24.1.1 release. Most notably:

  • [SQL] Reorder release patches for 24.0 release #8390
  • [Performance] Do not load module logger from constructor #8200
  • Download NIfTI file from imaging browser when a NIfTI file is available in addition to a MINC file #8206
  • [behavioural_qc] Fix critical error #8245
  • [issue tracker] Email watchers when issue is updated or created #8248
  • [core] return error message on invalid dob (rebase 24.1) #8279
  • [core] Fix incorrect message/error for instrument access #8284
  • [tools] Fix path in recreate_conflict #8292
  • [issue tracker] Fix emailing bug found in HBCD #8300
  • [issue_tracker] make assignee drop down not required #8301
  • [issue tracker] Fix issue description #8351
  • [imaging browser] Fix download of JSON, Bval and Bvec files when they are on s3 #8354
  • [imaging browser] Fix Human dangling out of nowhere #8363
  • [NDB_BVL_Instrument] Add get function to access protected selectMultipleElements #8381
  • [CSS/instruments] Fix control panel position when scrolling #8383
  • [MRI Violations] Fixes links to BrainBrowser from the MRI violations module #8392
  • Update CONTRIBUTING.md #8421

Full Changelog: v24.1.1...v24.1.2

Upgrade Process from version 23.X.Y to 24.1.2 (amendments)

Note: The instructions below REPLACE the instructions in the release notes of released versions 24.0.0 AND 24.1.0. The instructions in those releases should be disregarded.

23.x.y to 24.0.0

  1. Get the 24.1.2 source code
  2. Source the SQL/Release_patches/23.0_To_24.0_upgrade_A.sql SQL file into your database.
  3. Run the following scripts:
    1. php tools/configuration_check.php
      This script is used to validate the configuration of LORIS. It checks configuration settings and server paths to make sure that the application and underlying architecture are set up to allow LORIS to run properly.
    2. php tools/single_use/SaveUserIDToInstrumentData.php confirm
      This script is intended for a one-time use only to restore the value of the UserID column of instrument tables and the UserID key of the instrument JSON Data in the flag table.
    3. php tools/single_use/remove_publication_users_edit_perm_rel_duplicates.php
      This script deletes duplicate rows in publication_users_edit_perm_rel to make sure the patch '2020-01-07-publication_users_edit_perm_rel_pk.sql' will execute successfully
    4. php tools/single_use/Cleanup_Special_Chars_Document_Repository.php
      This script is written to clean up the files with special characters from the document repository data table as well as clean up the quotes appearing as %22 in the file names in the file system
    5. php tools/single_use/Cleanup_Special_Chars_Media.php
      This script is written to clean up the files with special characters from the media data table as well as clean up the quotes appearing as %22 in the file names in the file system
    6. php tools/single_use/Remove_duplicate_examiners.php
      This script is written to clean up duplicate userIDs in the examiners table
  4. Make sure the RegistrationProjectID column in the candidate table of the dataabse does not contain any NULL values. If it does, either assign an existing project to the candidate/scanner or create a new project for these entries before running the release patch (see "Notes for existing projects" for more details).
  5. Source the SQL/Release_patches/23.0_To_24.0_upgrade_B.sql SQL file into your database.
  6. Run the following scripts:
    1. php tools/single_use/populate_visits.php
      This script populates the visits table based on the config.xml, session table and Visit_Windows table.
    2. php tools/single_use/Set_Required_elements_completed_flag.php confirm
      This script is written to migrate the Data_entry_completion_status field from the instrument table (or Data column of the flag table) to it's own column in the flag table called Required_elements_completed. Note that this script can take a long time to complete on large projects.
  7. Run make all on the LORIS root directory
  8. OPTIONAL: Source SQL patches from the SQL/Archive/24.0/Cleanup directory at your discretion to remove superfluous or deprecated entries in the database.
  9. OPTIONAL: Run the tools/single_use/Remove_Data_entry_completion_status_instr_column.php PHP script to generate an SQL patch containing all DROP COLUMN statements for the now unused Data_entry_completion_status field in instruments. This script will generate the SQL patch and store it in the SQL/Archive/autogenerated/single_use/ directory under the name Remove_Data_entry_completion_status.sql.
  10. OPTIONAL: Remove the <visitLabel subprojectID="X"> tags in the Config.xml file

NOTE: The tools/single_use/SaveUserIDToInstrumentData.php can take several hours up to a day to run depending on the size and age of the databse and number of instruments used

24.0.0 to 24.1.2

  1. Source the SQL/Release_patches/24.0_To_24.1_upgrade.sql SQL file into your database.
  2. If you have LORIS-MRI installed, make sure to upgrade LORIS-MRI to 24.1.0 since the SQL changes will affect the MRI insertion scripts.