Relativity quick start guide

This article outlines how to configure your Relativity Integration within a project. For information on security and APIs in use, please refer to our Overview Documentation. 

Pre-requisites

You require some additional information before setting up the integration, and you also require certain permissions, as follows:

• You require at least a Project Admin level role on Opus 2. 
• You need the Client ID and Client Secret from Relativity or your Relativity Provider. 
• The URL of your Relativity instance. 

Setup

1. Navigate to Project settings option in the main project menu.
2. Navigate to the 'Integrations' menu tab
3. Select 'Add New Integration' and choose 'Relativity' from the drop-down menu.
   • The initial integration setup dialog will open with the Relativity service selected.
4. Choose a Name, and (Optional) Description. These details are used to identify different connections if you have more than one.
5. Enter the URL of the relativity instance you want to connect to, for example; 'https://relativity.example.com/Relativity/'

   Ensure you include the /Relativity/ at the end of the URL, as this is the API endpoint for Relativity connections.

6. Enter the Client ID and Client Secret to connect to your Relativity instance. The Client ID / Client Secret need to be generated on your Relativity Instance by an admin.

7. Click Test Connection. You are looking for a "Connected" message to confirm all above details are correct.

Configuration

Once you have setup your integration as described above, there are some additional steps to be carried out to enable syncing. 

Options

On the Options tab, you will need to select the following to proceed:

• A Workspace, 
• A Saved Search

Please note that the Relativity User you are impersonating has the correct permissions to view all Workspaces / Saved Searches needed. Our current limit for saved searches is 1000 - you will need to keep your saved search count visible to this user under this limit to see the full scope of searches in the integration. 

Metadata

On this tab, you can map Relativity Fields to Opus 2 Metadata fields. 

You will need to click Add Mapping for each new field you wish to map. 

Field Types must be the same to map. E.g. You cannot sync a "Date" field in Relativity to a Number Field in the Opus 2 Platform. 

Files

On this tab, you can choose a variety of options for what format you would like your data to be synced in. 

The options are as follows:

• Production Images. If so, you will need to choose a Production Set. 
• Send Original Images if no Production Images Found. This will send the native PDF or TIFF if there are no Production sets. 
• Send Native Formats. This will include a list of formats that Relativity has reported to the integration as available.

Running the Integration

After the configuration is complete, select save. On the next dialogue, select run. 

Issues and Troubleshooting

We do have performance limits when syncing Relativity documents and metadata, these can be found here. If you receive an error message when clicking Run please stop and contact platformsupport@opus2.com before clicking the button again so we can review the integration for you.