Simple File Upload

Simple File Upload, formerly Single File Upload, gives users the ability to add new documents to Relativity without using the Relativity Desktop Client.

This page contains the following information:

Special considerations

Keep the following considerations in mind:

  • To use Simple File Upload, you must be running .NET 4.6.2 for all server side machines with Relativity 9.5 and above and RelativityOne, including: web server, invariant, agents, and workers.
  • To use Simple File Upload with Relativity, the Relativity web servers must have Visual C++ Redistributable 2013 x86 and x64.
  • When you upload a document using Simple File Upload, Relativity imports the following metadata:
    • ArtifactID
    • Control Number
    • Extracted Text
    • Relativity Folder Name
    • Has Images
    • Has Native
    • Relativity Native Type
    • Supported By Viewer
    • System Created By
    • System Created On
    • System Last Modified By
    • System Last Modified On
    • File Name
    • File Size
  • You can search extracted text with keyword search or Data Grid. However, if Data Grid is enabled, keyword searching is disabled. See Relativity Data Grid.

Workspace security permissions

To configure workspace security permissions for Simple File Upload:

  1. Navigate to the Relativity Utilities console on the Workspace Details tab.
  2. Click Manage Workspace Permissions.
  3. Click Edit Permissions for a group on the Group Management tab.
  4. Grant access to the workspace security permissions listed in the table.
  5. Object Security Tab Visibility Other Settings
    • Document - View, Add
      • New Document (child)
    • Documents
    • N/A

      Notes:
    • The New Document button will appear in all workspaces. You can only remove the button by removing the Add Document permission from individual users.
    • If you are upgrading from Relativity 9.6 or below, the New Document permission is disabled upon upgrade.

Accessing Simple File Upload

Access Simple File Upload within a workspace in the Documents tab. The application functions on the Folders, Clusters, and Field Tree browsers.

Note: You need to have the Add Document permission to access the New Document button.

Uploading new documents

To upload a new document to a workspace:

  1. Click New document icon, which is located to the left of the View bar. The New Documents pop-up window appears.
  2. Drag and drop up to 100 files into the New Documents pop-up window or click on the pop-up to select files that you want to upload.

    New Document pop-up

      Notes:
    • The SFUMaxFilesToUpload instance setting determines the maximum number of documents you can upload using Simple File Upload. Admins can set the maximum number of documents that you can upload at one time up to 100.
    • When the instance setting is set to 100, you can only upload up to 100 files at one time with Simple File Upload. If you select more than 100 files, Relativity will only upload the first 100 files you selected. Any files after the first 100 will not upload. A warning message will display in the pop-up if more than 100 files are selected.

    The selected files will display in a list. If you choose not to upload one of the selected files, click the delete icon next to the file's name in the pop-up.

    New Document pop-up

  3. Click upload. When a document uploads successfully, a green check mark appears next to the file name. A progress bar tracks the progress of all the files selected.
    New Documents pop-up

Uploading existing documents

If you upload a document that shares a name with a document that already exists in Relativity, Simple File Upload gives you the option to either replace the file or cancel.

Replace Document pop-up

On replace, all existing meta data will remain intact, except for the following fields, which Relativity overwrites:

  • FileName
  • FileSize
  • FileExtension
  • Extracted text

Replacing documents

You can replace a document in the viewer of the Core Reviewer Interface by using the Replace document native icon.

Note: You need edit, add, and delete document permissions to access the Replace document native icon.

To replace a document in the viewer:

  1. Open a document.
  2. Navigate to the layout and click Replace document icon. The Replace Document pop-up widow opens.
    Replace Document icon
  3. Drag and drop or select the document that you would like to replace the current document in the viewer with.

On replace, the following meta data is uploaded:

  • ArtifactID
  • Control Number
  • Extracted Text
  • Folder Name
  • Has Images
  • Has Native
  • Relativity Native Type
  • Supported By Viewer
  • System Created By
  • System Created On
  • System Last Modified By
  • System Last Modified On
  • FileName
  • FileSize
  • FileExtension

If you replace a document with a document that shares the same name, all existing meta data will remain intact, except for the following fields, which Relativity overwrites:

  • FileName
  • FileSize
  • FileExtension
  • Extracted text

Simple File Upload for processing errors

If you have the Simple File Upload application installed on your workspace, you have the option of opening an individual processing error, downloading the errored file, and uploading the repaired file as a replacement after you resolve the error outside of Relativity.

This is available through the Error Actions console, which appears on the Processing Error Layout after you have configured your environment with the assistance of a support representative.

    Notes:
  • This option is available only for document-level errors that have a status of Ready to Retry.
  • The Error Actions console is hidden from the error layout if the option to Download and upload files with processing errors is not checked for the Processing Error object in the workspace security console. In order to access this functionality, every user, including system administrators, must be included in a group where this option has been manually checked after installing or upgrading the Simple File Upload application.

  • The Download and upload files with processing errors permission was added in Relativity 9.5.219.30.

(Click to expand)

Workspace Security pop-up

To upload a Simple file for a processing error, perform the following steps:

  1. Navigate to the Processing | Document Errors tab, locate the error you'd like to resolve, and click on the name of the error in the Current Error Message field to get to the document error layout.
    (Click to expand)
    Document Errors tab
  2. Click Download File on the Error Actions console on the right side of the layout. Note that when you do this, you're downloading the document from the same folder patch displayed in the Document file location field on the document error layout.
    Document Error layout
  3. Once the file appears in the lower-right hand corner of your browser window, either open or save it to your local machine.
    (Click to expand)
    Document error layout
  4. Outside of Relativity, address the error to repair the file. For example, if the error was due to password protection because you didn't previously provide that password in the Password Bank, enter it now to decrypt the file and then save the decrypted file to your local machine so that you can upload it here.
  5. Once you've repaired the file, return to the document error layout and click Upload Replacement File on the Error Actions console.
    • You must upload a file of the same extension as the file you downloaded or you will receive an error. If you receive this error, either click Upload New Document to return to your file explorer or click Cancel to return to the document error layout.
    • Processing Document pop-up

  6. Confirm that the upload completed successfully. Note that when you replace a document in this way, the Document file location, File ID, and Name values of the replacement document are identical to those of the file you downloaded.
    Processing Document pop-up
  7. Click Retry in the Error Actions console.
  8. When the Retry Error pop-up opens, click Retry.
    Retry Error pop-up
  9. The current status will change to Resolved.
    Document error layout

See Processing error workflow.

Viewing audits

When you use Simple File Upload for processing errors, Relativity audits your actions, which you can view via the View Audit button on the processing error layout. When you open the audit view, you can see such actions as File Download and File Upload, along with the processing error file download and replacement paths, among other details.

Note: Auditing for Simple File Upload for processing errors was added in Relativity 9.5.219.30.

(Click to expand)

Processing audit

You can also access audit information through the History tab by filtering on the Object Type field for ProcessingError and on the Action field for File Download and/or File Upload.

Processing audit