relativity configuration table guide v8
TRANSCRIPT
Configuration Table Guidev8.0
May 10, 2013
For the most recent version of this document, visit kCura'sDocumentation Site.
Relativity | Configuration Table Guide - 2
Table of Contents
1 Configuration table overview 3
1.1 Accessing the configuration table 3
2 Configuration table values 5
2.1 Configuration values and UI display for Document Skip 41
3 dtSearch default alphabet file text 42
Relativity | Configuration Table Guide - 3
1 Configuration table overviewThis guide provides a description of each entry in the configuration table, along with each entry’s defaultvalue.
1.1 Accessing the configuration tableTo access the configuration table, perform the following steps:
1. Access the primary server environment containing all databases, including EDDS.Configuration.2. Connect to theMicrosoft SQL Server Management Studio.3. In the Object Explorer tree, expand Databases > EDDS > Tables.
4. Right-click the eddsdbo.Configuration table, and select the option Select Top 1000 Rows.
The eddsdbo.Configuration table opens. It displays the Section, Name, Value, MachineName, andDescription for all the entries in the table.
Relativity | Configuration Table Guide - 4
5. Locate the configuration value you want to change and update the Value column. Note that doing socould have a significant effect on the performance and functionality of your Relativity environment.Refer to Configuration table values on page 5 for a complete list of Relativity configuration values.
Relativity | Configuration Table Guide - 5
2 Configuration table valuesThis table provides an alphabetical list of all the configuration values related to Relativity.
Name Class Value DescriptionAboutBoxPortalLink kCura.EDDS.Web https://na3.salesforce.com/
secur/login_portal.jsp?orgId=00D5000000072uY&portalId=060500000004fqC
The location to which the Relativity Icon Boxredirects.
AboutBoxSupportLink kCura.EDDS.Web http://kcura.com/relativity/support/technical-support
The location to which the Support link redirects.
Account kCura.LicenseManager UNSETACCOUNT This value populates the Account column in theCase Statistics Rollup report.
AdvancedImagingTimeout Relativity.Core 600 The amount of time, in seconds, that anadvanced imaging process can actively run untilit times out (does not include waiting time).
AdvancedSearchDefault kCura.EDDS.Web False Determines the default setting for AdvancedSearch Default when creating new users. “False”is private, and “true” is public.
AgentOffHourEndTime kCura.EDDS.Agents 5:00:00 This works in conjunction with theAgentOffHourStartTime value to specify a validtime range when off hour agents should run.Currently, this only applies to the File Deletionmanager, Case Statistics Manager, and CaseManager. The format should be hh:mm:ss.Please note that the File Deletion managerimmediately stops deleting documents once thetime of day passes the AgentOffHourEndTime.The Case Statistics manager and CaseManagercontinue to process until completion.
Relativity | Configuration Table Guide - 6
Name Class Value DescriptionAgentOffHourStartTime kCura.EDDS.Agents 00:00:00 This works in conjunction with the
AgentOffHourEndTime value to specify a validtime range when off hour agents should run.Currently, this applies only to the File Deletionmanager, Case Statistics Manager, and CaseManager. The format should be hh:mm:ss.
AllowChangesToOverwriteProtection
kCura.EDDS.Web False Determines if the Overwrite Protection drop-down is editable when editing or creating a lay-out. If set to true, the user can set this propertyto Disabled and then save a document even ifanother process has modified the documentsince loading.
AllowNativeRedactions kCura.EDDS.Web True Determines whether users can perform redac-tions within the Native Viewer.
AnalyticsCategorizationBatchSize
Relativity.Core 100000 The size of the batch of documents submittedto the Analytics engine to be categorized.
AnalyticsCategorizationCreationBatchSize
Relativity.Core 1000 The size of the batch of CategoryResult objectscreated within Relativity once the Analyticsengine has categorized them.
AnalyticsCategorizationDeadlockWait
kCur-a.Data.RowDataGate-way
30000 Time in milliseconds that determines how longthe query should wait to retry when deadlockoccurs during run of categorization set.
AnalyticsCategorizationDeletionBatchSize
Relativity.Core 1000 The size of the batch of CategoryResult objectsdeleted within Relativity when the user choosesto run a full categorization against a set that hasbeen previously categorized.
AncestorCountWarningLevel
kCura.EDDS.Web 50000 Awarning is displayed in the Security page whenthe item's security being changed has morethan this number of ancestors. The warning dis-plays because the database will be locked for asubstantial period of time.
Relativity | Configuration Table Guide - 7
Name Class Value DescriptionAPITimeout kCura.Relativity 30 Sets the Relativity API token expiration in
minutes.ApplicationManagerIsOffHourAgent
kCura.EDDS.Agents False This value controls whether the ApplicationManager agent behaves as an off hour agent. Ifset to True, applications containing custom com-ponents only deploy between the hours set inthe AgentOffHourStartTime andAgentOffHourEndTime values. If an applicationdeploys when the AgentOffHourEndTimepasses, the current deployment completes andno new deployments occur until the nextAgentOffHourStartTime.If set to False, theApplication Manager agent runs normally, andapplications containing custom pages are iden-tified and deployed in the typical process.
Applic-ationRestrictedFileTypes
Relativity.Core .exe;.com;.pif;.bat;.scr A semicolon(;) delimited list of file extensions(including dots) indicating file types that usersshould be prohibited from uploading as custompages or resource files. Examples include .exe,.com, and .bat. Also, see RestrictedFileTypes.
AuditCountQueries Relativity.Core False For each list that is generated, the system ini-tially runs a "count" query to get the total num-ber of records that fulfill the criteria. Setting thisvalue to True writes the SQL query to the His-tory record.
AuditingEnabled kCura.Audit True Determines if auditing is enabled throughoutRelativity.
AuditFullQueries Relativity.Core False For each list page that is generated, the systeminitially runs a query to get the data to fill therows on the current page. Setting this value toTRUE would write the SQL query to the Historyrecord.
Relativity | Configuration Table Guide - 8
Name Class Value DescriptionAuditIdQueries Relativity.Core True The system will get a batch of Artifact IDs that
fulfill the criteria and are needed to populate thecurrent page in the list. Setting this value toTRUE would write the SQL query to the Historyrecord.
AuditPivotColumnRetrievalQueries
Relativity.Core True For each pivot list and chart, a query is run toget the unique columns needed to display thedata. Setting this value to True writes the SQLquery to the History record.
AuditPivotFullQueries Relativity.Core True For each pivot list and chart, a query runs to getthe data for the rows and columns. Setting thisvalue to True writes the SQL query to the His-tory record.
AuthenticationEmailFrom kCura.Notification [email protected] This email address appears in the From field ofemail messages that contain authenticationinformation for users.
AuthenticationTokenLifetimeInMinutes
Relativity.Core 5 When an application other than Relativity isauthenticated using Relativity’s internal mech-anism, a token is received. This token is valid forthis period of time.
AutoCreateRate kCura.EDDS.Web 60 Howoften the system attempts to createbatches, in minutes.
Relativity | Configuration Table Guide - 9
Name Class Value DescriptionAutoEmailWithCaseStatisticsManager
kCura.Billing True If True, the Case Statistics Manager agent gen-erates a text file with client billing informationwhich is sent to kCura automatically throughthe SMTP server. Each time the agent runs, thenew text file is sent to kCura through the SMTPserver. If false, the Case Statistics Manageragent generates a zip file with client billinginformation, which is stored in the location spe-cified in the BillingInfoFileLocation value. Eachtime the agent runs, a new date-stamped file iscreated and stored in this folder. Zip files storedin this location can bemanually sent to kCura.
AutoGenPasswordLength kCura.EDDS.Web 8 The number of characters that an auto-gen-erated password contains.
BackupDirectory kCura.EDDS.SqlServer During Relativity installation The path to the backup directory used by SQLServer. This value should be relative to theserver where SQL Server is installed.
BaseApplicationPath kCura.EDDS.Procuro During Relativity installation The root path where the Procuro looks forrequired Relativity Applications.
BaseRelativityScriptPath kCura.EDDS.Procuro During Relativity installation The root path where the Procuro looks for itsSQL scripts.
BaseUpgradePath kCura.EDDS.Procuro During Relativity installation The base path to the upgrade scripts used byProcuro. This should be local to the installationof Procuro.
BasicImagingTimeout Relativity.Core 300 The amount of time, in seconds, that the basicimaging process waits for a single document tobe imaged before killing the export process andmoving to the next document.
BcpShareFolderName kCura.Chicago BCPPath The name of the share used for Bulk Inserts andthe Case Statistics Manager.
Relativity | Configuration Table Guide - 10
Name Class Value DescriptionBCryptWorkFactor Relativity.Core 11 This is a bCrypt work factor constant that con-
trols the strength of the encryption used forpassword hashing. Any value lower than 10defaults to 10. Incrementing by 1 doubles thetime it takes to hash the password.
BillingInfoFileLocation kCura.Billing blank If set, this determines the location of the date-stamped zip file containing client billing inform-ation. The AutoE-mailWithCaseStatisticsManager valuemust beset to false.
BrandingManagerBatchAmount
kCura.EDDS.Agents 100 The number of files the Branding Managerbrands in a single batch.
BrandingRecordCreationBatchSize
Relativity.Core 1000 Themaximum number of records inserted intothe BrandingQueue table in a single batch. Thisis used by both the Production Manager andwhen attempting to resolve errors in the web.
BufferAcquisitionTimeoutInMilliseconds
kCura.EDDS.Web.Distributed
5000 The amount of time the Distributed site waits toacquire a free buffer to use for downloadingbefore throwing an error.
BufferCount kCura.EDDS.Web.Distributed
1000 The number of buffers that the Distributed siteallocates to servicing download requests.
BufferSize kCura.EDDS.Web.Distributed
81920 Themaximum size, in bytes, of the buffer usedby Distributed. Increasing this may improve filedownload performance but increases the risk ofrunning the Distributed server out ofmemory.
BulkLoadFileFieldDelimiter
Relativity.Data þþKþþ The value used to separate fields when loadingbulk files into the SQL database. Line delimitersare this value plus a new line.
Relativity | Configuration Table Guide - 11
Name Class Value DescriptionCancelRequestEnabled Relativity.Core True This determines whether the option to cancel
requests is available to Relativity users. When itis set to True, users can see an overlay windowwith the option to cancel the request and a mes-sage indicating that items are loading. When setto False, this functionality is not available.
CancelRequestInitialPollingInterval
Relativity.Core 100msec This configuration setting indicates the initialtime interval (in milliseconds) used for pollingthe cache on the web server during the firstsecond of a cancel query request. After the firstsecond, the time interval increases to 450msec.
CancelRequestTimeDelay
Relativity.Core 3 seconds This value controls the time delay (in seconds)between the initiation of a search request andthe display of an overlay windowwith theoption to cancel the request.
CasesForGroupsViewID
kCura.EDDS.Web 900 The ArtifactID of the view used to display theworkspaces at the bottom of a group page.
CaseStatisticsBasedLockout
kCura.LicenseManager blank Used to determine if the Case Statistics-basedlockout is active.
CaseStatisticsNotificationIncludeEmails
kCura.LicenseManager True Expects either True or False. If True, the emailand original email address fields in the Case Stat-istics and User Rollup reports are populated. IfFalse, those fields are retrieved as empty.
CaseStatisticsNotificationList
kCura.LicenseManager empty Distribution list for Case Statistics reports. Itexpects a semicolon-delimited list of emails tosend the report to. If empty, emails aren't sent.
ChoiceLimitForUI Relativity.Core 200 For choices and single objects, themaximumnumber that can appear in a checkbox, drop-down, or radio button list before switching to apop-up picker; we recommend setting this valueto 15. If it's not set, lists automatically render aspop-up pickers.
Relativity | Configuration Table Guide - 12
Name Class Value DescriptionChunkEnabledQueryChunkSize
Relativity.Data 10000 Allows the Desktop Client to pull down a poten-tially large set of artifacts (choices and folders,specifically).
CompareWebAPIPath
kCura.EDDS.Web During Relativity installation The defined CompareWeb API path.
ConcurrentLogin kCura.LicenseManager per system The setting for requiring the Concurrent UserLogin restriction. This valuemust be changed bya tool that the dev teams owns; defaults to dis-allowed.
ContentAnalystDefaultDimensions
Relativity.Core 100 This number of default dimensions specified fornew Content Analyst indexes.
ContentAnalystDefaultMinCoherence
Relativity.Core 0.95 The default minimum coherence score to usewhen submitting a similar documents job toContent Analyst.
ContentAnalystDefaultNum-berOfProcessors
Relativity.Core 2 This value indicates the number of processorsthat a single Analytics index uses for a build.Increasing the number of processors to a valuegreater than 2may slow the performance of theAnalytics server. You must adjust any settingmodifications to the requirements of your envir-onment.
Relativity | Configuration Table Guide - 13
Name Class Value DescriptionContentAnalystFileMaxByteThreshold
Relativity.Core 524288000 One of the variables used to determine whenthe Content Analyst IndexManager sends abatch of documents to the Content Analystengine. Before adding a new document to abatch, the agent calculates the size of all the textassociated with it. If this size exceeds the valuedefined by Con-tentAnalystSingleRecordMaxByteThreshold, thetext is written to disk. If adding this documentto the existing batch causes the total size of allthe records written to disk for this batch toexceed the value of Con-tentAnalystFileMaxByteThreshold, then thebatch is sent to Content Analyst and a newbatch is created.Increasing this valuemay lead to better pop-ulation performance for document sets thatcontain many large files. However, the largerthis number becomes, the greater the chancethat the Content Analyst service (not the Relativ-ity agent) will run out ofmemory.
ContentAnalystMaximumBatchSize
Relativity.Core 1000 Determines the initial batch size for the ContentAnalyst Index Population. After the initial batchis created, dynamic batching determines thenumber of documents sent to the Content Ana-lyst engine.
ContentAnalystSimilarDocsJobType
Relativity.Core 0 This is the default similar documents job type tosubmit to Content Analyst (comprehensive).
ContentAnalystSingleRecordMaxByteThreshold
Relativity.Core 31457280 This variable is used by the Content AnalystIndexManager during population. Beforeadding a new document to a batch, the agent
Relativity | Configuration Table Guide - 14
Name Class Value Descriptioncalculates the size of all the text associated withit. If the size exceeds this value, the text is writ-ten to disk.
(The default directory is specified in Con-tentAnalystTemporaryDirectory below.However, you can also specify a temporary dir-ectory in the application when you add an Ana-lytics server to Relativity. See the RelativityAdmin Guide. )
Increasing this valuemay lead to better per-formance, as writing files to disk is a time-con-suming process. The larger this numberbecomes, however, the greater the chance thatthe agent will run out ofmemory.
ContentAnalystTemporaryDirectory
Relativity.Core blank When the Content Analyst IndexManagerneeds to write large extracted text files to disk,you can use this configuration value to enter aUNC share path for a directory where you wantto store these files. Use the format \\<servername>\<shared folder name> for the path, andensure that the directory is accessible to theagent server running the Analytics index. If thevalue is blank, Relativity writew the files to thedefault document directory for the workspace.
ContentAnalystTemporaryDirectory
Relativity.Threads blank When running structured data Analytics jobs,the worker agents may need to write some largeextracted text files to disk. You can use thisconfiguration value to enter a UNC share pathfor a directory to store these temporary files.Use the format \\<machine
Relativity | Configuration Table Guide - 15
Name Class Value Description
name>.<domain>\<Content Analyst temporarydirectory> (For example:'\\mainline.kcura.corp\SASTempDirectory'). Besure to use the real machine name rather thanthe localhost.If the value is blank, Relativity intelligentlydiscovers the directory. We recommend settingthis value only for single-server environments orwhen auto-discovery doesn't work.
ContentAnalystUpdateBatchSize
Relativity.Core 50000 The batch size to update the non-similar doc-uments in the documents table.
ContentAnalystWebServicesMaxByteThreshold
Relativity.Core 31457280 One of the variables used to determine whenthe Content Analyst IndexManager sends abatch of documents to the Content Analystengine. Before adding a new document to abatch, the agent calculates the size of all the textassociated with it. If this size is less than thevalue defined by this configuration value, thetext is stored in memory. If adding this doc-ument to the existing batch causes the total sizeof all text currently being stored in memory forthat batch to exceed the value of this configvalue, then the batch is sent to Content Analystand a new batch is created.
Increasing this valuemay lead to better per-formance because it allows for larger sets of doc-uments to be sent to the Content Analystengine. However, the larger this numberbecomes, the greater the chance that both theContent Analyst service and the Content Ana-lyst IndexManager will run out ofmemory.
Relativity | Configuration Table Guide - 16
Name Class Value DescriptionContentAnalystWebServicesTimeout
Relativity.Core 300000 The timeout value, in milliseconds, when con-necting to the Content Analyst Web Services.
CopyFilesToRepository kCura.EDDS.Winform True The default value that appears in all import andexport forms within the Relativity Desktop Cli-ent for the “copy files to repository” value.
CreateCaseTimeoutValue
Relativity.Data 1800 The timeout value, in seconds, associated withrunning queries related to case creation.
DatabaseQuery kCura.EDDS.Procuro SELECT CAST(1 AS BIT) AS [ ],' N/A' as ArtifactID, 'EDDS' as[Name], @@SERVERNAME as[Location], 'N/A' as [CaseStatus],'' as [UpgradeStatus] UNIONSELECT CAST(1 AS BIT) AS [ ],CAST([Case].[ArtifactID] ASVARCHAR(20)), [Case].[Name],[ResourceServer].[Name] as[Location], [Code].Name as Status,'' as [UpgradeStatus] FROM[Case] INNER JOIN [Code] ON [Code].ArtifactID = [Case].StatusCodeArtifactIDINNER JOIN [Artifact] ON[Artifact].[ArtifactID] = [Case].[ArtifactID] AND [Artifact].[DeleteFlag]= 0 INNER JOIN [ResourceServer] ON[Case].[ServerID] =[ResourceServer].[ArtifactID]
The query used by Procuro to determine the listof databases available for upgrading.
DataDirectory kCura.EDDS.SqlServer During Relativity installation The path to the data directory used by SQLServer. This value should be relative to theserver where SQL Server is installed.
DataFocusModeDefault kCura.EDDS.Web Off Default InterfaceMode for users. Types:n Data Focus Onn Data Focus Off
Relativity | Configuration Table Guide - 17
Name Class Value DescriptionDefaultCaseDownloadHandlerApplicationPath
kCura.EDDS.Web During Relativity installation The value that populates in the “DownloadHandler URL” field by default for new cases.If you enter a full URL for this value, the protocolmust match what is used in the browser. IfRelativity is set up to use either HTTP or HTTPS,but not both, you can enter a full URL. IfRelativity is set up to use both HTTP and HTTPS,do not specify the protocol in this value.
DefaultOIHiliteStyleID kCura.Code.Data 3 The default OIHiliteStyle associated with newchoices. Valid values are defined on theOIHiliteStyle table (look within a workspace data-base, not the EDDS database).
DefaultNativeImagingEngineURL
Relativity.Core Determined during nativeimaging installation; manuallyentered in configuration tableafter native imaging installationis completed
The base URL to the web services provided bythe processing server (Deprecated in 7.5).
DefaultQueryTimeout kCura.AssistedReview 30 (seconds) The timeout value, in seconds, used by defaultfor all AssistedReview queries.
DeobfuscateMapsFolderPath
Relativity.Core \Relativity\EDDS\Maps folder If set, the folder where the obfuscation map filesare stored for use in the Stack Trace Deo-bfuscation Tool. If not set, the Stack Trace Deo-bfuscation Tool uses the…\Relativity\EDDS\Maps folder.
DeveloperMachine kCura.EDDS.Web False Determines whether the environment shouldbe treated as a developer machine. This shouldalways be set to False for production envir-onments
Relativity | Configuration Table Guide - 18
Name Class Value DescriptionDeveloperMode Relativity.Core False Enables or disables developer mode options
within an instance of Relativity. These optionsinclude disabling the cross-site request forgery(CSRF) header requirement in the [[[Undefinedvariable kCura Variables.REST API]]] API andreturning detailed error messages such as stacktraces. Enable this setting only in a devel-opment environment.
DisabledUserMessage kCura.EDDS.Web Your Relativity Administrator The contact specified within themessage dis-plays when a user does not have access toRelativity.
DisplayDisclaimer kCura.EDDS.Web False Determines whether the disclaimer shouldappear when users log into Relativity.
DisplayHelpLink Relativity.Core True Determines whether the Help link appears for allnon-System Administrators. Setting this valueto False removes the Help link from the UI.
DisplayLogoInTitleBar kCura.EDDS.Web False When set to True, the company logo appears inthe top action bar.
DistinctBuilderMaxValue
Relativity.Data 255 Themaximum number of values allowed in achoice field before it changes from a picker inthe item list to disabled.
DocumentSkipDefaultBehaviorDefault
kCura.EDDS.Web True Determines the default value displayed in theSkip Default Preference field on the Add Userform. The UI displays Skip when this con-figuration option equals True, and it displaysNormal when it equals False. When Docu-mentSkipEnabledDefault is set to Disabled orForce Enabled, this configuration option isignored.
DocumentSkipEnabledDefault
kCura.EDDS.Web Enabled Determines the default value displayed in theDocument Skip field on the Add User form.
Relativity | Configuration Table Guide - 19
Name Class Value DescriptionAcceptable values are Enabled, Disabled, andForce Enabled. When this option is Enabled, thevalue for DocumentSkipDefaultBehaviorDefaultcontrols the default option displayed in the SkipDefault Preference field. When this option is setto Disabled, or Force Enabled, the Skip DefaultPreference field displays the read-only value ofNormal or Skip respectively See Configurationvalues and UI display for Document Skip onpage 41.
DocumentSkipLookAheadLength
kCura.EDDS.Web 1000 The progressive number of documents (startingwith the current + 1) that the system evaluatesagainst the current view/saved search criteriawhen Document Skipping is enabled. Systemdefault is 1000 documents, set to -1 for all doc-uments.
DocumentSkipNoMoreDocumentsMessage
kCura.EDDS.Web Document Skip is enabled.The remaining documents inyour queue no longer meetthe conditions of your viewor search. If you are done withthese records, click \"Return todocument list\".If you would like to see theremaining records, change your viewfrom \"Skip\" to \"Normal\".
Notification to user when Document Skip isenabled, and no more documents fit the savedsearch/view criteria.
DocumentSkipToolTip kCura.EDDS.Web This checkbox will enable youto bypass documents whichalready meet the criteria of thissaved search/view.
Document skip tooltip message displayed in thedocument profile.
DomainParsingSingleRecordMaxByteThreshold
Relativity.Data 1048576 The Domain Parsing tool doesn't parse recordswith a value that exceeds this length (in Bytes).
Relativity | Configuration Table Guide - 20
Name Class Value DescriptiondtSearchDefaultAlphabetFileText
Relativity.Core Listed in dtSearch default alphabet file texton page 42.
The default value of the text for the Alphabet filewhen creating a new dtSearch index.
dtSearchDefaultSubIndexSize
Relativity.Core 250000 This is used by the dtSearch IndexManager todetermine howmany sub-indexes will make upthe entire index. This value is themaximumnumber of documents to build into each sub-index and appears by default in the Sub-indexsize field when creating a dtSearch.
dtSearchEnableMetricsLogging
Relativity.Data 0 A bit value to determine if dtSearch Metricsgathering should be enabled, for Performancetesting or Troubleshooting.
dtSearchPopulationLogFilePath
Relativity.Core blank Set this to point to a file on disk when dia-gnosing dtSearch problems relating to pop-ulating indexes. This will cause dtSearch to writedebugging information to disk. This file itselfdoesn’t need to exist, but the path to it does.Make sure that this value is set back to nothingwhen the log file is no longer needed because itcan grow in size very quickly.
dtSearchQueryLogFilePath
Relativity.Core blank Set this to point to a file on disk when dia-gnosing dtSearch problems relating to per-forming searches. This will cause dtSearch towrite debugging information to disk. This fileitself doesn’t need to exist, but the path to itdoes. Make sure that this value is set back tonothing when the log file is no longer neededbecause it can grow in size very quickly.
dtSearchStreamBufferSize
Relativity.Data 1048576 (1MB) Controls the size, in bytes, of the buffer usedwithin the dtSearchStream object. This buffer isallocated into memory as soon as the agentstarts. Relativity checks to see if the value haschanged between jobs and reallocates the buf-
Relativity | Configuration Table Guide - 21
Name Class Value Descriptionfer if a change is detected.
dtSearchStreamThresholdInBytes
Relativity.Data 1048576 This is used by the dtSearch IndexManagerwhen populating an index. If the size of all thetext associated with a document is larger thanthis value, the text is streamed directly intodtSearch. Otherwise, the text is converted tobytes and the bytes are sent to dtSearch.
dtSearchWorkerProgressThreshold
Relativity.Data 1000 Controls the number of documents a workeragent sends to the dtSearch engine beforereporting progress back to the database.Changing this valuemay have an impact on per-formance.
EmailFrom kCura.Notification blank The email address populated in the “from” fieldwhen sending email notifications. The emailaddress must be valid. Email aliases can beentered in this format: Alias Name [email protected]
EmailLinkURLOverride
kCura.EDDS.Web https://relativity.kcura.com You need to set this item only when the URLused to access Relativity by end users is not theactual URL of the Relativity web server. This canhappen under certain conditions:
n Your Relativity IIS server is part of aserver farm and/or behind a load bal-ancer. In this case, the URL used toaccess Relativity is the URL of the load bal-ancer or the farm, not the URL of a spe-cific server.
n You have a security certificate installedon a load balancer or firewall, and thedevice is doing URL rewriting whenpassing requests on to the Relativityserver. In this case, you use HTTPS to
Relativity | Configuration Table Guide - 22
Name Class Value Description
access Relativity, but the actual Relativityserver doesn't use HTTPS.
EmailTo kCura.Notification blank The email address populated in the “to” fieldwhen sending email notifications. The emailaddress must be valid.
EnableNativeRedactions
kCura.EDDS.Web True To enable native highlighting, redactions, links,and tagging, this must bemanually added andset to True.
EnableTransactionalImports
Relativity.Core True You can set this value to False to turn off theSQL transactions that occur on import. Thiscould speed up performance in the database.However, it's dangerous because it can causeinvalid records in the database.
EncryptedSMTPPassword kCura.Notification blank The password for the username associated withthe credentials of the SMTP server. This pass-word validates against the SMTP authen-tication.
EnvironmentData kCura.LicenseManager xxxx Encrypted data about your environment.Changing this will shut down Relativity.
EnvironmentName kCura.Notification DefaultRelativityEnvironmentName The name of the environment. This value isused when sending notifications. You shouldupdate the default value to a setting appro-priate for use in your environment.
EnvironmentPubToken kCura.LicenseManager xxxx kCura’s public key. Do not change.
ExportBatchSize Relativity.Threads 50 The batch size used by Structured Analyticsagents when pulling document information outof Relativity and pushing it to Content Analyststaging web service. Changing this value willimpact performance.
Relativity | Configuration Table Guide - 23
Name Class Value DescriptionExportSubdirectoryDigitPadding
kCura.EDDS.Winform 3 The default value that appears in the RelativityDesktop Client export form for the “volume sub-directory digit padding” value.
ExportVolumeDigitPadding kCura.EDDS.Winform 2 The default value that appears in the RelativityDesktop Client export form for the ”exportvolume digit padding” value.
FavoritesEnabled Relativity.Core TRUE Determines if Favorites appear in the UI.FileDeleteChunkSizeOnDocumentDelete
Relativity.Data 1000 Determines the number of records deleted atonce from associated tables when documentsare deleted in mass.
FileDeletionManagerBatchAmount
kCura.EDDS.Agents 100 The number of documents that the File DeletionManager deletes in a single batch.
ForceWebClientManagerUpgrade
kCura.EDDS.Web False When set to True, Internet Explorer checks tomake sure the user's web client manager ver-sion matches the version of Relativity exactly. Ifit doesn't, it automatically prompts the user toinstall a newweb client manager.
For-gotPasswordRequestBody
kCura.EDDS.Web <HTML><BODY> <P>We received a requestto reset the password associated with thisemail address. Click the link below to resetyour password. This link will expire after 15minutes.<BR/><BR/> {RESETLINK}<BR/><BR/>We recommend opening thislink in Internet Explorer.<BR/><BR/> Youcan also copy and paste the following textinto your address bar:<BR/><BR/>{RESETTEXT}<BR/><BR/> If you did notrequest this change, contact your systemadministrator.<BR/><BR/> Please do notreply to thisemail.<BR/><BR/></P></BODY></HTML>
The text in the body of the forgotten passwordrequest email message.
Relativity | Configuration Table Guide - 24
Name Class Value DescriptionFor-gotPass-wordRequestCompletedBody
kCura.EDDS.Web <HTML><BODY> <P>The password asso-ciated with this email address has been suc-cessfully reset. Click the link below tologin.<BR/><BR/> {LOGINLINK}<BR/><BR/>We recommend opening this link in Inter-net Explorer.<BR/><BR/> You can also copyand paste the following text into youraddress bar:<BR/><BR/> {LOGINTEXT}<BR/><BR/> If you did not request thischange, contact your system admin-istrator.<BR/><BR/> Please do not reply tothisemail.<BR/><BR/></P></BODY></HTML>
The text in the body of the forgotten passwordrequest email message when the request hasbeen completed.
For-gotPass-wordRequestEmailFrom
kCura.Notification [email protected] The value in the From field for the forgottenpassword request email message.
For-gotPass-wordRequestInvalidBody
kCura.EDDS.Web <HTML><BODY> <P>We received a requestto reset the password associated with thisemail address. <BR/><BR/> Your passwordcan't be reset due to a problem with youraccount. Contact your system admin-istrator for assistance.<BR/><BR/> If youdid not request this change, contact yoursystem administrator.<BR/><BR/> Pleasedo not reply to thisemail.<BR/><BR/></P></BODY></HTML>
The text in the body of the forgotten passwordrequest email message if the user is locked out.
For-gotPass-wordRequestSubject
kCura.EDDS.Web Password reset request The value in the Subject field for the forgottenpassword request email message.
FTDirectory kCura.EDDS.SqlServer During Relativity installation The path to the full-text directory used by theSQL Server. This value should be relative to theserver where SQL Server is installed.
Relativity | Configuration Table Guide - 25
Name Class Value DescriptionHeaderLogo kCura.EDDS.Web kcura_blue.png The name of the image file used for the header.
This file must be located within the Imagesfolder.
HeaderLogoLarge kCura.EDDS.Web kcura_blue_50.png The name of the large image file used for theheader. This file must be located within theImages folder.
HelpLinkURL kCura.EEDS.Web http://kcura.com/relativity/Portals/0/Documents/<RELEASE NUMBER>-%20Documentation%20Help%20Site/index.htm#Relativity Online Help/DocumentationSite/Welcome.htm
The URL for the help link in the user drop-downmenu.
HTMLEditorToolbar kCur-a.Web.UI.WebControls
[[ 'fontname', 'space','fontsize','space','formatblock','space','bold', 'italic', 'underline','separator','strikethrough','subscript', 'superscript','separator','copy', 'cut', 'paste','space', 'undo', 'redo' ],[ 'justifyleft', 'justifycenter','justifyright', 'justifyfull','separator', 'orderedlist','unorderedlist', 'outdent', 'indent','separator','forecolor','hilitecolor', 'textindicator','separator','inserthorizontalrule','createlink', 'insertimage','inserttable']]
Sets the Relativity API token expiration inminutes.
Relativity | Configuration Table Guide - 26
Name Class Value DescriptionImageExportThreshold Relativity.Core 300 The amount of time, in seconds, that the TIFNat-
ivemanager waits for a single document to beimaged before killing the imaging process andmoving to the next document.
ImageViewerBufferSize kCura.EDDS.Web 10485760 Themaximum number of bytes that theImageViewer preloads into memory.
ImportBatchSize Relativity.Threads 500 The batch size used by Structured Analyticsagents when pulling document informationfrom the Content Analyst staging web serviceand pushing it into Relativity. Changing thisvalue impacts performance.
InitialNumberOfViewableDocuments
Relativity.Core 1000 The initial number of viewable items on listpages. This is the value in the “First xxx” drop-down menu on the bottom of list pages.
Instance kCura.LicenseManager UNSETINSTANCE In the Case User Rollup report, this value is usedas a prefix for the Case User ID and Usage IDcolumns. In the Case Statistics Rollup report,this value is used as a prefix in the Usage ID,Case ID, and name columns. It's used to pop-ulate the Instance column in the Case StatisticsRollup report.
Modifying the instance name by updating thisvalue immediately invalidates your Relativityand Processing licenses.
KeyboardShortcutsDefault kCura.EDDS.Web True For new users, this value determines the defaultvalue for Enabling Keyboard Shortcuts.
Relativity | Configuration Table Guide - 27
Name Class Value DescriptionLargeEx-tractedTextMaximumSize
Relativity.Threads 157286400 Themaximum acceptable size, in bytes, ofextracted text sent to Content Analyst. Ifextracted text exceeds this size, the job fails torun and an error message appears. You mustremove the flagged document(s) from yoursaved search before running the job.This value defaults to 157286400 bytes becauseContent Analyst doesn't reliably handleextracted text larger than this size.
LargeExtractedTextSize Relativity.Threads 2097152 The length, in bytes, at which extracted text iswritten to disk when providing information toContent Analyst for structured data analytics.
LazyLoadHighlightSets kCura.EDDS.Web True To enable selective loading of persistent high-light sets, this must bemanually added and setto True.
LdapTemplateUserID kCura.EDDS.Agents 9 The Relativity User Id to use as a template whenthe LdapUserManager Agent creates users. Thisis used when integrating Relativity and ActiveDirectory. Note: The LdapUserManager Agent isnot officially supported yet, so wemay not wantto document this.
LDFDirectory kCura.EDDS.SqlServer C:\Logs\ The path to the log file directory used by SQLServer. This value should be relative to theserver where SQL Server is installed.
LegacyAuditCutoff kCura.EDDS.Web 7/23/2008 3:16:57 PM The date that the environment was upgraded to4.20. It's used within messages explaining to theuser that audit framework changed.
LockoutNotificationList kCura.LicenseManager [email protected];[email protected]
Distribution list for emails warning of a Case Stat-istics-based or license-based lockout
LogOutLogo kCura.EDDS.Web relativityLogin.png The name of the image file used for the LogOutPage. This must be located within the Images
Relativity | Configuration Table Guide - 28
Name Class Value Descriptionfolder.
LongRun-ningQueryTimeout
kCura.AssistedReview 3600 (seconds) The timeout value, in seconds, used by thelong-running Assisted Review queries.
LongRun-ningQueryTimeout
kCur-a.Data.RowDataGate-way
6000 This is used in various places in the system totime out queries that run for a significant lengthof time, and potentially lock an associated table.
LongRun-ningQueryTimeout
Relativity.Threads 120 The timeout value, in seconds, associated withrunning queries related to structured data ana-lytics.
MassCleanseBatchAmount kCura.EDDS.Web 1000 The number of documents per batch for themass cleanse process.
MassCopyBatchAmount kCura.EDDS.Web 100 Defaults to the currently configured value forMassDeleteBatchAmount, controls the batchamount when copying Dynamic Objects.
MassCreateBatchSize kCura.Relativity 500 The number of artifacts per batch for themasscreate process of the API.
MassCreateWordIndexBatchAmount
kCura.EDDS.Web 1000 The number of documents per batch for themass create word index process.
MassDeleteBatchAmount kCura.EDDS.Web 100 The number of documents per batch for themass delete process.
MassDeleteBatchAmount kCura.Relativity 100 The number of documents per batch for themass delete process.Note: The RelativityServices API (RSAPI) doesnot currently support themass deleteoperation. This means that the RSAPI alwaysperforms a deletion one artifact at a time,regardless of the value for theMassDeleteBatchAmount configuration in thekCura.Relativity section of the table.
MassEditBatchAmount kCura.EDDS.Web 1000 The number of documents per batch for themass edit process. In processing, this is the
Relativity | Configuration Table Guide - 29
Name Class Value Descriptionnumber of errors that will bemarked as ignoredor will be put into retry tables at a time.
MassExportBatchAmount kCura.EDDS.Web 10000 The number of documents per batch for themass export process.
MassImageBatchAmount kCura.EDDS.Web 1000 The number of documents per batch for themass image process.
MassImportSqlTimeout Relativity.Data 60 The timeout value, in seconds, associated withlong running queries run by any form ofmassimport - this includes image and native.
MassMoveBatchAmount kCura.EDDS.Web 1000 The number of documents per batch for themass move process.
MassProcessTranscriptBatchAmount
kCura.EDDS.Web 1000 The number of documents per batch for themass transcript process.
MassPro-duceBatchAmount
kCura.EDDS.Web 1000 The number of documents per batch for themass produce process.
MassRedactPopupDelay Relativity.Core 3 Determines the length of time (in seconds)before the creating redactions popup appears.
MaxAnalyticsIndexIdleDays kCura.EDDS.Agents 30 The number of days that an Analytics Index canremain idle before the casemanager agent auto-matically disables it.
MaxArtifactBatchSizeForExecuteBatch
kCura.Relativity 2000 Maximum number of artifacts that can be sub-mitted to ExecuteBatch in one batch.
MaxColumnsForMinWidth kCura.EDDS.Web 20 Views with a column count greater than thisnumber are assumed to be wider than the dis-play. This allows the system to make optim-izations that drastically reduce lag timewhenworking with large views. However, this may res-ult in a suboptimal user experience on viewswith fewer columns. Reduce this number ifusers complain that their views are freezingInternet Explorer.
Relativity | Configuration Table Guide - 30
Name Class Value DescriptionMaxErrorListItems Relativity.Data 50000 Themaximum number of errors that appear on
the Error page.MaximumActionsAllowedForRelativityScript
kCura.EDDS.Web 10 For Relativity scripts, themaximum number ofactions that can be included in the script body;10 is the recommended value.
MaximumColumnsAllowedForRelativ-ityScriptReport
kCura.EDDS.Web 7 For Relativity scripts, themaximum number ofcolumns that can be rendered when the scriptruns as a report; 7 is the recommended value.
MaximumDisplayCountForMultiPicker
kCura.EDDS.Web 10 Themaximum number of items to display whileediting multi-object and multi-choice fields.
MaximumListPageTextLength
kCura.EDDS.Web 500 Themaximum number of characters that theitem list display for a text field.
MaximumLongTextSizeForExportInCell
kCura.EDDS.WebAPI 1048576 During export, if the length of a long-text cell (incharacters) exceeds this value, Relativity pullsdown a token instead of the text for that cell.When the Desktop Client comes across that cell,it knows to make a separate call to pull downthe text for that cell.
MaximumNativeSizeForViewerInBytes
kCura.EDDS.Web 10485760 Themaximum size, in bytes, of a native file thatthe Native Viewer attempts to display. If a nat-ive document exceeds this size, the user willinstead see a page explaining that the doc-ument is too large to be displayed.
MaximumNumberOfImagesForExportChunk
kCura.EDDS.WebAPI 10000 Themaximum number of images, in total bytes,that export in a single set.
MaximumPasswordAgeDefault
kCura.EDDS.Web 0 When creating users, the default value for themaximum password age.
MaximumTextVolumeForExportChunk
kCura.EDDS.WebAPI 1048576 Themaximum text, in total bytes, that export ina single set.
Relativity | Configuration Table Guide - 31
Name Class Value DescriptionMaxInvalidLoginAttempts Relativity.Core 10 Themaximum number of login attempts a user
can make with a given username before Relativ-ity locks out that username.
MaxListItems Relativity.Data 1000 Themaximum number of items that appear onthe dtSearch/CA error popups, thebatch/linked/search/relational panes in theviewer, and the error list in admin mode.
MaxNumberOfArtfactsToMassCreate
kCura.Relativity 1000000 Themaximum number of artifacts that can besubmitted to theMassCreate API function at atime.
MaxNumberOfArtfactsToMassEdit
kCura.Relativity 1000000 Themaximum number of artifacts that can besubmitted to theMassEdit API function at atime.
MaxPasswordHistory Relativity.Core 5 Controls howmany password changes thatRelativity checks for duplicate passwords. Set-ting this to a large value could prevent a userfrom ever using the same password twice.
MaxPDVQueryLength Relativity.Core 60 The timeout value, in seconds, associated withrunning queries related to displaying documentlists.
MaxQueryConditionCharacterLength
Relativity.Core 100000 Themaximum length of a criterion in the viewcriteria picker.
MaxTreeviewChildNodes Relativity.Core 1000 Themaximum number of nodes under a singleparent node that appear in the tree view. If thenumber of child nodes is exceeded, an errormessage appears. This improves user exper-ience and avoids memory issues within thebrowser.
MinimumExcerptTextLength
kCura.AssistedReview 120 Theminimum number of characters requiredfor a text excerpt for designation and issues.
Min- kCura.EDDS.Web 8 Lists theminimum version of IE that is allowed
Relativity | Configuration Table Guide - 32
Name Class Value DescriptionimumSupportedIeVersion to view Relativity. Relativity is designed for IE 8
or higher, and lowering this valuemay result ina poor user experience for users with IE7 orbelow. Note: This value is not meant for clientmodification and dictates only which versions ofIE are supported. Changing this value doesn'tattempt improve the user experience for userswith versions of IE lower than 8.
OCRCompilationBatchSize kCura.EDDS.Agents 100 The number of updates to the document table,with the OCRed text, that the OCRManagermakes in a single transaction.
OCRProcessingBatchSize kCura.EDDS.Agents 1000 The number of items transferred from OCR_POP tables into OCR_TEXT in a single batch.
OCRWorkerBatchAmount kCura.EDDS.Agents 100 The number of images a single OCR workeragent pulls and OCRs at a time.
OCRWorkerInsertBatchSize kCura.EDDS.Agents 500 The number of inserts to the OCRWorker tablethat the OCRManager agent batches into asingle transaction.
PasswordNotificationRelativityURL
kCura.Relativity blank The URL for Relativity used in a password noti-fication email (used only by the API).
Pass-wordResetMessageBody
kCura.EDDS.Web Hello - The following Relativitylogin information hasbeen set: - URL = {URL} -UN = {EMAIL} - PW = {PASSWORD}You should now be able to log in.Remember, the password iscase sensitive. Thanks!
The password Reset Email message Text.
PasswordResetMessageSubject
kCura.EDDS.Web Relativity Login Information - {EMAIL} The password Reset Email Subject Text.
Pass-wordResetRequestLimit
Relativity.Data 10 Indicates the number (from 10-50) of passwordreset requests that an individual email address
Relativity | Configuration Table Guide - 33
Name Class Value Descriptioncan generate. After reaching this number, theemail address can't receive any additional ResetPassword emails unless the user clicks the linkprovided in the email. After the CaseManageragent runs again, the Reset Password emailsresume. Until the CaseManager agent runs, noauditing is logged for the user.
PivotMaximumNumberOfColumns
Relativity.Data 100 Themaximum number of columns that appearin the pivot.
PivotMaximumNumberOfRows
Relativity.Data 20000 This is themaximum number of rows thatappear in the pivot.
PivotNum-berOfRowsPerPage
kCura.EDDS.Web 15 The default number of rows per page in thepivot.
PivotQueryTimeout Relativity.Data 180 This is the timeout period, in seconds, on thepivot query.
PrintImageWarn-ingThreshold
kCura.EDDS.Web 500 If a user attempts to mass print and the numberof images to be printed exceeds this threshold,a warning appears to let the user know thatthey're attempting to print a large number ofdocuments.
ProcessingErrorRetrievalInitialBatchSize
Relativity.Core 1000 The initial number of errors to pull back fromthe processing server in one call. If this fails, thenumber is halved until it either succeeds or failsin pulling back one error.
ProcessingErrorUpdateBatchSize
Relativity.Core 1000 The batch size used when updating processingerrors.
ProcessingExportBatchSize Relativity.Core 1000 The number of documents per batch whenimporting documents during processing.
ProcessingHomeItemListMaximum
Relativity.Core 1000 Themaximum number of processing sets thatappear in the item list on the processinghomepage.
Relativity | Configuration Table Guide - 34
Name Class Value DescriptionProcessingSetStatusUpdateInterval
Relativity.Core 5000 (milliseconds) The interval at which the processing set consoleupdates the status of the processing set.
ProcessingWebAPIPath Relativity.Core <blank> The URL that directs to theWindows Authentic-ated Relativity Web API endpoint used by pro-cessing. This URL is required for processing andmust be entered by the Relativity Admin-istrator.
QueryCacheMode Relativity.Core SQLDependency QueryCacheMode controls the type of SQL cach-ing Relativity uses.Configuration value options:
n SQLDependency – Uses SQL ServiceBroker
n TimeBased – Caches data in the SQLcache for 30 seconds
The preferred configuration value is SQLDepend-ency, as this option notifies the web server inthe event SQL data is updated. Since theTimeBased option caches SQL data for 30seconds, data used by the web server may bebriefly outdated. You can also enter a value ofNone, but doing so results in no SQL cachingand denies those performance increasesallowed by either of the above values. Becauseof this, we recommend that you don't enterNone.
RecentHistoryEnabled Relativity.Core TRUE Determines if recent history items appear.RecentHistoryNumberOfItemsDisplayed
Relativity.Core 10 The number of recent history items stored anddisplayed by the favorites control if Recent His-tory is enabled.
Relativ-ityScriptPickerViewID
kCura.EDDS.Web 902 The ViewArtifactID of the Relativity ScriptPicker.
Relativity | Configuration Table Guide - 35
Name Class Value DescriptionRelativityServicesPath Relativity.Core Set during Relativity installation Indicates the URL for the Services API. This path
is referenced by event handlers and custompages. Procuro automatically sets this value oninstallation.
ReplaceCaseNameWithArtifactID
kCura.Billing False If True, the Case Name in the billing statisticsreport (generated either by manual run of theBilling Statistics - User script or by automatic runof the Case Statistics Manager agent) is replacedwith the Case ArtifactID. By default, this is False,and the Case Name appears.
ReplaceUserNameWithHashValue
kCura.Billing False Determines whether the user name portions ofuser email addresses are replaced with hash val-ues in billing information sent manually or sentautomatically through the SMTP server. If True,all text preceding the@ symbol in each useremail address is replaced with a unique hashvalue. Domains remain unencrypted. Bydefault, this value is set to False, and entire useremail addresses appear. If you manually run thebilling script, the value you select in the inter-face overrides this configuration value.
RepositoryVolumeMax Relativity.Core 1000 Themaximum number of files allowed in arepository case sub-directory.
ResourceServerPollingInterval
Relativity.Core 60000 Interval used to check for new resource serversor refresh existing ones. This check is doneinside of the agent service.
RestrictedFileTypes Relativity.Core .exe;.html;.htm;.js A semicolon-delimited list of file extensions,including dots, that users are prohibited fromuploading to file fields (excluding CustomPages). For example: .exe;.htmlSee also ApplicationRestrictedFileTypes.
RestrictedNativeFileTypes Relativity.Core HTML;HTM;EXE A semicolon-delimited list of file types users are
Relativity | Configuration Table Guide - 36
Name Class Value Descriptionprohibited from uploading to file fields (exclud-ing Custom Pages). These values are regularexpression enabled, so custom validation beha-vior is also supported.
Retries kCura.AssistedReview 3 Number of times agents retry upon failure of agiven operation. After retries are exhausted, theproject has an error status; retries occur every30 seconds by default.
RetryWaitTime kCura.AssistedReview 30 The number of seconds between Relativity'sattempt to retry errors.
RSAConfigFilePath Relativity.Core %RelativityWebInstallDir%\RSA The location of the sdconf.rec file and optionalsdopts.rec file. These files initialize the RSA lib-rary when RSA authentication is configured.
SearchAgentServicePort Relativity.Core 6870 The default port which used by the dtSearchA-gent to service search requests.
SearchCacheTableCreationTimeout
Relativity.Core 60 The timeout value, in seconds, for the creationof a Search Cache table.
SearchIndexerLongRunningQueryTimeout
Relativity.Data 1200 The timeout value, in seconds, associated withlong running queries run by dtSearch, CA, andDomain Parsing.
SearchIndexerMaxPopulationErrors
Relativity.Data 5000 Themaximum number of errors allowed for asingle population process in dtSearch or CAbefore the job is terminated. If this limit isreached, the respective agent throws an excep-tion saying that the failure limit has beenreached.
SearchIndexerTextFromSQLChunkSizeInBytes
Relativity.Data 1048576 The size of the text chunks streamed from SQLto either the dtSearch or CA agents when theyare writing large files to disk. Increasing thisvaluemay improve performance when pop-ulating large files. The larger this value becomes,
Relativity | Configuration Table Guide - 37
Name Class Value Descriptionthe greater the chance that either the dtSearchor CA agent will run out ofmemory.
SendNotificationOnImportCompletion
Relativity.Core False Determines whether an email is sent to the userrunning the import upon completion.
SendNotificationOnImportCom-pletionByDefault
kCura.EDDS.Winform False The default value for sending a notification tothe user uploading data.
ServerManagerRetries kCura.EDDS.Agents 3 Number of attempts made by the Server Man-ager agent to connect to a server before it setsthe server inactive.
ServicesAPIBaseUriOnAgentServers
kCura.Relativity net.pipe://localhost/ Base URI for the self-hosted Services API onagent servers. Use the following format:net.pipe://localhost/.
ServicesAPIHostingOnAgentServersMode
kCura.Relativity SelfHosting Determines how agents access the Services APIin a Relativity environment. Available Valuesinclude SelfHosting and PredefinedURL.
ServicesAPIHostingOnAgentServer-sPredefinedURL
kCura.Relativity http://localhost:9997/Relativity.Services/
The URL that agents use to access the ServicesAPI server when Ser-vicesAPIHostingOnAgentServersMode is set toPredefinedURL.
ServicesAPIMetadataPortOnAgentServers
kCura.Relativity 6867 TCP port used by themetadata endpoint of theself-hosted Services API on agent servers.
SessionTimeoutDelay kCura.EDDS.Web 90000 Relativity issues a warning before a user’s ses-sion expires. This value is the amount of time, inmilliseconds, that the user receives the warningbefore the session expires.
ShowDeobfuscateTool kCura.EDDS.Web False If False, the deobfuscate tool won't appear.ShowForgotPasswordLink
kCura.EDDS.Web False If True, displays the "Forgot your password?"link on the Relativity login screen, allowing usersto reset their own passwords.
Relativity | Configuration Table Guide - 38
Name Class Value DescriptionShowStackTraceOnError kCura.EDDS.Web True If True, full stack traces display to users when an
error occurs.SMTPPort kCura.Notification 25 The port used for SMTP transactions. The
default value can be changed to another portbased on the setup of the SMTP server in yourenvironment. It must be an integer value.
SMTPServer kCura.Notification blank The SMTP server used to send notifications. Thedefault value should be updated with a settingappropriate for your environment.
SMTPUserName kCura.Notification blank The username associated with the credentials ofthe SMTP server. It's validated against theSMTP authentication. The SMTPUserNamemust be associated with the same account asdefined in EmailFrom.
SqlServerLDFDirectory Relativity.Data During Relativity installation The path to the log file directory used by SQLServer. This value should be relative to theserver where SQL Server is installed.
SupportedVersions kCur-a.EDDS.Tem-plateManager
X.X The Relativity versions supported by the tem-platemanager.
SupportLinkHref kCura.EDDS.Web blank The URL for the support link.SyncExcludes Relativity.Core kCura.Sync.dll;
kCura.Sync.Utility.dll;NullableTypes.dll;itextsharp.dll
A list of system DLLs that exist in the sync dir-ectory that should not be recognized as syncs.
SystemArtifactCacheExpiration
Relativity.Core 240 (minutes) The number ofminutes before the system arti-fact cache for any given workspace expires andrefreshes the next time it's accessed.
If you're restoring archived databases intonewly created workspaces, we recommend thatyou reduce this value to 15 or 30minutes.
Relativity | Configuration Table Guide - 39
Name Class Value DescriptionTallyBatchAmount kCura.EDDS.Web 1000 The number of documents per batch for the
tally process.TermsLinkHref kCura.EDDS.Web blank The URL for the terms link. If this isn't blank,
every user must agree to the disclaimer at leastonce before logging into Relativity.
TextExtractionTemporaryDirectory
Relativity.Core blank The temporary directory used by the Text Extrac-tion Manager. If left blank, the default doc-ument directory for the case is used.
TitleText kCura.EDDS.Web Relativity The text of the header title within Relativity.TrustedIPsForTokenLogin kCura.EDDS.Web empty The comma-delimited list of trusted IP
addresses for logging into Relativity with anauthentication token.
UserCanChangePasswordDefault
kCura.EDDS.Web True When creating a user, the default value for theUser Can Change Password option.
UserCanChangeSettingsDefault
kCura.EDDS.Web True When creating a user, the default value for theUser Can Change Settings option.
UseHashJoin Relativity.Core True If true, the hashjoin:true query hint is used bythe performance dataview.
ViewableDocumentsIncrementCount
Relativity.Core 5000 The number of items that can be added to theviewable set on various list pages. It's the valuein the “Add next xxx” drop-down menu on thebottom of various lists. This has a functionalmaximum value of 10,000. This means that evenif the value in the configuration table exceeds10,000, the user will see Add next 10,000 in thedrop down.
ViewQueryOptimization Relativity.Core True If set to True, this populates the total doc-uments in an Item List view using one SQL queryto generate the IDs of all items in the list. Thiseliminates the need for a second SQL query toget the total count of documents.
Relativity | Configuration Table Guide - 40
Name Class Value DescriptionValidateAssemblyVersion kCura.EDDS.WebAPI x.x.*.* Determines which parts of the Relativity version
number validate between the Desktop Clientand the Relativity | Configuration Table - 17WebAPI version. For example, given theWebAPI version is 4.20.1.1 and the Desktop Cli-ent is 4.20.1.2
n *.*.*.* matchn x.x.*.* matchn x.x.x.x do not match (the last node
between the two is different)n x.x.x.* matchn *.*.*.x do not match
WebAPIPath kCura.EDDS.DBMT http://localhost/RelativityWebAPI/ TheWeb API path that the DBMT uses.WebAPIPath kCura.EDDS.Web During Relativity installation TheWebAPI path for Relativity.
If you enter a full URL for this value, the protocolmust match what is used in the browser. IfRelativity is set up to use either HTTP or HTTPS,but not both, you can enter a full URL. IfRelativity is set up to use both HTTP and HTTPS,do not specify the protocol in this value.
WebClientBatchSize Relativity.Core 1000 Determines the batch size for mass creating andmass deleting redactions within the web client
WebClientTimeout kCura.EDDS.Web 3000 The value, in milliseconds, that the web clientcomponents will wait for a response when mak-ing aWebAPI call before assuming the requesthas timed out.
WebCli-entMaximumRetries
kCura.EDDS.Web 2 Themaximum number of times the web clientattempts to make aWebAPI call before throw-ing an error.
WebClientNativeViewerCacheA-
kCura.EDDS.Web 52428800 Themaximum size, in bytes, a file can be toallow the Relativity Web Client Native Viewer
Relativity | Configuration Table Guide - 41
Name Class Value DescriptionheadMaxSizeInBytes Cache Ahead technology to cache it.WebClientPerformanceLatencyTests
kCura.EDDS.Web 5 The number of latency tests performed by theRelativity web client when logging performance.
WebClientPerformanceLoggingInterval
kCura.EDDS.Web 300000 The amount of time, in milliseconds, betweenperformance logging audits from the Relativityweb client.
WebClientPopupDelay kCura.EDDS.Web 3000 Determines the length of time (in milliseconds)before popups appear when performing a longrunning operation.
WebClientRedactionWarning
kCura.EDDS.Web False When set to True, a warning appears if there is a25x25 redaction on the page.
WebClientLongTimeout kCura.EDDS.Web 3000 The value, in milliseconds, that the web clientcomponents waits for a response when makinga potentially long running WebAPI call beforeassuming the request has timed out.
WebClientValidateAssemblyVersion
kCura.EDDS.Web x.x.x.x This value affects how the web client managerdetermines whether it needs to download andinstall a new version of the web client. Forexample, given that Relativity is version 4.20.1.1and the web client is 4.20.1.2:
n *.*.*.* will not cause a download/installn x.x.*.* will not cause a download/installn x.x.x.x will cause a download/install (the
last node between the two is different)n x.x.x.* will not cause a download/installn *.*.*.x will cause a download/install
2.1 Configuration values and UI display for Document SkipThe following rules apply to the DocumentSkipDefaultBehaviorDefault configuration value and UI display:
Relativity | Configuration Table Guide - 42
DocumentSkipDefaultBehaviorDefault (configuration value and UIdisplay for document skip field)
DocumentSkipDefaultBehaviorDefault(configuration value)
Skip Default PreferenceField (UI display)
Enabled True SkipEnabled False NormalDisabled Setting Ignored Normal (Read-only)Force Enabled Setting Ignored Skip (Read-only)
3 dtSearch default alphabet file textSome of the characters in the alphabet file are not printable, so screenshots were used instead of the actual text.[Letters] // Original letter, lower case, upper case, unaccented
0 0 0 0
1 1 1 1
2 2 2 2
3 3 3 3
4 4 4 4
5 5 5 5
6 6 6 6
7 7 7 7
8 8 8 8
9 9 9 9
A a A A
B b B B
C c C C
D d D D
E e E E
F f F F
G g G G
H h H H
Relativity | Configuration Table Guide - 43
I i I I
J j J J
K k K K
L l L L
Mm MM
N n N N
O o O O
P p P P
Q q Q Q
R r R R
S s S S
T t T T
U u U U
V v V V
W w WW
X x X X
Y y Y Y
Z z Z Z
_ _ _ _
a a A a
b b B b
c c C c
d d D d
e e E e
f f F f
g g G g
hh H h
i i I i
Relativity | Configuration Table Guide - 44
j j J j
k k K k
l l L l
m m Mm
n n N n
o o O o
p p P p
q q Q q
r r R r
s s S s
t t T t
u u U u
v v V v
w w W w
x x X x
y y Y y
z z Z z
[Hyphens]
-
[Spaces]
Ignore
[End]
CJKRanges = 2e80-ac00 ac00-d7af f900-faff fe30-fe4f
Relativity | Configuration Table Guide - 45
Proprietary RightsThis documentation (“Documentation”) and the software to which it relates (“Software”) belongs to kCuraCorporation and/or kCura’s third party software vendors. kCura grants written license agreements whichcontain restrictions. All parties accessing the Documentation or Softwaremust: respect proprietary rights ofkCura and third parties; comply with your organization’s license agreement, including but not limited tolicense restrictions on use, copying, modifications, reverse engineering, and derivative products; and refrainfrom any misuse or misappropriation of this Documentation or Software in whole or in part. The Software andDocumentation is protected by the Copyright Act of 1976, as amended, and the Software code is protectedby the Illinois Trade Secrets Act. Violations can involve substantial civil liabilities, exemplary damages, andcriminal penalties, including fines and possible imprisonment.©2013. kCura Corporation. All rights reserved. Relativity® and kCura® are registered trademarks of kCuraCorporation.