Instance settings' descriptions

This page provides an alphabetical list of all the instance settings related to 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.

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

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. Note that 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.

B

C

D

E

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

K

KeplerServicesUri

Section	kCura.EDDS.Web
Value	True
Description	Specifies if the Relativity instance name can be seen in the About box

Section	Relativity.Authentication
Value	https://www.relativity.com/support/
Description	Identifies the location to which the Support link redirects.

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

Section	Relativity.Core
Value	600
Description	The amount of time, in seconds, that an advanced imaging process can actively run until it times out (does not include waiting time).

Section	kCura.ARM
Value	False
Description	Controls whether Advanced Restore Options are shown when creating a restore or move ARM job. If set to True, additional options will be available for ARM jobs.

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	Relativity.Data
Value	True
Description	Enables the removal of documents from an Analytics Index before population begins.

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	kCura.Billing
Value	True
Description	Determines the type of file the Case Statistics Manager agent generates to send client billing information to Relativity. If set to True, the Case Statistics Manager agent generates a text file with client billing information which is sent to Relativity. Each time the agent runs, the new text file is sent to Relativity through the SMTP server. If set to False, the Case Statistics Manager generates a zip file with client billing information, which is stored in the location 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 Relativity.

Section	Relativity.Authentication
Value	240
Description	Determines the number of additional minutes that the authentication token remains valid after the authentication cookie has expired. Because this token has a longer lifetime than a session cookie, you can use it to access Relativity APIs, which 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. You must reset the IIS for these changes to take effect.

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.

Section	Relativity.Authentication
Value	Text
Description	A semicolon delimited list of Artifact IDs of groups allowed access to Relativity while maintenance mode is active. This instance setting isn’t encrypted. For more information, see InMaintenanceMode setting.

Section	kCura.EDDS.Web
Value	True
Description	Determines whether users can perform redactions within the Native Viewer. If set to True, users can perform redactions within the Native Viewer. If set to False, users can't perform redactions within the Native Viewer.

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	kCura.EDDS.Web.Distributed
Value	5000
Description	The amount of time, in milliseconds, the Distributed site waits to acquire a free buffer to use for downloading before throwing an error.

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.Telemetry
Value	500
Description	The size of batches used for flushing non-aggregated metrics in the client-side queues. This instance setting is available only when you install telemetry in your environment.

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

Section	Relativity.Conversion
Value	500
Description	Determines the maximum number of documents to submit for conversion at a time when running an imaging set. Note: This instance setting must be manually added to your 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.Method
Value	600 seconds
Description	Controls the amount of time the settings are re-loaded on recurring basis with the default every 10 minutes (600 seconds). By default this instance setting is not deployed and, if needed, has to be created manually.

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 (seconds)
Description	The timeout value, in seconds, used by default for all AssistedReview queries.

Section	Relativity.DocumentViewer
Value	False
Description	Determines if the Collect Folder Path Data agents are off hours or not. If set to True, we recommend changing the run interval of KCD_1037595_FolderPath - Manager to 86400 seconds.

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. This requires that the ImageViewerIsHTMLConversionType setting is also set to True. 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	Relativity.ForgotPassword
Value	<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 system admin.<BR/><BR/> Please do not reply to this email.<BR/><BR/></P></BODY></HTML>
Description	Determines the text in the body of the forgotten password request email message.