Agent Setup and Testing
  • 13 Jun 2022
  • 2 Minutes to read
  • Dark
    Light

Agent Setup and Testing

  • Dark
    Light

The Agent server must install the ASP.NET Core Runtime 6.0.5 Hosting Bundle specifically.
Without this, the Agent will fail to communicate nor connect with the server. Other Core Runtime versions do not contain the required dlls.

Please check the server has this installed before proceeding. 

This article reviews the setup and testing of an Agent, as well as how to uninstall one. Note that setup requires adding and registering an Agent, installing it to a machine, and implementing it into the Decisions environment.

Protocol Agents are directly affiliated with network security as well as other aspects. Please see Introduction to Agents prior to Agent setup. 

Setup

Non-admin and non-Designer users should have, at minimum, "Can Use" permissions enabled on a Designer Element in order to use its function with Agents.

When registering an Agent, the Decisions instance Portal Base URL can not be localhost. To adjust the Portal Base URL, refer to Changing the Portal Base URL. 

  1. From the Decisions Studio, navigate to System > Designers > Agents. Click ADD/REGISTER AGENT. 
  2. Provide a Title and optional Description, then click REGISTER AGENT. 
  3. From the Agents Folder, right-click the newly added Agent and select Download Agent
  4. Extract the contents of the .zip file. 
  5. As an Administrator, Install the Agent from the download location. This file installs and creates the Decisions Management Agent. 
  6. After the Agent installs, copy over AgentSettings.xml and PortalPublicKey.key to C:\Program Files\(x86)\Decisions Management Agent.
  7. Select the Start menu on the Local machine, then search for and open Services.
  8. Locate the Decisions Management Agent Service, right-click it and Start the Agent. 


Testing 

For testing purposes, open the Agent Dashboard found at System > Designers > Agents.

This dashboard displays all deployed Agents and Recent Agent Actions.  Any Unknown Client entity suggests the client is not yet identified.
  1. On the Decisions Server, navigate to System > Designers > Agents > Test Agent.
    Ensure that the STATE of the Agent is Complete.

    A Complete status indicates the client has been identified by the Decisions Server and is ready for communication
  2. Under Deployed Agents, right-click the Agent and select Ping Agent

    Pinging the Agent checks to see if the Agent is available. 

  3. After the notification displays, refresh the Recent Agent Actions to ensure that the Ping Action executed.

  4. Right-click the Ping Action and click View Results.
    If applicable, resulting data from the Agent Action will display.



Check Agent for Polling Mode

Agents for Decisions can enter polling mode if no ports are available which can lead to performance issues. To confirm if an agent is in polling mode:

  1. Right-click and use the View Last Status for an agent

If the agent is properly configured, View Last Status will display Live Connection: True. If this message is not shown, the agent is currently in polling mode.


Uninstalling and Removing an Agent 

In the event that a user needs to remove an Agent, or the Agent needs to be updated and replaced with a new version, Agents in Decisions can be uninstalled from the File System.

To do so:

  1.  From the File System, open to Control Panel.
  2. From the Control Panel, under Programs, select Uninstall a Program.
  3.  From the Programs and Features window, locate Decisions Management Agent Bootstrapper, select it, then click Uninstall.
  4. Confirm the Uninstall by selecting Yes.
  5. Confirm that the Agent has been uninstalled by navigating to System > Designers > Agents in the Decisions Studio



Was this article helpful?