Release Notes 24.11 (November 2024)

Documentation
We're delighted to announce the release of LabKey Server version 24.11 (November 2024).

LabKey Server SDMS

Premium Edition Feature Updates

  • Include "Calculation" fields in lists, datasets, sample, source, and assay definitions. (docs)
  • Support for using a Snowflake database as an external data source is now available. (docs)
  • The "External Tool Access" page has been improved to make it easier to use ODBC and JDBC connections to LabKey. (docs)
  • Administrators can generate a report of file root sizes across the site. (docs)
  • Reporting usage statistics to LabKey can be enabled without also enabling upgrade banners. (docs)
  • SAML authentication uses RelayState instead of a configuration parameter, and the configuration interface has been streamlined. Also available in 24.7.7 (docs)
  • Administrators can save incomplete authentication configurations if they are disabled. Also available in 24.7.4 (docs)
  • Sample Manager Feature Updates
  • LabKey LIMS Feature Updates
  • Biologics LIMS Feature Updates
Learn more about Premium Editions of LabKey Server here.

Community Edition Updates

  • Linking Sample data to a visit-based study can now be done using the visit label instead of requiring a sequencenum value. (docs)
  • Date, time, and datetime fields are now limited to a set of common display patterns, making it easier for users to choose the desired format. (docs)
  • A new validator will find non-standard date and time display formats. (docs)
  • Use shift-click in the grid view customizer to add all fields from a given node. (docs)
  • When a pipeline job is cancelled, any queries it has initiated will also be cancelled. (docs)
  • Users can include a description for future reference when generating an API key. (docs)
  • Folder file root sizes are now calculated and shown to administrators. (docs)
  • Administrators can provide a set of allowed external sources of data. (docs)
  • Sending of the Server HTTP header may be disabled using a site setting. (docs)
  • Some "Experimental Features" have been relocated to a "Deprecated Features" page to better describe their status. (docs)
  • When a user changes their database password, all current sessions associated with that login are invalidated. (docs)

Distribution Changes and Upgrade Notes

  • LabKey Server embeds a copy of Tomcat 10. It no longer uses or depends on a separately installed copy of Tomcat.
    • LabKey Cloud subscribers have been upgraded automatically.
    • For users with on-premise installations, the process for upgrading from previous versions using a standalone Tomcat 9 has changed significantly. Administrators should be prepared to make additional changes during the first upgrade to use embedded Tomcat. (docs)
    • For users with on-premise installations who already upgraded to use embedded Tomcat will follow a much simpler process upgrade to 24.11. (linux | windows)
    • The process for installing a new LabKey Server has also changed significantly, making it simpler than in past releases. (docs)
  • All specialty assays (ELISA, ELISpot, Microarray, NAb, Luminex, etc.) are now only distributed to clients actively using them. Administrators will see a warning about unknown modules when they upgrade and can safely remove these unused modules. Please contact your Account Manager if you have questions or concerns.
  • HTTP access logging is now enabled by default and the recommended pattern has been updated. (docs)
    • Users of proxies or load balancers may wish to add this to their accesslog.pattern to capture the IP address of the originating client: %{X-Forwarded-For}i
  • MySql 9.0.0 is now supported. (docs)

Deprecated Features

  • The "ms2" module is no longer included in most distributions. Administrators who see a warning after upgrading about this module being unknown can safely delete it. Contact your Account Manager if you have questions or concerns. (doc archive)
  • Support for Microsoft SQL Server 2014 has been removed. (docs)
  • Some older wiki macros were removed; the list of supported macros is in the documentation.
  • Support for "Advanced Reports" has been removed.
  • Support for the "Remote Login API" has been removed.
  • The "Vaccine Study Protocol" web part and editor interface, deprecated in 2015, is still available behind an experimental flag but will be removed in a future release. It has been replaced with the "Manage Study Products" interface. (docs)
  • Support for bitmask (integer) permissions has been removed. Developers can learn more below.
  • Future deprecations: These features will be deprecated in the 25.3 (March 2025) release and removed completely in 25.7. Contact your Account Manager if you have questions or concerns.
    • Additional date, time, and datetime parsing patterns. Selecting a date parsing mode (Month-Day-Year or Day-Month-Year) will still be supported. (docs)
    • You will no longer have the "Advanced import options" of choosing objects during import of folders, as well as having folder imports applied to multiple folders. (docs)
    • "Assay Progress Reports" in studies. (docs)

Client APIs and Development Notes

  • Version 3.4.0 of Rlabkey is available. (docs)
  • Client API calls that provide credentials and fail authentication will be rejected outright and immediately return a detailed error message. Previously, a call that failed authentication would proceed as an unauthenticated user which would fail (unless guests have access to the target resource) with a less informative message. This change is particularly helpful in cases where the credentials are correct but do not meet password complexity requirements or are expired.
  • Version 3.0.0 of our gradlePlugin was released. It's earliest compatible LabKey release is 24.8 and it includes a few changes of note for developers. A few examples are here, and more are listed in the gradlePlugin release notes:
    • The AntBuild plugin has been removed, so we no longer have a built-in way to detect modules that are built with Ant instead of Gradle.
    • We removed support for picking up .jsp files from resources directories. Move any .jsp files in a resources directory under the src directory instead.
  • Support for bitmask (integer) permissions has been removed. Class-based permissions replaced bitmask permissions many years ago. Developers who manage .view.xml files should replace <permissions> elements with <permissionClasses> elements. Code that inspects bitmask permissions returned by APIs should switch to inspecting permission class alternatives. (docs)
  • Documentation has been added to assist you in determining which packages and versions are installed for R and python. (R info | python info)
  • API Resources

Sample Manager

The Sample Manager Release Notes list features by monthly version and product edition.


LabKey LIMS

Announcing LabKey LIMS! Learn more here:

The LabKey LIMS Release Notes list features in addition to those in the Professional Edition of LabKey Sample Manager.


Biologics LIMS

The Biologics LIMS Release Notes list features in addition to those in LabKey LIMS.


Previous Release Notes: Version 24.7

Was this content helpful?

Log in or register an account to provide feedback


previousnext
 
expand allcollapse all