How To Set Up An Agent

Last Updated: 06/14/2018 Introduced in Version: 4.0

Warning: Setting up Agent involves very detailed settings and every provider and customer environment is different.  If Agent is new to you, it may take time and several attempts to get all of the identifying data and settings correct to allow for secure and reliable authentication.  We recommend making sure you have someone from your organization with experience in Agent and your IT infrastructure available to streamline the process.  Our support team is available to help, but may not be not be able to answer questions or solve problems that are unique to your company.

This tutorial demonstrates how to Set Up an Agent in Decisions. Agent in Decisions is an application that allows intuitive integration with other servers or machines. After Agent is created and registered in Decisions, it can be downloaded and installed on the client machine. Then, Agent creates Decisions Management Agent Local Service on the client machine. This service allows Decisions Server treat client machine as a part of the local system.

Example:

In this example we are going to demonstrate how to Set Up an Agent, download and install it on the client machine, and validate client initialization from Decisions Server.

We begin with creating an Agent in Decisions Server. Navigate to System > Designers > Agents Folder in the Studio. Then, click Add/Register Agent on the Folder Actions Menu.

Note: in order to create an Agent, URL to Decisions Portal cannot be localhost.

In the resulting pop-up window we Name the Agent and click Ok to save and continue.

Next, we should be able to see our Agent created in the Agents Folder.

Then, we move to our client machine and log in to Decisions Server. On the client machine we navigate to System > Designers > Agents > Our Agent Folder and click Download agent on Folder Actions Panel.

If we switch back to our Decisions Server we should see an entity in Our Agent’s Folder.  Unknown Client entity tells us that our client is not Identified yet.

Next, we switch back to our client machine, locate downloaded Agent and Install it.

Agent installs and creates Decisions Management Agent Local Service.

Then, we switch back to Decisions Server. In our Agent’s Folder, we see only one entity: Client Identity named by our client machine name. This means that our Client is Identified by our Server and ready for communication.

In our Agent’s Folder we can Get Status for our Client using Action on Folder Actions Panel…

…And receive pop-up Notification with Client’s Status.

Also, we can use Ping Agent Action to ping our client and see if it is still available.

Server – Client communications with Agent

The following diagram demonstrates communication between Decisions Server and Client machine where Agent installed.

The Agent also uses port 4502 to talk directly to its Decisions host server.

The reverse communication path (Agent client to Decisions Application Server) is what needs to be open.  On the Decisions Server, a firewall rule should be added to allow incoming connections on ports 4502-4534.  Once that is in place, restarting the Agent should put it in Live Connection mode.

If the Agent cannot connect to its host Server on port 4502, then it will use a polling mode on port 80/443 instead.

Client machine communicates with the Server through port 80 (if Server is set up to http) or through port 443 (if Server is set up for https). Therefore, port 80 or 443 should be open for outbound connections on Client’s Firewall.

Server communicates with a Client through the range of 4502-4534 ports (the first in range that is not in use). Decisions Management Agent Local Service on Client machine needs to have permissions for the inbound connections on Client’s Firewall.

Additional Resources