Configuring your conversion agents

When you convert a document in Relativity, that conversion job is performed by a dedicated conversion agent.

Relativity Server 2021 uses Service Bus for Windows Server to submit conversion jobs and communicate with your designated conversion agents. You must install either Service Bus for Windows Server or RabbitMQ before you run your upgrade to Relativity Server 2021. For more information, see Installing Service Bus for Windows Server or Installing RabbitMQ.

If you have dedicated conversion workers, it's recommended that you re-purpose the dedicated workers as agent servers with a single conversion agent. For more information, see Re-purposing a conversion worker as a conversion agent.

If you have a Tier 1 or similar environment that doesn't have any Invariant workers dedicated solely to conversion, you can add a conversion agent to an existing agent server. Or you can allocate new hardware dedicated to conversion. For more information, see Adding conversion agents to an environment with no dedicated conversion workers.

This page contains the following sections:

Conversion agent considerations

Consider the following about conversion agents when installing or upgrading to Relativity Server 2021:

  • On a new installation of Relativity Server 2021, Relativity automatically creates one conversion agent and adds it to the default secondary agent server. You should then add the agent server to the appropriate resource pool. For more information, see Resource pools.
  • On upgrade to Relativity Server 2021 from 9.4 or previous, you must add the  Service Bus agent server to the appropriate resource pool. Then, manually create the conversion agents using a new agent type of Conversion agent. For more information, see Agents.

Re-purposing a conversion worker as a conversion agent

If you have existing Invariant workers that Relativity uses solely for conversion, you can re-purpose your hardware to support conversion agents.

Note: If your worker server handles more than just conversion jobs, do not follow these steps. You still need Invariant workers for other jobs such as Processing, Imaging, and Save as PDF.

To re-purpose a conversion worker as a conversion agent, perform the following steps:

Note: These steps are only required if you're upgrading from Relativity 9.3 or lower, since conversion was performed by a worker in those versions, and only if your worker was designated for conversion.

  1. Ensure either Service Bus for Windows Server or RabbitMQ is installed in the environment.
  2. Uninstall Invariant on the server via Windows Control Panel Add/Remove Programs. Doing this uninstalls existing Invariant applications.
  3. (Click to expand)

    uninstalling invariant

  4. If it's still visible in the Server Management tab in Relativity, delete the old worker from that location.
  5. Set up a new agent server for conversion agents. For more information, see Infrastructure configuration.
    • This process requires a manual copy of a valid SSL certificate to the agent server.

To set up the second agent server, perform the following steps:

    1. Edit the RelativityResponse.txt file to include only the lines enabled (=1).
    2. INSTALLAGENTS = 1 in the feature section.

    3. Run the Relativity installer on the machine. For more information see, Agent installation.

    Note: Service Bus for Windows Server is required only for the first agent server running conversion jobs.

Adding conversion agents to an environment with no dedicated conversion workers

If your environment doesn't have any Invariant workers dedicated to conversion, you have two options when setting up conversion for Relativity Server 2021.

Adding a conversion agent to an existing server

You can add a conversion agent to one of your existing servers.

If you use this option, add the conversion agent to one of your lesser-used agent servers. You could also rearrange some of your existing agents between your agent servers, which dedicates more resources to conversion.

For greater control over the resources you allocate to conversion, you can also install a new agent server in a virtual machine and host a single conversion agent on that machine. For more information see, Agent installation.

Allocate additional hardware to host a new agent server

You also have the option of allocating additional hardware to host a new conversion agent server. To allocate additional hardware, follow these steps:

  1. Ensure that either Service Bus for Windows Server or RabbitMQ is installed in the environment.
  2. Set up a new, secondary agent server for conversion agents. For more information, see Infrastructure configuration.

To set up a secondary agent server, perform the following steps:

  1. Ensure that either Service Bus for Windows Server or RabbitMQ is installed in the environment.
  2. Edit the RelativityResponse.txt file to include only the lines enabled (=1).
  3. INSTALLAGENTS = 1 in the feature section.

  4. Run the Relativity installer on the machine. For more information see, Agent installation.
  5. Note: Service Bus for Windows Server or RabbitMQ is only required for the first agent running conversion jobs.