Relativity Admin Guide - 9.4

635 Pages·2017·14.13 MB·English

Admin Guide
January 22, 2019 | Version 9.4
Forthemostrecentversionofthisdocument,visitourdocumentation website.
Table of Contents
1 Admin guide overview 25
1.1Navigation 25
1.1.1Loggingin 25
1.1.2Tabnavigation 25
1.1.3Useroptions 27
1.1.4NewUI framework 31
1.1.5Corereviewerinterface 33
1.1.6Resettingyourpassword 35
1.1.7Favorites 36
1.1.8Quicknav 37
1.1.9Quicknavfunctionality 39
1.2LoggingintoRelativity 39
1.2.1Passwordonly 39
1.2.2Password:twofactor 40
1.2.3Active Directory 40
1.2.4IntegratedAuthentication 41
1.2.5ClientCertificate 41
1.2.6RSA 42
1.2.7OpenIDConnect 42
1.2.8SAML2.0 42
1.2.9Creatingorresettingapassword 43
1.2.10LoggingintoRelativitywithapassword 45
2 Relativity applications 46
2.1Systemsecuredapplications 46
2.1.1ApplicationsinstalledintheApplicationLibrary 46
2.1.2Applicationsinstalledinworkspaces 47
2.2Relativitycustomapplications 47
2.3AdministeringRelativityapplications 47
2.4Exportingapplications 48
AdminGuide 2
2.4.1Applicationstatesettingsonexport 48
2.4.2Exportinganapplication 48
2.5Lockingandunlockingapplications 49
2.5.1Lockinganapplication 49
2.5.2Modifyingsavedsearchesinalockedapplication 50
2.5.3Unlockinganapplication 50
2.6Installingapplications 51
2.6.1InstallingapplicationstotheApplicationLibrary 51
2.6.2Installingapplicationstoworkspaces 53
2.7Troubleshootingapplicationinstallationerrors 59
2.7.1Installationerrorlist 59
2.7.2Resolvinginstallationerrors 60
2.7.3PreandPostInstalleventhandlererrors 61
2.7.4Checkingtheerrorstatuses 61
2.8Uninstallinganddeletingapplications 61
2.8.1Uninstallingapplications 61
2.8.2Deletingapplications 71
2.9Upgradingapplications 71
2.9.1Upgradinganapplication 71
2.9.2Troubleshootingapplicationupgrades 72
3 Authentication 74
3.1Authenticationmechanisms 74
3.2Authenticationobjectmodel 75
3.2.1Authenticationobjectpermissions 75
3.3ConfiguringRelativityauthentication 76
3.4Enableauthenticationprovidertypes 76
3.5Creatingauthenticationproviders 77
3.5.1Authenticationprovidersettings 77
3.5.2IntegratedAuthenticationprovider 78
3.5.3ActiveDirectoryprovider 78
3.5.4RSAprovider 78
AdminGuide 3
3.5.5Passwordprovider 78
3.5.6Clientcertificateprovider 79
3.5.7OpenIDConnectprovider 79
3.5.8SAML2.0provider 83
3.6Authenticationchangesfrompreviousversions 90
3.6.1Changesfrompreviousversions 90
3.6.2Passwordworkflowchanges 90
3.7Managinguserauthenticationmethods 91
3.7.1Invitationworkflow 91
3.7.2Manuallysettingpasswords 94
3.7.3ActiveDirectory 95
3.7.4IntegratedAuthentication 95
3.7.5ClientCertificate 96
3.7.6RSA 97
3.7.7OpenID Connect 98
3.7.8SAML2.0 98
3.8Authenticationprocedures 98
3.8.1SettingIPaddressrange 98
3.8.2Settingintegratedauthentication 99
3.8.3SendingEmail 100
3.8.4EnablingIntegratedAuthentication 100
3.8.5RSA configuration 104
3.9OAuth2clients 105
3.9.1CreatingoreditinganOAuth2client 105
3.9.2Resettingaclientsecret 107
3.9.3DeletinganOAuth2client 107
ViewinganOAuth2clientaudithistory 108
3.10Federatedinstances 108
3.10.1Creatingoreditingafederatedinstance 109
3.10.2Deletingafederatedinstance 110
Viewingafederatedinstanceaudithistory 110
AdminGuide 4
4 Bandwidth tester 112
4.1Launchingthebandwidthtester 112
4.2Executingalatencytest 113
4.2.1Measuringnetworkdelaywithalatencytest 113
4.2.2Executingalatencytest 114
4.3Executingadownloadtest 115
4.3.1Measuringdownloadspeedwithadownloadtest 115
4.3.2Executingadownloadtest 115
5 Batches 117
5.1BatchfieldsinRelativity 117
5.2Creatingandeditingbatchsets 118
5.2.1Fields 118
5.2.2BatchSetconsole 120
5.3Deletingabatchset 120
5.4Searchingfordocumentsnotincludedinexistingbatchsets 121
5.5Assigningbatchesandcheckingbatchesinandout 121
5.5.1Assignabatchorcheckabatchout 121
5.5.2Reassignabatchorcheckabatchin 122
5.6Buildingviewsforchecked-outdocuments 122
5.6.1Buildachecked-outdocumentsview 122
6 Choices 124
6.1Creatingandeditinganadminchoice 124
6.1.1Adminfields 124
6.2Workingwithchoices 125
6.3Addingchoices 125
6.4Editingchoices 127
6.5Reorderingchoices 127
6.5.1Orderingchoicesalphabetically 128
6.5.2Nestingchoices 128
6.5.3Choiceoptions 130
6.5.4Removingachoice 131
AdminGuide 5
6.6Permissionconsiderationsforthechoiceeditor 131
6.7AccessingtheChoicesListtab 131
6.7.1Fieldsinworkspaces 132
6.7.2Removingachoice 133
6.7.3Sorttoplevelchoices 133
7 Clients 135
7.1Creatingoreditingaclient 135
7.1.1Fields 135
7.2Enablingtenancyonaclient 135
7.2.1Generatingatenancyrequest 136
7.2.2Applyingtheactivationkey 136
8 Dashboards 138
9 Document skip 143
9.1Enablingdocumentskip 144
9.2Usingdocumentskip 144
9.2.1Changingskipmode 145
10 Errors 146
10.1Fields 147
11 Fields 148
11.1Systemfields 148
11.2Creatingandeditingfields 150
11.3Fieldsonfield 150
11.3.1Object 150
11.3.2Fieldinformation 151
11.3.3Propagation 154
11.3.4Listproperties 155
11.3.5Yes/Nofielddisplayvalues 157
11.3.6Relationalfieldproperties 157
11.3.7Keyboardshortcut 159
11.3.8RelativityApplications 159
11.4Fieldtypes 159
AdminGuide 6
11.4.1Fixed-lengthtext 160
11.4.2Longtext 160
11.4.3Date 160
11.4.4Wholenumber 160
11.4.5Decimal 160
11.4.6Currency 160
11.4.7Yes/No 161
11.4.8Singlechoice 161
11.4.9Multiplechoice 161
11.4.10User 161
11.4.11File 162
11.4.12Singleobject 162
11.4.13Multipleobject 162
11.4.14AssociativeObjectType 163
11.5Fieldsandperformance 163
11.6Applyingpropagationtodocuments 163
11.6.1Propagatingtodocumentsinmultiplegroups 164
12 Filters 167
12.1Showingandhidingfiltersintheitemlist 167
12.2Settingafilter 168
12.3Filtertypes 170
12.3.1UsingBooleanfilters 170
12.3.2Usingnumericfiltersfornumbers 171
12.3.3UsingListfilters 172
12.3.4Usingdatefilters 174
12.3.5Usingmultilistfilters 175
12.3.6Usingtextboxfilters 177
12.3.7Textboxfiltersearchexamples 178
12.3.8Usingadvancedtextboxfiltering 181
12.4Changingitemsetsperpage 182
12.5Savingfiltersasasearch 182
AdminGuide 7
13 Groups 183
13.1Systemgroups 183
13.2Creatingandeditinggroups 184
13.3Fields 184
13.4Addinguserstogroups 185
13.5Addingorremovinggroupsfromatenancy 185
14 History 187
14.1Historyviewfields 187
14.2FiltersontheHistorytab 188
14.3Auditedactions 189
15 Imaging 192
15.1Troubleshootingimaging 192
15.2Imageonthefly 192
15.3Massimage 193
15.4Imagingprofiles 193
15.4.1Creatingandeditinganimagingprofile 193
15.4.2Fields 194
15.4.3Nativefileimagingprofilevalidation 200
15.4.4Viewingimagingprofiledetails 201
15.5Imagingsets 204
15.5.1Usingimagingsets 204
15.5.2Creatingandeditinganimagingset 204
15.5.3Fields 205
15.6ApplicationFieldCodes 206
15.6.1ApplicationFieldCodesinRelativity 207
15.6.2ApplicationFieldCodeformats 209
15.6.3CreatingoreditinganApplicationFieldCode 210
15.6.4Fields 210
15.6.5LinkinganApplicationFieldCodetoanativeimagingprofile 211
15.7Runninganimagingset 211
15.7.1Imagingprocess 213
AdminGuide 8
15.7.2Imagingprofilecaching 214
15.7.3PasswordBank 214
15.8Monitoringimagingstatus 214
15.9Imagingerrors 216
15.9.1Viewingimagingerrors 216
15.9.2Imagingerrorscenarios 218
15.9.3Retryingimagingerrors 219
15.10QCReview 220
15.10.1HidingimagesforQC 220
15.10.2Releasingimages 221
15.11ImagingjobsintheWorkerManagerqueue 223
15.12Imaginghistory 225
15.13Imagingnativetypes 226
15.13.1Editinganativetype 227
15.13.2Generatingacompletelistofnativetypesandtheirrespectiveimagingengines 227
16 Indented lists 228
16.1Creatingabasicindentedlistview 229
16.2Fields 231
16.3Creatingaconversationindexindentedlist 231
16.4CreatinganEquivioindentedlist 232
16.5Creatinganumericindentedlist 233
17 Inline tagging 235
17.1Creatingtagsfortranscripts 238
17.2Addingatagtoatranscript 239
17.3Viewingtagsinatranscript 239
17.4Removingatagfromatranscript 239
18 Instance Details tab 240
18.1MonitoringRelativityenvironmentsfromtheInstanceDetailstab 241
18.1.1Licenseinformation 241
18.1.2Alerts 241
18.1.3Security 241
AdminGuide 9
18.1.4UserInformation 242
18.1.5Queues 242
18.2AddingandeditingaMessageoftheDay 242
19 Instance settings 244
19.1Creatingandeditinganewinstancesetting 244
19.1.1Editinganinstancesetting 244
19.2InstanceSettingInformationlayoutfields 245
19.3Deletinganinstancesetting 246
Viewinganinstancesetting'shistory 247
20 Keyboard shortcuts 248
20.1Keyboardshortcutslegend 249
20.2Specialconsiderationsforkeyboardshortcuts 250
20.3Documentfieldtypeshortcuts 251
20.4Documentchoiceshortcuts 251
20.5Creatingkeyboardshortcuts 252
21 Layouts 254
21.1Creatingandeditinglayouts 255
21.2LayoutInformationfields 255
21.3Usingthelayoutbuilder 257
21.3.1LayoutOptionsconsole 258
21.3.2Creatingandeditingalayoutgroup 259
21.3.3Savingthelayout 261
21.4Addingachoicetoalayout 261
21.5ChoiceInformationfields 262
21.6Pop-upsonthelayout 262
21.7Addingandeditinganobjectlist 263
21.7.1Addingandeditinganobjectlist 263
21.8Addingfieldsandtext 264
21.8.1Layoutoptions 265
21.8.2Addingfieldstoacategory 266
21.8.3Removingfieldsfromacategory 267
AdminGuide 10