API ReferenceProduct Documentation
Product Documentation

Tetra Chromeleon Agent v2.2.x Release Notes

Suggest Edits

The following are the Tetra Chromeleon Agent release notes for versions 2.2.x.

v2.2.0

Release date: 29 April 2025

TetraScience has released its next version of the Tetra Chromeleon Agent version 2.2.0. This release offers significant improvements, including the ability to ingest Report Templates and Electronic Reports. A new Tetra Data Platform (TDP) command has been added, enabling sequence creation through a specified Chromeleon eWorkflow. The update also allows for flexible mapping to modify sequence and injection properties post-creation. Overall performance is enhanced through a multi-process architecture that improves throughput and provides better management of ingestion latency.

Prerequisites

The following Tetra Data components are required for Tetra Chromeleon Agent v2.2.0:

📘

NOTE

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

New Functionality

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

Create Sequence from eWorkflow

This version introduces a new TetraScience.Agent.chromeleon.EWorkflowCreation command that enables the creation of a Sequence in Chromeleon from an eWorkflow.

For more information, see Tetra Chromeleon Agent eWorkflow Creation Command.

📘

NOTE

The Chromeleon Software Development Kit (SDK) used by the Agent sets the precedence of the settings on the eWorkflow definition higher than that of the command payload.

"Nevertheless, the eWorkflow definition has a higher priority than the context data (a definition in the eWorkflow overrides the definition in the context - see ISequenceCreationContext for detailed information)."

This means the Location specified in the command payload will not be used if the eWorkflow definition has a value for the Data Vault field on the Sequence General tab. To make sure that the Sequence is created in the location specified in the command, set the Data Vault field to the empty value on the eWorkflow definition in Chromeleon.

Generate Chromeleon Reports

The Agent introduces a new feature called Report Service, which produces a PDF version of the Electronic Report and a designated sheet within the Report Template. The report generation progress status displays in the Summary page in the Agent Management Console. To maintain backward compatibility, there's also an option to extract Report Template Data for use in Injection ingestion.

For more information, see Generate Chromeleon Sequence Reports in the Tetra Chromeleon Agent User Manual (v2.2.x).

Fetch Chromeleon Users and Roles on Demand

The Agent can now receive a new TetraScience.Agent.chromeleon.UserRoleFetch command, which triggers the on-demand upload of Chromeleon users and roles to the TDP.

For more information, see Tetra Chromeleon Agent User Role Fetch Command.

Initiate Chromeleon Sequence Scan through a TDP Command

A new TetraScience.Agent.chromeleon.SequenceUpdate command notifies the Agent when specific sequences have been updated. After receiving this command, the Agent scans the specified sequences and updates them as needed.

For more information, see Tetra Chromeleon Agent Update Sequence Command.

Enhancements

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

  • A new multi-process architecture and concurrent upload mechanism boosts data ingestion throughput.
  • Customers can now set a minimum disk space requirement. If the available disk space falls below the specified threshold, the Agent pauses file generation until the files are uploaded or additional disk space is added. During initial configuration, if the available disk space is already below the specified minimum, the Agent prevents the startup.
  • The S3 Direct Upload option is now activated by default for new Tetra Chromeleon Agent installations. The option allows Agents to directly upload files to Amazon Simple Storage Service (Amazon S3) buckets in the TDP by using AWS API endpoints and supports uploading files up to 5 TB. If S3 Direct Upload is deactivated, the Agent will alert the user each time the Agent Management Console opens.
  • File uploads with S3 Direct Upload enabled now use a SHA256 checksum to ensure data integrity on uploads.
  • The Receive Commands option is now activated by default for new Tetra Chromeleon Agent installations. This option allows the Agent to receive Command Service commands from the TDP.
  • The Agent now publishes and uploads various events from the Injection Service and Report Service to the TDP. The TDP's new Health Monitoring dashboard (available in TDP v4.1.0 and higher) then aggregates these events, offering improved visibility into Agent file processing statuses and diagnostic data.
  • Raw injection and reports uploaded to the TDP now have limited, delayed retries —— also known as a retry with exponential backoff pattern. By using this new pattern, the Agent now delays retries instead of attempting them immediately, until the maximum number of upload attempts is reached.
  • Application logs are now retained locally for up to 72 hours (an increase from the previous 60 hours).

Proxy Enhancements

Advanced Settings now include the following options for configuring how the Agent interacts with a proxy:

  • System (default setting): Uses the system proxy specified in Windows for the service user. If basic authentication is required, a username and password can be specified for the proxy.
  • Custom: Makes all of the Agent's proxy options configurable, regardless of any other settings. This proxy takes precedence over any existing system proxy or L7 proxy.
  • None: Explicitly configures the Agent service to not use any proxies for web requests.

Bug Fixes

The following bugs are now fixed.

  • A blocking issue with injection ingestion generation is now resolved.
  • A Chromeleon Agent Database lock problem that occurs during simultaneous database operations is now resolved.

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 following are known or possible issues in Tetra Chromeleon Agent v2.2.0:

  • To reduce sequence detection latency, the Agent adds a configuration option that limits detection to sequences created within a specified number of recent days. Sequences created earlier than this period are excluded from change detection. This configuration option is per Data Vault.
  • Report Templates using Report Templates 2.0 do not render correctly using the Chromeleon SDK. This issue is under investigation with the vendor.
  • Report Templates with pages which require a Component context do not render correctly when using the Chromeleon SDK. This issue is under investigation with Chromeleon.
  • Renaming a Report Template that is set as the Default Report Template for a Sequence in Chromeleon will not correctly update the Sequence with the new Report Template name. It will also cause any associated injections to be generated with an empty Report Template. To regenerate these injections after changing the name of a Report Template, you must select the Report Template as the Default Report Template for the Sequence again.
  • Because of a lack of the sample sequence and injections for testing, the formula used by the following Report Variables is not verified:
    • Injection
      • ChemicalFormulaAndAdductMassesSingleLineListUsingInjectionAdducts
      • ChemicalFormulaAndAdductMassesMultiLineListUsingInjectionAdducts
      • ChemicalFormulaAndAdductsSingleLine
      • ChemicalFormulaAndAdductsMultiLine
      • LevelCheck
    • Chromatogram
      • MsSignalExtractParameters
        • EvaluationType
    • Peak Result
      • AmountDeviationAbsoluteInAmountUnits
      • AmountDeviationRelativeInPercentageOfTheExpectedAmount
      • KValueForDeadTimeStoredInProcessingMethod
      • RelativeAmountForCorrespondingInternalStandardComponent
      • RelativeAmountForCorrespondingReferenceComponent
      • RelativeAreaForCorrespondingInternalStandardComponent
      • RelativeAreaForCorrespondingReferenceComponent
      • RelativeCeAreaForCorrespondingInternalStandardComponent
      • RelativeCeAreaForCorrespondingReferenceComponent
      • RelativeHeightForCorrespondingInternalStandardComponent
      • RelativeHeightForCorrespondingReferenceComponent
      • RelativeRetentionTime
      • ResolutionWithEPFormulaAndPreviousIndentifiedPeak
      • ResolutionWithEPFormulaAndCorrespondingReferenceComponent
      • ResolutionWithEPFormulaAndCorrespondingInternalStandardComponment
      • ResolutionWithUSPFormulaAndPreviousIndentifiedPeak
      • ResolutionWithUSPFormulaAndCorrespondingReferenceComponent
      • ResolutionWithUSPFormulaAndCorrespondingInternalStandardComponment
      • ResolutionWithStatisticalMomentFormulaAndPreviousIndentifiedPeak
      • ResolutionWithStatisticalMomentFormulaAndCorrespondingReferenceComponent
      • ResolutionWithStatisticalMomentFormulaAndCorrespondingInternalStandardComponment
      • RetentionIndexLinear
      • RetentionIndexLogarithmic
    • Peak Purity
      • InternalStandardChromatogramChannelName
      • InternalStandardChromatogramDetector
      • InternalStandardPeakName
      • InternalStandardPeakNumber
      • ReferenceMsSpectrumMatch
      • Hit Spectrum
    • Peak Fluorescence Spectrum
      • ScanValue2ndGreatestRelativeMaximum
      • ScanValue3rdGreatestRelativeMaximum
      • ScanValue4thGreatestRelativeMaximum
      • ScanValue5thGreatestRelativeMaximum
    • Peak Composite
      • IsotopicDotProduct
    • Peak Tentative Identification
      • Amount
      • InternalStandardName
        LibraryName
      • Match
      • Name
      • Probability
      • ReverseMatch
    • Processing Method
      • BlankRunInjectionName
      • LastFixedCalibrationUpdateOperator
      • LastFixedCalibrationUpdateTime
    • Processing Method Component
      • RetentionIndex
    • Processing Method Component Detection Parameters
      • BaseLineNoiseStartTime
      • BaseLineNoiseEndTime
      • LockedBaseline
      • MaxAreaReject
      • MaxHeightReject
      • MinBaselineScans
      • PeakShoulderThreshold
      • PeakSliceValue
      • RiderThreshold
      • FrontRidersToMainPeak
      • Sensitivity
      • ValleyToValley
      • VoidVolumeTreatment
    • Processing Method Peak Group
      • CurrentInjectionAmount
      • MinAmount
      • MaxAmount
    • Processing Method Ms Settings
      • AbsoluteThreshold
      • FixedBaselineCorrectionRangeMaxFor1stFixedRange
      • FixedBaselineCorrectionRangeMaxFor2ndFixedRange
      • FixedBaselineCorrectionRangeMinFor1stFixedRange
      • FixedBaselineCorrectionRangeMinFor2ndFixedRange
    • Processing Method Test Case
      • NumberOfFailActions
      • NumberOfPassActions

Upgrade Considerations

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

Updated 6 days ago