Configuration
  • 3 Minutes to read
  • Dark
    Light
  • PDF

Configuration

  • Dark
    Light
  • PDF

Article summary

Choose an Authorization Method

Agility Blue offers two authorization methods to connect to Relativity: Basic or OAuth2

  • Basic Authorization requires you to enter a Relativity username and password in order to access Relativity resources. Relativity account information is stored on the Agility Blue servers in an encrypted format.
  • OAuth2 Authorization requires you to create an OAuth2 client within Relativity using the “Client Credentials” OAuth2 flow. Relativity OAuth2 information is stored on the Agility Blue servers in an encrypted format.
The OAuth2 Authorization method is our recommended approach. There is more setup involved on the Relativity side, but the benefit is that you do not have to expose any username or password information to Agility Blue in order to communicate with Relativity.

Relativity Permissions

Regardless of the chosen authentication method, it is necessary that the linked Relativity user account has enough permissions to be able read a list of Workspaces and have the ability to read Production Sets within a workspace.

Configure Relativity for Basic Authorization

If you choose to use the Basic Authorization method to connect to Relativity from Agility Blue, there is not much setup needed from Relativity. We recommend that a dedicated Relativity user account be created specifically for Agility Blue for access control and auditing purposes, though not necessary. The Relativity user account must be setup with a Password Authentication Provider, as you will need to provide the Relativity username and password to Agility Blue.

More information about how Relativity leverages OAuth2 can be found here.
  1. Login to Relativity as a user that has permission to create OAuth2 Clients.
  2. Navigate to the “OAuth2 Client” tab (this can typically be found under the “Authentication” parent tab).
  3. Click on the “New OAuth2 Client” button.
    1. Fill out the form
    2. Name: Agility Blue
    3. OAuth2 Flow: Client Credentials
    4. Context User: Select a user that will be represented by calls from Agility Blue. We recommend that a dedicated Relativity user account be created specifically for Agility Blue for access control and auditing purposes, though not necessary.
    5. Enabled: Yes
    6. Access Token Lifetime: Relativity recommends setting this value to 60 (1 hour). This means that when Agility Blue receives an OAuth2 token from Relativity, the token will be valid for one hour before Agility Blue needs to ask Relativity for a new token.

When you save the form, Relativity will display the OAuth2 client details. Pay attention to the two fields that Relativity generates on this screen: “Client Id” and “Client Secret”. You will enter these values into Agility Blue during Agility Blue configuration.

Configure Agility Blue

  1. Login to an Agility Blue account that has permissions to save integration configurations.
  2. Navigate to the Workspace that you would like Relativity to communicate within.
  3. Navigate to the Settings screen.
  4. Click on the Integrations Tab
  5. Locate the “Relativity” integration. If the toggle switch on the far right is gray (off), click on it to enable it. If the toggle switch is already enabled, click on the cog button to the left of the switch. If you do not see the Relativity Integration listed, please contact support@sadiebluesoftware.com to get it installed into your Workspace.
  6. Fill out the Form
    1. Relativity Instance URL: This is the base URL used to access your Relativity instance. For example: https://relativity.sadiebluesoftware.com. It is highly recommended that your Relativity Instance URL is configured as HTTPS to ensure secure communication between Agility Blue and Relativity.
    2. Relativity Authorization Method: Choose the method that you would like to use based on whether or not you created an OAuth2 client within Relativity as outlined in the steps above.
    3. If you chose the Basic Authorization Method:
      1. Relativity Username: Enter a Relativity username.
      2. Relativity Password: Enter the password for the Relativity user.
    4. If you chose the OAuth2 Authorization Method:
      1. Relativity OAuth2 Client Id: Enter the OAuth2 Client Id that Relativity provided during the OAuth2 Client setup instructions above.
      2. Relativity OAuth2 Client Secret: Enter the OAuth2 Client Secret that Relativity provided during the OAuth2 Client setup instructions above.
    5. Click on the “Save” button

If Agility Blue is able to connect to your Relativity instance, a message will briefly display that a successful connection was made and the connected Relativity version.

You can change the configuration settings by clicking on the cog button to the left of the toggle switch on the right.

You can test if the communication between Agility Blue and Relativity is working by clicking on the “Run Test” button.