Tetra Empower Agent Release Notes (v4.2.2 and Below)

📘

NOTE

As newer versions of Agents are released, their release notes will appear here.

This document provides the Tetra Empower Agent release notes. Release notes are organized by version number.

📘

NOTE:

To upgrade the Tetra Empower Agent, see this document.

v4.2.2

Release Date: 1 December 2022

Enhancements (New Features and Functionality)

The following are enhancements for this release.

• AG-2583 - The agent keeps track of the last time a project begins scanning. If the scan process times out and restarts, the scanning will continue from the project with no previous scan time or the earliest last scan time.
• AG-2585 - Better handling of child process timeouts in the host process.

Bug Fixes

The bug fixes for this release appear below.

• AG-2540/AG-2408 - Agent scan job times out when there is a large number of projects. Addressed by AG-2583 (see enhancements above).
• AG-2605 - Fix the missing response values for the last time point and last wavelength for 3D channels. To remediate injections with 3D channels where RAW JSON is already generated, you can reupload the projects via Empower agent to fix the issue.
• AG-2622 - Change data type from float to double for some data fields to avoid potential data precision loss issues in RAW JSON. To remediate injection RAW JSONs already generated, where these field values may not have been extracted with correct precision, you need to re-upload them after upgrading to v4.2.2. If injections for a project are in the middle of getting generated during the upgrade, they will need to be re-uploaded again. The impacted data fields include the following:
  • Peak.SignalToNoise
  • Peak.USPSignalToNoise
  • SignOff.DetectorNoise
  • SignOff.DetectorDrift
  • SignOff.PeakToPeakNoise
  • SignOff.AverageDetectorNoise
  • SignOff.AverageDetectorDrift
  • SignOff.AveragePeakToPeakNoise
  • Injection.eCordMaximumTemperature

Known and possible issues

• If the channel type is 3D MS, Agent uses Empower SDK function (Get3D) to extract the 3D channel data, however, this SDK function has a bug confirmed by Waters and the response from the SDK truncates the accuracy. TetraScience has identified a fix in collaboration with Waters and will release it as part of the v5.x agent releases. It will require re-uploading the projects via Empower agent and upgrading the RAW to IDS pipeline protocol.
• Empower agent v4.x defined these 3 fields with data type based on sample data TetraScience has, however, sometimes, these data types may not apply to your Empower data. In these cases, Empower agent will put null in the RAW JSON.
  • Peak.PeakLevel
    • Based on sample data, Empower agent v4.x defined it as float, however, sometimes, this field can contain string like information.
  • Peak.CorrectArea
    • Based on sample data, Empower agent v4.x defined it as float, however, sometimes, this field can contain string like information.
  • InstrumentMethod.InstrumentMethodSetup[*].NeedleWash
    • Based on sample data, Empower agent v4.x defined it as boolean, however, sometimes, this field can contain string like information.
• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.

Deprecated Features

There are no deprecated features for this version of the software.

Minor Functionality Changes

There are no minor functionality changes for this version of the software.

v4.2.1

Release Date: 18 October 2022

Enhancements (New Features and Functionality)

There are no new enhancements for this version of the Tetra Empower Agent.

Bug Fixes

• AG-1794 - Injection Status and Channel Status are added back to respective custom fields of RAW JSON when agent extracts data from Empower Post SR3.

Known and possible issues

• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.

Deprecated Features

There are no deprecated features for this version of the software.

Minor Functionality Changes

There are no minor functionality changes for this version of the software.

v4.2.0

RELEASE DATE: 6 April 2022

This topic provides information on enhancements, bug fixes, deprecated features, and minor functionality changes for version 4.2.0 of the Tetra Empower Agent.

Enhancements (New Features and Functionality)

• The Agent will defer the RAW JSON generation/upload when the injection is still in processing or in buffering mode. The Injection Generation Boundary Parameters section, which includes two fields (Maximum Acquisition Duration and Run Time Tolerance), has been added to the Agent Management Console to facilitate this change.

• Includes InjectionStatus and ChannelStatus fields in RAW JSON for Empower Post-SR3.

• Projects are now organized alphabetically.

Bug Fixes

• AG-1500/AG-1434 - The issue with properly handling an injection that is still in processing or buffering mode was addressed with an enhancement. See the Enhancements section for more details.

• AG-1509 - The Agent now skips invalid projects when determining which injections will be processed. Invalid projects include those that the Agent cannot process due to permissions issues.

Known and possible issues

• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.

Deprecated Features

There are no deprecated features for this version of the software.

Minor Functionality Changes

There are no minor functionality changes for this version of the software.

Other Notes

The Empower Installation guide (Empower 3 FR5) indicates that Empower software should be installed on the machine on the server with region setting as English-US.

If the Tetra Agent is installed on the server with region setting other than that, it might have unexpected behavior, such as: the values of date, time, or the decimal are not formatted correctly. Cultural markers for decimal places and units reflect US standards.

v4.1.3

RELEASE DATE: 3 January 2022

This topic provides information on enhancements, bug fixes, deprecated features, and minor functionality changes for version 4.1.3 of the Tetra Empower Agent.

Enhancements (New Features and Functionality)

There are no new enhancements for this version of the Tetra Empower Agent.

Bug Fixes

• AG-1110 - Empower Agent - Support Extracting Message Center Data with Empower 3 SR3/FR5
  Empower SR3+/FR5 non-experimental message center data can now be extracted.

• AG-1148 - Empower Agent - S3 Direct upload creates Inconsistent File Path for Raw injection without Sample Set in S3 bucket as GDC/CDC
  Previously, if you used GDC to upload a file without a sample set and then used S3 to upload the file again - the Tetra Data Platform treated it as two completely different files instead of two versions of the same file. With this fix, even if you upload the file several times using GDC and S3, the Tetra Data Platform treats the files as different versions of the same file.

• AG-1212 - Empower Agent - Project Status: 207 - Project Login Invalid User/Password in TetraScience
  Under certain circumstances, such as when reauthentication is required, Empower generates log in errors. Many of these errors are transitory and are quickly resolved by Empower. Previously, these types of errors remained in the log. To declutter the log, if these error types are resolved, they are now removed from the log.
  

• AG-1267 - Empower Agent - Project Structure incorrect and AG-976 - Empower Agent - Project Structure is not shown correctly
  When a new project is detected, the Tetra Empower Agent displays it under its parent project in the Management Console.'

• AG-1358 Empower Agent - Fix the decimal data conversion issue when deployed to host machine whose OS culture setting is not en-US. The agent now correctly converts numbers that use culture-specific formatting. For example, the number 10,00, in the format of German English, is now 10.0.

Known and possible issues

• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.

Deprecated Features

There are no deprecated features for this version of the software.

Minor Functionality Changes

There are no minor functionality changes for this version of the software.

v4.1.2

RELEASE DATE: 21 October 2021

This topic provides information on enhancements, bug fixes, deprecated features, and minor functionality changes for version 4.1.2 of the Tetra Empower Agent.

Enhancements (New Features and Functionality)

There are no new enhancements for this version of the software.

Bug Fixes

• AG-1159: Empower Agent - Non-experimental project access extraction fails when running on more than 1000 projects

When more than 1000 projects were processed in the Tetra Empower Agent, non-experimental project access extraction failed due to a database size limitation. This issue was resolved and the Tetra Empower Agent can now process more than 1000 projects without failing.

Known and possible issues

• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.

Deprecated Features

There are no deprecated features for this version of the software.

Minor Functionality Changes

There are no minor functionality changes for this version of the software.

v4.1.1

RELEASE DATE: 14 October 2021

This topic provides information on enhancements, bug fixes, deprecated features, and minor functionality changes for version 4.1.1 of the Tetra Empower Agent.

Enhancements (New Features and Functionality)

These enhancements were added to this version of the software:

• Added the Generation Processor Number setting in the Agent Run Time section of the Management Console. To expedite processing time, you can use this setting to specify how many processors you want the Tetra Empower Agent to use to process injections.

• Added the Upload Batch Size setting in the Agent Run Time section of the Management Console. This setting allows you to indicate how many files are made available for processing at a time.

• Added the Required Free Disk Space setting in the Agent Run Time section of the Management Console. This enhancement builds upon the 4.1.0 release feature that protects against a potential extraction failure due to long interruptions in connectivity. You can use this setting to specify how much free disk space is needed before an injection is processed. When the available free space drops below this level, the processing of injections is paused. Processing resumes when the free disk space meets or exceeds the required free disk space value (for example, when processed files are uploaded to the Tetra Data Platform).

Bug Fixes

• AG-1098: Fixed a regression related to Upload Retry functionality that allows the user to set the number of upload retries (set to 50 by default).

• AG-1059: Fixed a bug occurring in the upgrade process, where the agent shows the oldest installed version as the latest, with this fix, the agent shows correctly the latest installed version as the latest.

Known and possible issues

• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.

Deprecated Features

There are no deprecated features for this version of the software.

Minor Functionality Changes

There are no minor functionality changes for this version of the software.

v4.1.0

RELEASE DATE: 8 September 2021

This topic provides information on enhancements, bug fixes, deprecated features, as well as minor functionality changes for version 4.1.0 of the Tetra Empower Agent.

Enhancements (New Features and Functionality)

There were several enhancements in this version of the software.

• Added a new option to generate Empower project access and user access permission data.
• Included the Empower database and project names from the Raw files generated by the Empower System Audit Trail, Project Audit Trail, and Message Center.
• Added a safety measure to pause injection extraction when the output folder drive has less than 1GB storage available and resume extraction when storage is made available, e.g., via injection upload. This feature protects against potential extraction failure due to long interruptions in connectivity.

Minor Functionality Changes

The following changes were made to the Injection Raw file

• Outputs the constant value of Pharmacopeia. The data transformation is handled in the Tetra Pipeline. The mapping is listed below:

• 1 is mapped to US Pharmacopoeia
• 2 is mapped to European Pharmacopoeia
• 3 is mapped to Japanese Pharmacopoeia
• 4 is mapped to All
• 5 is mapped to Chinese Pharmacopoeia

Known and possible issues

• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.

v4.0.0

RELEASE DATE: 12 August 2021

This topic provides information on enhancements, bug fixes, deprecated features, as well as minor functionality changes for version 4.0.0 of the Tetra Empower Agent.

Enhancements (New Features and Functionality)

There were several enhancements in this version of the software.

• Added new options to generate Empower non-experiment data, such as System Audit Trails, Project Audit Trails, and messages from the Message Center.
• Added a new option to generate the Raw file without uploading them to the Tetra Data Platform.
• Implemented a multi-processor application architecture. This improves the agent's overall performance, scalability, throughput, and reliability.

Bug Fixes

The following bug fixes were made to the agent.

• AG-648: Empower Agent Trim the Sample Set Name when generating the Injection

Previously, if a Sample Set Name had an empty space at the end, the folder path could not be created. This is because the Sample Set Name is part of the folder path. Now, empty spaces are programmatically trimmed from the end of the Sample Set Name; so the folder path can now be created.

Known and possible issues

• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.

Deprecated Features

The following feature(s) are currently deprecated.

• Re-upload injections has been deprecated. This feature allowed to upload previously generated injections that the user chose to save locally. The feature has been deprecated because of confusion and potential data integrity issues. Please use Rerun Project(s) instead if you need to re-upload Empower injection data into TDP.

Minor Functionality Changes

The following minor functionality changes are in this version of the software.

• The audit trail no longer includes Empower Toolkit Login and Log Off messages. This makes the audit trail easier to review.
• The Tetra Empower Agent now uses the sequence number rather than change date to track Project Audit Trail changes.
• In the Management Console, the Raw Injection Reupload information has been removed because it duplicates the functionality available when the Project Rerun button is clicked.

v3.3.0

RELEASE DATE: 22 April 2021

This topic provides information on enhancements, bug fixes, deprecated features, as well as minor functionality changes for version 3.3.0 of the Tetra Empower Agent.

Enhancements (New Features and Functionality)

There were several enhancements in this version of the software.

• This version provides an option in Window Management Console to automatically extract Injections from the new projects being added to the Empower.
• The JWT Token in the Sqlite database is encrypted.

Bug Fixes

The following bug fixes were made to the agent.

• AG-275: Fix an error when parsing wavelength from Channel description.
  Fixed an error when parsing decimal value in Channel description.

Known and possible issues

• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.

Deprecated Features

The following feature(s) are currently deprecated.

• Usage of the API Key for Authentication: The API Key, which was used for authentication, is deprecated and is no longer available in Data Connection for new installations of the software. However, this feature is still backward compatible with previous versions (if the API Key was previously used).
• Removed the desktop shortcut.

Minor Functionality Changes

The following minor functionality changes are in this version of the software.

• NaN is now converted to null in the RAW file data cube that is created when the data is converted to IDS format in the TDP.

Additional Notes

There are no other notes for this version of the software.

v3.1.1

Bug Fix

• Fix an issue in Agent upgrading with the missing previous configuration setting.

Known and possible issues

• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.

v3.1.0

New features and functionality changes

• Support Result Sign Off options when generating Raw Injection files. Please check here for more details.

Enhancement

• Include SampleSet Method in the Raw Injection file
• Improve Agent Log traceability by associating file trace Id to every log entry
• Separate Agent Log files for Agent executables
• Scan and generate selected projects in sequence

Bug Fix

• Fix the issue that the Agent deselects the unsaved projects when Windows Management UI refreshes periodically.

Known and possible issues

• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.

v3.0.0

New features and functionality changes

• Support various Data Connection options, including GDC, UDI, and S3 direct upload. Please see the detailed options
• Upload local host server System Metrics to Tetra Data Platform

Bug Fix

• In Injection Service Summary Page, fix Rerun Project(s) function when the Project has Audit Trail
• In Injection Service Summary Page, apply Local Server Time format for both Last Scan Time and Next Scan (Est.) Time

Known and possible issues

• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.

v2.8.7

New Feature and functionality changes

• Integrate Empower Injection Service and Archive Service into one application

Enhancement

Archive Service:

• Implement S3 multi-part low-level API to upload large files up to 500 GB
• For Archive Service, verify if project backup is valid by checking Oracle Error in the backup.log

Injection Service:

• Support various Date Time formats in Empower
• Fix missing custom field data value when the value is the same as the default value of the data type.

Other Enhancement

• Agent Installer supports Agent upgrade function.

Known and possible issues

• When the Agent fetches Channel data and gets a non-Toolkit exception such as an Out of Memory error, the Injection RAW file it generates has an empty Channel data cube.