Relativity Admin Guide - 9.6

678 Pages·2017·14.69 MB·English

Admin Guide
July 31, 2020 | Version 9.6.202.10
Forthemostrecentversionofthisdocument,visitourdocumentation website.
Table of Contents
1 Admin guide overview 27
1.1Navigation 27
1.1.1Loggingin 27
1.1.2Tabnavigation 27
1.1.3Useroptions 29
1.1.4UI framework 32
1.1.5Corereviewerinterface 36
1.1.6Resettingyourpassword 38
1.1.7Favorites 39
1.1.8Quicknav 40
1.1.9Quicknavfunctionality 41
1.2LoggingintoRelativity 42
1.2.1Passwordonly 42
1.2.2Password:twofactor 42
1.2.3Active Directory 43
1.2.4IntegratedAuthentication 43
1.2.5ClientCertificate 44
1.2.6RSA 44
1.2.7OpenIDConnect 45
1.2.8SAML2.0 45
1.2.9Creatingorresettingapassword 45
1.2.10LoggingintoRelativitywithapassword 48
2 Relativity applications 50
2.1Systemsecuredapplications 50
2.1.1ApplicationsinstalledintheApplicationLibrary 50
2.1.2Applicationsinstalledinworkspaces 51
2.2Relativitycustomapplications 51
2.3AdministeringRelativityapplications 52
2.4Exportingapplications 52
AdminGuide 2
2.4.1Avoidingerrorsduringapplicationexport 52
2.4.2Applicationstatesettingsonexport 55
2.4.3Exportinganapplication 55
2.5Lockingandunlockingapplications 56
2.5.1Lockinganapplication 56
2.5.2Customizinglockedapplications 57
2.5.3Modifyingsavedsearchesinalockedapplication 57
2.5.4Unlockinganapplication 58
2.6Installingapplications 58
2.6.1InstallingapplicationstotheApplicationLibrary 59
2.6.2PushinganapplicationfromtheApplicationLibrarytoaworkspace 60
2.6.3Installingapplicationstoworkspaces 61
2.7Troubleshootingapplicationinstallationerrors 67
2.7.1Installationerrorlist 67
2.7.2Resolvinginstallationerrors 68
2.7.3PreandPostInstalleventhandlererrors 69
2.7.4Checkingtheerrorstatuses 69
2.8Uninstallinganddeletingapplications 69
2.8.1Uninstallingapplications 69
2.8.2Deletingapplications 79
2.9Upgradingapplications 79
2.9.1Upgradinganapplication 79
2.9.2Troubleshootingapplicationupgrades 80
3 Authentication 82
3.1Authenticationmechanisms 82
3.2Authenticationobjectmodel 83
3.2.1Authenticationobjectpermissions 83
3.3ConfiguringRelativityauthentication 84
3.4Enableauthenticationprovidertypes 84
3.5Creatingauthenticationproviders 85
3.5.1Authenticationprovidersettings 85
AdminGuide 3
3.5.2DefaultIntegratedAuthenticationprovider 86
3.5.3DefaultActiveDirectoryprovider 86
3.5.4DefaultRSAprovider 86
3.5.5DefaultPasswordprovider 86
3.5.6Defaultsmartcardprovider 87
3.5.7OpenIDConnectwithMicrosoftAzureAD 87
3.5.8SAML2.0provider 101
3.6Authenticationchangesfrompreviousversions 108
3.6.1Changesfrompreviousversions 108
3.6.2Passwordworkflowchanges 108
3.7Managinguserauthenticationmethods 109
3.7.1Invitationworkflow 109
3.7.2Manuallysettingpasswords 112
3.7.3ActiveDirectory 113
3.7.4IntegratedAuthentication 113
3.7.5ClientCertificate 114
3.7.6RSA 115
3.7.7OpenID Connect 116
3.7.8SAML2.0 116
3.8Authenticationprocedures 116
3.8.1SettingIPaddressrange 116
3.8.2Configuringintegratedauthentication 118
3.8.3SendingEmail 118
3.8.4RSAconfiguration 119
3.9OAuth2clients 120
3.9.1CreatingoreditinganOAuth2client 120
3.9.2Resettingaclientsecret 122
3.9.3DeletinganOAuth2client 122
ViewinganOAuth2clientaudithistory 123
3.10Federatedinstances 123
3.10.1Creatingoreditingafederatedinstance 124
AdminGuide 4
3.10.2Deletingafederatedinstance 125
Viewingafederatedinstanceaudithistory 125
4 Bandwidth tester 127
4.1Launchingthebandwidthtester 127
4.2Executingalatencytest 128
4.2.1Measuringnetworkdelaywithalatencytest 128
4.2.2Executingalatencytest 129
4.3Executingadownloadtest 130
4.3.1Measuringdownloadspeedwithadownloadtest 130
4.3.2Executingadownloadtest 130
5 Batches 132
5.1BatchfieldsinRelativity 132
5.2Creatingandeditingbatchsets 133
5.2.1Batch SetsforReviewers 133
5.2.2Fields 134
5.2.3BatchSetconsole 135
5.3Deletinganindividualbatch 136
5.4Deletingabatchset 137
5.5Searchingfordocumentsnotincludedinexistingbatchsets 137
5.6Assigningbatchesandcheckingbatchesinandout 138
5.6.1Assignabatchorcheckabatchout 138
5.6.2Reassignabatchorcheckabatchin 139
5.7Buildingviewsforchecked-outdocuments 139
5.7.1Buildachecked-outdocumentsview 139
6 Choices 141
6.1Creatingandeditinganadminchoice 141
6.1.1Adminfields 141
6.2Workingwithchoices 142
6.3Addingchoices 142
6.4Editingchoices 145
6.5Performingmassoperationsonchoices 145
AdminGuide 5
6.6Reorderingchoices 145
6.6.1Orderingchoicesalphabetically 146
6.6.2Nestingchoices 146
6.6.3Choiceoptions 148
6.6.4Removingachoice 149
6.7Permissionconsiderationsforthechoiceeditor 149
6.8AccessingtheChoicesListtab 150
6.8.1Fieldsinworkspaces 150
6.8.2Removingachoice 151
6.8.3Sorttoplevelchoices 151
7 Clients 153
7.1Creatingoreditingaclient 153
7.1.1Fields 153
7.2Enablingclientdomainsonaclient 153
7.2.1Generatingaclientdomainrequest 154
7.2.2Applyingtheactivationkey 154
8 Dashboards 156
9 Document skip 162
9.1Enablingdocumentskip 163
9.2Usingdocumentskip 163
9.2.1Changingskipmode 164
10 Errors 165
10.1Fields 166
11 Fields 167
11.1Systemfields 167
11.2Creatingandeditingfields 169
11.3Fieldsonfield 169
11.3.1Object 169
11.3.2Fieldinformation 170
11.3.3Propagation 174
11.3.4Listproperties 174
AdminGuide 6
11.3.5Yes/Nofielddisplayvalues 177
11.3.6Relationalfieldproperties 177
11.3.7Keyboardshortcut 178
11.3.8RelativityApplications 178
11.4Fieldtypes 179
11.4.1Fixed-lengthtext 179
11.4.2Longtext 179
11.4.3Date 179
11.4.4Wholenumber 180
11.4.5Decimal 180
11.4.6Currency 180
11.4.7Yes/No 180
11.4.8Singlechoice 180
11.4.9Multiplechoice 181
11.4.10User 181
11.4.11File 181
11.4.12Singleobject 181
11.4.13Multipleobject 182
11.4.14AssociativeObjectType 182
11.5Fieldsandperformance 182
11.6Applyingpropagationtodocuments 183
11.6.1Propagatingtodocumentsinmultiplegroups 183
12 Filters 186
12.1Showingandhidingfiltersintheitemlist 186
12.2Settingafilter 187
12.3Filtertypes 189
12.3.1UsingBooleanfilters 189
12.3.2Usingnumericfiltersfornumbers 190
12.3.3UsingListfilters 191
12.3.4Usingdatefilters 193
12.3.5Usingmultilistfilters 194
AdminGuide 7
12.3.6Usingtextboxfilters 196
12.3.7Textboxfiltersearchexamples 197
12.3.8Usingadvancedtextboxfiltering 199
12.4Changingitemsetsperpage 200
12.5Savingfiltersasasearch 201
13 Groups 202
13.1Systemgroups 202
13.2Creatingandeditinggroups 203
13.3Fields 203
13.4Addinguserstogroups 204
13.5Addingorremovinggroupsfromaclientdomain 205
14 History 207
14.1Historyviewfields 207
14.2FiltersontheHistorytab 208
14.3Auditedactions 209
14.4Exportingthehistorylist 212
15 Imaging 213
15.1Requiredsecuritypermissionsforimaging 213
15.2Installingimagingagents 214
15.3Troubleshootingimaging 216
15.4Imageonthefly 216
15.5Massimage 217
15.6Imagingprofiles 217
15.6.1Creatingandeditinganimagingprofile 218
15.6.2Fields 218
15.6.3Nativefileimagingprofilevalidation 226
15.6.4Viewingimagingprofiledetails 227
15.7Imagingsets 230
15.7.1Usingimagingsets 230
15.7.2Creatingandeditinganimagingset 230
15.7.3Fields 231
AdminGuide 8
15.8Imageupload 232
15.8.1Requiredsecuritypermissions 233
15.8.2Uploadinganimage 234
15.8.3Auditsforimageupload 237
15.9ApplicationFieldCodes 238
15.9.1ApplicationFieldCodesinRelativity 239
15.9.2ApplicationFieldCodeformats 241
15.9.3CreatingoreditinganApplicationFieldCode 242
15.9.4Fields 242
15.9.5LinkinganApplicationFieldCodetoanativeimagingprofile 243
15.10Runninganimagingset 243
15.10.1Specialconsiderations 244
15.10.2ImagingSetsconsole 244
15.10.3Imagingprofilecaching 245
15.10.4PasswordBank 245
15.11Monitoringimagingstatus 246
15.12Imagingerrors 247
15.12.1Viewingimagingerrors 247
15.12.2Imagingerrorscenarios 249
15.12.3Retryingimagingerrors 251
15.13QCReview 252
15.13.1HidingimagesforQC 252
15.13.2Releasingimages 253
15.14ImagingjobsintheWorkerManagerQueue 254
15.15Imaginghistory 256
15.16Imagingnativetypes 257
15.16.1Editinganativetype 258
15.16.2Generatingacompletelistofnativetypesandtheirrespectiveimagingengines 258
15.17Supportedfiletypesforimaging 259
16 Instance Details tab 261
16.1MonitoringRelativityenvironmentsfromtheInstanceDetailstab 262
AdminGuide 9
16.1.1Licenseinformation 262
16.1.2Alerts 262
16.1.3Security 264
16.1.4UserInformation 264
16.1.5Queues 264
16.2AddingandeditingaMessageoftheDay 265
17 Instance settings 266
17.1Creatingandeditinganewinstancesetting 266
17.1.1Editinganinstancesetting 266
17.2InstanceSettingInformationlayoutfields 267
17.3Deletinganinstancesetting 269
Viewinganinstancesetting'shistory 269
18 Keyboard shortcuts 271
18.1Keyboardshortcutslegend 272
18.2Specialconsiderationsforkeyboardshortcuts 273
18.3Documentfieldtypeshortcuts 274
18.4Documentchoiceshortcuts 275
18.5Creatingkeyboardshortcuts 275
19 Layouts 277
19.1Creatingandeditinglayouts 278
19.2LayoutInformationfields 278
19.2.1Changinglayoutswhilecoding 280
19.3Usingthelayoutbuilder 280
19.3.1LayoutOptionsconsole 281
19.3.2Creatingandeditingalayoutgroup 282
19.3.3Savingthelayout 284
19.4Addingachoicetoalayout 284
19.5ChoiceInformationfields 285
19.6Pop-upsonthelayout 285
19.7Addingandeditinganobjectlist 286
19.7.1Addingandeditinganobjectlist 286
AdminGuide 10