Instance settings

This page provides an alphabetical list of all the instance settings in Relativity.

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

Instance settings change log

The following table lists all added, removed, and modified instance settings for Server 2023.

Type of change	Name	Section	Notes
Type of change	Name	Section	Notes
Added	AuthenticatorRegistrationName	Relativity.Authentication
Added	IAPICommunicationMode	DataTransfer.Legacy
Removed	AdvancedOptionsEnabled	kCura.ARM
Removed	AdditionalSortBy	kCura.Audit
Removed	CustodianPortalAuthLoadRefreshTime	kCura.Method
Removed	CacheTimeout	Relativity.CaseDynamics
Removed	DisableAutoCSVIdentification	Relativity.Conversion
Removed	HungOiLinkProcessCleanerRunIntervalInMinutes	Relativity.Conversion
Removed	OiLinkMaximumAllowedLifeSpanInMinutes	Relativity.Conversion
Removed	AdvancedImagingTimeout	Relativity.Core
Removed	DisableOffHoursCollectFolderPath	Relativity.DocumentViewer
Removed	ViewerVisibilityWithoutContentForRelativityReview	Relativity.DocumentViewer
Removed	TransmissionUrl	Relativity.Telemetry

Instance settings descriptions

A | B | C | D | E | F | G | H | I | J | K | L | M | N | O | P | Q | R | S | T | U | V | W | X | Y | Z

A

AccessTokenExtraLifetime

Section	Relativity.Authentication
Value	240
Description	Determines the number of additional minutes the authentication token remains valid after the authentication cookie has expired. You can use this token to access Relativity APIs because it has a longer lifetime than a session cookie. This may execute long running processes requiring tokens. This instance setting supports a maximum value of 600 minutes, or 10 hours, and a minimum value of 240 minutes, or 4 hours. You must reset the IIS for these changes to take effect.
Recommended security value	Use the default setting. It is more secure to limit the life of this token.

AdditionalWorkFactorDefault

Section	Relativity.Authentication
Value	0
Description	Sets the default value for the AdditionalWorkFactor setting in the Authentication Provider Settings section of the Authentication Provider tab.
Recommended security value	Use the default setting unless your organization decides more hashing is necessary. More hashing means better encryption, but increasing this value should be tested prior to making the change in Production, as it could significantly increase login time.

AgentOffHourEndTime

Section

kCura.EDDS.Agents

Value

5:00:00

Description

Specifies a valid time range when off hour agents should run. This instance setting is used in conjunction with the AgentOffHourStartTime instance setting.

Currently, this only applies to the File Deletion manager, Case Statistics Manager, Case Manager, and Cache Manager. The File Deletion manager immediately stops deleting documents once the time of day passes the AgentOffHourEndTime. The Case Statistics manager and Case Manager continue to process until completion.

To enter a setting, use 24-hour time notation with the format of hh:mm:ss. If the start time is before midnight, 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, you can set the end time to any value after 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

Section

kCura.EDDS.Agents

Value

00:00:00

Description

Specifies a valid time range when off hour agents should run. This instance setting is used in conjunction with the AgentOffHourEndTime instance setting.

AllowHtmlVisible

Section	Relativity.Core
Value	False
Description	Controls the accessibility of the Allow HTML property on Field objects. If set to False, the Allow HTML property is hidden from the New Field page and its value defaults to No. The Edit Field page displays the property only if the field being edited already has the property's value set to Yes. If set to True, there is unrestricted access to the Allow HTML field property.
Recommended security value	False - this prevents administrators from allowing HTML as inputs into fields. By doing this, attackers cannot input malicious HTML or scripts.

ApplicationRestrictedFileTypes

Section	Relativity.Core
Value	.exe;.com;.pif;.bat;.scr
Description	A semicolon-delimited list of file extensions, including periods, indicating file types users are prohibited from uploading as custom pages or resource files. Examples include .exe, .com, and .bat. Also, see RestrictedFileTypes.
Recommended security value	Use the default values plus any other file extensions your organization deems necessary. Add any file extensions to the list that your organization deems unsafe.

B

C

CookieHttpOnly

Section	Relativity.Authentication
Value	True
Description	Controls access to cookies. If set to True, this instance setting prevents access to cookies by JavaScript and other client-side elements. This flag is designed to attach to sensitive cookies such as the session cookie ASP.NET_SessionId.
Recommended security value	Keep at default, unless your organization wants to further limit the amount of time one user’s Relativity session will last. Limiting this value decreases the chance an attacker could compromise the authentication cookie.

D

DeveloperMode

Section	Relativity.Core
Value	False
Description	Controls developer mode options within an instance of Relativity. Setting this value to True enables developer mode options. Setting this value to False disables developer mode options. These options include disabling the cross-site request forgery (CSRF) header requirement in the API and returning detailed error messages such as stack traces. Enable this setting only in a development environment.
Recommended security value	False - Setting this value to false will cause Relativity to enforce the cross-site request forgery (CSRF) header requirement in the API and stop sending detailed error messages like stack traces.

E

EnforceHttps

Section	Relativity.Authentication
Value	Warn
Description	Controls how Relativity Service Host handles HTTP/HTTPS traffic. Values include On, Off, and Warn. If set to On, this instance setting forces Service Host to use HTTPS only. If set to Off, HTTP traffic is allowed. If Warn, the browser and all API endpoints will allow any traffic but will log a warning. The default value is Warn.
Recommended security value	On - make sure to add a certificate to the Personal certificate store of the Computer Account on all web and agent servers. If the certificate is self-signed, you must add it to both the Personal and the Trusted Root Certification Authorities certificate stores for the Computer Account on all web and agent servers. It is also a requirement that you edit the value of the KeplerServicesUri instance setting and the KeplerServicesUriForAgents instance setting to reflect HTTPS. This requires Service Host traffic to be encrypted with SSL/TLS in order to not send in cleartext.

ESIndexCreationSettings

Section

kCura.Audit

Value

Click here to view default Data Grid template

{
                "order": 0,
                "index_patterns": ["audit_*"],
                "settings": {
                    "index": {
                    "max_result_window": "2147483647",
                    "analysis": {
                        "filter": {
                        "substring": {
                            "type": "nGram",
                            "min_gram": "1",
                            "max_gram": "20"
                        }
                        },
                        "analyzer": {
                        "lwhitespace": {
                            "filter": [
                            "lowercase"
                            ],
                            "tokenizer": "whitespace"
                        },
                        "str_index_analyzer": {
                            "filter": [
                            "lowercase",
                            "substring"
                            ],
                            "tokenizer": "keyword"
                        },
                        "str_search_analyzer": {
                            "filter": [
                            "lowercase",
                            "substring"
                            ],
                            "tokenizer": "keyword"
                        }
                        }
                    },
                    "number_of_shards": "1",
                    "number_of_replicas": "1"
                    }
                },
                "mappings": {
                    "audit": {
                    "dynamic_templates": [
                        {
                        "details_run_item_as_text": {
                            "path_match": "Details.auditElement.run.item.*",
                            "mapping": {
                                "fields": {
                                    "keyword": {
                                        "type": "keyword"
                                    }
                                },
                                "type": "text"
                            }
                        }
                        },
                        {
                        "raw": {
                            "match_pattern": "regex",
                            "path_match": "Details\\.auditElement\\..*",
                            "mapping": {
                            "type": "text",
                            "fields": {
                                "raw": {
                                "analyzer": "lwhitespace",
                                "type": "text"
                                }
                            }
                            },
                            "match_mapping_type": "string"
                        }
                        },
                        {
                        "newvalue": {
                            "match_pattern": "regex",
                            "path_match": ".*\\.newValue$",
                            "mapping": {
                            "type": "text",
                            "fields": {
                                "raw": {
                                "analyzer": "lwhitespace",
                                "type": "text"
                                }
                            }
                            }
                        }
                        },
                        {
                        "oldvalue": {
                            "match_pattern": "regex",
                            "path_match": ".*\\.oldValue$",
                            "mapping": {
                            "type": "text",
                            "fields": {
                                "raw": {
                                "analyzer": "lwhitespace",
                                "type": "text"
                                }
                            }
                            }
                        }
                        },
                        {
                        "analytics_text": {
                            "match_pattern": "regex",
                            "path_match": ".*\\.#text$",
                            "mapping": {
                            "type": "text",
                            "fields": {
                                "raw": {
                                "analyzer": "lwhitespace",
                                "type": "text"
                                }
                            }
                            }
                        }
                        }
                    ],
                    "properties": {
                        "Guid": {
                            "type": "keyword"
                        },
                        "ActionName": {
                            "type": "keyword"
                        },
                        "UserName": {
                            "type": "keyword"
                        },
                        "Details.auditElement.field.@id": {
                            "type": "keyword"
                        },
                        "TimeStamp": {
                            "format": "strict_date_optional_time||epoch_millis",
                            "type": "date"
                        }
                    }
                    }
                },
                "aliases": {
                    "{index}_write": {},
                    "{index}_read": {},
                    "{index}_verify": {}
                }
}

Description

Defines a template to create new indexes for Data Grid.

Note: This instance setting must be manually added to your environment.

F

G

H

I

InvitationLinkLifetimeInMin

Section	Relativity.Authentication
Value	10080
Description	The number of minutes the link sent in the Invitation Email remains valid.
Recommended security value	Determine how much time your organization is comfortable having links remain valid before sending a new email. The longer the link remains viable, the more chance it could be compromised.

J

K

KeplerServicesUri

Section	Relativity.Core
Value	http://localhost/Relativity.Rest/API/
Description	Specifies the URL at which Relativity custom pages and event handlers can access the Services API Kepler services using API helpers. The URL must end in a forward slash. Note: This instance setting must be manually added to your environment.
Recommended security value	Change the link from http to https. For example, change http://localhost/Relativity.Rest/API/ to https://localhost/Relativity.Rest/API/. If EnforceHTTPS was set to True, this needs to be set to HTTPS instead of HTTP.

KeplerServicesUriForAgents

Section	Relativity.Core
Value	http://127.0.0.1:8990/Kepler
Description	Specifies the URL at which Relativity agents can access local Services API Kepler services using API helpers. The default port number, 8990, can be changed if there is a port conflict with some other server application.
Recommended security value	Change the link from http to https. For example, change http://127.0.0.1:8990/Kepler to https://127.0.0.1:8990/Kepler. Set EnforceHTTPS to True if this value is set to HTTPS instead of HTTP.

L

LastAccessedBatchTimerInterval

Section

Relativity.Conversion

Value

10 seconds

Description

The amount of time, in seconds, between updates to the LastAccessed column on the ConvertedCacheFile table associated with the cache IDs for a group of converted documents. Relativity tracks the date and time when a user last converted the document to determine how long to store the document 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 instance setting or on the number of records set in LastAccessedBatchRecordSizeLimit, depending on which limit is met first. For more information, see LastAccessedBatchRecordSizeLimit.

You can increase the setting for this value and the LastAccessedBatchRecordSizeLimit 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 documents.

M

MaximumAdditionalWorkFactorRestriction

Section	Relativity.Authentication
Value	3
Description	Sets the maximum additional work factor that can be selected for the Password Provider on the Authentication Provider Settings section of the Authentication Provider tab.
Recommended security value	Use the default setting unless your organization decides more hashing is necessary. More hashing means better encryption, but increasing this value should be tested prior to making the change in Production as it could significantly increase login time.

MaximumPasswordAgeDefault

Section	kCura.EDDS.Web
Value	0
Description	Determines the default value for the maximum password age when creating password authentication providers.
Recommended security value	Set this value to a number greater than zero so users are encouraged to change their passwords after a certain number of days. Password rotation can protect Relativity against passwords that may have been compromised.

MaximumPasswordHistory

Section	Relativity.Core
Value	5
Description	Determines how many password changes Relativity examines for duplicate passwords. Setting this to a large value could prevent a user from ever using the same password twice.
Recommended security value	Determine if your organization wants to limit users from reusing the same passwords they have used in the past. This can protect the Relativity environment from a previously compromised password.

MOTDTextOnly

Section	kCura.EDDS.Web
Value	False
Description	Controls how the message of the day (MOTD) is entered and displayed. If set to True, the MOTD can only be entered and displayed as plain text. If set to False, the MOTD can be entered and displayed using the full HTML editor. Note: This instance setting must be manually added to your environment.
Recommended security value	Set the value to True unless you want the ability to use JavaScript in this field. By only allowing text in the Message of the Day box, cross-site scripting and cross-frame scripting can be prevented.

N

O

OutputStructure

Section

Relativity.Conversion

Value

Chunked

Description

Determine the data transfer encoding method that Relativity's processing engine uses when converting files into documents that are readable in the viewer. The method can be chunked or streamed. By default, this value is set to Chunked.

Chunked—Relativity transfers data to the processing engine in a series of chunks. The size of each chunk is sent directly before the chunk itself so that the engine knows when it has finished receiving data for that chunk. Chunked is the default value. Chunked and Flat get similar conversion results.
Streamed—Relativity transfers data to the processing engine in a steady and continuous stream. If the engine receives the data more quickly than required, it temporarily saves the excess data in a buffer until it's ready to process it. Do not select Streamed. If you select Streamed, you will experience conversion failures.

P

PasswordResetEmailExpirationInMinutes

Section	Relativity.ForgotPassword
Value	15
Description	Defines how long, in minutes, password reset links remain valid after the email is sent. Changing this instance setting affects all subsequent reset password links, after about 30 seconds. It does not affect the links that have already been sent.
Recommended security value	Your organization should limit the time the password reset link remains valid. The longer the link remains active, the more risk it will be compromised by an attacker.

Q

R

ReplaceUserNameWithHashValue

Section	kCura.Billing
Value	False
Description	Controls whether Relativity replaces the username portions of user email addresses with hash values in billing information sent manually or sent automatically through the SMTP server. If set to True, Relativity replaces all text preceding the @ symbol in each user email address with a unique hash value. Domains remain unencrypted. If set to False, entire user email addresses appear. If you manually run the billing script, the value you select in the interface overrides this instance setting.
Recommended security value	True - this will hide the usernames and case names in Billing Data sent through the SMTP server.

RestrictedFileTypes

Section	Relativity.Core
Value	.exe;.html;.htm;.js
Description	A semicolon-delimited list of file extensions, including dots, that users are prohibited from uploading to file fields, excluding Custom Pages. For example, .exe;.html See also ApplicationRestrictedFileTypes. Note: This instance setting must be manually added to your environment.
Recommended security value	Use the default values plus any other file extensions your organization deems necessary. Certain types of files could contain malicious scripts.

RestrictedNativeFileTypes

Section	Relativity.Core
Value	HTML;HTM;EXE
Description	A semicolon-delimited list of file types users are prohibited from uploading to file fields, excluding Custom Pages. These values are regular expression enabled, so custom validation behavior is also supported. Note: This instance setting must be manually added to your environment.
Recommended security value	Use the default values plus any other file extensions your organization deems necessary. Certain types of files could contain malicious scripts.

RestrictReferentialFileLinksOnImport

Section	Relativity.Core
Value	True
Description	Controls whether non-system administrators can import documents, objects, images, and productions using referential links for files already in a valid, Relativity-accessible location. When set to True, non-system administrators can import only by uploading files. When set to False, all users can import using referential links.
Recommended security value	True - this ensures users cannot import files from workspaces they have no access to.

S

ServiceBusFullyQualifiedDomainName

Section

Relativity.ServiceBus

Value

localhost

Description

When using Service Bus for Windows Server, if the FarmDNS property for the service bus farm has a value, then the installer sets the ServiceBusFullyQualifiedDomainName instance setting to this value.
When using Service Bus for Windows Server, if the FarmDNS property does not have a value, then the installer sets the ServiceBusFullyQualifiedDomainName instance setting to a semi-colon delimited list of all hosts in the farm.
When using RabbitMQ, ServiceBusFullyQualifiedDomainName specifies the fully-qualified domain name for the machine or load balancer where Relativity can reach the environment’s cluster. The Relativity installer automatically sets this value during an installation or upgrade based on the inputs in the RelativityResponse.txt file.

Note: The semi-colon delimited list is not supported for RabbitMQ.

For more information, see Relativity installation or Upgrading your Relativity Service Bus.

ShowStackTraceOnError

Section	kCura.EDDS.Web
Value	True
Description	Controls whether full stack traces appear to users when an error occurs. If set to True, full stack traces appear to users when an error occurs. If set to False, full stack traces do not appear to users when an error occurs.
Recommended security value	Set the value to False unless you want all users with access to the Errors tab to see full stack traces for errors. Set to True for active troubleshooting situations. It is more secure to hide the details of error messages, so users cannot see more information than is necessary. Without hiding this information, software and server details could be revealed.

T

TreatHtmlAndXmlAsText

Section	kCura.EDDS.Web.Distributed
Value	True
Description	Controls the content-type header returned by files with HTM or HTML extensions from Relativity.Distributed. If set to True, the content-type is text/plain. If set to False, the content-type is set to text/html. The default value is True. The net effect of setting this to True is that the Native Viewer displays the raw markup of HTML files instead of rendering the content.
Recommended security value	True - this helps prevent malicious code from executing when a Native document is viewed in the Viewer because it’s not automatically rendered. The content of the content-type header for the native files is unknown and, therefore, untrusted.

U

UsePermissionsCachingMode

Section

Relativity.Data

Value

Standard

Description

Indicates the mechanism used to check Relativity user permissions. This instance setting can be set to the following:

Cache—use a permissions caching mechanism to improve performance by minimizing calls to the SQL database.
Standard (Default)—request the full permission matrix and then filter for required permissions. The most reliable, but may slow performance.
Lazy—only pull permission rows with given artifactTypeId. No caching, but better performance than Standard.

V

ValidateAssemblyVersion

Section

kCura.EDDS.WebAPI

Value

x.x.*.*

Description

As of the Relativity 10.3 , this instance setting is no longer used to determine the compatibility of the RDC or Import API with a specific version of Relativity. For more information, see RDC compatibility matrix.

Determines which parts of the Relativity version number are validated between the desktop client and the Relativity WebAPI version. For example, given the WebAPI version is 4.20.1.1 and the desktop client is 4.20.1.2:

*.*.*.* match
x.x.*.* match
x.x.x.x do not match (the last node between the two is different)
x.x.x.* match
*.*.*.x do not match

W

WebClientValidateAssemblyVersion

Section

kCura.EDDS.Web

Value

x.x.x.x

Description

Affects how the web client manager determines whether it needs to download and install a new version of the web client. For example, given that Relativity is version 4.20.1.1 and the web client is 4.20.1.2:

*.*.*.* will not cause a download/install
x.x.*.* will not cause a download/install
x.x.x.x will cause a download/install (the last node between the two is different)
x.x.x.* will not cause a download/install
*.*.*.x will cause a download/install

Section	kCura.LicenseManager
Value	UNSETACCOUNT
Description	Determines the text that appears in the Account column in the Case Statistics Rollup report.

Section	Relativity.Conversion.Cache
Value	4
Description	The minimum time that must elapse, in hours, before a cached document already marked dirty is added to the job.

Section	kCura.Data.RowDataGateway
Value	30000
Description	The amount of time, in milliseconds, a query waits to retry when a deadlock happens during the run of a categorization set.

Section	kCura.Relativity
Value	30
Description	Sets the Relativity API token expiration time in minutes.

Section	kCura.Notification
Value	authentication@relativity.com
Description	Defines the email address that appears in the From field of email messages that contain authentication information for users.

Section	Relativity.DataGrid
Value	False
Description	This instance setting prevents the dropping of the column from the full text index and the document table. If enabled, the user is responsible for dropping this column from the database.

Section	kCura.EDDS.SqlServer
Value	During Relativity installation
Description	Identifies the path to the backup directory that SQL Server uses. This value should be relative to the server where SQL Server is installed.

Section	kCura.EDDS.Procuro
Value	During Relativity installation
Description	Identifies the root path where Procuro looks for required Relativity applications.

Section	kCura.Chicago
Value	BCPPath
Description	Defines the name of the share used for Bulk Inserts and the Case Statistics manager.

Section	Relativity.Production
Value	10
Description	The number of times branding managers can be timed out for a single production before all incomplete branding jobs are marked as errored. Set to 0 to disable.

Section	Analytics.Core
Value	5
Description	The interval, in minutes, at which the Categorization Set agent checks if there are untrained coding decisions. If there is a change in coding decisions, but no new changes since the last interval check, a build will commence.

Section	Relativity.StructuredAnalytics
Value	blank
Description	This setting was deprecated in Relativity 8.1. Changing this value has no effect on the environment.

Section	kCura.EDDS.Winform
Value	True
Description	Determines the default value that appears in all import and export forms within the Relativity Desktop Client for the copy files to repository value.

Section	kCura.Relativity.WebProcessing
Value	600
Description	The amount of time, in seconds, that the system will wait before removing previous versions of a deployed custom page.

Section	Relativity.Audit
Value	3
Description	Number of attempts made by the Data Grid to perform an operation before it returns a failure.

Section	kCura.Code.Data
Value	3
Description	Determines the default OIHiliteStyle associated with new choices. Valid values are defined on the OIHiliteStyle table. Look within a workspace database, not the EDDS database.

Section	kCura.AssistedReview
Value	30
Description	The timeout value, in seconds, used by default for all AssistedReview queries.

Section	Relativity.Imaging
Value	10,000
Description	The maximum number of documents that can be submitted for the Mass Imaging action. If a user attempts to mass image and the number of documents selected exceeds this value, a warning appears to prevent the user from performing this action to suggest creating an Imaging Set as best practice.

Section	Relativity.ReviewInterface
Value	True
Description	If this is set to True, the Viewer is available as a preview panel in the document list for users with appropriate permissions. If the instance setting is set to false, the preview panel is not available in the document list.

Section	kCura.IntegrationPoints
Value	1000
Description	The number of records being exported in a batch through an Integration Points job.

Section	kCura.Web.UI.WebControls
Value	[[ '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']]
Description	A list of options used by the HTMLEditorToolbar. This is used within rich text fields.

Section	Relativity.ApplicationBase
Value	8092
Description	The port on the Worker Manager Server that is hosting the Kepler Invariant API.

Section	Relativity.Core.Log
Value	10080
Description	Do not modify without advice from Relativity Customer Support. Determines whether Relativity logs performance metrics. Set this to True to log performance metrics.

Section	Relativity.Core.Logging
Value	Information
Description	Do not modify without advice from Relativity Customer Support. Determines the Log Level for Relativity Application Logging. Possible values are Verbose, Debug, Information, Warning, Error, and Fatal.

Section	Relativity.MassOperations
Value	0
Description	Max number of threads for each Mass Operation Manager. If 0 or less, defaults to Agent server processor count * 2.

Section	kCura.Fta
Value	168
Description	The maximum period of time, in hours, before a file transfer job expires.

Section	Relativity.DataGrid.Migration
Value	500
Description	Default size of batches for migration

Section	Relativity.DataGridMigrator.Agent
Value	104857600
Description	Maximum size that Data Grid Text Migrator agent will attempt load documents in memory. The default value is 104857600 (100MB).

Section	Relativity.DataTransfer
Value	4
Description	The maximum number of parallel threads ARM for Processing will use during the file repository copy operation.

Section	Analytics.ActiveLearning
Value	150
Description	Defines the number of documents that are requested for review from the analytics engine when the number of outstanding documents in a review queue falls under the level defined by the ReviewQueueRefreshThreshold instance setting. The actual number of documents requested is the number of active reviewers on the review multiplied by the ReviewQueueBatchSize value.