Common Tetra Agent Installation and Upgrade Information

This page provides installation and upgrade information that is common to Tetra Agents. For details, see the specific Tetra Agent Installation guide.

Install a Tetra Agent

You install each Tetra Agent using a Microsoft Installer (.MSI) package. To get a link to the .MSI package, please contact your TetraScience Customer Success Manager (CSM).

Once you have the link, you can download the Tetra Agent to a machine and double-click the Tetra Agent installation file to start the installation wizard.

Once installed, you can use the application's user-friendly interface to configure and monitor the Tetra Agent. Configuration options and parameters are specific to each Tetra Agent.

Upgrade a Tetra Agent

To upgrade a Tetra Agent, you must:

  • Prepare the Tetra Agent
  • Perform the Upgrade
  • Verify the Upgrade

Prepare the Tetra Agent

To prepare to upgrade a Tetra Agent, you must:

  • Verify that the Tetra Agent is not processing data
  • Back up the SQLite database

To prepare to upgrade a Tetra Agent:

  1. Open the Tetra Agent's Management Console.
  2. Stop the Tetra Agent.
  3. Note the configuration settings because you will need this information when you verify the upgrade.
  4. Review the Summary page to ensure that there are no uploads or any pending files to generate.
  5. Copy the SQLite Database's applicationdb.sqlite file and store in a safe place. The file location differs by Tetra Agent:
    • Tetra Chromeleon Agent: <Directory where you installed the agent>\Bin\Database
    • Tetra Empower Agent: <Directory where you installed the agent>\db
    • Tetra File-Log Agent: <Directory where you installed the agent>\Bin\Database
    • Tetra LabX Agent: <Directory where you installed the agent>\Bin\Database
    • Tetra UNICORN Agent: <Directory where you installed the agent>\Bin\Database


Local SQLite Database

Additional runtime states (such as, list of files pending upload) are stored in a local SQLite database. These files store internal details for the Tetra Agent. Do not manually change these files.

Perform the Upgrade

To upgrade a Tetra Agent, use the new version of the installation package that you obtained from your CSM. When you upgrade a Tetra Agent, you select the Upgrade option instead of the Install option. This method upgrades the Tetra Agent in-place which retains its existing configuration settings and state, but deletes the local copies of the log files.



Log files are backed up in CloudWatch.

Verify the Upgrade

Once the Tetra Agent has been upgraded, you should verify the upgrade:

  1. Open the Management Console and verify that the new version displays in the Management Console's title bar.
  2. Verify that the configuration settings are the same as they were before.

Upgrade the Tetra Agent Hardware

To upgrade the Tetra Agent hardware:

  1. Carefully review the prerequisites and installation instructions for the Tetra Agent. Ensure that the new hardware meets the necessary requirements.
  2. Follow the Prepare the Tetra Agent instructions.
  3. Follow the Tetra Agent's installation instructions to install the Tetra Agent on the new hardware instance.
  4. Replace the SQLite database on the new hardware with the SQLite database that was on the previous hardware.
  5. Follow the Verify the Upgrade instructions.


Configuration Notes

You can disable a Tetra Agent if you notice incorrect behavior. When you disable a Tetra Agent, it cannot communicate with the GDC or Cloud until you re-enable it.

If you configure a Tetra Agent for Direct S3 Upload, then the temporary AWS credentials are valid and used until the expiration time (set to less than an hour) is reached. After the Tetra Agent reaches the expiration time, the Tetra Agent cannot retrieve new temporary AWS credentials.