Tetra Empower Agent v5.4.x Release Notes

The following are the Tetra Empower Agent release notes for versions 5.4.x.

v5.4.0

Release date: 8 October 2024

What's New

TetraScience has released its next version of the Tetra Empower Agent, version 5.4.0. This release introduces new functionality to improve the Agent's latency and performance.

Prerequisites

The following Tetra Data components are required for the Tetra Empower Agent v5.4.0:

📘

NOTE

Documentation for Tetra Data components is in the TetraConnect Hub. To request access, see Access the TetraConnect Hub.

  • Tetra Data Platform (TDP) v4.0.3 or higher
  • Tetra Data:
    • LC-UV Empower IDS (lcuv-empower) v15.0.0 or higher, v17.0.0 (recommended)
      • empower-raw-to-ids Protocol v8.2.1 or higher, v10.0.1 (recommended)
      • Task Script v14.1.0 or higher, v16.0.1 (recommended)

The following Tetra Data components are compatible with Tetra Empower Agent v5.4.0:

New Functionality

New Functionality includes features not previously available in the Tetra Empower Agent.

Scan Multiple Projects at the Same Time

The Agent can now scan multiple projects in parallel, significantly improving its performance and reducing its latency. To configure parallel project scans, customers have the option to configure multiple scan processes for both Normal and High priority projects. The default is 1 process for each priority.

For more information, see Configure Agent Run Time Advanced Settings in the Tetra Empower Agent User Manual (v5.4.x).

Enhancements

Enhancements are modifications to existing functionality that improve performance or usability, but don't alter the function or intended use of the system.

  • When archiving a project, the Agent now applies a back-off retry mechanism in the following status transitions:
    • From Locked status to Failed status (when the project is locked, but no modification is detected)
    • From Extracting status to Deleting status
  • The Agent can now regenerate an injection if the related channel is unlocked.
  • The scan interval has been modified from minutes to seconds to provide more granular control of scan frequency. The following new settings are available:
    • Normal Priority Scan Interval (seconds): Default is 60 seconds
    • High Priority Scan Interval (seconds): Default is 60 seconds
    • Project Priority Scan Interval (seconds): Default is 60 seconds

Bug Fixes

The following bugs are now fixed:

  • The Agent is able to set the Project User Group correctly when the project is restored from the TDP.
  • Data latency is now calculated correctly in agents.empower.injectionUploadCompleted.v3
  • The Date-time filter on the Project UI now works correctly.
  • When using Oracle as the option for Data Precision Specification, the Agent no longer returns TRUE for all of the boolean values under Peak. The Agent now returns the correct values in Empower.

Deprecated Features

There are no new deprecated features in this release. For more information about TDP deprecations, see Tetra Product Deprecation Notices.

Known and Possible Issues

  • The Agent may re-upload injections that are still pending in the Empower processing queue. This occurs when the Agent detects an injection change from the Project Audit Trail before the injection is actually ready for upload. Because there is typically a 1–2 minute delay between when Empower records the change in the Project Audit Trail and when the injection becomes ready. A fix for this issue is currently in development and testing, and will be included in a future release.
  • Multiple versions of files may exist on the TDP that have the same database name, project, and injection ID values. A fix for this issue is in development and testing and is scheduled for a future release. For more information, please contact TetraScience Customer Engineering and Support (CES).
  • When the Agent generates RAW JSONs, it uses the Sample Set Method name to include the sample set method information in the RAW JSON. This is the only toolkit method available. Customers might have changed the Sample Set Method. If customers are using the Sample Set Method in the RAW JSON or IDS JSON, it's recommended that they compare the SampleSet.SampleSetMethodDate in the RAW JSON and the sample.set.method.created_at in the IDS JSON with the time of the injection to confirm which Sample Set Method is referred to.
  • If the Empower project name has non-ASCII characters (for example, accents or dieresis), the order of projects displayed in the Empower project browser and Agent Management Console may not be the same.
  • Sample Set Method information for an Injection through the toolkit provides the Sample Set Method name of the approved Sample Set Method version instead of the Sample Set Method ID of the version used to set up the sample set. This may or may not be the Sample Set Method version that was actually used for the sample set in the Injection.
  • The Agent won't ingest the file if the injection contains results processed using GPC/GPCV (Gel Permeation Chromatography) processing methods.
  • When the Agent selects Oracle as the option for Data Precision Specification, the following issues occur:
    • The data fields, ICHThreshold and ImpurityType in Peak, are displayed as index values rather than as their string descriptions.
    • PeakType displays the enumeration of mtkPeakType instead of the corresponding string description
    • The date-time type data fields defined for Peak display the date-time value without any hour offset or time zone information.
    • A longer detection latency can be observed when using the Oracle option. It is recommended to not use this option until this issue is resolved. A fix for this issue is currently in development, and will be included in a future release.

Upgrade Considerations

When upgrading to Tetra Empower Agent v5.4.x, keep in mind the following:

  • It's recommended that you update the Agent's associated Tetra Data protocol and task script to the latest versions; however, updating these components isn't required.
  • Any version of the lcuv-empower IDS earlier than v13 is now incompatible with Tetra Empower Agent v5.1.0 and higher.
  • After customers complete the upgrade to Tetra Empower Agent v5.4.x and open the Agent Management Console for the first time, the console prompts them to run a database upgrade script. This script is required to clean up potential duplicate injections.

To upgrade the Agent, see Common Tetra Agent Upgrade and Installation Information and the Tetra Empower Agent Installation Guide (v5.4.x). To configure and use the Agent after it's installed, see the Tetra Empower Agent User Manual (v5.4.x).