Relativity Admin Guide - 9.2

618 Pages·2017·15.92 MB·English

Admin Guide
February4,2019-Version9.2
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
Forthe mostrecentversion ofthisdocument,visitourdocumentation website.
Table of Contents
1 Admin guide overview 25
1.1Navigation 25
1.1.1Loggingin 25
1.1.2Tabnavigation 27
1.1.3Useroptions 29
1.1.4Corereviewerinterface 33
1.1.5Resettingyourpassword 34
1.1.6Favorites 35
1.1.7Quicknav 36
1.1.8Quicknavfunctionality 38
2 Relativity applications 39
2.1Systemsecuredapplications 39
2.1.1ApplicationsinstalledintheApplicationLibrary 39
2.1.2Applicationsinstalledinworkspaces 39
2.2Relativitycustomapplications 40
2.3AdministeringRelativityapplications 40
2.4Exportingapplications 41
2.4.1Applicationstatesettingsonexport 41
2.4.2Exportinganapplication 41
2.5Lockingandunlockingapplications 42
2.5.1Lockinganapplication 42
2.5.2Modifyingsavedsearchesinalockedapplication 43
2.5.3Unlockinganapplication 43
2.6Installingapplications 43
2.6.1InstallingapplicationstotheApplicationLibrary 44
2.6.2Installingapplicationstoworkspaces 46
2.7Troubleshootingapplicationinstallationerrors 52
2.7.1Installationerrorlist 52
2.7.2Resolvinginstallationerrors 52
Relativity|AdminGuide-2
2.7.3PreandPostInstalleventhandlererrors 53
2.8Checkingtheerrorstatuses 53
2.9Uninstallinganddeletingapplications 54
2.9.1Uninstallingapplications 54
2.9.2Deletingapplications 63
2.10Upgradingapplications 63
2.10.1Upgradinganapplication 63
2.10.2Troubleshootingapplicationupgrades 64
3 Authentication 66
3.1Authenticationmechanisms 66
3.2Authenticationobjectmodel 67
3.2.1Authenticationobjectpermissions 67
3.3ConfiguringRelativityauthentication 68
3.4Enableauthenticationprovidertypes 68
3.5Creatingauthenticationproviders 69
3.5.1Authenticationprovidersettings 69
3.5.2IntegratedAuthenticationprovider 70
3.5.3ActiveDirectoryprovider 70
3.5.4RSAprovider 70
3.5.5Passwordprovider 70
3.5.6Clientcertificateprovider 71
3.5.7OpenIDConnectprovider 71
3.5.8SAML2.0provider 75
3.6Authenticationchangesfrompreviousversions 81
3.6.1Changesfrompreviousversions 81
3.6.2Passwordworkflowchanges 82
3.7Managinguserauthenticationmethods 82
3.7.1Invitationworkflow 82
3.7.2Manuallysettingpasswords 85
3.7.3ActiveDirectory 85
3.7.4IntegratedAuthentication 86
Relativity|AdminGuide-3
3.7.5ClientCertificate 86
3.7.6RSA 87
3.7.7OpenID Connect 88
3.7.8SAML2.0 88
3.8Authenticationprocedures 89
3.8.1SettingIPaddressrange 89
3.8.2Settingintegratedauthentication 90
3.8.3SendingEmail 90
3.8.4EnablingIntegratedAuthentication 91
3.8.5RSA configuration 94
3.9OAuth2clients 95
3.9.1CreatingoreditinganOAuth2client 95
3.9.2Resettingaclientsecret 97
3.9.3DeletinganOAuth2client 97
ViewinganOAuth2clientaudithistory 98
3.10Federatedinstances 98
3.10.1Creatingoreditingafederatedinstance 99
3.10.2Deletingafederatedinstance 100
Viewingafederatedinstanceaudithistory 100
3.11Authenticationbefore9.2.600.19(October4,2016)productupdate 101
3.11.1Authenticationmethods 101
3.11.2Understandingenvironmentsettingsandloginbehavior 102
3.11.3SettingWindowsauthenticationforaRelativityinstance 102
3.11.4Settinganauthenticationmethodforaspecificuser 103
3.11.5SettingtrustedIPaddressesforauser 107
3.11.6EnablingWindowsauthenticationforawebsiteusingAD 108
4 Bandwidth tester 113
4.1Launchingthebandwidthtester 113
4.2Executingalatencytest 114
4.2.1Measuringnetworkdelaywithalatencytest 114
4.2.2Executingalatencytest 115
Relativity|AdminGuide-4
4.3Executingadownloadtest 116
4.3.1Measuringdownloadspeedwithadownloadtest 116
4.3.2Executingadownloadtest 116
5 Batches 118
5.1BatchfieldsinRelativity 118
5.2Creatingandeditingbatchsets 119
5.2.1Fields 119
5.2.2BatchSetconsole 121
5.3Deletingabatchset 121
5.4Searchingfordocumentsnotincludedinexistingbatchsets 121
5.5Assigningbatchesandcheckingbatchesinandout 122
5.5.1Assignabatchorcheckabatchout 122
5.5.2Reassignabatchorcheckabatchin 123
5.6Buildingviewsforchecked-outdocuments 123
5.6.1Buildachecked-outdocumentsview 123
6 Choices 124
6.1Creatingandeditinganadminchoice 124
6.1.1Adminfields 124
6.2Creatingandeditingachoiceinaworkspace 125
6.2.1Fieldsinworkspaces 125
6.3Removingachoice 126
6.4Sorttoplevelchoices 126
7 Clients 128
7.1Creatingoreditingaclient 128
7.1.1Fields 128
7.2Enablingtenancyonaclient 128
7.2.1Generatingatenancyrequest 129
7.2.2Applyingtheactivationkey 129
8 Document skip 131
8.1Enablingdocumentskip 131
8.2Usingdocumentskip 132
Relativity|AdminGuide-5
8.2.1Changingskipmode 133
9 Errors 134
9.1Fields 135
10 Fields 137
10.1Systemfields 137
10.2Creatingandeditingfields 139
10.3Fieldsonfield 139
10.3.1Object 139
10.3.2Fieldinformation 140
10.3.3Propagation 142
10.3.4Listproperties 143
10.3.5Yes/Nofielddisplayvalues 145
10.3.6Relationalfieldproperties 145
10.3.7Keyboardshortcut 146
10.3.8RelativityApplications 147
10.4Fieldtypes 147
10.4.1Fixed-lengthtext 147
10.4.2Longtext 147
10.4.3Date 148
10.4.4Wholenumber 148
10.4.5Decimal 148
10.4.6Currency 148
10.4.7Yes/No 148
10.4.8Singlechoice 148
10.4.9Multiplechoice 149
10.4.10User 149
10.4.11File 149
10.4.12Singleobject 149
10.4.13Multipleobject 150
10.4.14AssociativeObjectType 150
10.5Fieldsandperformance 150
Relativity|AdminGuide-6
10.6Applyingpropagationtodocuments 151
10.6.1Propagatingtodocumentsinmultiplegroups 151
11 Filters 154
11.1Settingfilters 154
11.1.1Changingitemsetsperpage 155
11.1.2Savingfiltersasasearch 156
11.2Filtertypes 156
11.2.1Booleanfilters 156
11.2.2Customonly 157
11.2.3Listfilters 158
11.2.4MultiListfilters 159
11.2.5Popuppickerfilters 159
11.2.6Textboxfilters 160
11.3Textboxfiltersearchexamples 161
11.3.1Booleanandothersearchoperators 161
11.3.2Alphabeticalfiltering 161
11.3.3Datesandnumbers 162
12 Groups 164
12.1Systemgroups 164
12.2Creatingandeditinggroups 165
12.3Fields 165
12.4Addinguserstogroups 166
12.5Addingorremovinggroupsfromatenancy 166
13 History 168
13.1Historyviewfields 168
13.2FiltersontheHistorytab 169
13.3Auditedactions 171
14 Imaging 173
14.1Troubleshootingimaging 173
14.2Imageonthefly 174
14.3Massimage 174
Relativity|AdminGuide-7
14.4Imagingprofiles 174
14.4.1Creatingandeditinganimagingprofile 174
14.4.2Fields 175
14.4.3Nativefileimagingprofilevalidation 181
14.4.4Viewingimagingprofiledetails 182
14.5Imagingsets 185
14.5.1Usingimagingsets 185
14.5.2Creatingandeditinganimagingset 185
14.5.3Fields 186
14.6ApplicationFieldCodes 187
14.6.1ApplicationFieldCodesinRelativity 188
14.6.2Applicationfieldcodeformats 190
14.6.3CreatingoreditinganApplicationFieldCode 190
14.6.4Fields 191
14.6.5LinkinganApplicationFieldCodetoanativeimagingprofile 192
14.7Runninganimagingset 192
14.7.1Imagingprocess 194
14.7.2Imagingprofilecaching 195
14.7.3PasswordBank 195
14.8Monitoringimagingstatus 195
14.9Imagingerrors 197
14.9.1Viewingimagingerrors 197
14.9.2Imagingerrorscenarios 199
14.9.3Retryingimagingerrors 200
14.10QCReview 201
14.10.1HidingimagesforQC 201
14.10.2Releasingimages 202
14.11ImagingjobsintheWorkerManagerqueue 204
14.12Imaginghistory 206
14.13Imagingnativetypes 207
14.13.1Editinganativetype 208
Relativity|AdminGuide-8
14.13.2Generatingacompletelistofnativetypesandtheirrespectiveimagingengines 208
15 Indented lists 210
15.1Creatingabasicindentedlistview 210
15.2Fields 212
15.3Creatingaconversationindexindentedlist 212
15.4CreatinganEquivioindentedlist 214
15.5Creatinganumericindentedlist 215
16 Inline tagging 216
16.1Creatingtagsfortranscripts 219
16.2Addingatagtoatranscript 220
16.3Viewingtagsinatranscript 220
16.4Removingatagfromatranscript 220
17 Instance Details tab 221
17.1MonitoringRelativityenvironmentsfromtheInstanceDetailstab 222
17.1.1Licenseinformation 222
17.1.2Alerts 222
17.1.3Security 222
17.1.4UserInformation 223
17.1.5Queues 223
17.2AddingandeditingaMessageoftheDay 223
18 Keyboard shortcuts 225
18.1Keyboardshortcutslegend 226
18.2Specialconsiderationsforkeyboardshortcuts 227
18.3Documentfieldtypeshortcuts 228
18.4Documentchoiceshortcuts 228
18.5Creatingkeyboardshortcuts 229
19 Layouts 231
19.1Creatingandeditinglayouts 232
19.2Fields 233
19.3Addingachoicetoalayout 234
19.4Fieldsonchoice 234
Relativity|AdminGuide-9
19.5Addinglayoutcontent 235
19.6Pop-upsonthelayout 236
19.7Addingfieldsandtext 236
19.7.1FieldsonAddFieldtoLayout 236
19.7.2Addingtexttoalayout 239
19.7.3FieldsonAddText 239
19.8Creatinganewcategory 240
19.8.1Fields 240
19.9Addingchildandassociativeobjectlists 241
19.9.1Addinganobject 241
19.9.2Addingchildobjectlists 242
19.9.3Fieldsonchildobjectlist 242
19.9.4Addingassociativeobjectlists 243
19.9.5Fieldsonassociativeobjectlist 243
19.10CopyfromPrevious 244
19.10.1AddingtheCopyfromPrevioustoolbar 244
19.10.2UsingCopyfromPrevious 244
20 Lists 246
20.1Enablinglistsonanobject 247
20.2Savingalist 248
20.3Viewingitemsinalist 249
20.3.1Convertinganewlistofdocumentsintoasavedsearch 249
20.3.2Incorporatingalistofdocumentsasasearchcriterioninasavedsearch 249
20.3.3Creatingaviewfromasavedlist 250
21 Relativity Script Library 251
21.1Analyticsbillableestimate 252
21.1.1Specialconsiderations 253
21.1.2Inputs 253
21.1.3Results 253
21.2Billingstatistics-caserollup 253
21.2.1Inputs 253
Relativity|AdminGuide-10