Installing to agent servers

Every agent server runs on the kCura.EDDS.AgentManager Windows Service. This service launches all Relativity agents and runs the agent framework.

During Relativity installation, you can select whether to install the Agent Service on your server. The server running the Agent Service functions as the primary agent server because it runs all of the single-installation agents. See Primary agent server.

When you edit the RelativityResponse.txt file set the DEFAULTAGENTS setting in the Agent Properties section to 1 to install the full set of default Relativity agents to your server. See Secondary agent server for more information.

Note: The DEFAULTAGENTS setting only works during initial installation. This field is ignored on upgrade.

Using the Relativity user interface, you can add, modify, or delete Relativity agents from the server. See Managing agents in Relativity for more information.

To run a job in a workspace, you must have that particular agent running on the agent server assigned to the resource pool where your workspace resides. For example, if the Transform Set Manager agent is not present on any of the agent servers in the resource pool that houses your workspace, you won't be able to run a Transform Set job.

Note: This applies to all agents except the Case Manager, Case Statistics Manager, Distributed Job Manager, Distributed Job Worker, and File Deletion Manager. These agents run across the environment regardless of their assigned server and resource pool. For more information, see Agents and Agents.

Primary agent server

The primary agent server in a Relativity environment is intended to run one full set of agents, including both single-installation and multiple-installation agents. In addition to hosting a full set of agents, you can optionally configure your primary agent server to host secondary instances of the multiple-installation agents.

We recommend installing only one additional instance of each Branding Manager or Production Manager agent on your primary agent server. See List of agents for details.

Secondary agent server

If you select the Include default agents check box during installation, the Relativity installation package installs the full set of agents on a secondary agent server. You can then manually remove the single-installation agents and add additional multiple-installation agents. You can add the Workspace Upgrade Manager agent to a secondary server, but you should install only a single agent of this type per environment.

You can add several of the following multiple-installation agents to each secondary agent server:

  • Application Installation Manager
  • AssistedReviewWorkerAgent
  • Branding Manager
  • dtSearch Index Worker
  • OCR Worker
  • Production Manager
  • Content Analyst Index Manager
  • Workspace Upgrade Worker
  • Distributed Job Manager
  • Distributed Job Worker

Secondary agent servers are commonly configured to run 2x quad-core processors. This configuration supports any combination of eight agents, such as four Branding Manager agents and four Production Manager agents.

Note: In this example, the combined count of Branding and Production Managers can't exceed the total number of individual processor cores present on the server.

Installing agent servers in a workgroup

After installing the Relativity agent server on a machine that is a part of a workgroup, start the kCura.EDDS.AgentManager service under a Windows account that is a member of the Administrators group.

Note: If your environment contains workspaces with Data Grid enabled fields, agent servers must have access to the endpoint URL on the Elasticsearch client node for dtSearch functionality.

Adding an agent server to a resource pool

You need to add your agent server to a resource pool after you configure it. This step ensures that the agents on the server are available to run jobs.

  1. From Home, select the Resource Pools tab.
  2. Select the resource pool to which you want to add the workgroup server.
  3. In the Resource Pool information screen, go to the Agent Servers section and click Add.
  4. Select the NewAgentServerMachineName workgroup server, and then click OK.