Installing and configuring Processing

This topic provides information on installing and configuring processing so that you can run it in your Relativity environment.

This page contains the following information:

You must have the following in order to use processing:

  • A processing license. See Licensing for more information.
  • The worker manager server installed and configured. For more information, see Worker manager server installation. 
  • The worker manager server attached to the resource pool in which the workspace resides.
  • A token-authentication processing Web API path specified for the ProcessingWebApiPath entry in the Instance Settings table.

Upgrade considerations for Relativity Goatsbeard

  • The processing profile now includes a new text extraction failover method for Excel, Word, and PowerPoint files. When you select the new Native (failover to dtSearch) method, Relativity uses the native program to extract text from the file with dtSearch as a backup text extraction method if the native program fails.

Installation process

The following steps make up the comprehensive procedure for installing processing:

  1. Review the most current system processing requirements to ensure that you have enough resources to run processing. See Processing system requirements.
  2. Review the worker manager server pre-installation steps to ensure that your environment is updated with the required security and other configuration settings. See Worker manager server pre-installation steps.
  3. Run the Invariant installer for a fresh install or an upgrade. See Installing the worker manager server.
  4. Add/configure the worker manager server in the Servers tab. See Configuring the worker manager server.
  5. Add the worker manager server to a resource pool. See Adding the worker manager server to a resource pool.
  6. Enter the ProcessingWebAPIPath instance setting. See Entering the ProcessingWebAPiPath instance setting.
  7. Import the processing application. See Importing the Processing application.
  8. Configure the processing agents (if they weren't automatically created when you imported the Processing application). See Configuring processing agents.
  9. Create a choice for the processing source location. See Creating a choice for the processing source location.

Throttle settings for distributed publish

Note the following recommended throttle settings for distributed publish:

  • The following instance settings have been added to facilitate the work of distributed publish.
    • ProcessingMaxPublishSubJobCountPerRelativitySQLServer- the maximum number of publish jobs per Relativity SQL server that may be worked on in parallel.
      • This puts an absolute limit on the number of publish jobs that occur in parallel for a given SQL server, independent of how many workspaces may be publishing simultaneously. This means that it overrides the limit set by ProcessingMaxPublishSubJobCountPerWorkspace.
      • The default value is 21. Leaving this setting at its default value will result in increased throughput; however, we recommend contacting Support before you upgrade for guidance on what value will be most beneficial to you based on your environment setup.
      • This updates on a 30-second interval.
      • If you change the default value, note that setting it too high could result in web server, SQL server, or BCP/file server issues. In addition, other jobs in Relativity that use worker threads may see a performance decrease, such discovery or imaging. If you set it too low, publish speeds may be lower than expected.
    • ProcessingMaxPublishSubJobCountPerWorkspace - the maximum number of publish jobs per workspace that may be worked on in parallel.
      • You can't allocate more jobs per workspace than what is allowed per SQL server. This means that if this value is set to be higher than the value for the MaxPublishJobCountPerRelativitySQLServer instance setting, then Relativity only allows the maximum of jobs per SQL server. For example, if you have a workspace limit of 4 and a server limit of 8 and all of your workspaces are on the same SQL server, you will have at most 8 publish sub jobs running concurrently.
      • The default value is 7. Leaving this setting at its default value will result in increased throughput; however, we recommend contacting Support before you upgrade for guidance on what value will be most beneficial to you based on your environment setup.
      • Note: The default value of this setting was changed from 3 to 5 in Relativity 9.6.202.10.

      • This updates on a 30-second interval.
      • If you change the default value, note that setting it too high could result in web server, SQL server, or BCP/file server issues. In addition, other jobs in Relativity that use worker threads may see a performance decrease, such discovery or imaging. If you set it too low, publish speeds may be lower than expected.
  • The ProcessingExportMaxThreads instance setting has been deprecated in accordance with the addition of the ProcessingMaxPublishSubJobCountPerWorkspace and ProcessingMaxPublishSubJobCountPerRelativitySQLServer instance settings, which facilitate the work of distributed publish.

The following table provides the recommended values for each instance setting per environment setup:

Environment setup ProcessingMaxPublishSubJobCountPerWorkspace ProcessingMaxPublishSubJobCountPerRelativitySQLServer
Tier 1 5 7
Tier 2 6 12
RelativityOne baseline 5 7

License considerations

You are unable to process data in Relativity if any of the following conditions are true:

  • You don't have a processing license associated with your environment.
  • The processing license associated with your environment is invalid.
  • The processing license associated with your environment is expired.
  • The worker manager server associated with the resource pool is not included in the processing license.

Contact your system admin if any of these occur. For more information, see Licensing.

Note: You can add processing capacity to your environment by adding hardware and additional licenses. For more information, contact your system admin.

Importing the Processing application

To install processing in your Relativity environment, import the Processing application from the application library. To do this, you must have the appropriate system admin rights.

You must have obtained a processing license before you can import the Processing application. See Licensing for more information.

To import the Processing application:

  1. Navigate to the Relativity Applications tab.
  2. Click New Relativity Application.
  3. Select Select from Application Library.
  4. Click ellipsis button on the Choose from Application Library field.
  5. Select Processing and click OK.
  6. Click Import.

Worker manager server

The worker manager server uses workersWorkers are the machines a worker manager server uses to complete imaging, document conversion, and processing jobs. to perform imaging, and all phases of processing, including inventory, discovery, and publish. You can configure the default queue priorities for your entire environment on the Worker Manager Server layout. If you are not licensed for processing, then the worker manager server only handles save as PDF and imaging.

To enable processing in your workspace, you must add a worker manager server to your Relativity environment through the Servers tab available from Home. For information on how to do this, see Worker manager server.

Note: Don't restart a worker manager server if there are currently processing jobs running on it, as you'll need to recreate those jobs and re-run them once the server has completed restarting.

Designating a worker for processing

In order to process files, you need to designate at least one worker for processing.

To designate a worker for processing, perform the following steps:

  1. In Home mode, navigate to the Server and Agent Management tab.
  2. Select the Servers tab.
  3. From the list of servers, select the worker(s) on your worker manager server that you need to perform processing jobs.
  4. Click Edit on the worker layout and navigate to the Worker Designated Work field.
  5. Check the box next to the Processing choice.
    Designating a worker for processing
  6. Click Save.

Entering the ProcessingWebAPiPath instance setting

You must enable token authentication on your web server for certain Relativity features, such as the worker manager server, which requires this authentication type for processing.

You must also edit the ProcessingWebAPIPath Instance Setting. This setting identifies the URL that directs to the Relativity token-authenticated endpoints that Invariant uses to process and image files. Invariant requires this URL and a Relativity admin must enter it.

To do this, perform the following steps to comply with this change:

  1. While in Home mode, navigate to the Instance Settings tab.
  2. In the default All Instance Settings view, enable filters and enter ProcessingWebAPIPath in the Name field.
  3. Click the ProcessingWebAPIPath name and click Edit in the instance setting layout.
  4. In the Value field change the existing ProcessingWebAPI URL to the RelativityWebAPI URL.
  1. Click Save.

Depending on what Relativity version you're installing or upgrading, you may need to enable the RelativityWebAPI setting in IIS for Anonymous authentication in order to publish documents to a workspace.

To do this, perform the following steps:

  1. Open IIS.
  2.  To enable anonymous authentication, complete the following steps:
    1. Click on the RelativityWebAPI site.
    2. In the Features view, click Authentication.
    3. In the Authentication view, right-click on Anonymous Authentication and click Enable.
    4. Anonymous auth enabled for webapi

    1. To update the web.config file, locate it in the following folder:

      C:\Program Files\Relativity Corporation\Relativity\WebAPI

    2. Open the file in an editor. Update the authentication mode and authorization sections as follows:
      <system.web>
           <authentication mode="None" />
           <authorization><allow users="*" />
      </authorization>
      </system.web>
  3. Restart IIS.

Adding the worker manager server to a resource pool

You must add the worker manager server to the resource pool associated with the workspace that is hosting processing. You can only have one worker manager server per resource pool.

Worker manager server on resource pool

Note: Don't change the worker manager server in a resource pool after you've processed data in a workspace that uses that resource pool. Changing the worker manager server after data has been processed causes unexpected results with retrying errors, deduplication, and document numbering. This is because a new server is not aware of what has happened in the workspace before it was added.

Configuring processing agents

The Processing application uses the following agents:

  • Server Manager - retrieves version information from the worker manager server and updates the processing queue tab with this information.
  • Processing Set Manager - manages the running of processing sets, retrieves errors encountered while sets are running, and picks up processing set deletion jobs and submits them to the worker manager server.

We recommend running two Processing Set Manager agents and adding more of them as needed.

To manually install processing agents, perform the following steps:

  1. Click your name in the user drop-down menu and click Home.
  2. Navigate to the Agents tab.
  3. Click New Agent and complete the following required fields:
    • Agent Type - click ellipsis button to display a list of agents. Filter for one of the processing agents, select the agent, and click OK.
    • Number of agents - enter the number of agents you want to add.
    • Agent Server - click ellipsis button to display a list of servers, then select a server and click OK. Select the regular agent server here, not the processing worker or processing queue manager.
    • Run interval - enter the interval, in seconds, at which the agent should check for available jobs.
    • Logging level of event details - select Log critical errors only (recommended), Log warnings and errors, or Log all messages.
    • Enabled - select Yes.
  4. Click Save.

Creating a choice for the processing source location

After saving a processing set, you must select a value for the Select source for files to process field on the data sources you add to the set. To make a value available for this field, you must create a choice for the Processing Source Location field.

To create a choice for the Processing Source Location field:

  1. In your File Explorer, locate the folder containing the files that you intend to publish, right-click on it and select Properties.
  2. In the Properties window, select the Sharing tab and then click the Share button in the Network File and Folder Sharing section.
  3. In the File Sharing window, add the appropriate user and click the Share button.
  4. Return to the Sharing tab in the Properties window and copy the folder path displayed in the Network Path field. When you create the corresponding choice in Relativity, you'll use this path as the name of that choice.
    (Click to expand)
    Network path under Sharing tab
  5. Log in to Relativity and navigate to the Choices List tab.
  6. Click New Choice.
  7. Enter the following values for the following required fields:
    Choice information fields
    • Field - select Processing Source Location. The Processing Source Location field is automatically created for you.
    • Name - the name of the repository containing the files you want to process. Enter an absolute network path (UNC). For example, \\pt-func-file01.example.com\FileShare\Custodian\MJones.

      Note: The Relativity Service Account must have read access to the processing source location.

    • Order - the desired order of the choice.
  8. Add the source location you just created to the resource pool:
    1. Click your name in the user drop-down menu and click Home.
    2. Navigate to the Resource Pools tab.
    3. Select the pool to which you want to add the source location.
    4. Click Add on the Processing Source Locations object.
    5. Select the source location choice you created and click Ok. The source location is now attached to the resource pool.

Logging for processing

The logging framework enables you to efficiently gather runtime diagnostic information. You can use logging for troubleshooting application problems when you need a very granular level of detail, for example, when working with a Relativity Support representative.

Relativity system components that can log messages are identified based on the system-subsystem-application designation. When troubleshooting, use the system-subsystem-application matrix to configure logging to target a specific Relativity component, such as the Processing application.

Note: It's recommended that you not set your logging to verbose when publishing documents to a workspace, as doing so can cause your worker to run out of resources (CPU, RAM, disk usage, etc.), which then causes your publish job to cease entirely. If you need to use verbose logging in order to collect detailed logs, do so for short periods of time only (under 5 minutes) and have a developer on hand to troubleshoot if any issues occur.

For more information, see Logging and Logging system-subsystem-application matrix.

Security permissions

The following security permissions are the bare minimum required to publish files to a workspace with Relativity Processing.

Object Security Tab Visibility
  • Processing set - Add, Edit, View
  • Processing Data Source - Add, View
  • Document - Add, View
  • Documents
  • Processing (parent)
    • Processing Sets (child)

If you want access to view, add, and edit other processing objects, such as profiles, errors, reports, and the password bank, you must configure these options in the Tab Visibility and Object Security windows in the Workspace Security console.

You're finished configuring processing in your Relativity environment. You can now move on to using the processing feature in your workspace through the following components and phases: