🚧

Agent and IDS/Protocol/Task Script Compatibility

This release of the Tetra Empower Agent has changes that impact the Tetra Empower intermediate data schemas (IDS) and their parsers. Using this version of the Tetra Empower Agent with an incompatible or older version of the protocol and IDS will break your pipelines.

Please make sure that you have the compatible versions of the Tetra Empower IDS parsers and update the pipelines and processes to use the new protocols and IDS, so that pipelines continue to work as expected. For more information about the compatible IDS, protocol, and task script versions, see the Tetra Empower v5.x.x release notes.

This page describes how a system administrator can install, configure, and run Tetra Empower Agent versions 5.3.x.

To run the Tetra Empower Agent, you must do the following:

1. Verify the prerequisites:
   • Make sure the requirements of the hardware, software, and user account are met
2. Install and configure the Agent:
   • Select and set up a data connection
   • Install the Tetra Empower Agent
3. Verify the Tetra Empower Agent Installation:
   • Verify that the Tetra Empower Agent was installed on the local drive
4. Verify the Tetra Empower Agent Connection Setup:
   • Verify the connection to empower
   • Verify the empower group account
   • Verify connection settings
   • Verify injection configuration settings
   • Save and start the Agent
   • Verify that the Tetra Empower Agent can retrieve Empower data

For instructions, see the procedures in each of the following sections.

📘

NOTE

To restrict access to the local Tetra Agent Management Console, you can edit the Agent’s installation folder’s permissions to grant least privilege access. For more information, see Restrict Access to Agent Installation.

Prerequisites

Hardware and Software Requirements

To install and run Tetra Empower Agent v5.2.x, the following hardware and software versions are required:

• One of the following Microsoft Windows versions:
  • Windows 10 Enterprise or Professional, 64-bit
  • Windows Server 2016 Standard or 2019 Standard
• .NET Framework 4.8
• 16 GB RAM at minimum (64 GB RAM is recommended)
• 8 Core CPU
• Minimum 300 GB of free disk space
• Empower 3 Service Release 2 or higher Client Software (English Edition)

📘

NOTE

• The required disk space needs to accommodate both the project data fetched from the Empower Oracle database and the project Raw files from the Empower File System.
• If installing Empower software on an English-language computer, make sure that you confirm the Windows region settings are configured for English (United States). The symbols for English (United States) use decimal formatting, not comma formatting, which is important when displaying numeric values (12.56, not 12,56).
• For files produced by Empower, the limit is approximately 2.5 GB for a RAW JSON file.

🚧

Empower 3 Client Software

You must install the Tetra Empower Agent at the same workstation where the Empower 3 Client Software is running. The Tetra Empower Agent is compatible with Empower 3 Service Release 2 or higher. If the Empower 3 Client version is earlier than Service Release 2, then you must upgrade the Empower 3 Client software. For detailed system requirements, see the Client Software section in the Empower 3 System Administrator Guide.

User Account Credentials

To run Tetra Empower Agent v5.3.x, you must have the following valid user account credentials:

• Empower DB User account: Provides access to the Empower database through the Empower Toolkit.
• Empower Oracle TNS Names details: Provides access to the Empower database through the Empower client (the required information can typically be found in the <Oracle Client Install folder>\\network\\admin\\tnsnames.ora file in the Oracle folder of the Empower client machine).
• Group User account: Runs the Tetra Empower Agent and accesses the Empower file server.

📘

NOTE

Projects available for extraction from the Tetra Empower Agent depend on the access permissions of the EmpowerDB User account. The Oracle Transparent Network Substrate (TNS) Names' details are used to extract the date fields in a consistent ISO format.

You must ensure that the Group User account that runs the Tetra Empower Agent is part of the Empower User Group in the Active Directory Organization Unit, and has the same privileges as the standard Empower User, which requires a read-only permission to access the Empower RAW data on the Empower File System. This account must have the following privileges from Empower and Windows.

• The Group User account should have Empower View Audit Trail permissions to detect the Injection changes.
• The Group User account should have Windows Log on as a service permissions to run the Agent as Windows Services program.
• Always verify the date time and decimal format settings of the Group User’s Windows Profile to ensure they match the settings from the current login user who's configuring the Empower Agent.

🚧

Notes for upgrade

If trying to upgrade the Empower Agent from the previous version, please ALWAYS back up the Agent’s SQLite database before proceeding.

The Agent's SQLite database is in the following location:<existing_empower_agent_installation>\db\applicationdb.sqlite

Installation and Configuration

Step 1: Set Up a Data Connection

The Tetra Empower Agent generates RAW JSON files that are uploaded to the TDP either directly or through a Data Connector. Before you install the Tetra Empower Agent, you must set up the agent's data connection to the TDP by using one of the following methods:

• On-Premises—requires the use of a Tetra Hub.

  -or-

• TDP (No Connector)—allows the Agent to upload source data directly to the TDP or Amazon Simple Storage Service (Amazon S3).

For more information about each data connection option, see see Agent Deployment Options.

Step 2: Install the Tetra Empower Agent

TetraScience provides a Microsoft Installation Package (.msi) file to install the Tetra Empower Agent on the host server.

To get the installation package and install the Agent, do the following:

1. Get the link to the .msi installation package by contacting your TetraScience customer success manager (CSM).
2. After you have the link to the installation package, download the Agent to a machine that runs a supported Empower version.

🚧

IMPORTANT

To access the server and run the installation package, you must sign in as an Administrator.

3. Move the downloaded files to a local folder. Then, run the following command to install the software: TetraScience.Agent.Empower.v5.2\_.x\_\_.msi

Default Installation Folder Location

C:\TetraScience\TetraScience.Agent.Empower.v5.2.0\

After the Tetra Empower Agent is installed, the TetraScience Agent Empower shortcut is added to the Windows All Program Group menu.

📘

NOTE

To initialize the Tetra Empower Agent, you must add the configuration settings.

Verify Tetra Empower Agent Installation

Confirm that the Tetra Empower Agent was installed on the local drive by verifying the following:

• The TetraScience Empower Agent is installed under the C:\\TetraScience directory by default.
• Under the TetraScience folder, TetraScience.Agent.Empower.v5.2.x appears.
• The following subfolders appear under the TetraScience.Agent.Empower.v5.2.x folder:
  • bin
  • bin64
  • db
  • logs
• The TetraScience folder is added to the Windows Start Menu, which includes the TetraScience Agent Empower application.

📘

NOTE

To launch the TetraScience Empower Agent Management Console, select the TetraScience Agent Empower link in the Windows Start Menu.

Verify the Tetra Empower Agent Connection Setup

To verify that the Agent can connect to Waters Empower and the TDP, do the following.

Verify the Connection to Waters Empower

1. Open the Tetra Empower Agent Management Console. Then, in the left navigation menu, under Menu, choose Configuration. The Agent configuration page opens.
   
2. For Database Name, enter the Waters Empower Database Account.
3. For User Name, enter the Waters Empower User Account.
4. For Password, enter the Waters Empower User password.
5. For Oracle Host Name, enter the Waters Empower Database Oracle Host Name (you can get this information from tnsnames.ora file).
6. For Service Name, enter the Waters Empower Database Oracle Service Name (you can get this information from tnsnames.ora file).
7. For Port, enter the Waters Empower Database Oracle Port (you can get this information from tnsnames.ora file).
8. Select Test Connection. Then, do one of the following based on if the connection test is successful or not:
   • If the connection was successful, a dialog appears. Select OK to confirm the connection to the Empower system.
     -or-
   • If the connection was not successful, then check the database account name and Empower user account credentials or the Oracle host name, service name, and port. Then, repeat the steps to verify the connection.

Verify the Empower Group Account

1. Open Tetra Empower Agent Management Console. Then, in the left navigation menu, under Menu, choose Configuration.
2. For User Name, enter the Waters Empower User Group Account. This is an active directory authenticated user account.
3. For Password, enter the password for the user. This is an active directory authenticated user account. After you move the cursor, the Tetra Empower Agent validates the account immediately.

Verify Connector settings

1. Set up a Tetra Hub or use a direct connection to the TDP (TDP (No Connector)). For more information, see Agent Deployment Options.
2. From the Tetra Empower Agent Management Console, in the left navigation menu, under Menu, choose Configuration.
3. Select S3 Direct Upload toggle value. The default value is Yes. For more information, see S3 Direct Upload (Recommended).
4. Select Receive Commands toggle value. The default value is No.
5. (Optional) To reset the default settings for data connection status checks and agent log file uploads, select Advanced Settings The Agent Configuration Advanced Settings dialog appears, which includes the following settings:
   • Data Connection status check every: Indicates how often the software checks the status of the connection (heartbeat) between the TDP and the Agent. If the TDP doesn't receive a heartbeat message for more than five minutes, the platform assumes that the Agent is offline. The default value is 30 seconds.
   • Agent log files upload every: Indicates how often the Agent uploads log files to the Data Lake. The default value is 300 seconds.
   • To keep the recommended settings, or to save the new values you entered, choose OK. Only consider changing these values if connection checks (heartbeat) frequency needs to be changed, or if logs files are needed to be uploaded to the TDP at a different frequency.
     
6. For Agent Id, enter the Agent ID (created in the TDP).
7. For the Connection Url field, enter the complete URL of the Tetra Hub, Generic Data Connector (GDC) attached to a Data Hub, or No Connector, based on your connection type.
8. (For “TDP (No Connector)” setups only) If you’re using an Agent without a Connector, make sure that you do the following:
   • For Org Slug, enter your organizational slug. To get your organizational slug, see Viewing Organization Details. The organizational slug is required when using a JSON Web Token (JWT). Adding the slug to this field attaches it to the Agent’s API request headers.
   • For Authorization, select Add/Edit. Then, enter your JWT in the dialog that appears. To get a JWT, see Generate a JSON Web Token for an Existing Service User. Then, choose Save to encrypt and save the JWT. The Agent validates the connection immediately and displays the updated connection status next to the Connection Url field.
9. (Optional) To specify the Destination Id for allowing the files to be uploaded to the same S3 location from multiple agents. Destination Id is a UUID. This feature helps to split the load into multiple agents for scaling horizontally.
10. Verify Enable Injection Service is set to Yes and Enable Archive Service is set to No.
    After you enter the information, the Tetra Empower Agent immediately validates the connection status.

Verify Injection Configuration Settings

1. In the Agent Run Time section of the Injection portion of the Configuration page, verify Upload Raw File to TDP is set to Yes.
2. For the Empower Agent Output Folder field, select a folder in the local file system where the Empower Group User (if configured) or local system user has write access.

📘

Injection Configuration

For the rest of the configuration settings in the Injection section, keep the default values. If any particular setting needs to be updated, see [TBD?]

👍

Save Configuration and Start the Agent

After all of the configurations are verified, remember to Save and Start the agent.

Save and Start the Agent

In the Agent Management Console, select the top Save button. Then, select the Start button and verify that the Agent Status displays as Running.

Verify that the Tetra Empower Agent Can Retrieve Empower Data

When the Tetra Empower Agent is running, you can validate the detection, generation, and upload of the Tetra Empower Agent RAW JSON file by doing the following:

1. Open the Tetra Empower Agent Management Console. Then, under Menu in the left navigation pane, select Injection Service and choose Project.
   
2. Choose Refresh to retrieve the most recent list of Empower projects.
3. From the Project list, select a test project (for example, Demo).
4. Select the 3D MS Method option for the selected project. The default setting is Get3D. You can also select None or GetSpectra. To understand how this impacts the injection generation, see Tetra Empower Agent User Manual (Version 5.2.x).
5. Choose Save.
   

🚧

Notes for Peak Amount and Peak Height data precision

Please verify the setting of Number of Digits of Precision for Area and Height in Processing tab from Empower Project Properties.
The Agent will output the values with the specified precision.

Verify Processing Status

1. From the Tetra Empower Agent Management Console, navigate to the Injection Summary tab, and review the Tetra Empower Agent status.
2. After the Agent completes its routine scan and generates the RAW file, you can validate these tasks listed in the Processing Summary section:
   • Scanned Injections: Number of injections the Agent detected for the Demo project
   • Generated RAW File: Number of injections the Agent retrieved for the Demo project
   • Uploaded: Number of injections the Agent uploaded to the Tetra Data Platform

The count for each step listed in the Processing Summary section should match the total injection count in the Waters Empower client.

Verify That the Generated RAW Files Are Uploaded to the TDP

1. Sign in to the TDP.
2. From the Search File page, check the RAW files of project Demo in the search result.
3. Verify that the total number of RAW files from project Demo equals 131.

🚧

Daily Agent Run Schedule

After you complete the initial installation and configuration, you can use a Windows task script to restart the Tetra Empower Agent (for example, you can set it to run at 1:00 a.m.) and make sure that it runs constantly.