Вы находитесь на странице: 1из 101
Configuration Table Guide February 4, 2019 - Version 9.2

Configuration Table Guide

February 4, 2019 - Version 9.2

-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

For the most recent version of this document, visit our documentation website.

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

100

1 Configuration table overview

This guide provides a description of each entry in the configuration table, along with each entry’s default value.

1.1 Accessing the configuration table

To access the configuration table, perform the following steps:

1. Access the primary server environment containing all databases, including EDDS.Configuration.

2. Connect to the Microsoft SQL Server Management Studio.

3. In the Object Explorer tree, expand Databases > EDDS > Tables.

tree, expand Databases > EDDS > Tables . 4. Right-click the eddsdbo.Configuration table, and

4. Right-click the eddsdbo.Configuration table, and select the option Select Top 1000 Rows.

table, and select the option Select Top 1000 Rows . The eddsdbo.Configuration table opens. It displays

The eddsdbo.Configuration table opens. It displays the Section, Name, Value, MachineName, and

Description for all the entries in the table.

Note: If the MachineName field is empty, this is the default value for all machines in the Relativity instance. Otherwise, this value for the setting only applies to the specified machine, overwriting the default value.

5. Locate the configuration value you want to change and update the Value column. Note that doing so could have a significant effect on the performance and functionality of your Relativity environment.

and functionality of your Relativity environment. Note: Relativity provides several instance settings that

Note: Relativity provides several instance settings that enable you to customize email notifications, for example, user invitation and password reset emails. These instance settings include system variables enclosed in braces, such as {EMAIL}, {LINKTEXT}, {LOGINLINK}, {LOGINTEXT}, {PASSWORD}, and {URL}. The values of these variables are generated by Relativity and cannot be changed. For more information, contact kCura Client Services.

Refer to Configuration table values on page 5 for a complete list of Relativity configuration values.

2 Configuration table values

This table provides an alphabetical list of all the configuration values related to Relativity.

Note: A number of the configuration table entries listed below should never be modified in your environment, despite the fact that they appear in the EDDS.Configuration table in the database. For these entries, we've included a "Do not modify" statement at the beginning of the description.

Name

Section

Value

Description

AboutBoxPortalLink

kCura.EDDS.Web

https://na3.salesforce.com/

The location to which the Relativity Icon Box redir- ects.

secur/login_portal.jsp?

orgId=00D5000000072uY

&portalId=060500000004fqC

 

AboutBoxSupportLink

Relativ-

http://relativity.com/relativity/

The location to which the Support link redirects.

ity.Authentication

support/technical-support

AccessTokenExtraLifeTime

Relativ-

240

The number of additional minutes that the authen- tication token remains valid after the authentication cookie has expired. Since this token has a longer life- time than a session cookie, you can use it to access Relativity APIs, which may execute long running pro- cesses requiring tokens. This configuration value supports a maximum set- ting of 600 minutes (or 10 hours), and a minimum set- ting of 0 minutes. You must reset the IIS for these changes to take effect.

ity.Authentication

Account

kCur-

UNSETACCOUNT

This value populates the Account column in the

a.LicenseManager

Name Section Value Description Case Statistics Rollup report. AdvancedImagingTimeout Relativity.Core 600 The
Name
Section
Value
Description
Case Statistics Rollup
report.
AdvancedImagingTimeout
Relativity.Core
600
The amount of time, in
seconds, that an advanced
imaging process can act-
ively run until it times out
(does not include waiting
time).
AdvancedSearchDefault
kCura.EDDS.Web
False
Determines the default set-
ting for Advanced Search
Default when creating new
users. “False” is private,
and “true” is public.

Name

Section

Value

Description

AgentOffHourEndTime

kCura.EDDS.Agents

5:00:00

Used in conjunction with the AgentOffHourStartTime value to specify a valid time range when off hour agents should run. Currently, this only applies to the File Dele- tion manager, Case Stat- istics Manager, Case Manager, and Cache Man- ager. The File Deletion manager immediately stops deleting documents once the time of day passes the AgentOffHourEndTime. The Case Statistics man- ager and Case Manager continue to process until completion.

To enter a setting, use 24- hour time notation with the format of hh:mm:ss.

Note that if the start time is before midnight, then you must also set the end time before midnight. For example, a start time of 23:00:00 might have an end time of 23:59:00. If the start time is midnight or later, then you can set the end time to any value after

Name

Section

Value

Description

     

the start time. For example, a start time of midnight that is between 00:00:00 and 03:00:00 can have any end time.

AgentOffHourStartTime

kCura.EDDS.Agents

00:00:00

Used in conjunction with the AgentOffHourEndTime value to specify a valid time range when off hour agents should run. Currently, this applies only to the File Dele- tion manager, Case Stat- istics Manager, Case Manager, and Cache Man- ager.

To enter a setting, use 24- hour time notation with the format of hh:mm:ss. See the description for the AgentOffHourEndTime configuration value.

AllowChangesToOver-

kCura.EDDS.Web

False

Determines if the Overwrite Protection drop-down menu is editable when edit- ing or creating a layout. If set to true, the user can set this property to Disabled and then save a document even if another process has modified the document since loading.

writeProtection

AllowHtmlVisible

Relativity.Core

False

This controls the access-

Name

Section

Value

Description

     

ibility of the Allow HTML property on Field objects. When this configuration value is set to False, the Allow HTML property is hid- den from the New Field page and its value is defaul- ted to No, and the Edit Field page will display the prop- erty only if the field being edited already has the prop- erty's value set to Yes. When this configuration value is set to True, there is unrestricted access to the Allow HTML field property.

AllowNativeRedactions

kCura.EDDS.Web True

Determines whether users can perform redactions within the Native Viewer.

AnalyticsCategorizationBatchSize

Relativity.Core

100000

The size of the batch of doc- uments submitted to the Analytics engine to be cat- egorized.

Ana-

Relativity.Core

1000

The size of the batch of Cat- egoryResult objects cre- ated within Relativity once the Analytics engine has categorized them.

lyt-

icsCat-

egorizationCreationBatchSize

Ana-

kCur-

30000

Time in milliseconds that determines how long the query should wait to retry when deadlock occurs dur- ing run of categorization set.

lyticsCategorizationDeadlockWait

a.Data.RowDataGat-

eway

Name Section Value Description Ana- Relativity.Core 1000 lyt- icsCat- egorizationDeletionBatchSize The size of
Name
Section
Value
Description
Ana-
Relativity.Core
1000
lyt-
icsCat-
egorizationDeletionBatchSize
The size of the batch of Cat-
egoryResult objects
deleted within Relativity
when the user chooses to
run a full categorization
against a set that has been
previously categorized.
AncestorCountWarningLevel
kCura.EDDS.Web
50000
A warning is displayed in
the Security page when the
item's security being
changed has more than this
number of ancestors. The
warning displays because
the database will be locked
for a substantial period of
time.

Name

Section

Value

Description

APIAl-

Relativity.Core

True

Controls whether users can log in using forms authen- tication when configured to use two-factor authen- tication. If set to True, users can log in to Relativity APIs using forms authentication even when the users are configured for an authen- tication model that the API does not support, for example: RSA, or Send Code two-factor authen- tication. If set to False, users configured to use two-factor authentication are prohibited from logging

waysAllowFormsAuthentication

in

to any of the Relativity

APIs, RDC, and Import API using forms authentication.

APITimeout

kCura.Relativity

30

Sets the Relativity API token expiration in minutes.

ApplicationRestrictedFileTypes

Relativity.Core

.exe;.com;.pif;.bat;.scr

A

semicolon(;) delimited list

of

file extensions (including

dots) indicating file types that users should be pro- hibited from uploading as custom pages or resource files. Examples include .exe, .com, and .bat. Also,

see RestrictedFileTypes.

AuditApplicationUninstallEnabled

Relativity.Core

True

Determines whether Relativity writes an entry to the audit log for each com-

Name

Section

Value

Description

     

ponent edited or deleted when you uninstall an application. By default, auditing is enabled.

AuditBatchSize

kCura.Audit

1000

This is the batch size that the agent uses when read- ing from SQL and writing to Data Grid.

AuditCountQueries

Relativity.Core

False

For each list that is gen- erated, the system initially runs a "count" query to get the total number of records that fulfill the criteria. Set- ting this value to True writes the SQL query to the History record.

AuditDataGridEndPoint

kCura.Audit

blank

This is the end point for Data Grid. For example:

http://client-node-com-

puter-name:9200

AuditingEnabled

kCura.Audit

True

Determines if auditing is enabled throughout Relativ- ity.

AuditFullQueries

Relativity.Core

False

For each list page that is generated, the system ini- tially runs a query to get the data to fill the rows on the current page. Setting this value to TRUE would write the SQL query to the His- tory record.

AuditIdQueries

Relativity.Core

True

The system will get a batch of Artifact IDs that fulfill the

Name

Section

Value

Description

     

criteria and are needed to populate the current page in the list. Setting this value to TRUE would write the SQL query to the History record.

AuditPayloadByteThreshold

kCura.Audit

1048576

This is the maximum pay- load size for the Data Grid data store.

AuditPivotColum-

Relativity.Core

True

For each Pivot list and chart, a query is run to get the unique columns needed to display the data. Setting this value to True writes the SQL query to the History record.

nRetrievalQueries

AuditPivotFullQueries

Relativity.Core

True

For each Pivot list and chart, a query runs to get the data for the rows and columns. Setting this value to True writes the SQL query to the History record.

AuditQueueMaxDocumentErrors

kCura.Audit

100

The maximum number of errors allowed for a single batch in the Audit Migration Agent before the job is ter- minated.

AuthenticationEmailFrom

kCura.Notification

authentication@relativity.com

This email address appears in the From field of email messages that contain authentication information for users.

AuthenticationTag

Relativity.Telemetry

Internal use only

Do not modify. The authen-

Name Section Value Description tication tag used for Relativ- ity ODA LLC data trans- mission.
Name
Section
Value
Description
tication tag used for Relativ-
ity ODA LLC data trans-
mission. This configuration
value is available only when
you install telemetry in your
environment.
Authentic-
Relativity.Core
5
ationTokenLifetimeInMinutes
When an application other
than Relativity is authen-
ticated using Relativity’s
internal mechanism, a
token is received. This
token is valid for this period
of time.
AutoCreateRate
kCura.EDDS.Web
60
How often the system
attempts to create batches,
in minutes.

Name

Section

Value

Description

AutoE-

kCura.Billing

True

If

True, the Case Statistics

mailWithCaseStatisticsManager

Manager agent generates

a

text file with client billing

information which is sent to Relativity ODA LLC auto- matically through the SMTP server. Each time the agent runs, the new text file is sent to Relativity ODA LLC through the SMTP server. If false, the Case Statistics Manager agent generates a zip file with cli- ent billing information, which is stored in the loc- ation specified in the EDDSFileShare value. Each time the agent runs, a new date-stamped file is created and stored in this folder. Zip files stored in this location can be manually sent to kCura.

AutoGenPasswordLength

kCura.EDDS.Web

8

The number of characters that an auto-generated password contains.

BackupDirectory

kCura.EDDS.SqlSer

During Relativity installation

The path to the backup dir- ectory used by SQL Server. This value should be rel- ative to the server where SQL Server is installed.

ver

BaseApplicationPath

kCura.EDDS.Procur

During Relativity installation

The root path where the Procuro looks for required Relativity applications.

o

Name

Section

Value

Description

BaseRelativityScriptPath

kCur-

During Relativity installation

The root path where the Procuro looks for its SQL scripts.

a.EDDS.Procuro

BasicImagingTimeout

Relativity.Core

300

The amount of time, in seconds, that the basic ima- ging process waits for a single document to be imaged before killing the export process and moving to the next document.

BcpShareFolderName

kCura.Chicago

BCPPath

The name of the share used for Bulk Inserts and the Case Statistics Man- ager.

BCryptWorkFactor

Relativity.Core

11

This is a bCrypt work factor constant that controls the strength of the encryption used for password hashing. Any value lower than 10 defaults to 10. Incre- menting by 1 doubles the time it takes to hash the password.

BrandingManagerBatchAmount kCura.EDDS.Agents 100

 

The number of files the Branding Manager brands in a single batch.

Brand-

Relativity.Core

1000

The maximum number of records inserted into the BrandingQueue table in a single batch. This is used by both the Production Man- ager and when attempting to resolve errors in the web.

ingRecordCreationBatchSize

Name Section Value Description Buffer- kCura.EDDS.Web.D 5000 AcquisitionTimeoutInMilliseconds istributed The
Name
Section
Value
Description
Buffer-
kCura.EDDS.Web.D
5000
AcquisitionTimeoutInMilliseconds
istributed
The amount of time the Dis-
tributed site waits to
acquire a free buffer to use
for downloading before
throwing an error.
BufferCount
kCura.EDDS.Web.D
1000
istributed
The number of buffers that
the Distributed site alloc-
ates to servicing download
requests.
BufferSize
kCura.EDDS.Web.D
81920
istributed
The maximum size, in
bytes, of the buffer used by
Distributed. Increasing this
may improve file download
performance but increases
the risk of running the Dis-
tributed server out of
memory.
BulkLoadFileFieldDelimiter
Relativity.Data
þþKþþ
The value used to separate
fields when loading bulk
files into the SQL database.
Line delimiters are this
value plus a new line.

Name

Section

Value

Description

CacheLocationLowerThreshold

Relativity.Core

30

Specifies the lower limit of the cache size as a per- centage of the total space available on the drive where the cache is stored. After the Cache Manager agent runs, the size of the cache table is below its lower limit.

Note: If you leave this

value blank, then Relativity uses the default value of

30.

CacheLocationUpperThreshold

Relativity.Core

70

Specifies the upper limit of the cache size as a per- centage of the total space available on the drive where the cache is stored. The cache table must equal or exceed this upper limit before the Cache Manager clears entries from it.

Note: If you leave this

value blank, then Relativity uses the default value of

70.

CacheManagerFileDeletionRetry Relativity.Core

3

The number of attempts made by the Cache Man- ager to delete a specific file.

CacheManagerFileDeletionWait

Relativity.Core

1000

The number of milliseconds that the Cache Manager should wait before retrying

Name

Section

Value

Description

     

to delete a file.

CancelRequestEnabled

Relativity.Core

True

This determines whether the option to cancel requests is available to Relativity users. When it is set to True, users can see an overlay window with the option to cancel the request and a message indicating that items are loading. When set to False, this func- tionality is not available.

CancelRequestIni-

Relativity.Core

100 msec

This configuration setting indicates the initial time interval (in milliseconds) used for polling the cache on the web server during the first second of a cancel query request. After the first second, the time inter- val increases to 450 msec.

tialPollingInterval

CancelRequestTimeDelay

Relativity.Core

3 seconds

This value controls the time delay (in seconds) between the initiation of a search request and the display of an overlay window with the option to cancel the request.

CasesForGroupsViewID

kCura.EDDS.Web

900

The ArtifactID of the view used to display the work- spaces at the bottom of a group page.

Name

Section

Value

Description

CaseStatisticsBasedLockout

kCura.LicenseManag blank er

Used to determine if the Case Statistics-based lock- out is active.

CaseS-

kCura.LicenseManag

True

Expects either True or False. If True, the email and original email address fields in the Case Statistics and User Rollup reports are populated. If False, those fields are retrieved as empty.

tatisticsNotificationIncludeEmails

er

CaseStatisticsNotificationList

kCura.LicenseManag

empty

Distribution list for Case

er

Statistics reports. It expects

a

semicolon-delimited list of

emails to send the report to.

If

empty, emails aren't sent.

ChoiceLimitForUI

Relativity.Core

200

For choices and single objects, the maximum num- ber that can appear in a checkbox, drop-down menu, or radio button list before switching to a pop- up picker; we recommend setting this value to 15. If it's not set, lists automatically render as pop-up pickers.

ChunkEnabledQueryChunkSize

Relativity.Data

10000

Allows the Desktop Client to pull down a potentially large set of artifacts (choices and folders, spe- cifically).

ClientBatchSize

Relativity.Telemetry

500

The size of batches used for flushing non-aggreg- ated metrics in the client-

Name

Section

Value

Description

     

side queues. This con- figuration value is available only when you install tele- metry in your environment.

ClientConfigUpdateInterval

Relativity.Telemetry

15

The interval in seconds between updates to the configuration of the client- side metrics queues. This configuration value is avail- able only when you install telemetry in your envir- onment.

ClientFlushTimeout

Relativity.Telemetry

5

The number of seconds between each flush of the client-side queue. When the queue is flushed, the service bulk posts any con- tent that it contained to the Kepler endpoint. This con- figuration value is available only when you install tele- metry in your environment.

CompareWebAPIPath

kCura.EDDS.Web During Relativity installation

The defined Compare Web API path.

ConcurrentLogin

kCura.LicenseManag

per system

The setting for requiring the Concurrent User Login restriction. This value must be changed by a tool that the dev teams owns; defaults to disallowed.

er

Name

Section

Value

Description

Con-

Relativity.Core

0.95

The default minimum coher- ence score to use when submitting a similar doc- uments job to Content Ana- lyst.

tentAnalystDefaultMinCoherence

Con-

Relativity.Core

2

This value indicates the number of processors that a single Analytics index uses for a build. Increasing the number of processors to a value greater than 2 may slow the performance of the Analytics server. You must adjust any setting modifications to the require- ments of your environment.

tentAna-

lystDefaultNumberOfProcessors

Con-

Relativity.Core

524288000

This was deprecated in Relativity 8.1. Changing this value has no effect on the environment.

tentAnalystFileMaxByteThreshold

Con-

Relativity.Core

1000

This is the number of doc- uments sent to the Ana- lytics server by each JDBC connector at once during index population. This value should not be lowered from 1000, as this would slow down pop- ulations environment-wide.

tentAnalystMaximumBatchSize

Con-

Relativity.Core

4

The default maximum num- ber of connections allowed between the Analytics server and SQL for each index that uses this server.

tentAna-

lys-

tMaxConnectorsPerIndexDefault

Name

Section

Value

Description

Con-

Relativity.Core

50

The default maximum num- ber of connections allowed between the Analytics server and SQL across all indexes using this server.

tentAna-

lystMaxTotalConnectorsDefault

Con-

Relativity.Core

False

Determines whether Identify Similar Documents functionality is available for Analytics indexes created after Relativity 8.0.

tentAna-

lys-

tShowIdentifySimilarDocuments

Con-

Relativity.Core

False

Determines whether Integ- rated dtSearch functionality is available for Analytics indexes created after Relativity 8.0.

tentAna-

lystShowIntegratedDtSearch

Con-

Relativity.Core

0

This is the default similar documents job type to sub- mit to Content Analyst (comprehensive).

tentAnalystSimilarDocsJobType

Con-

Relativity.Core

31457280

This was deprecated in Relativity 8.1. Changing this value has no effect on the environment.

tentAna-

lys-

tSingleRecordMaxByteThreshold

Content Ana- lystSmartTrain®OnByDefault

Relativity.Core

True

Determines whether Ana- lytics indexes are enabled by default to use the Optim- ize training set functionality, which automatically excludes conceptually-irrel- evant documents from an index’s training set.

Con-

Relativity.Core

blank

This was deprecated in Relativity 8.1. Changing this value has no effect on

tentAnalystTemporaryDirectory

Name

Section

Value

Description

     

the environment.

ContentAnalystTemporaryDirecto

Relativ-

blank

This was deprecated in Relativity 8.1.202.3. Changing this value has no effect on the environment.

ry

ity.Struc-

turedAnalytics

ContentAnalystUpdateBatchSize

Relativity.Core

50000

The batch size to update the non-similar documents in the documents table.

Con-

Relativity.Core

31457280

This was deprecated in Relativity 8.1. Changing this value has no effect on the environment.

tentAna-

lys-

tWebServicesMaxByteThreshold

Con-

Relativity.Core

300000

The timeout value, in mil- liseconds, when connecting to Analytics Web Services.

tentAnalystWebServicesTimeout

CookieHttpOnly

Relativ-

True

Prevents access to cookies by JavaScript and other cli- ent-side elements when set to True. This flag is designed to attach to sens- itive cookies such as the session cookie ASP.NET_ SessionId.

ity.Authentication

CookieSecure

Relativ-

True

Forces a web browser to send session information over HTTPS only when set to True. This flag is designed to attach to sens- itive cookies such as the session cookie ASP.NET_ SessionId. When set to True, users cannot log into Relativity over HTTP.

ity.Authentication

Name

Section

Value

Description

ConversionBatchSize

Relativity.Conversion

1,000

The maximum number of documents to submit for conversion at a time when running an imaging set.

Con-

Relativity.Conversion

30

The amount of time, in minutes, before Relativity abandons a conversion request sent to Invariant and then sends a can- cellation request.

versionOverallRequestTimeout

ConversionRequestTimeout

Relativity.Conversion

1

The amount of time, in minutes, before Relativity checks to see if Invariant has started working on a conversion job that Relativ- ity sent to it.

CookieDuration

Relativ-

600

The number of minutes that the authentication cookie is valid. This value controls the length of time that the users are logged in to Relativity before the system automatically logs them off and requires them to re- authenticate. This con- figuration value supports a maximum setting of 1440 minutes (or 24 hours), and a minimum setting of 240 (or 4 hours). You must reset the IIS for these changes to take effect.

ity.Authentication

Name

Section

Value

Description

CopyFilesToRepository

kCura.EDDS.Winfor

True

The default value that appears in all import and export forms within the Relativity Desktop Client for the “copy files to repos- itory” value.

m

CreateCaseTimeoutValue

Relativity.Data

1800

The timeout value, in seconds, associated with running queries related to case creation.

CreateZSRTablesForSTRs

Relativity.Core

True

Controls whether ZSR tables are created by search terms reports. If True, search terms reports create ZSR tables, caching the results for future use. This improves per- formance, but may make rebuilding and deleting indexes take longer. If False, building search terms reports may take longer. Fewer tables are left in the database, poten- tially resulting in faster dtSearch index builds.

Cus-

kCura.EDDS.Agents

False

This value controls whether the Application Manager agent behaves as an off hour agent. If set to True, applications containing cus- tom components only deploy between the hours

tomPageManagerIsOffHourAgent

Name Section Value Description set in the AgentOffHourStartTime and AgentOffHourEndTime val- ues. If an
Name
Section
Value
Description
set in the
AgentOffHourStartTime
and
AgentOffHourEndTime val-
ues. If an application
deploys when the
AgentOffHourEndTime
passes, the current deploy-
ment completes and no
new deployments occur
until the next
AgentOffHourStartTime.If
set to False, the Application
Manager agent runs nor-
mally, and applications con-
taining custom pages are
identified and deployed in
the typical process.

Name

Section

Value

Description

DatabaseQuery

kCur-

SELECT CAST(1 AS BIT) AS [ ], ' N/A' as ArtifactID, 'EDDS' as [Name], @@SERVERNAME as [Location], 'N/A' as [CaseStatus], '' as [UpgradeStatus] UNION SELECT CAST(1 AS BIT) AS [ ], CAST([Case].[ArtifactID] AS VARCHAR(20)), [Case].[Name], [ResourceServer].[Name] as [Location], [Code].Name as Status, '' as [UpgradeStatus] FROM [Case] INNER JOIN [Code] ON [Code]. ArtifactID = [Case].StatusCodeArtifactID INNER JOIN [Artifact] ON [Artifact].[ArtifactID] = [Case]. [ArtifactID] AND [Artifact].[DeleteFlag] = 0 INNER JOIN [ResourceServer] ON [Case].[ServerID] = [ResourceServer].[ArtifactID]

 

a.EDDS.Procuro

The query used by Procuro to determine the list of data- bases available for upgrad- ing.

DataCenter

kCura.Billing

Blank string ("")

Geographical location of the facility where a Relativ- ity instance is housed. The Case Statistics Manager agent includes this location in the RelativityVersion.txt metadata file that it gen- erates.

DataDirectory

kCur-

During Relativity installation

The path to the data dir- ectory used by SQL Server. This value should be rel- ative to the server where SQL Server is installed.

a.EDDS.SqlServer

DataFocusModeDefault

kCura.EDDS.Web

Off

Default Interface Mode for users. Types:

Name

Section

Value

Description

     

n

Data Focus On

n

Data Focus Off

DataGridEndPoint

Relativity.DataGrid

 

This value defines the end point for Data Grid con- nection. Relativity requires this value toactivate Data Grid operation for this Relativity instance (http://cli-

ent:9200).

DataGridBufferCount

Relativity.DataGrid

10

Do not modify. This is the number of Data Grid buf- fers that the Distributed site will allocate to servicing download requests.

DataGridBufferSize

Relativity.DataGrid

104857600

Do not modify. This is the size, in bytes, of each Data Grid buffer allocated by the Distributed site to service download requests. The default value is 104857600

(100MB).

DataGridHttpClientTimeout

kCura.Audit

100

This is the default value for the Http Client timeout for DataGridHttpClient spe- cified in seconds.

DataGridHttpClientTimeout

Relativity.DataGrid

100

This is the default value for the Http Client timeout for DataGridHttpClient spe- cified in seconds.

DataGridIndexCreationSettings

Relativity.DataGrid

{

These settings define a tem- plate to create new indexes for Data Grid.

"template": "text_*", "mappings": {

Name

Section

Value

Description

   

"text": { "_id": {

 

"path": "artifactID"

}

},

"childtext": {

"_parent": {

"type": "text"

}

}

}

}'

DataGridIndexPrefix

Relativity.DataGrid

relativity

Use this value to construct index names for Data Grid to distinguish multiple Relativity instances that write to the same Data Grid cluster.

DataGridMemoryByteS-

Relativity.DataGrid

104857600

The maximum byte size that the Data Grid Migrator agent attempts to load a batch's documents in memory. This allows the cli- ent to account for an agent server's memory capacity. When set to 0 or less, the agent attempts to load the entire batch to memory regardless of batch size.

izeThreshold

DataGridMigratorBatchSize

Relativ-

1000

This is the batch size in MB that the agent uses when reading from SQL and writ- ing to the Data Grid.

ity.DataGridMi-

grator.Agent

DataGridMi-

Relativ-

100

The maximum number of errors allowed for a single

gratorQueueMaxDocumentErrors

ity.DataGridMi-

Name

Section

Value

Description

 

grator.Agent

 

batch in the Data Grid Migration Agent before the job is terminated. If this limit is reached, the respective agent an exception error occurs stating that the fail- ure limit has been reached.

DataGridMultiIn-

Relativity.DataGrid

30GB (32212254720 bytes)

This configuration value represents the maximum size (in bytes) of each shard in the DataGrid index before Relativity creates a new index. Writing to an index that is over the threshold causes Relativity to create a new index. Set this to 0 to disable the threshold behavior.

dexSplitSizeThreshold

DataGridMultiIn-

kCura.Audit

30GB (32212254720 bytes)

This configuration value represents the maximum size (in bytes) of each shard in the DataGrid index before Relativity creates a new index. Writing to an index that is over the threshold causes Relativity to create a new index. Set this to 0 to disable the threshold behavior.

dexSplitSizeThreshold

DataGridNumberOfRetries

Realtivity.DataGrid

3

Number of attempts made by the Data Grid to perform an operation before it returns a failure.

DataGridPay-

Relativity.DataGrid

1048576

This value determines the

Name

Section

Value

Description

loadByteSizeThreshold

   

internal write batch size for DataGrid (1MB by default).

DataGridRESTServicePort

Relativity.DataGrid

9400

This value defines the port number that is used to con- nect JAVA CA connector to DataGrid REST service.

DataGridRetryWaitTime

Relativity.DataGrid

50

The time in milliseconds that Data Grid waits between operation retries.

DataGridVerification

Relativity.DataGrid true

This value enables post import data verification.

DataGridVerificationTimeout

Relativity.DataGrid

30

This value sets the time span upon which post import data verification occurs.

DefaultCaseDown-

kCura.EDDS.Web

During Relativity installation

The value that populates in

loadHandlerApplicationPath

the “Download Handler URL” field by default for new cases.

If you enter a full URL for this value, the protocol must match what is used in the browser. If Relativity is set up to use either HTTP or HTTPS, but not both, you can enter a full URL. If Relativity 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 new choices. Valid values are defined on the OIHiliteStyle

Name Section Value Description table (look within a work- space database, not the EDDS database).
Name
Section
Value
Description
table (look within a work-
space database, not the
EDDS database).
DefaultNativeImagingEngineURL
Relativity.Core
Determined during native
imaging installation; manually
entered in configuration table
after native imaging installation
is completed
The base URL to the web
services provided by the
worker manager server
(Deprecated in 7.5).
DefaultQueryTimeout
kCur-
30 (seconds)
a.AssistedReview
The timeout value, in
seconds, used by default
for all AssistedReview quer-
ies.
DefaultTextRedactionTextSize
kCura.EDDS.Web
-1
When a user draws a text
redaction for the first time
that browser session, this is
the font size. -1 is auto
mode.
DeveloperMachine
kCura.EDDS.Web
False
Determines whether the
environment should be
treated as a developer
machine. This should
always be set to False for
production environments

Name

Section

Value

Description

DeveloperMode

Relativity.Core

False

Enables or disables developer mode options within an instance of Relativity. These options include disabling the cross- site request forgery (CSRF) header require- ment in the API and return- ing detailed error messages such as stack traces. Enable this setting only in a development envir- onment.

DisabledUserMessage

kCura.EDDS.Web

Your Relativity Administrator

The contact specified within the message displays when

a

user does not have

access to Relativity.

DisplayDisclaimer

Relativ-

False

Determines whether the disclaimer should appear when users log into Relativ- ity.

ity.Authentication

DisplayHelpLink

Relativity.Core

True

Determines whether the Help link appears for all non-systemadministrators. Setting this value to False removes the Help link from the UI.

DisplayLogoInTitleBar

kCura.EDDS.Web False

When set to True, the com- pany logo appears in the top action bar.

DistinctBuilderMaxValue

Relativity.Data

255

The maximum number of values allowed in a choice field before it changes from

a

picker in the item list to dis-

Name

Section

Value

Description

     

abled.

Docu-

kCura.EDDS.Web

True

Determines the default value displayed in the Skip Default Preference field on the Add User form. The UI displays Skip when this con- figuration option equals True, and it displays Normal when it equals False. When Docu- mentSkipEnabledDefault is set to Disabled or Force Enabled, this configuration option is ignored.

mentSkipDefaultBehaviorDefault

DocumentSkipEnabledDefault

kCura.EDDS.Web

Enabled

Determines the default

value displayed in the Docu- ment Skip field on the Add User form. Acceptable val- ues are Enabled, Disabled, and Force Enabled. When this option is Enabled, the value for Docu-

mentSkipDe-

faultBehaviorDefault controls the default option displayed in the Skip Default Preference field. When this option is set to Disabled, or Force Enabled, the Skip Default Preference field displays the read-only value of Normal or Skip respectively

See Configuration values

Name

Section

Value

Description

     

and UI display for Docu- ment Skip on page 100.

DocumentSkipLookAheadLength

kCura.EDDS.Web

1000

The progressive number of documents (starting with the current + 1) that the sys- tem evaluates against the current view/saved search criteria when Document Skipping is enabled. Sys- tem default is 1000 doc- uments, set to -1 for all documents.

Docu-

kCura.EDDS.Web

Document Skip is enabled. The remaining documents in your queue no longer meet the conditions of your view or search. If you are done with these records, click \"Return to document list\". If you would like to see the remaining records, change your view from \"Skip\" to \"Normal\".

Notification to user when Document Skip is enabled, and no more documents fit the saved search/view cri- teria.

mentSkipNoMoreDocu-

mentsMessage

DocumentSkipToolTip

kCura.EDDS.Web

This checkbox will enable you to bypass documents which already meet the criteria of this saved search/view.

Document skip tooltip mes- sage displayed in the doc- ument profile.

DocumentTimeout

kCura.EDDS.Web

120000

This is the amount of time (in seconds) until the Viewer will timeout when attempting to retrieve a doc- ument.

Name

Section

Value

Description

DomainPars-

Relativity.Data

1048576

The Domain Parsing tool doesn't parse records with a value that exceeds this length (in Bytes).

ingSingleRe-

cordMaxByteThreshold

dtSearchDataGridBufferSize

Relativity.Data

16777216

The size of the cache used to bulk read non-stream- able documents from Data Grid to dtSearch. (in Bytes).

dtSearchDefaultAlphabetFileText

Relativity.Core

Listed in dtSearch default alphabet file text in the Searching guide.

The default value of the text for the Alphabet file when creating a new dtSearch index.

dtSearchDe-

Relativity.Core

9

This value is used as the default value for the Sub- index fragmentation threshold field on the dtSearch Index Information screen. The value must be an integer greater than or equal to 1. When the frag- mentation level for a sub- index equals or exceeds the threshold level, the sys- tem automatically com- presses the sub-index during an incremental build.

faultSubIn-

dexFragmentationThreshold

Name

Section

Value

Description

dtSearchDefaultSubIndexSize

Relativity.Core

250000

This is used by the dtSearch Index Manager to determine how many sub- indexes will make up the entire index. This value is the maximum number of documents to build into each sub-index and appears by default in the Sub-index size field when creating a dtSearch.

dtSearchEnableMetricsLogging

Relativity.Data

0

A

bit value to determine if

dtSearch Metrics gathering should be enabled, for Per- formance testing or Troubleshooting.

dtSearchPopulationLogFilePath

Relativity.Core

blank

Set this to point to a file on disk when diagnosing dtSearch problems relating

to

populating indexes. This

will cause dtSearch to write debugging information to

disk. This file itself doesn’t need to exist, but the path

to

it does. Make sure that

this value is set back to nothing when the log file is no longer needed because it can grow in size very quickly.

dtSearchQueryLogFilePath

Relativity.Core

blank

Set this to point to a file on disk when diagnosing dtSearch problems relating

Name

Section

Value

Description

     

to performing searches. This will cause dtSearch to write debugging inform- ation to disk. This file itself doesn’t need to exist, but the path to it does. Make sure that this value is set back to nothing when the log file is no longer needed because it can grow in size very quickly.

dtSearchStreamBufferSize

Relativity.Data

1048576 (1 MB)

Controls the size, in bytes, of the buffer used within the dtSearchStream object.

This buffer is allocated into memory as soon as the agent starts. Relativity checks to see if the value has changed between jobs and reallocates the buffer if

a

change is detected.

dtSearchStreamThresholdInBytes

Relativity.Data

1048576

This is used by the dtSearch Index Manager

when populating an index.

If

the size of all the text

associated with a doc- ument is larger than this value, the text is streamed directly into dtSearch. Otherwise, the text is con-

verted to bytes and the bytes are sent to dtSearch.

Name

Section

Value

Description

dtSearchWork-

Relativity.Data

1000

Controls the number of doc- uments a worker agent sends to the dtSearch engine before reporting pro- gress back to the database. Changing this value may have an impact on per- formance.

erProgressThreshold

EDDSFileShare

Relativity.Data

During Relativity installation

The location used for the master-level file share. If you change the location, make sure that the new dir- ectory is shared.

EmailFrom

kCura.Notification

blank

The email address pop- ulated in the “from” field when sending email noti- fications. The email address must be valid. Email aliases can be entered in this format: Alias

Name user- name@example.com

EmailLinkURLOverride

kCura.EDDS.Web

https://relativity.relativity.com

You need to set this item only when the URL used to access Relativity by end users is not the actual URL of the Relativity web server. This can happen under cer- tain conditions:

n

Your Relativity IIS server is part of a server farm and/or behind a load bal-

Name

Section

Value

Description

       

ancer. In this case, the URL used to access Relativity is the URL of the load balancer or the farm, not the URL of a spe- cific server.

n

You have a security certificate installed on a load balancer or firewall, and the device is doing URL rewriting when passing requests on to the Relativity server. In this case, you use HTTPS to access Relativity, but the actual Relativity server doesn't use HTTPS.

EmailTo

kCura.Notification

blank

The email address pop- ulated in the “to” field when sending email notifications. The email address must be valid. Separate multiple email addresses with a semicolon.

EnableNativeRedactions

kCura.EDDS.Web

True

To enable native high- lighting, redactions, links, and tagging, this must be manually added and set to True. This allows for redac-

Name

Section

Value

Description

     

tions and highlighting on transcripts from Relativity 6.10 and prior.

EnableTransactionalImports

Relativity.Core

True

You can set this value to False to turn off the SQL transactions that occur on import. This could speed up performance in the data- base. However, it's dan- gerous because it can cause invalid records in the database.

EncryptedSMTPPassword

kCura.Notification

blank

The password for the user- name associated with the credentials of the SMTP server. This password val- idates against the SMTP authentication.

EnvironmentData

kCura.LicenseManag xxxx er

Encrypted data about your environment. Changing this will shut down Relativity.

EnvironmentName

kCura.Notification

DefaultRelativityEnvironmentName

The name of the envir- onment. This value is used when sending notifications. You should update the default value to a setting appropriate for use in your environment.

EnvironmentPubToken

kCura.LicenseManag xxxx er

kCura’s public key. Do not change.

ESIndexCreationSettings

kCura.Audit

Click here to view default Data Grid template

These are ES settings for index creation.

Name

Section

Value

Description

{

"template": "audit_*", "aliases": { "{index}_read": {}, "{index}_write": {}

}, "settings": { "index": { "number_of_shards": 12, "number_of_replicas": 2

}, "analysis": { "analyzer": { "str_search_analyzer": { "tokenizer": "keyword", "filter": [ "lowercase", "substring"

]

}, "str_index_analyzer": { "tokenizer": "keyword", "filter": [ "lowercase", "substring"

]

}, "lwhitespace": { "tokenizer": "whitespace", "filter": [ "lowercase"

}

]

}, "filter": { "substring": { "type": "nGram", "min_gram": 1, "max_gram": 20

}

Name Section Value Description } } }, "mappings": { "audit": { "dynamic_templates": [ {
Name
Section
Value
Description
}
}
},
"mappings": {
"audit": {
"dynamic_templates": [
{
"raw": {
"path_match": "Details\\.auditEle-
ment\\ *",
"match_pattern": "regex",
"match_mapping_type" : "string",
"mapping": {
"type": "string",
"fields": {
"Raw": {
"type": "string",
"analyzer": "lwhitespace"
}
}
}
}
}
],
"_timestamp": {
"enabled": true
},
"_size": {
"enabled": true,
"store": true
},
"properties": {
"ActionName": {
"type": "string",
"index": "not_analyzed"
},
"UserName": {
"type": "string",
"index": "not_analyzed"
}
}
}
}

Name

Section

Value

Description

ESIndexPrefix

kCura.Audit

This prefix used for naming and referencing of all ES indexes.

ESPayloadSettings

kCura.Audit

 

These are ES settings attached to every payload.

ExplicitBrowserWhitelist

Relativ-

Mozilla/[0-9].[0-9] \(Windows.+; .+; Trident/[7-9].[0-

Do not modify. This is a list of regular expressions which are always allowed to access Relativity even if unsupported. Correct func- tion of browsers added to this list by users is not guar- anteed. List separated by \n

ity.Authentication

9]; rv:[0-9][0-9].[0-9]\) like Gecko\nMozilla/[0-9].[0-9] \(Windows.+; .+; Trident/[7-9].[0-9]; .+; rv:[0-9][0-9].

[0-9]\)

ExportBatchSize

Relativ-

1000

The batch size used by Structured Analytics agents when pulling document information out of Relativity and pushing it to Content Analyst staging web ser- vice. Changing this value will impact performance.

ity.Struc-

turedAnalytics

ExportSubdirectoryDigitPadding

kCur-

3

The default value that appears in the Relativity Desktop Client export form for the “volume sub- directory digit padding” value.

a.EDDS.Winform

ExportVolumeDigitPadding

kCur-

2

The default value that appears in the Relativity Desktop Client export form for the ”export volume digit padding” value.

a.EDDS.Winform

Name

Section

Value

Description

ExternalStylesheetUrls

Relativity.Conversion

blank

The external stylesheets

used to include in every con- verted document. These entries are separated by semicolons. By default this

is

empty

FavoritesEnabled

Relativity.Core

TRUE

Determines if Favorites appear in the UI.

FileDe-

Relativity.Data

1000

Determines the number of records deleted at once from associated tables when documents are deleted in mass.

leteChunkS-

izeOnDocumentDelete

FileDe-

kCura.EDDS.Agents

100

The number of documents that the File Deletion Man- ager or Cache Manager deletes in a single batch.

letionManagerBatchAmount

FileTypesToDown-

kCur-

txt;vsd;vsdx;xls;xlsx;doc;docx;

A

semicolon(;) delimited list

loadAsAttachments

a.EDDS.We-

of

file extensions (not includ-

b.Distributed

ing dots) users would like to download as attachments rather than inline from the native viewer. For example "txt;vsd;vsdx;"

ForceWebClientManagerUpgrade

kCura.EDDS.Web

False

When set to True, Internet Explorer checks to make sure the user's web client manager version matches the version of Relativity exactly. If it doesn't, it auto- matically prompts the user

to

install a new web client

manager.

Name

Section

Value

Description

ForgotPasswordRequestBody

Relativ-

<HTML><BODY> <P>We received a request to reset the password associated with this email address. Click the link below to reset your password. This link will expire after 15 minutes .<BR/><BR/> {RESETLINK}<BR/><BR/> We recommend opening this link in Internet Explorer. <BR/><BR/> You can also copy and paste the following text into your address bar:

<BR/><BR/> {RESETTEXT}<BR/><BR/> If you did not request this change, contact your sys- tem admin.<BR/><BR/> Please do not reply to this email.<BR/><BR/></P></BODY></HTML>

The text in the body of the

ity.ForgotPassword

forgotten password request email message.

For-

Relativ-

<HTML><BODY> <P>The password associated with this email address has been successfully reset. Click the link below to login.<BR/><BR/> {LOGINLINK}<BR/><BR/> We recommend opening this link in Internet Explorer. <BR/><BR/> You can also copy and paste the following text into your address bar:<BR/><BR/> {LOGINTEXT}<BR/><BR/> If you did not request this change, contact your sys- tem admin.<BR/><BR/> Please do not reply to this email.<BR/><BR/></P> </BODY></HTML>

The text in the body of the forgotten password request email message when the request has been com- pleted.

gotPass-

ity.ForgotPassword

wordRequestCompletedBody

For-

Relativ-

PasswordReset@relativity.com

The value in the From field for the forgotten password request email message.

gotPasswordRequestEmailFrom ity.ForgotPassword

For-

Relativ-

<HTML><BODY> <P>We received a request to reset the password associated with this email address. <BR/><BR/> Your password can't be

The text in the body of the forgotten password request email message if the user is locked out.

gotPasswordRequestInvalidBody

ity.ForgotPassword

Name

Section

Value

Description

   

reset due to a problem with your account. Contact your system admin for assistance. <BR/><BR/> If you did not request this change, contact your system admin. <BR/><BR/> Please do not reply to this email.<BR/><BR/></P></BODY></HTML>

 

ForgotPasswordRequestSubject

Relativ-

Password reset request

The value in the Subject field for the forgotten pass- word request email mes- sage.

ity.ForgotPassword

FTDirectory

kCur-

During Relativity installation

The path to the full-text dir- ectory used by the SQL Server. This value should be relative to the server where SQL Server is installed.

a.EDDS.SqlServer

GlobalWorkspaceUpgradeLimit

Relativity.Data

4

The global limit on the max- imum number of Work- space Upgrade Worker agents that can access any of the SQL servers in your Relativity environment. Each SQL server can have a different number of these agents accessing it, but the maximum number access- ing a single server can’t exceed the global limit set in this configuration value. To set the number of agents on a specific server, see Servers on the Docu- mentation site.

HeaderLogo

kCura.EDDS.Web

kcura_blue.png

The name of the image file

Name

Section

Value

Description

     

used for the header. This file must be located within the Images folder.

HeaderLogoLarge

kCura.EDDS.Web

kcura_blue_50.png

The name of the large image file used for the header. This file must be located within the Images folder.

HelpLinkURL

kCura.EEDS.Web

The URL for the help link in the user drop-down menu.

HTMLEditorToolbar

kCur-

[[ '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 in minutes.

a.We-

b.UI.WebControls

 

IdentityCertificateThumbprint

Relativ-

CF8D71DB6278106766361271CD8159FC2AC8A- The thumbprint of the cer-

 

ity.Authentication

562

tificate used to sign identity tokens. This certificate is

Name

Section

Value

Description

     

installed in the certificate store of the primary data- base server. If you want to use your own certificate for identity tokens, you must specify it during the install- ation of your Relativity instance. You must also update this value with the certificate’s thumbprint, and then reset the IIS so the configuration changes take effect. For more inform- ation, see Pre-installation in the Relativity 9.2 Docu- mentation site.

Note: If you enter an invalid thumbprint, an error occurs when loading Relativity, which prevents it from run- ning.

ImageExportThreshold

Relativity.Core

300

The amount of time, in seconds, that the TIFNative manager waits for a single document to be imaged before killing the imaging process and moving to the next document.

ImageOnTheFlyJobPriorityDefault

Relativity.Core

1

The default priority for all Image-on-the-fly jobs.

Name

Section

Value

Description

ImageQCOnByDefault

kCur-

False

The checkbox that prompts to Hide Images for QC Review when imaging doc- uments in an Imaging Set defaults to checked if this value is set to True.

a.Ima-

gingSetEventHand-

lers

ImageViewerBufferSize

kCura.EDDS.Web

10485760

The maximum number of bytes that the ImageViewer preloads into memory.

ImageView-

kCura.EDDS.Web

500

When you view a document containing more pages than this value in the Image Viewer, switch to Single Paging Mode.

erContinuousPagingThreshold

ImagingBatchSubmitMaxRetries

Relativ-

3

The maximum number of times a user can re-try each batch of documents for con- version.

ity.Converstion

ImagingJobCleanupInterval

Relativity.Conversion

1440

The number of minutes between attempts to clean up stalled imaging jobs. The default is 1440 minutes, which is 24 hours.

ImagingJobPriorityDefault

Relativity.Core

100

The default priority for all Imaging jobs, excluding Image-on-the-fly jobs.

ImagingRequestTimeout

Relativity.Conversion

1

The amount of time, in minutes, before Relativity checks to see if Invariant has started working on an imaging job that Relativity sent to it. The default is 1 minute.

Name

Section

Value

Description

ImportBatchSize

Relativ-

2000

The batch size used by Structured Analytics agents when pulling document information from the Ana- lytics staging web service and pushing it into Relativ- ity. Changing this value impacts performance.

ity.Struc-

turedAnalytics

Ini-

Relativity.Core

1000

The initial number of view- able items on list pages. This is the value in the “First xxx” drop-down menu on the bottom of list pages.

tialNumberOfViewableDocuments

Instance

kCura.LicenseManag

UNSETINSTANCE

In the Case User Rollup

er

report, this value is used as

a

prefix for the Case User

ID and Usage ID columns. In the Case Statistics Rol-

lup 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 Statistics Rol-

lup report.

Modifying the instance name by updating this value immediately inval- idates your Relativity and Processing licenses.

Name

Section

Value

Description

Invari-

Relativity.Core

300

The number of seconds that must elapse while Invariant returns no files for deletion before the Invari- ant File Deletion Kepler Service times out.

antFileDeletionServiceTimeout

InvitationEmailRequestBody

Relativ-

<HTML><BODY> <P>Your administrator has con- figured a Relativity account for you at the following URL:<BR/><BR/> <a href="{LINKTEXT}">Log in to Relativity</a><BR/><BR/> Click this link to access Relativity. You can also copy and paste the following text into your address bar:<BR/><BR/> {LINKTEXT}<BR/><BR/> If you were not expecting this e-mail, please contact your system admin- istrator.<BR/><BR/> Please do not reply to this email.<BR/><BR/></P></BODY></HTML>

The Invitation Workflow request email message text. The email text must be formatted as HTML.

ity.Authentication

InvitationEmailRequestFrom

Relativ-

PasswordReset@relativity.com

The Invitation Workflow request email message sender.

ity.Authentication

InvitationEmailRequestSubject

Relativ-

Welcome to Relativity

The Invitation Workflow request email message sub- ject.

ity.Authentication

InvitationLinkLifetimeInMin

Relativ-

10080

The number of minutes the link sent in the Invitation Email remains valid.

ity.Authentication

IsPerformanceEnabled

Relativity.Core.Log

False

Do not modify. Set this to True to log performance metrics.

KeplerServicesUri

Relativity.Core

http://localhost/Relativity.Rest/API

The URL at which Relativ- ity custom pages and event handlers can access the Services API Kepler ser- vices using API helpers.

Name

Section

Value

Description

KeplerServicesUriForAgents

Relativity.Core

http://127.0.0.1:8990/Kepler

The URL at which Relativ- ity agents can access local Services API Kepler ser- vices using API helpers. The default port number (8990) can be changed if there is a port conflict with some other server applic- ation. Secure connections are not supported at this time, but the services are still protected by normal Relativity authentication.

KeyboardShortcutsDefault

kCura.EDDS.Web

True

For new users, this value determines the default value for Enabling Key- board Shortcuts.

LargeExtractedTextMaximumSize

Relativ-

157286400

The maximum acceptable size, in bytes, of extracted text sent to Relativity Analytics. If extracted text exceeds this size, the job fails to run and an error message appears. You must remove the flagged document(s) from your saved search before running the job.

This value defaults to 157286400 bytes because Analytics doesn't reliably handle extracted text larger than this size.

ity.Struc-

turedAnalytics

Name

Section

Value

Description

LastAccessedBatchTimerInterval

Relativity.Conversion

10 seconds

Determines the number of seconds between updates to the LastAccessed column on the Con- vertedCacheFile table asso- ciated with the cache IDs for a group of converted documents. Relativity tracks the date and time when a user last viewed a converted document to determine how long the document should be stored in the cache. To monitor these time intervals, it updates the information stored in this column by batches based on the time interval set in this con- figuration value or on the number of records set in

LastAc-

cessedBatchRe-

cordSizeLimit, depending on which limit is met first. For more information, see

LastAc-

cessedBatchRe-

cordSizeLimit.

Note: You can increase the setting for this value and the LastAc-

cessedBatchRe-

Name

Section

Value

Description

     

cordSizeLimit if your SQL server experiences a high number of requests for updates. This change causes the web server to retain more data in memory before sending a database request. Alternatively, you can decrease this setting if the web server is running out of memory because it is holding too many doc- uments.

LastAc-

Relativity.Conversion

500

Determines the maximum number of cache IDs added to a batch before Relativity updates the date and time information stored in the LastAccessed column on the ConvertedCacheFile table for these converted documents. For more information, see LastAc-

cessedBatchTimerInterval.

cessedBatchRecordSizeLimit

LazyLoadHighlightSets

kCura.EDDS.Web

True

To enable selective loading of persistent highlight sets, this must be manually added and set to True.

LdapTemplateUserID

kCura.EDDS.Agents

9

Do not modify. This is the Relativity User Id to use as a template when the LdapUserManager Agent creates users. This is used when integrating Relativity

Name

Section

Value

Description

     

and Active Directory.

LDFDirectory

kCur-

C:\Logs\

The path to the log file dir- ectory used by SQL Server. This value should be rel- ative to the server where SQL Server is installed.

a.EDDS.SqlServer

LegacyAuditCutoff

kCura.EDDS.Web

7/23/2008 3:16:57 PM

The date that the envir- onment was upgraded to 4.20. It's used within mes- sages explaining to the user that audit framework changed.

LoadImportedFullTextFromServer

Relativity.Data

False

Controls whether the Extracted Text field data is loaded directly from its file path during an import, rather than as part of a client-generated bulk load file.

Setting this option to True will move some IO time from the Invariant Worker to the Relativity Processing WebAPI in addition to doing less IO overall. Depending on your environment setup, Processing Publish may take less time with this option on.

LocalCollectionStorage

Relativity.Telemetry

SQLServer

The medium used to store statistics on the client before they are transmitted to kCura. Supported set-

Name

Section

Value

Description

     

tings include SQLServer or Elasticsearch. If you set this value to Elasticsearch, you must install Data Grid. This configuration value is avail- able only when you install telemetry in your envir- onment.

LockoutNotificationList

kCura.LicenseManag

sales@relativity.com;

Distribution list for emails warning of a Case Stat- istics-based or license- based lockout

er

Relativitystats@relativity.com

LoggingLevel

Relativ-

Information

Do not modify. This is the Log Level for Relativity Application Logging. Poss- ible values are Verbose, Debug, Information, Warn- ing, Error, and Fatal.

ity.Core.Logging

LoggingLocation

Relativ-

None

Do not modify. This is the location for Relativity Applic- ation Logging. Possible val- ues are SQLServer, DataGrid, and None.

ity.Core.Logging

LogOutLogo

Relativ-

relativityLogin.png

The name of the image file used for the LogOut Page. This must be located within the Images folder.

ity.Authentication

LongRunningQueryTimeout

kCur-

3600 (seconds)

The timeout value, in seconds, used by the long- running Assisted Review queries.

a.AssistedReview

LongRunningQueryTimeout

kCur-

600 (seconds)

This is used in various places in the system to time