Staging Explorer

The Staging Explorer option within the Relativity Desktop Client (RDC) application enables you to rapidly transfer large amounts of data to jump-start and sustain the data pipeline for critical projects. Use this option to upload files to a staging area for RelativityOne or to download files from your RelativityOne storage location to a local computer.

The Staging Explorer uses Aspera to facilitate transfer speeds that can be 10 times faster than a traditional FTP. Combined with proprietary software, all transfers are fast, secure, and defensible.

You can seed data for a new matter, quickly load newly discovered data, or quickly download produced documents. This makes accessing data in the cloud as quick and as seamless as if it was contained within your own environment.

This page contains the following sections:

Minimum system requirements

The following minimum system requirements are required to use the Staging Explorer.

Operating system Memory
Windows 7 or above

8GB RAM

Port considerations

Windows does not support multiple active connections on the same UDP port. Therefore, the business firewall must allow a range of UDP ports to reach the Aspera server. Incoming client connections automatically increment to use the next available port in the range. Open these ports on any machine that stages any data to RelativityOne. This includes ports on your network, as well as local machine firewalls. You must make the following business firewall changes to ensure concurrent Staging Explorer transfers can occur:

  • Allow inbound/outbound connections to the server on the TCP port 33001.

    Note: You can test the TCP port connection by running the following command in Windows Powershell. The following command is for US clients, enter fta-ukso.relativity.one for UK and fta-esas.relativity.one for Hong Kong:

    > Test-NetConnection -ComputerName fta-ctus.relativity.one -Port 33001

  • Allow outbound connections to the server on the UDP ports 33001 - 33050.

The Staging Explorer handles opening the required ports for the Windows firewall on the end-user's machine. However, if you use any third party firewalls, you must manually open the ports referenced above. Improperly configured ports and/or a lack of UDP port ranges result in transfer failures.

For more information, contact Client Services at support@relativity.com.

Staging Explorer security permissions

The following minimum security permissions are required to use the Staging Explorer.

Object security Tab visibility Admin operations
 
  • Workspace Details
  • Access RelativityOne Staging Explorer*
  • Download Relativity Desktop Client
  • View Workspace Details

Note: The * indicates permissions set in the Instance security.

Best practices and considerations

General considerations

The following are some good practices to consider when using Staging Explorer:

  • Only one Windows user can run an instance of Staging Explorer on a machine at a time.
  • Only the same type of user can see mapped disks which have mapped them. For example, if a regular user mapped a disk a regular user needs to be logged into Staging Explorer to view them. And if an admin user mapped a disk an admin user needs to be logged into Staging Explorer to view them.
  • Staging Explorer does not support UNC paths. All the disks need to be mapped in order to view them in Staging Explorer.
  • Microsoft Azure Import/Export Service may be used at your discretion. See https://docs.microsoft.com/en-us/azure/storage/storage-import-export-service.

Performance considerations

  • We recommend that your all active transfers do not exceed 10M documents (e.g., 3 active transfers, 3M of files per each job).
  • Speeds can be set as high as 100 Mbps (default rate is 55 Mbps).
  • At 100 Mbps, 500 GB should transfer in 12 hours or less. However, there are other variables that can degrade performance. See the Aspera  performance calculator to roughly estimate performance.
    • Transfers from slow network shares, thumbdrives, etc. will degrade performance. It may be more efficient to copy the data to the local drive and then transfer from fast local storage.
    • When workstations have an active VPN session open, it can interfere with transfers from that workstation. RelativityOne is hosted in a public cloud and does not require VPN.
  • Due to cloud disk I/O, avoid compressing datasets (with ZIP, 7z, etc.). The faster transfer time, due to fewer multi-part files, is negated by the time and effort to compress and decompress.
  • Due to bandwidth sharing, avoid doing large transfers in parallel.

Job history

When opening Staging Explorer all of the users previously run transfer jobs will display in the Jobs grid.

  1. Launch the Relativity Desktop Client application and log in with your RelativityOne credentials.
  2. Select a workspace and select Staging Explorer from the Tools menu. The Staging Explorer window opens.
  3. Click on the column headers to filter the jobs displayed in the Jobs grid.

    (Click to expand)

Note: When a new job is created the job will be added at the top of the Jobs grid under the condition that no sorting has been selected.

Uploading files

To upload files:

  1. Launch the Relativity Desktop Client application and log in with your RelativityOne credentials.
  2. Select a workspace and select Staging Explorer from the Tools menu. The Staging Explorer window opens.
  3. Note: Click on any column header to sort the column in ascending or descending order.

  1. Select and open the drive and folder that contains the files you want to upload in the Local pane on the left. A list of files in the folder is displayed.

    Note: Click to go to the parent folder for the current folder you are in.

  1. Select and open the folder in your RelativityOne storage location where you want to upload your files in the Staging pane on the right.
  2. If applicable, you can perform any of the following operations:

    • Click the button to create a new folder where you want to upload and/or download your files in the Staging or Local panes.
  3. Click on a listed file in the Local Pane to select it. The Upload button is enabled.
  4. Note: You may also hold down CTRL to select multiple individual files or SHIFT to select all the files between the first one you selected and the next.

  5. Click the Upload button at the top of the Local pane to add the selected files to an upload job in the Job pane below.
  6. If the Auto Start checkbox is selected, the transfer job will begin immediately. Otherwise, see Starting and canceling a transfer.

    Monitor upload progress via the Progress and Status columns displayed for the job. When the job is complete, you can click the icon to view the job details. See Viewing and editing transfer job details.

Downloading files

To download files:

  1. Launch the Relativity Desktop Client application and log in with your RelativityOne credentials.
  2. Select a workspace and select Staging Explorer from the Tools menu. The Staging Explorer window opens.
  3. Select and open the folder in your RelativityOne storage location where you want to download the files from the Staging pane on the right. A list of files in the folder is displayed.
  1. Select and open the drive and folder where you want to download the files to in the Local pane on the left.
  2. Note: Click to go to the parent folder for the current folder you are in.

  3. If applicable, you can perform any of the following operations:
    • Click to create a new folder where you want to upload and/or download your files in the Staging or Local panes.
  1. Click on a listed file in the Staging pane to select it. The Download button is enabled.
  2. Note: You may also hold down CTRL to select multiple individual files or SHIFT to select all the files between the first one you selected and the next.

  3. Click the Download button at the top of the Staging pane to add the selected files to a download job in the Job pane below.
  4. If the Auto Start checkbox is selected, the transfer job will begin immediately. Otherwise, see Starting and canceling a transfer.

    Monitor upload progress via the Progress and Status columns displayed for the job. When the job is complete, you can click the icon to view the job details. See Viewing and editing transfer job details.

Job settings

You can change the Maximum Active Jobs setting to run up to three parallel active jobs at the same time.

Note: the default value for Maximum Active Jobs is set to 1.

  1. Launch the Relativity Desktop Client application and log in with your RelativityOne credentials.
  2. Select a workspace and select Staging Explorer from the Tools menu. The Staging Explorer window opens.
  3. Click above the Jobs grid. The Settings window displays.
  4. Use the drop-down to set the number of Maximum Active Jobs.
  5. Click Save.

Starting and canceling a transfer

You can manually start a transfer job or cancel a transfer job in progress. To start a transfer job, click the icon in the Action column for the transfer job. To cancel a transfer job, click the icon to stop the transfer. The transfer completes the most recent file in progress and stops immediately after that.

Note: You may also hold down CTRL to select multiple individual jobs or SHIFT to select all the jobs between the first one you selected and the next. Click the icon to start multiple jobs, the next job will start automatically when the previous job finishes.

Retrying a transfer

The Retry button is enabled if the transfer was stopped or it failed due to an error. When you click this button, the job status reverts to "Transferring" once the transfer is started again the values pick up from where the transfer originally stopped. Files that were transferred successfully will not need to be re-transferred. Incompletely transferred files will be re-transferred in their entirety.

Note: Transfers that completed successfully are not eligible for retry.

Deleting a transfer

Individual jobs with the status New, InQueue, Canceled, Finished, or Failed can be deleted by clicking the icon under the Actions column. You may also hold down CTRL to select multiple individual jobs or SHIFT to select all the jobs between the first one you selected and the next and click to delete multiple jobs.

Note: Once a job is deleted it is removed from both the Jobs grid and the user's machine.

Connectivity Check

You can check Staging Explorer connectivity to ensure your network is set appropriately to transfer data.

  1. Click above the Jobs grid. The Connectivity Check window displays and connectivity check starts.

  2. The Connectivity Check checks the following:
    • Connection with RelativityOne.
    • Connection with Aspera Server (TCP ports check).
    • Aspera credentials in Workspace.
    • Minimum memory requirements.
  3. The connectivity test results are shown under Diagnostic summary.

  4. Note: If any of the Connectivity Check tests fail, the user is notified about a root cause and possible actions to take to correct them.

  5. If applicable, click Run to run the connectivity check again.
  6. If applicable, click Copy to Clipboard to copy the results or click Cancel to close Connectivity Check window.
  7. Note: The Connectivity Check option is available only when there is no active transfer.

Viewing and editing transfer job details

Viewing transfer job details

To view job details for a transfer job, click the icon for the job in the Jobs pane. When you extend the Job details of a job, all folders/files that are in scope of that job are highlighted in gray in the source directory in the Local or Staging pane depending on the Job type.

The following information is displayed about the transfer:

  • Job ID unique number of a job.
  • Status - status of the transfer (e.g., New, InQueue, Calculating, Authorizing, InProgress, Finished, Canceled, Failed).
  • Remaining Time - how long the transfer job will take.
  • Duration - how long the transfer job took.
    • Started On - the date the transfer started.
  • Transfer Rate - the rate at which the file transferred.
  • Finished on - the date the transfer completed.
  • Transferred Data -the size of the data currently transferred in reference of the total size of the job.
  • Transferred Files - the number of files currently transferred in reference of the total amount of files of the job.
  • Error - text box displays error messages.

    (Click to expand)

Editing transfer job details

You can set the Target Rate per each transfer.

Note: Global Bandwidth Limit is taken from Relativity.StagingExplorer.exe.config / <transfer settings> / TapiTargetDataRateMbps. It will also display in the Settings window.

  1. To edit the Transfer Rate for a transfer job, click the icon for the job in the Jobs pane.
  2. Note: The default value is set to Auto, which means that the bandwidth indicated in the Global Bandwidth Limit is redistributed equally among all active transfers. For example, if the Global Bandwidth Limit is set to 100Mbps and there are three active transfers, the Target Rate will be 33Mbps for each job. However, if the Target Rate is changed manually for one job, i.e. 80Mbps giving this job the highest priority, all the jobs with Target Rate set to Auto will take 20Mbps redistributed accordingly.

  3. Click the Target Rate text field.
  4. If applicable, insert a number between 1 and the number reflected in the Global Bandwidth Limit. Double click outside the text field to save the change.

  5. Note: If a number exceeding the Global Bandwidth Limit is entered a warning message will display.

  6. Click the Auto button or remove the number and double click outside the text field to set the Transfer Rate to Auto.