| Minimum Software Version | 8.16.0 |
| Solution(s) | All |
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 will require some additional information before being able to setup the integration, you will also require certain permissions, please see below:
- You will require at least a Project Admin level role on Opus 2.
- You will need the Client ID and Client Secret from Relativity or your Relativity Provider.
- The URL of your Relativity instance.
Setup
- Navigate to 'Project settings' option in the main project menu.
- Navigate to the 'Integrations' menu tab
- Click 'Add New Integration' and choose 'Relativity' from the drop-down menu.
- The initial integration setup dialog will open with the Relativity service selected.
- Choose a Name, and (Optional) Description. These can be used to identify different connections if you have more than one.
- Enter the URL of the relativity instance you are connect to, for example; 'https://relativity.example.com/Relativity/'
Please ensure you include the /Relativity/ at the end of the URL, as this is the API endpoint for Relativity connections.
- Enter the Client ID and Client Secret to connect to your Relativity instance. This needs to be generated on your Relativity Instance by an admin.
- Click Test Connection. You are looking for a "Connected" message to confirm all above details are correct.
Configuration
Once you have setup your integration above, there are some additional steps to be carried out to enable syncing, these are covered below.
Options
On the Options Tab, you will need to select the following to proceed:
- A Workspace and,
- 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.
These are:
- 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
Now the above configuration is complete, you can click Save. Then on the new dialogue available, click run.
Issues and Troubleshooting
We do have performance limits to 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 issue again so we can review the integration for you.