Workspace Portal

Note: Workspace Portal application no longer needs to be manually installed for RelativityOne instances. In RelativityOne instances, you will access workspaces in other connected instances from the Workspaces tab. See Workspaces tab.

In Relativity, a workspace provides a secure data repository for documents used in cases or for applications developed with Dynamic Objects. Workspace portal refers to a Relativity application that enables you to view all your workspaces from a single tab that exists in both your master Relativity Server instance and a satellite RelativityOne instance in the cloud. You can navigate between the instances seamlessly using single sign-on, and easily create and edit new workspaces in either environment.

Workspace portal

    Notes:
  • To use the workspace portal successfully, you must ensure each of your instances are configured to use the HTTPS protocol. We also recommend that you have an authentication provider set up in both the master and duplicate instances to get the most seamless experience from workspace portal using single sign-on (SSO) capability. If you do not have single sign-on set up, you will have to log in whenever you navigate between your master and satellite instances.
  • This functionality is only available for customers running supported Relativity versions as well as running at least one RelativityOne instance. For more information, see Version support policy.

This page contains the following information:

Installing Workspace Portal (Relativity Server)

Note: Workspace Portal application no longer needs to be manually installed for your RelativityOne instances. In RelativityOne instances, you will access workspaces for connected instances from the Workspaces tab. See Workspaces tab.

The Workspace portal application must be installed in both the master and duplicate instances. You can find the Workspace portal application files in the Application Library. Install Workspace Portal (Master) to your master instance and Workspace Portal (Duplicate) to your duplicate instance.

Note: Relativity recommends that you keep your master / duplicate Relativity Server instances on the highest possible version of Workspace Portal.

Once you install the application, you will see a new Workspace Portal tab in your instance.

Note: If you install the RelativityOne Activity Dashboard, the Workspace Portal tab will become a child tab nested under the RelativityOne Home tab.

Upgrading Workspace Portal (Relativity Server)

Note: Relativity recommends that you keep your master / duplicate Relativity Server instances on the highest possible version of Workspace Portal.

If Workspace Portal was previously installed and you need to upgrade the application, follow the steps of the scenario that best matches your circumstances.

Setting up Workspace Portal in Relativity Server instances

To set up workspace portal:

  1. Complete the Required prerequisites for configuration.
  2. Follow the steps of the scenario that matches your circumstances.

Required prerequisites for configuration

Please have the following actions completed before proceeding with configuration steps:

  • Master and duplicate instance URLs - have the URL of your master and duplicate Relativity Instance in a text file for you to copy and paste from.
  • Workpace Portal / User Sync user (duplicate instance) - set up and enable this user in your duplicate instance. This is the Relativity user account that will be used exclusively by the Relativity User and Group Synchronization and Workspace Portal applications. Use this email address for the user: wp@relativity.one. If you have set up User and Group Synchronization, this account should already exist in your duplicate instance and should be assigned the Workpace Portal / User Sync group.
  • Note: If you have not set this user up, please create a new user in your duplicate Relativity instance.

  • If you are upgrading to RelativityOne or Relativity 10.2 and above, you must update the email address for the appropriate context user for the Workspace Portal OAuth client to wp@relativity.one. To update the email address:

    1. Navigate to the OAuth client used for Workspace Portal in the satellite instances and identify the configured user.

      Note: If the configured user is an active user in the system or not a specific user for the Workspace Portal app (including Relativity Admins or a Relativity Service Accounts), then a new user must be created and added to the group. See Required prerequisites for configuration.

    2. Navigate to the Users tab and search for the identified user.

    3. Edit the user and replace the email address with wp@relativity.one.

  • Workpace Portal / User Sync group (duplicate instance) - set up this group in your duplicate instance. this is the Relativity group that will be used exclusively by the Relativity User and Group Synchronization and Workspace Portal applications. If you have set up User and Group Synchronization, this account should already exist in your duplicate instance. This group should have the following instance-level security permission setup:
    Permissions Workspace Portal only with User and Group Sync
    Instance object security permissions (Instance details tab)
    UserN/AView, Add, Edit
    GroupN/AView, Add, Edit
    ClientN/AView, Add, Edit
    ChoiceN/AView, Add, Edit
    FieldN/AView, Edit
    Login MethodN/AView, Add, Edit, Delete
    Instance object detail security permissions (Instance Settings tab)
    InstanceIdentifier instance settingViewView
    FriendlyInstanceName instance settingN/AView
    HeaderLogo instance setting ViewView
  • Note: If you have not set this group up, please create this group in your duplicate Relativity instance, and then assign the Workpace Portal / User Sync group to your Workpace Portal / User Sync user.

  • When doing configuration in a Relativity Server instance, consider the following. Ciphers are used in web server certificates and must match what is available for creating a connection into RelativityOne. RelativityOne supports the following TLS 1.2 cipher suites (in server-preferred order):
    • TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
    • TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
    • TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
    • TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
    • TLS_RSA_WITH_AES_256_GCM_SHA384
    • TLS_RSA_WITH_AES_128_GCM_SHA256
    • TLS_RSA_WITH_AES_256_CBC_SHA256
    • TLS_RSA_WITH_AES_128_CBC_SHA256

    Note: To find out whether your web servers have the appropriate certificates and ciphers, visit www.ssllabs.com/ssltest/, and then enter the URL for your Relativity instance.

  • SSO setup on both master and duplicate (recommended) - set up single sign-on (SSO) in both your master and duplicate instance to allow you to navigate between these instances without having to use two sets of credentials. SeeSingle sign-on workflow (SSO) overview.

Scenario: Relativity Server master instance, RelativityOne duplicate instance

This scenario has the following requirements:

  • Master instance uses Relativity 9.5 or above
  • Master instance has .Net 4.6.2 runtime installed

Note: Please ensure that you complete the steps in the order listed.

Scenario: RelativityOne master instance, Relativity Server duplicate instance

This scenario has the following requirements:

  • Relativity Server duplicate instance must be accessible to the Internet over HTTPS
  • Relativity Server duplicate instance has Relativity 9.5 or above installed
  • Relativity Server duplicate instance has .Net 4.6.2 runtime installed

Note: Please ensure that you complete the steps in the order listed.

Workspace Portal security permissions

The following minimum instance-level security permissions are required to use the Workspace Portal. Users must be part of a group that is added at the instance level.

Object security Tab visibility Admin operations
  • N/A
  • Workspace Portal Services - View
    • Workspace Portal Services Permission (child)
  • Workspace Portal
  • View Admin repository

For new groups that you want to grant access to Workspace Portal, add item-level security permission to the SMTPPassword instance setting.

Note: Workspace portal will only display the workspaces that you have View permissions for.

Using Workspace Portal

Workspace portal gives you access to all workspaces between your Relativity Server and your RelativityOne instances from a single tab. The available list of workspaces displays in the grid below the search, and you can access favorited or recently used workspaces via the Pinned and Recent workspaces links in the heading of the table.

Note: Only users who have access to both the master and duplicate instance will be able to view workspaces from both instances.

For Pinned workspaces, you can drag and drop the workspace thumbnails to reorder them in the ribbon at the top and you also have the ability to display pinned workspaces from a specific instance in a certain color by setting an Instance Color for the instance. This can help users tell which instance a workspace is from at a glance.

You can easily navigate back to your master instance at any time by clicking on the Master instance setting icon icon that displays to the right of the Relativity logo at the top left corner of your screen (this button is only available for RelativityOne and Relativity 9.5.219.30and above).

Master instance link

Clicking into the menu to the right of the New Workspace menu lets you access the Relativity workspace views that you have access to within your local instance.

Workspaces list

To search for a specific workspace in your list, you can enter matching keywords in the Search textbox at the top. Matching workspaces display as you type in the pop-up list below. Click on a workspace in the list to navigate to it or tap Enter to navigate to the currently selected workspace at the top of the list.

Note: The Workspace Portal search bar displays the same results as the QuickNav menu (e.g., matching Favorites, Workspaces, and Admin tabs).

You can also sort and filter the list of workspaces below by using standard Relativity item list functionality.

Workspace portal search

Common Workspace Portal icons and actions

You can perform the following additional actions from the Workspace Portal tab:

  • Master instance button (Master instance setting icon) - click this button to the right of the Relativity logo to navigate directly to your designated master instance (this button is only available for RelativityOne and Relativity 9.5.219.30and above).
  • New Workspace button - click this button to create a new workspace.
  • Refresh Workspaces (Refresh workspace icon ) - click this icon refresh the list of available shared workspaces.
  • Manage Instance Connections ( Settings icon ) - click this icon to view the list of registered instances or add a new instance connection. See Managing your instance connections.
  • Note: The Manage Instance Connections icon (Settings icon ) is only available to Relativity system admins.

  • Pin workspace button (pin workspace icon ) - click this icon to the left of a listed workspace in your list to pin it in the Pinned Workspaces thumbnail section at the top for easy access to your most used workspaces. Click the blue Pin icon icon to unpin the workspace from the Pinned Workspaces item list or click Unpin workspace in the thumbnail section under the search bar to unpin it.
  • Pinned workspace

Managing your instance connections

Click the Connect an Instance icon (Connect an instance icon ) to link a new instance to the current instance. See Setting up Workspace Portal in Relativity Server instances for more information on how to connect a new satellite instance.

Note: Only users who have access to both the master and duplicate instance will be able to connect a new instance.

Click the (Settings icon) icon to edit or delete instances. Click the (Edit instance icon) icon to edit an existing registered instance connection or the (Delete instance icon) icon to delete a registered instance connection. When editing the current instance, you can select a Custom Name to display for workspaces associated with that instance instead of the Instance Name.

Note: If you are using the User and Group Synchronization application, we only recommend 1 satellite instance for every master instance.