TetraScience

Tetra Data Platform Documentation

Welcome to TetraScience Tetra Data Platform (TDP) documentation site. Here, you'll find Product Documentation, API Documentation, and Release Notes for TDP components.

Release Notes    API Documentation

Cloud Configuration of Tetra Agents

There are two ways to configure agents. You can configure them directly by creating the connections in the TDP (in the cloud) and locally configuring the agents. Or, you can configure the agents in the Cloud Configuration screen.

📘

NOTE:

For version 3.1 of the software, only the File-Log Agent can be configured using this feature.

Access the Agents Screen

To use the cloud configuration feature, you'll need to access the Agents screen. To access the Agents screen, complete the following steps.

  1. Click the Hamburger Menu button, which is in the top left corner of the page.
Hamburger Menu buttonHamburger Menu button

Hamburger Menu button

  1. From the menu, select Data Sources, then Agents.
Data Source Agents Option SelectedData Source Agents Option Selected

Data Source Agents Option Selected

  1. The Agents screen appears.
Agents ScreenAgents Screen

Agents Screen

Each field in this screen is listed in the table below.

FieldDescription
Number of AgentsTotal number of agents listed.
OnlineNumber of agents that are online.
OfflineNumber of agents that are offline.
Search Text BoxAllows you to find the names of agents that match what is typed in the text box.
Connector Type FilterAllows you to see all results (All), or to view only GDC (Generic Data Connector) or CDC (Cloud Data Connector).
Agent TypeSelections include All, as well as the different types of agents that we support, such as Empower or File-Log Agent.
Status FilterFilters results so that you can see all statuses, only agents that are online, and only agents that are offline.
StatusIndicates whether the agent is online or offline, the type of agent, the type of configuration (cloud or local), and whether the queue is enabled or disabled.
DetailsShows the details for each agent, the source, and shows tags.

Create a New Agent

These instructions explain how to use the centralized config feature to select a connector for an agent, add an agent record, and install the agent.

  1. In the Agents page, click the Create New Agent button which is in the upper right corner of the page.
Create New Agent ButtonCreate New Agent Button

Create New Agent Button

  1. The Add Agent wizard appears.
Add Agent Wizard (Select Connector)Add Agent Wizard (Select Connector)

Add Agent Wizard (Select Connector)

  1. Select an existing connector. If you don’t have a connector, then you’ll need to create one. See the Tetra Integrations (Data Sources) section of the documentation. When finished, click Next.
  2. The wizard advances to the next page, which allows you to add information on the agent.
    a. Add the agent’s name.
    b. Add the description.
    c. If desired, add attributes like a label, metadata, or tags. For more information on these things, see this topic.
    d. Add the Agent Type from the drop down menu.
    e. Add source type.
Add Agent Wizard (Create Agent)Add Agent Wizard (Create Agent)

Add Agent Wizard (Create Agent)

📘

NOTE:

If the agent type is the File-Log Agent, you can choose to configure it.

  1. Click Create Agent.
  2. The Agent is created. Choose whether you want to install the agent later or now. If you want to install the agent later, click Install Agent Later. If you want to Install Agent Now, click Install Agent Now.
Agent Created MessageAgent Created Message

Agent Created Message

  1. If you chose to install the agent now, the Add Agent page appears. Complete the instructions on that page to install the page. Note that the installation documentation is indicated in step 1.
Add Agent Wizard (Install Agent)Add Agent Wizard (Install Agent)

Add Agent Wizard (Install Agent)

  1. When complete, click the Check Status button to see if the agent is online or offline.
  2. Click Done to close the wizard.

Edit an Agent

To edit an agent record in the centralized configuration agents, complete the following steps.

  1. In the Agents page, select the Edit option for the agent whose information you want to modify. Edit is an option on the right side of the agent’s entry.
Edit OptionEdit Option

Edit Option

  1. Modify the agent’s name, description, attributes, agent type, and or source type.
Edit AgentEdit Agent

Edit Agent

  1. Click the save button.
  2. The Cloud Configuration is sent to the on-prem agent.  As long as the on-prem agent has the queue enabled in their interface, the configuration will be pushed there. 
    

Get Instructions for how to Upload CURL Command to an Agent

For ease of use, an example of how to use a curl command to upload data to an agent can be accessed from the Agent page.

  1. In the Agents page, select the More option for the agent whose information you want to modify. The More option is in the drop-down menu on the right side of the agent’s entry.
  2. Select Upload curl Command from the menu that appears.
Curl UploadCurl Upload

Curl Upload

  1. Make note of the items needed, then click Close.

Disable an Agent's Connection

When you disable an agent's connection, the TDP will not accept data from the agent. The agent will still function. but the files will not be copied to the Tetra Data Lake via the TDP.

To disable an agent's connection, do the following.

  1. In the Agents page, select the More option for the agent that you want to disable. The more option is in the drop-down menu on the right side of the agent’s entry.
  2. Select the Disable option.
Disable OptionDisable Option

Disable Option

  1. A message appears asking you to confirm that you want to disable the agent. Click OK.
  2. In the Agent entry, Queue Disabled apears in the status.

Enable an Agent's Connection

To enable an agent, do the following.

  1. In the Agents page, select the More option for the agent that you want to enable. The more option is in the pull down menu on the right side of the agent’s entry.
  2. Select the Enable option.
  3. A message appears asking you to confirm that you want to enable the agent. Click OK.

Delete an Agent

To delete an agent, complete the following steps.

  1. In the Agents page, select the Delete option for the agent whose information you want to modify. Edit is an option on the right side of the agent’s entry.
  2. A message appears asking you to confirm that you want to delete the agent. Click OK.
  3. The agent is deleted and disappears from the list.

Enable the Connector's Queue

To enable the connector's queue, complete the following steps.

  1. In the Agents page, select the More option for the agent that you want to enable. The more option is in the pull down menu on the right side of the agent’s entry.
  2. Select the Enable Queue option.
Enable Queue OptionEnable Queue Option

Enable Queue Option

  1. A message appears asking you to confirm that you want to enable the queue. Click OK.
  2. In the entry, Queue Enabled appears in the status.

Disable the Connector's Queue

To disable the connector's queue, complete the following steps.

  1. In the Agents page, select the More option for the agent that you want to disable. The more option is in the pull down menu on the right side of the agent’s entry.
  2. Select the Disable Queue option.
  1. A message appears asking you to confirm that you want to disable the queue. Click OK.
  2. In the Agent entry, Queue Disabled appears in the status.

Troubleshooting Agent Configuration Issues

  • If you get a message "Cloud/Local Configuration is Out of Sync" - it means that the Cloud and the Local configurations are different. You can review the differences by clicking the Review Cloud Configuration and Review Local Configuration buttons. You can then choose whether to push the configuration or reject it.
  • If you need the org slug and token you'll need to either get it from your account page or generate a token for a service user.
  • Note that in the File-Log Agent, the username needs to have a dash, e.g., Administrator fails, but .\Administrator works

Updated 2 months ago


Cloud Configuration of Tetra Agents


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.