Tetra Empower Agent Installation Guide (Version 5.1.x)

🚧

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 the Tetra Empower Agent and verify the system integration.

Before you can run the Tetra Empower Agent, you must do the following:

  • Create a Tetra Empower Agent in the Tetra Data Platform (TDP)
  • Set up the data connection
  • Make sure that you have the required hardware, software, and user account credentials

For more information about all of the features and configuration options for the Tetra Empower Agent, see the Tetra Empower Agent User Manual (Version 5.1.x).

πŸ“˜

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.

Set Up the 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:

For more information about each data connection option, see Tetra Agent Integration and Connector Overview.

Hardware and Software Requirements

To install and run Tetra Empower Agent v5.1.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 150 GB of free disk space
  • Empower 3 Service Release 2 or higher Client Software

πŸ“˜

NOTE

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 the Tetra Empower Agent, you need 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 provides access to the Empower file server.

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 make sure that the Group User account that runs the Tetra Empower Agent is part of the Empower User Group in the Active Directory Organization Unit. You must also make sure that the Group User account has the same privileges as the standard Empower User. The Tetra Empower Agent uses this account to access the raw data stored in the Empower file server.

Install the Tetra Empower Agent

The Tetra Empower Agent includes an installation package. For download instructions, please contact your Customer Success Manager (CSM).

After you move the downloaded files to a local folder, run the following command to install the software: TetraScience.Agent.Empower.v5.1\_.x\_\_.msi

The following is the default installation folder location:

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

TetraScience Empower Agent Installer (Select Installation Folder)

TetraScience Empower Agent Installer (Select Installation Folder)

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.1.x appears.
  • The following subfolders appear under the TetraScience.Agent.Empower.v5.1.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 pane, under Menu, choose Configuration.
  2. Enter the Waters Empower Database Account in the Database Name field.
  3. Enter the Waters Empower User Account in the User Name field.
  4. Enter the Waters Empower User password in the Password field.
  5. Enter the Waters Empower Database Oracle Host Name in the Oracle Host Name field (you can get this information from tnsnames.ora file).
  6. Enter the Waters Empower Database Oracle Service Name in the Service Name field (you can get this information from tnsnames.ora file).
  7. Enter the Waters Empower Database Oracle Port in the Port field (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/Empower user account credentials or the Oracle host name/service name/port. Then, repeat the steps to verify the connection.
1259

Verified Empower DB Connection

Verify the Empower Group Account

  1. Open Tetra Empower Agent Management Console. Then, in the left navigation pane, under Menu, choose Configuration.
  2. Enter the Waters Empower User Group Account in the User Name field. This is an active directory authenticated user account.
  3. Enter the password for the user in the Password field. This is an active directory authenticated user account.

After you move the cursor, the Tetra Empower Agent validates the account immediately.

1351

Verified Empower Group User

Verify Connector settings

  1. Set up a Data Hub/Data Connector or use a direct connection to the TDP (no connector).
  2. From the Tetra Empower Agent Management Console, in the left navigation pane, under Menu, choose Configuration.
  3. Select S3 Direct Upload toggle value. The default value is Yes.
  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:
    • The Data Connection status check every setting has a default value of 30 seconds.
    • The Agent log files upload every setting has a default value of 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. Enter the Agent ID (created in the TDP) in the Agent Id field.
  7. Enter the complete URL of the GDC or no connector in the Connection Url field.
  8. (Optional if you select no connector) Enter the Org Slug and JSON Web Token (JWT) in the Org Slug field and Authorization field, respectively.

After you enter the information, the Tetra Empower Agent immediately validates the connection status.

Verified Connector status

Verified Connector 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.
Agent Run Time settings

Agent Run Time settings

πŸ“˜

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 Tetra Empower Agent User Manual (Version 5.1.x) for details.

πŸ‘

Save Configuration and Start the Agent

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

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.1.x).
  5. Choose Save.

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.