Relativity Desktop Client For Mac

  

Relativity’s security rights are highly customizable. Each group you add to a workspace can have vastly different permissions than others. You can also copy an existing group’s permissions to save time on configuring them.

The three most recent versions of Chrome and Firefox (for Windows and Mac OSX) at the time of a given Relativity release The two most recent versions of Safari included with Mac OS X at the time of a given Relativity release Note:Relativity only supports Firefox in Relativity 9.0.237.3 and higher. Native File Exporter will allow you to quickly export sets of native files as a ZIP file without using desktop client on a PC or a Mac. By Relativity Processing.

You set group permissions when adding a group to workspace, but you can change these permissions at any time from the Workspace Details page.

Note: If a user is a member of multiple security groups, the user's permission settings default to the group with the highest level of security access.

This page contains the following topics:

See the following related pages:

Managing multiple security groups

Large workspaces usually require multiple security groups. You should organize documents and define security groups to assist with review workflow. Start with a baseline security group for each main role.

For example, you may need to create a baseline group for each of the following roles:

  • System administrator
  • Operations administrator
  • Operations technician
  • Project manager
  • Project specialist
  • Case administrator
  • Case review
  • Case technician
  • Contract reviewer
  • Experts

Set security permissions from the baseline, giving each user group incremental security rights as necessary. For example, three different user groups may need permissions for the following tasks:

  • Contract review
  • Contract review – QA – Access to QA layouts, fields, choices
  • Contract review – Privilege – Access to Privilege Log layouts, fields, choices
  • Contract review – Dep Prep – Access to Deposition Prep layouts, fields, choices, mass actions

Permissions

Relativity divides permissions into five categories:

  • Security
  • Tab visibility
  • Browsers
  • Mass actions
  • Admin operations
View security permissions

In the group permissions area, you set object-level permissions. They follow a basic pattern, with some variation. The rights are:

  • View - allows users to view and is the minimal permission.
  • Edit - allows users to edit and view.
  • Delete - allows users to delete, edit, and view.
  • Add - allows users to add new instances of the object.
  • Edit security - allows users to edit the security for instances of the object.

Security rights work jointly with corresponding tab visibility or browser permission.

For example, a user with all the rights listed above for fields could only add, edit, delete, or edit security for fields if he/she had access to the fields tab as well. This pattern follows for most workspace objects.

There is a separate security section for each Relativity object:

  • Workspace - sets the group’s permissions for the workspace.
    • View - allows group members to see the workspace and is the minimal permission.
    • Edit - allows group members to see the workspace and edit the workspace details. Editing the workspace requires access to the Workspace Details tab.
    • Delete - allows group members to see the workspace, edit the workspace details, and delete the workspace. Editing or deleting the workspace requires access to the Workspace Details tab.
    • Edit security - allows group members to access and edit the workspace security.
  • Folder - sets the group’s permissions for the folder browser. Group members must also have permission to view the folder browser, which you can set in the browser permissions section.
    • View - allows group members to view the folder browser.
    • Edit - allows group members to edit the folder names and view the folders.
    • Delete - allows the group to delete folders, edit the folder names, and view the folders.
    • Add - allows the group to add folders to the workspace.
    • Edit security - allows group members to edit folders' security.
  • Document - sets the group's permissions for the documents.
    • View - allows group members to view documents.
    • Edit - allows group members to view and edit documents.
    • Note: The edit document permission allows users to tag documents with workspace coding values using layouts. Don't make assign coding users rights to edit fields or edit layouts instead. The edit fields permission (along with access to the fields tab) allows users to edit field properties, such as changing a fixed length text field from 255 to 320 characters.

    • Delete - allows group members to view, edit, and delete documents.
    • Add - allows group members to add new documents.
    • Edit Security - allows group members to secure documents.
    • Print - allows group members to print individual documents from Relativity.
    • Local Access - allows group members to open the file in its native application, to copy text from the viewer, or to perform a print screen.
    • Redact Document - allows group members to place stamp or textbox redactions on a document.
    • Highlight Document - allows group members to place a highlight on a document.
    • Add Image - allows group members to use Relativity’s image-on-the-fly functionality.
    • Delete Image - allows group members to delete images in Relativity.
  • Report - sets group permissions for summary reports. All of the following permissions require access to the Summary Report tab.
    • View - allows group members to view summary reports.
    • Edit - allows group members to view and edit summary reports.
    • Delete - allows group members to view, edit, and delete summary reports.
    • Add - allows group members to add new summary reports.
    • Edit Security - allows group members to edit the security of summary reports.
  • Field - sets group permissions for fields.
    • View - allows group members to view fields.
    • Edit - allows group members to view and edit fields Editing fields requires access to the Fields tab.
    • Delete - allows group members to view, edit, and delete fields. Deleting fields requires access to the Fields tab.
    • Add - allows group members to add new fields. Adding fields requires access to the Fields tab.
    • Edit Security - allows group members to edit field security. Editing security for a field requires access to the Fields tab.
    • Add Field Choice By Link - allows users to add a choice to the field from a layout.
  • Layout - sets group permissions for layouts.
    • View - allows group members to view layouts.
    • Edit - allows group members to view and edit layouts. Editing a layout requires access to the Layouts tab.
    • Delete - allows group members to view, edit, and delete layouts.Deleting layouts requires access to the Layouts tab.
    • Add - allows group members to add new layouts. Adding new layouts requires access to the Layouts tab.
    • Edit Security - allows group members to edit layout security. Editing security for a layout requires access to the Layouts tab.
  • Production - sets group permissions for production sets. This is the only default live textbox.
    • View - allows group members to view production sets.
    • Edit - allows group members to view and edit production sets. Editing production sets requires access to the Production Sets tab.
    • Delete - allows group members to view, edit, and delete production sets. Deleting production sets requires access to the Production Sets tab.
    • Add - allows group members to add new production sets. Adding production sets requires access to the Production Sets tab.
    • Edit Security - allows group members to edit production sets permissions. Editing security for a production set requires access to the Production Sets tab.

      Note: The Production checkbox is a live checkbox by default. There are no permissions for specific viewer options. To restrict productions from appearing in the viewer for a certain group, clear the Production checkbox.

  • View - sets group permissions for views.
    • View - allows group members to view views. Viewing any views besides document views requires access to the view object’s tab.
    • Edit - allows group members to view and edit views. Editing any views besides document views requires access to the view object’s tab or the Views tab.
    • Delete - allows group members to delete views. Deleting views requires access to the Views tab.
    • Add - allows group members to add a view. With add view rights, group members can add views for any tabs they have rights to see.
    • Edit security - allows group members the rights to edit view security. Editing security for a view requires access to the Views tab.
  • Search Folder - sets group permission for saved search folders.
    • View - allows group members to view search folders. Viewing search folders requires access to the saved searches browser.
    • Edit - allows group members to view and edit saved search folders. Editing saved search folders requires access to the saved searches browser.
    • Delete - allows group members to view, edit, and delete saved search folders. Deleting saved search folders requires access to the saved searches browser.
    • Add - allows group members to add new saved search folders. Adding saved search folders requires access to the saved searches browser.
    • Edit Security - allows group members to edit saved search folder security. Editing security for saved search folders requires access to the saved searches browser.
  • Search - sets group permissions for saved searches.
    • View - allows group members to view the results of saved searches. Viewing saved searches requires access to the saved searches browser.
    • Edit - allows group member to view and edit saved searches. Editing saved searches requires access to the saved searches browser.
    • Delete - allows group member to view, edit, and delete searches. Deleting searches requires access to the saved searches browser.
    • Add - allows group members to add new searches. New searches can be added from the saved searches browser.
    • Edit Security - allows group members to edit saved search security.Editing security for a search requires access to the saved searches browser.
  • Choice - sets the group permissions for choices.
    • View - allows group members to view choices
    • Edit - allows group member to view and edit choices. Editing choices requires access to the Choices tab.
    • Delete - allows group member to view, edit, and delete choices. Deleting choices requires access to the Choices tab.
    • Add - allows group members to add new choices. New choices can be added from the Choices tab, or directly from layouts.
    • Edit Security - allows group members to edit choice security. Editing security for a choice requires access to the Choices tab
  • Markup Set - sets group permissions for markup sets.
    • View - allows group member to view markup sets.
    • Edit - allows group members to view and edit markup sets. Editing Markup sets requires access to the Markup Sets tab.
    • Delete - allows group members to view, edit, and delete markup sets. Deleting markup sets requires access to the Markup Sets tab.
    • Add - allows group members to add new markup sets. Adding new markup sets requires access to the Markup Sets tab.
    • Edit Security - allows group members to edit markup set security. Editing security for a markup set requires access to the Markup Sets tab.
    • Note: The only proper way to secure the text behind a redaction is to the produce the document that contains the redacted text. If a group has View rights only to a markup set (not Edit or Delete rights) and a reviewer in that group loads a document in the Viewer because they have no other way to view that document, they can actually see the text behind the redaction, in which case that text is not totally secured.

  • Tab - sets group permissions for tabs.
    • View - allows group members to View tabs.
    • Edit - allows group members to view and edit tabs. Editing tabs requires access to the Tabs tab.
    • Delete - allows group members to view, edit and delete tabs. Deleting tabs requires access to the Tabs tab.
    • Add - allows group members to add new tabs. Adding new tabs requires access to the Tabs tab.
    • Edit Security - allows group members to edit tab security. Editing security for tabs requires access to the Tabs tab.
  • Batch Set - sets group permissions for batch sets.
    • View - allows group members to see batch sets.
    • Edit - allows group members to view and edit batch sets. Editing batch sets requires access to the Batch Sets tab.
    • Delete - allows users to view, edit and delete batch sets. Deleting batch sets requires access to the Batch Sets tab.
    • Add - allows group members to add new batch sets. Adding new batch sets requires access to the Batch Sets tab.
    • Edit Security - allows group members to edit the security of existing batch sets. Editing the security of existing batch sets requires access to the Batch Sets tab.
  • Batch - sets group permissions for batches.
    • View - allows group members to see batches.
    • Edit - allows group members to view, check out, and edit batches. Editing batch sets requires access to the Batches tab.
    • Delete - allows users to view, edit and delete batches. Deleting batches requires access to the Batches tab.
    • Add - allows group members to add new batch sets. Adding new batch sets requires access to the Batch Sets tab.
    • Edit Security - allows group members to edit the security of existing batch sets. Editing the security of existing batch sets requires access to the Batch Sets tab.
  • Object Type - sets group permissions for object types.
    • View - allows group members to see object types.
    • Edit - allows group members to view and edit object types. Editing object types requires access to the Object Types tab.
    • Delete - allows group members to view, edit and delete object types. Deleting object types requires access to the Object Types tab.
    • Add - allows group members to add new object types. Adding object types requires access to the Object Types tab.
    • Edit Security - allows group members to edit the security of existing object types. Editing the security of object types requires access to the Object Types tab.
  • RelativityScript - sets group permissions for scripts.
    • View - allows group members to see Relativity scripts.
    • Edit - allows group members to view and edit any unlocked scripts. Editing scripts requires the user to be a member of the Script Admin group.
    • Delete - allows group members to delete scripts. Deleting scripts requires the user to be a member of the Script Admin group.
    • Add - allows group members to add new scripts.
    • Edit Security - allows group members to edit the security of existing scripts. Editing security on scripts requires the user to be a member of the Script Admin group.
  • Search Index - sets group permissions for search indexes.
    • View - allows group members to see search indexes.
    • Edit - allows group members to edit search indexes. Editing search indexes requires access to the Search Indexes tab.
    • Delete - allows group members to delete search indexes. Deleting search indexes requires access to the Search Indexes tab.
    • Add - allows group members to add search indexes. Adding search indexes requires access to the Search Indexes tab.
    • Edit Security - allows group members to edit search indexes. Editing the security of search indexes requires access to the Search Indexes tab.
    • Dictionary Access - allows group member to see the dictionary function when searching with a dtSearch index.
  • ObjectRule - sets groups permissions for object rules.
    • View - allows group members to see object rules.
    • Edit - allows group members to edit object rules.
    • Delete - allows group members to delete object rules.
    • Add - allows group members to add object rules.
    • Edit Security - allows group members to edit the security of existing object rules.
  • AgentType - sets groups permissions for agent types.
    • View - allows group members to see agent types.
    • Edit - allows group members to edit agent types.
    • Delete - allows group members to delete agent types.
    • Add - allows group members to add agent types.
    • Edit Security - allows group members to edit the security of existing agent types.
  • EventHandler - sets groups permissions for event handlers.
    • View - allows group members to see event handlers.
    • Edit - allows group members to edit event handlers.
    • Delete - allows group members to delete event handlers.
    • Add - allows group members to add event handlers.
    • Edit Security - allows group members to edit the security of existing event handlers.
  • TransformSet - sets groups permissions for transform sets.
    • View - allows group members to see transform sets.
    • Edit - allows group members to edit transform sets.
    • Delete - allows group members to delete transform sets.
    • Add - allows group members to add transform sets.
    • Edit Security - allows group members to edit the security of existing transform sets.
  • Transform - sets group permissions for the transforms that are added to transform sets.
    • View - allows group members to see transforms.
    • Edit - allows group members to see transforms.
    • Delete - allows group members to delete transforms.
    • Add - allows group members to add transforms.
    • Edit Security - allows group members to edit the security of existing transforms.
  • SearchTermsReport - sets group permissions for search terms reports.
    • View - allows group members to view search terms reports.
    • Edit - allows group members to edit search terms reports.
    • Delete - allows group members to delete search terms reports.
    • Add - allows group members to add search terms reports.
    • Edit Security - allows group members to edit the security of existing search terms reports.
  • SearchTermsResult - sets the group permissions for search terms results.
    • View - allows group members to view search terms results.
    • Edit - allows group members to edit search terms results.
    • Delete - allows group members to delete search terms results.
    • Add - allows group members to add search terms results.
    • Edit Security - allows group members to edit the security of existing search terms results.
  • WorkProduct - sets the group permissions for work products.
    • View - allows group members to view work products.
    • Edit - allows group members to edit work products.
    • Delete - allows group members to delete work products.
    • Add - allows group members to add work products.
    • Edit Security - allows group members to edit the security of existing work products.
  • Contacts - sets the group permissions for contacts.
    • View - allows group members to view contacts.
    • Edit - allows group members to edit contacts.
    • Delete - allows group members to delete contacts.
    • Add - allows group members to add contacts.
    • Edit Security - allows group members to edit the security of existing contacts.
  • CaseInfo - sets the group permissions for case information.
    • View - allows group members to view case information.
    • Edit - allows group members to edit case information.
    • Delete - allows group members to delete case information.
    • Add - allows group members to add case information.
    • Edit Security - allows group members to edit the security of existing case information.
  • PivotProfile - sets the group's permissions for pivot profiles.
    • View - allows group members to view pivot profiles.
    • Edit - allows group members to edit pivot profiles.
    • Delete - allows group members to delete pivot profiles.
    • Add - allows group members to add pivot profiles.
    • Edit Security - allows group members to edit the security of existing pivot profiles.
  • OCRProfile - sets the group's permissions for OCR profiles.
    • View - allows group members to view OCR profiles.
    • Edit - allows group members to edit OCR profiles.
    • Delete - allows group members to delete OCR profiles.
    • Add - allows group members to add OCR profiles.
    • Edit Security - allows group members to edit the security of existing OCR profiles
  • OCRSet - sets the group's permissions for OCR sets.
    • View - allows group members to view OCR sets.
    • Edit - allows group members to edit OCR sets.
    • Delete - allows group members to delete OCR sets.
    • Add - allows group members to add OCR sets.
    • Edit Security - allows group members to edit the security of existing OCR sets.
  • RelativityApplication - sets the group permissions for applications.
    • View - allows group members to view applications.
    • Edit - allows group members to edit unlocked applications.
    • Delete - allows group members to delete unlocked applications.
    • Add - allows group members to add new applications.
    • Edit Security - allows group members to edit the security of existing applications.
    • Note: Groups assigned Relativity Applications permissions require access to the Relativity Applications tab in order to perform any tasks associated with the View, Edit, Delete, Add, or Edit Security permissions. Select Relativity Applications in the Tab Visibility permissions category.

    AnalyticsProfile - sets the group permissions for Analytics profiles.
    • View - allows group members to view Analytics profiles.
    • Edit - allows group members to edit Analytics profiles.
    • Delete - allows group members to delete Analytics profiles
    • Add - allows group members to add Analytics profiles.
    • Edit Security - allows group members to edit the security of existing Analytics profiles.
  • RepeatedContentFilter - sets the group permissions for Repeated Content filters.
    • View - allows group members to view Repeated Content filters.
    • Edit - allows group members to edit Repeated Content filters.
    • Delete - allows group members to delete Repeated Content filters.
    • Add - allows group members to add Repeated Content filters.
    • Edit Security - allows group members to edit the security of existing Repeated Content filters.
  • NativeType - sets the group permissions for native types.
    • View - allows group members to view native types.
    • Edit - for native types, allows group members to edit the restricted from imaging by default checkbox.
    • Delete - allows group members to remove native types from the restricted list.
    • Add - allows group members to add existing native types to the restricted list.
    • Note: Even with all native type permissions, users can't add new native file types. Relativity is already configured with the native file types that it recognizes. For more information, see Restricted native types.

    • Edit Security - allows group members to edit the security of existing native types.
  • ImagingProfile - sets the group permissions for imaging profiles.
    • View - allows group members to view imaging profiles.
    • Edit - allows group members to edit imaging profiles.
    • Delete - allows group members to delete imaging profiles.
    • Add - allows group members to add imaging profiles.
    • Edit Security - allows group members to edit the security of existing imaging profiles.
  • ImagingSet - sets the group permissions for imaging sets.
    • View - allows group members to view imaging sets.
    • Edit - allows group members to edit imaging sets.
    • Delete - allows group members to delete imaging sets.
    • Add allows group members to add imaging sets.
    • Edit Security allows group members to edit the security of existing imaging sets.
  • AnalyticsCategorizationResult - sets the group permissions for Analytics categorization results.
    • View - allows group members to view Analytics categorization results.
    • Edit - allows group members to edit Analytics categorization results.
    • Delete - allows group members to delete Analytics categorization results.
    • Add - allows group members to add Analytics categorization results.
    • Edit Security - allows group members to edit the security of existing Analytics categorization results.
  • AnalyticsCategorizationSet - sets the group permissions for Analytics categorization sets.
    • View - allows group members to view Analytics categorization sets.
    • Edit - allows group members to edit Analytics categorization sets.
    • Delete - allows group members to delete Analytics categorization sets.
    • Add - allows group members to add Analytics categorization sets.
    • Edit Security - allows group members to edit the security of existing Analytics categorization sets.
  • AnalyticsCategory - sets the group permissions for Analytics categories.
    • View - allows group members to view Analytics categories.
    • Edit - allows group members to edit Analytics categories.
    • Delete - allows group members to delete Analytics categories.
    • Add - allows group members to add Analytics categories.
    • Edit Security - allows group members to edit the security of existing Analytics categories.
  • AnalyticsExample - sets the group permissions for Analytics examples.
    • View - allows group members to view Analytics examples.
    • Edit - allows group members to edit Analytics examples.
    • Delete - allows group members to delete Analytics examples.
    • Add - allows group members to add Analytics examples.
    • Edit Security - allows group members to edit the security of existing Analytics examples.
  • PersistentHighlightSet - sets the group permissions for persistent highlight sets.
    • View - allows group members to view persistent highlight sets.
    • Edit - allows group members to edit persistent highlight sets.
    • Delete - allows group members to delete persistent highlight sets.
    • Add - allows group members to add persistent highlight sets.
    • Edit Security allows group members to edit the security of existing persistent highlight sets.
  • RelativityTimeZone - sets the group permissions for Relativity time zones.
    • View - allows group members to view Relativity time zones.
    • Edit - allows group members to edit Relativity time zones.
    • Delete - allows group members to delete Relativity time zones.
    • Add - allows group members to add Relativity time zones.
    • Edit Security - allows group members to edit the security of existing Relativity time zones.
  • CustomPage - sets the group permissions for custom pages.
    • View - allows group members to view custom pages.
    • Edit - allows group members to edit custom pages.
    • Delete - allows group members to delete custom pages.
    • Add - allows group members to add custom pages.
    • Edit Security - allows group members to edit the security of existing custom pages.
View Tab Visibility permissions

In the Tab Visibility section, you can grant group rights to view tabs. As described above, you need to combine sets of rights and tab visibility to give users the tools they need to complete their tasks. Select the checkbox next to a tab to make it visible for the group.


You can enable the following tabs for a group:

  • Administration
  • Analytics & Indexing
  • Analytics Categorization Set
  • Analytics Profiles
  • Batch Sets
  • Choices
  • Documents
  • Fields
  • History
  • Note: If a user has view access or greater to the History tab, but doesn't have permission to View All Audits, the user can't view the History tab.

  • Imaging
  • Imaging Profiles
  • Imaging Sets
  • Layouts
  • Markup Sets
  • Native Types
  • OCR
  • OCR Profiles
  • OCR Sets
  • Object Types
  • Persistent Highlight Sets
  • Pivot Profiles
  • Production Sets
  • Relativity Applications
  • Repeated Content Filters
  • Review Batches
  • Scripts
  • Search Indexes
  • Search Terms Reports
  • Summary Reports
  • Tabs
  • Transform Sets
  • User Status
  • Views
  • Workspace Details
  • Note: If a user has view access or greater to the Workspace Details tab, but doesn't have permission to View Workspace Details, the user can't view the Workspace Details tab.

  • <Custom> - custom tabs will be listed individually
View Browsers permissions

In the Browsers section, you control which browser options are visible to the group. Select the checkbox next to the browser type to make it visible for the group.

You can enable the following browser options for a group:

  • Advanced & Saved Searches
  • Clusters
  • Field Tree
  • Folders

Groups with rights to no browsers simply see their views with the documents area spanning the whole screen.

View Mass Actions permissions

In the Mass Actions section, you control which types of mass action rights the group can access. Select the checkmark next to the mass action you want group members to have access to.


You can select the following mass actions:

  • Cluster gives group members the rights to cluster documents using Relativity Analytics clustering.
  • Process Transcript allows group members to process imported transcripts for viewing in Relativity.
  • Mass Copy gives group members the rights to copy securable objects such as views, layouts and summary reports.
  • Mass Edit gives group members the rights to use their layouts to simultaneously edit document field values for multiple documents.
  • Mass Move gives group members the right to simultaneously move documents from one or more folders to one target folder. Mass Move also requires add and delete document rights.
  • Mass Delete allows group members to mass-delete documents. Mass delete also requires the rights to delete documents.
  • Mass Produce gives group members the right to simultaneously add multiple documents to a production set.
  • Mass Replace allows group members to perform a replace operation on multiple documents. Examples include:
    • Copying the contents of one text field to another.
    • Adding a set string to the beginning or end of an existing field.
    • Merging the values of a source field with the values of a target field.
  • Mass Images allows group members to simultaneously send image requests for multiple native files.
  • Mass Print Image gives group members the right to simultaneously print images from multiple documents.
  • Note: When you mass print images, you can choose how to print the redactions on those images (visible, transparent, or hidden). Even if users don't have permission to move or delete redactions, if they mass print images, they can choose to print redactions as transparent or hidden.

  • Tally/Sum/Average allows group members to tally, sum and average the values of any numeric fields. This action is recorded under the document history.
  • Send To CaseMap allows group members to send multiple documents to CaseMap.

    Note: CaseMap is not compatible with Windows 8.

  • Export to File gives group members the right to export the contents of a view to a .csv, .xls or .dat file.

For more information about mass operations, see Mass operations.

View Admin Operations permissions

You can secure several Admin operations separately. To assign permissions to a group, select checkboxes for any combination of these operations.

Relativity Desktop Client For Mac Os


Relativity Desktop Client For Mac

The options available in the Admin Operations section include:

  • Assign Batches gives group members permissions to check out batches to other reviewers.
  • When adding a new object type, Manage Object Types gives group members permissions to add a new tab for the new object type.
  • Use Pivot/Chart gives group members permissions to use the pivot grid and chart functions.
  • View Workspace Details gives group members permissions to access the Workspace Details page and the Relativity Utilities console.
  • Note: If a user has view access or greater to the Workspace Details tab, but doesn't have permission to View Workspace Details, the user can't view the Workspace Details tab.

  • View User Status gives group members permissions to access the User Status tab.
  • Download Relativity Desktop Client gives group members permission to the Download Relativity Desktop Client 32-bit and Download Relativity Desktop Client 64-bit buttons. These buttons are located in the Relativity Utilities console on the Workspace Details page. See Using the utilities console.
  • Override Production Restrictions gives group members permissions to override the setting in the Production Restrictions option on the Workspace Details page. The group members will be able to produce documents that contain conflicts based on these restrictions. See Adding and editing production restrictions.
  • Manage Relativity Applications allows group members to associate objects with applications by making the Relativity Applications field available on create and edit pages for Field, Layout, View, Script, Object Types, and all other objects compatible with applications. Users with this and Edit permissions for Applications are allowed to lock and unlock an application from editing.
  • Modify System Keyboard Shortcuts gives group members permission to the Manage System Keyboard Shortcuts button. This button is located in the Relativity Utilities console on the Workspace Details page. See Keyboard shortcuts
  • Delete Object Dependencies gives group members permission to force the deletion of an object, which includes unlinking associative objects and deleting child objects. The group members must also have permissions to delete any dependent child and/or modify associative objects. See Deleting object dependencies.
  • Allow dtSearch Index Swap gives group members the ability to execute the Index Swap function from the dtSearch console. See Search indexes.
  • View All Audits gives group members permission to view the history of a document in the Viewer through the Document History icon, as well as workspace objects, such as markup sets, Dynamic Objects, fields, etc., through the View Audit option on those objects’ layouts.
  • Note: If a user has view access or greater to the History tab, but doesn't have permission to View All Audits, the user can't view the History tab.

  • View Batch Pane gives group members permission to view the batches associated with a document in the related items pane.
  • View Image Thumbnails gives group members permission to access the thumbnail viewer while in Image mode in the Core Reviewer Interface. This viewer allows users to run a quality control check on images by scanning and deleting blank thumbnails from a document. Note that the thumbnail viewer uses up significant environment resources. We recommend that no more than 20 users in an environment be granted this permission.

You can fine-tune the performance of the RDC in your environment by adjusting its configuration settings, for example, for batching, data validation, and retries.

This page contains the following information:

RDC configuration file

To set custom configuration properties for the RDC:

  1. Exit the RDC if it is currently open.
  2. Navigate to the kCura.EDDS.Winform.exe.config file on the machine where the RDC is installed. By default, this configuration file is located in the following directory:

    [Installation_Directory]kCura CorporationRelativity Desktop Client

    Note: Make a backup copy of this file in case you need to rollback any configuration changes made to it.

  3. Open the kCura.EDDS.Winform.exe.config file in a text or XML editor and edit it as necessary.
kCura.EDDS.Winform.exe.config

Configuration settings

kCura.EDDS.Winform.exe.config contains these configuration properties:

kCura.Utility section

NameDescriptionDefault Value
CreateErrorForInvalidDate Specify whether to treat invalid dates as errors. True
IOErrorNumberOfRetries The number of import retries I/O errors. 20
IOErrorWaitTimeInSeconds The wait time in seconds between each import retry attempt. 30
ExportErrorNumberOfRetries The number of export retries I/O errors. 20
ExportErrorWaitTimeInSeconds The wait time in seconds between each export retry attempt. 30

kCura.WinEDDS section

NameDescriptionDefault Value
ImportBatchMaxVolume The maximum number of bytes which, when exceeded, forces an upload of all bulk load files to the server. This value can have a significant impact when importing data sets that contain large amounts of extracted text. 10485760
ImportBatchSize The maximum number of lines to import before forcing an upload of all bulk load files to the server. 1000
ExportThreadCount The total number of threads to create when performing an export. 2
DynamicBatchResizingOn Specify whether to lower the ImportBatchSize value by 100 when an I/O error occurs. True
MinimumBatchSize Specify whether the minimum batch size is set. This is only relevant if ImportBatchSize is undefined or less than ImportBatchSize. 100
CreateErrorForEmptyNativeFile Specify whether to treat zero-byte files as an error. If specified, the line status includes a message indicating that the file is empty. False
LoggerConfigFile Specify the file name or full path of the Relativity logging configuration file. For more information, see Logging. LoggerConfig.xml
DisableNativeValidation Specify whether to skip retrieving file identification information during an import that uses the Outside In technology. False
DisableNativeLocationValidation Specify whether to skip all of the file exists checks during an import. If during the import an error is raised because the file doesn’t exist, setting this flag to True prevents the import from failing. False
TapiForceClientCandidates Force an ordered list of transfer modes, also referred to as TAPI (Transfer API) clients, when probing a workspace and choosing the best mode. This value is a semi-colon delimited list. Native TAPI client identifiers must be used, for example:
Empty
TapiForceAsperaClient Force the Aspera mode (Aspera client). If a failure occurs, the import will fall back to the Web mode (HTTP client). False
TapiForceFileShareClient Force the Direct mode (file share client). If a failure occurs, the import will fall back to the Web mode (HTTP client). False
TapiForceHttpClient Force the Web mode (HTTP client). If a failure occurs, RDC throws a fatal exception. False
TapiLargeFileProgressEnabled Enable extended progress for large files. When enabled, the status messages are in the form “Step x of y” to provide an additional level of progress information. False
TapiMaxJobParallelism Specify the maximum degree of parallelism for a transfer job. This value isn't guaranteed to be used by all clients. 10

Batch handling

You have the option to set several configuration settings that control how the RDC uses batches to load records in the database. Large batch sizes may cause timeouts to occur during the loading process, because Relativity initially attempts to load all documents or images in these batches.

By default, the RDC uses dynamic batch resizing when a timeout occurs. This dynamic bath resizing automatically lowers the size of the batch and retries the import. The RDC reduces the batch size by 100 until it determines the optimum number of records for import. It can also reduce the number of records when the data size (in bytes) for the batch approaches the value set for the ImportBatchMaxVolume.

Relativity Desktop Client For Mac Catalina

To set custom configuration setting for batch handling in your RDC configuration file:

  1. In the kCura.EDDS.Winform.exe.config file, delete the opening comment tag <! -- displayed before the tag <kCura.WinEDDS>, and the closing tag --> displayed after the tag </kCura.WinEDDS>.
  2. Edit the attribute values as necessary. Modify only the values in the previous code sample.
    • ImportBatchMaxVolume: This value represents the maximum data size (in bytes) for a batch. When the data size approaches this value, the RDC reduces the batch size by 100 using dynamic batch resizing. The default value is 10485760 bytes (or 10 MB).
    • ImportBatchSize: This value represents the initial number of records in an import batch. If dynamic batch resizing is enabled, this value may be reset for a job to accommodate the number of records or the size of the data. The default value is 1000 records.
    • ExportBatchSize: This value represents the number of records in an export batch. The default value is 1000 records.
    • ExportThreadCount: This value represents the number of threads the RDC uses to export natives, images, productions, and text. The default value is 2. If you have a high-performing machine, you can configure this setting to get better performance. The maximum value is 8. If you have a lower-performing machine, you can set this value to 1.
    • DynamicBatchResizingOn: When default value of True is set, the RDC automatically uses dynamic batch resizing to decrease the batch size by 100 records and retry the import job. When the value is set to False, the RDC timeouts when the import job is too large to complete.
    • MinimumBatchSize: When DynamicBatchResizingOn is set to True, this value represents lower bound on the batch size. Batch sizes cannot be smaller than this value. The default value is 100 records.
    • CreateErrorForEmptyNativeFile: When the default value of False is set, the RDC imports only the metadata for the record associated with an empty file (of 0 KB), and it displays a message on the Warning tab. When this value is set to True, the RDC does not import the metadata for the empty file, and the Error tab displays a message.

      Note: The RDC does not import empty files. This instance setting controls only the import of metadata, and where information about an empty file displays.

  3. Save your changes to the file. You can now log in to the RDC.

Validation and auditing

You have the option to add configuration settings that control whether the RDC performs validation for native and image file types. The configuration settings can also control the locations for all import jobs. You can also set the level of detail you want the audit log to capture for all import jobs. You must manually add these settings to the configuration file.

Use these instructions to customize the configuration settings for native and image validation, as well as audit level.

Relativity Web Client Download

Before disabling validation, you should confirm that your files are all of supported types and that the native file paths in the load files are correct.

Note the following:

  • When you disable file type validation, you do not receive any warnings regarding unsupported file types. It's therefore possible for files to be imaged and result in errors.
  • Disabling the file type validation also causes the application to set the Relativity Native Types field to Unknown Format.
    • Setting a native type to unknown has no effect on productions or OCR.
    • Setting a native type to unknown has no effect on how the viewer or imaging engine handles the file. This means that a native type of unknown can't be the sole cause of an error in the viewer or the imaging engine. If a file is designated unknown and it actually has an unsupported file type, the Viewer or imaging engine throws an error based on the fact that it has an unsupported file type.
  • When you disable file location validation, the RDC may temporarily stop and then restart if the load file lists paths that do not contain files. Similarly, the RDC will stop when the load file does not include a path for a native file, but it will load any files prior to encountering this issue.

Complete these steps to configure file validation and auditing:

  1. In the kCura.EDDS.Winform.exe.config file, delete the opening comment tag
  2. To disable the validation of native file types for all jobs, add the following setting between the <kCura.WinEDDS>…</kCura.WinEDDS> tags:
  3. To disable the validation of the native file locations for all jobs, add the following setting between the <kCura.WinEDDS>…</kCura.WinEDDS> tags:

    Note: Do not use the DisableNativeLocationValidation flag when copying files to a repository. File locations are validated regardless of the flag before they are copied.

  4. To disable the validation of image file types for all jobs, add the following setting between the <kCura.WinEDDS>…</kCura.WinEDDS> tags:
  5. To disable the validation of the image file locations for all jobs, add the following setting between the <kCura.WinEDDS>…</kCura.WinEDDS> tags:

    Note: The options represented in steps 5-8 are controlled separately; however native type validation is dependent upon native location validation. Image type validation is dependent upon image location validation. To enable any of these functions, set the respective value to False.

  6. To disable auditing, add the following setting between the <kCura.WinEDDS>…</kCura.WinEDDS> tags:

    You can set audit level to any of the following values:

    • FullAudit: Includes create, update, and delete messages. Snapshot is also enabled so all current field values (Audit Details) are captured for updates. This is the default setting.
    • NoSnapshot: Includes create, update, and delete messages. Snapshot is disabled so current field values (Audit Details) are not captured for updates.
    • NoAudit: Auditing is disabled.
  7. Save your changes to the file. You can now log in to the RDC.

Import and export

You can control and retry the behavior for importing and exporting using the importing and exporting settings. You can also control how to bypass specific invalid date errors when importing with the RDC.

Use the following instructions to set custom configuration settings in your RDC configuration file for importing and exporting:

  1. In the kCura.EDDS.Winform.exe.config file, edit any of the following attribute values:
    • CreateErrorForInvalidDate: You can suppress errors that occur as a result of importing dates as'00/00/0000.' The default value is True. This can result in an error when importing with an invalid date.
    • IOErrorNumberOfRetries: This value controls the number of import and export attempts after an error occurs. The default number of retries is 20.
    • IOErrorWaitTimeInSeconds: This value sets the number of seconds the RDC waits before retrying an import or export after an error occurs. The default value is 30 seconds.
    • ExportErrorNumberOfRetries This value sets the number of export retries for I/O errors.
    • ExportErrorWaitTimeInSeconds This value sets the wait time in seconds between each export retry attempt.
  2. Save your changes to the file. You can now log in to the RDC.

RDC transfer mode

You can force a specific RDC mode using these properties in the kCura.WinEDDS section of the kCura.EDDS.Winform.exe.config file:

  • TapiForceClientCandidates
  • TapiForceAsperaClient
  • TapiForceFileShareClient
  • TapiForceHttpClient

For more information on RDC transfer modes, see Relativity Desktop Client

Mac

You can also use the TapiLargeFileProgressEnabled property to display more detailed progress information.