Relativity.DataExchange.IAppSettings

IAppSettings

public interface IAppSettings

Represents an abstract object that provides thread-safe general import/export application settings.

Documentation

string ApplicationName { get; set; }

Gets or sets the name of the application. This value is encoded within logs, metrics and potential transfer monitors.

string AuditLevel { get; set; }

Gets or sets the audit level applied to import jobs. Valid values include: FullAudit, NoSnapshot, and NoAudit.

int BatchInProgressNumberOfRetries { get; set; }

Gets or sets the number of retry attempts for batch in progress policy.

int BatchInProgressWaitTimeInSeconds { get; set; }

Gets or sets the number of seconds to wait between retry attempts for batch in progress policy.

bool CreateErrorForEmptyNativeFile { get; set; }

Gets or sets a value indicating whether to create an error when importing or exporting a zero byte file. This is false by default.

bool CreateErrorForEmptyPdfFile { get; set; }

Gets or sets a value indicating whether to create an error when exporting a zero byte file. This is false by default.

bool CreateErrorForInvalidDate { get; set; }

Gets or sets a value indicating whether to create an error when importing fields with invalid dates. This is true by default.

bool CreateFoldersInWebApi { get; set; }

Gets or sets a value indicating whether to create folders using a WebAPI web service or a legacy client-side API. This is true by default.

int DefaultMaxErrorCount { get; set; }

Gets or sets the default maximum error count.

bool DisableImageLocationValidation { get; set; }

Gets or sets a value indicating whether to disable image location validation. This is false by default.

bool DisableImageTypeValidation { get; set; }

Gets or sets a value indicating whether to disable image type validation. This is false by default.

bool DisableOutsideInFileIdentification { get; set; }

Gets or sets a value indicating whether to disable file identification using Outside In technology. This is false by default.

bool DisableTextFileEncodingCheck { get; set; }

Gets or sets a value indicating whether to disable the text file encoding check. This is false by default.

bool DisableThrowOnIllegalCharacters { get; set; }

Gets or sets a value indicating whether to disable throwing exceptions when illegal characters are found within a path. This is false by default.

bool DynamicBatchResizingOn { get; set; }

Gets or sets a value indicating whether to automatically decrease the import batch size during the import when an error occurs. This is true by default.

bool EnableCaseSensitiveSearchOnImport { get; set; }

Gets or sets a value indicating whether to use case-sensitive file matching during imports. This is true by default.

bool EnforceMinRetryCount { get; set; }

Gets or sets a value indicating whether to enforce minimum retry counts. This is true by default.

bool EnforceMinWaitTime { get; set; }

Gets or sets a value indicating whether to enforce minimum wait times. This is true by default.

int ExportBatchSize { get; set; }

Gets or sets the max number of records to export per batch.

int ExportErrorNumberOfRetries { get; set; }

Gets or sets the number of retry attempts for export related fault tolerant methods.

int ExportErrorWaitTimeInSeconds { get; set; }

Gets or sets the number of seconds to wait between retry attempts for export related fault tolerant methods.

int ExportLongTextBufferSizeBytes { get; set; }

Gets or sets the size of the buffer in bytes to use when retrieving long text field data from Object Manager during export jobs.

int ExportLongTextDataGridThreadCount { get; set; }

Gets or sets the number of concurrent requests to retrieve long text field data, stored in Data Grid, from Object Manager during export jobs.

int ExportLongTextLargeFileProgressRateSeconds { get; set; }

Gets or sets the rate, in seconds, that large file progress events are raised when retrieving long text field data from Object Manager during export jobs.

bool ExportLongTextObjectManagerEnabled { get; set; }

Gets or sets a value indicating whether to use Object Manager or the legacy Relativity.Distributed to retrieve long text field data during export jobs. This is true by default.

int ExportLongTextSqlThreadCount { get; set; }

Gets or sets the number of concurrent requests to retrieve long text field data, stored in SQL Server, from Object Manager during export jobs.

bool ExportPermissionErrorsRetry { get; set; }

Gets or sets a value indicating whether permission specific errors are retried in export. This is false by default.

int FileTypeIdentifyTimeoutSeconds { get; set; }

Gets or sets the maximum number of seconds to identify a file type before reaching the timeout.

bool ForceFolderPreview { get; set; }

Gets or sets a value indicating whether to force a folder preview. This is true by default.

bool ForceWebUpload { get; set; }

Gets or sets a value indicating whether to force web-mode. This is false by default.

int HttpErrorNumberOfRetries { get; set; }

Gets or sets the number of retry attempts for HTTP related fault tolerant methods.

int HttpErrorWaitTimeInSeconds { get; set; }

Gets or sets the number of seconds to wait between retry attempts for HTTP related fault tolerant methods.

int HttpExtractedTextTimeoutSeconds { get; set; }

Gets or sets the timeout, in seconds, for the legacy Relativity.Distributed long text specific HTTP/REST-based API web services. This is 900 seconds by default.

int HttpTimeoutSeconds { get; set; }

Gets or sets the HTTP timeout in seconds. This is 300 seconds by default.

int ImportBatchMaxVolume { get; set; }

Gets or sets the maximum number of metadata bytes for a single single batch.

int ImportBatchSize { get; set; }

Gets or sets the max number of records to import per batch.

int InternalKeplerTimeoutInSeconds { get; set; }

Gets or sets the number of seconds for internal Kepler timeout when calling ExecuteAsync().

int IoErrorNumberOfRetries { get; set; }

Gets or sets the number of retry attempts for I/O related fault tolerant methods.

int IoErrorWaitTimeInSeconds { get; set; }

Gets or sets the number of seconds to wait between retry attempts for I/O related fault tolerant methods.

int JobCompleteBatchSize { get; set; }

Gets or sets the total of bytes for a single batch.

bool LoadImportedFullTextFromServer { get; set; }

Gets or sets a value indicating whether to load full-text data during the import. This is false by default.

bool LogAllEvents { get; set; }

Gets or sets a value indicating whether to log all the I/O events. This is false by default.

string LogConfigXmlFileName { get; set; }

Gets or sets the name of the Relativity Logging Xml configuration file.

bool LogHashingEnabled { get; set; }

Gets or sets a value indicating whether to hash sensitive data.

int MaxReloginTries { get; set; }

Gets or sets the maximum number of WebAPI login attempts.

int MinBatchSize { get; set; }

Gets or sets the minimum number of records for a single batch.

string OAuth2ImplicitCredentialRedirectUrl { get; set; }

Gets or sets the OAuth2 implicit credential redirect URL. This is only used for interactive processes like the RDC.

IList<int> ObjectFieldIdListContainsArtifactId { get; set; }

Gets or sets the list of artifacts to use for object field mapping.

string OpenIdConnectHomeRealmDiscoveryHint { get; }

Gets the Open ID Connect HRD or home realm discovery login hint.

bool PermissionErrorsRetry { get; set; }

Gets or sets a value indicating whether permission specific errors are retried in import. This is false by default.

int PreviewThreshold { get; set; }

Gets or sets the preview threshold.

int ProcessFormRefreshRate { get; set; }

Gets or sets the process form refresh-rate. This is a Relativity Desktop Client specific setting.

string ProgrammaticWebApiServiceUrl { get; set; }

Gets or sets the programmatic Relativity Web API service URL.

int ReadCommunicationModeErrorNumberOfRetries { get; set; }

Gets or sets the number of retry attempts for reading communication mode.

int ReadCommunicationModeErrorWaitTimeInSeconds { get; set; }

Gets or sets the number of seconds to wait between retry attempts for reading communication mode.

bool RetryInTheOriginalTransferMode { get; set; }

Gets or sets a value indicating whether gets or sets the value indicating whether the transfer client mode will attempt retries in the original mode before switching to the web mode.

RetryOptions RetryOptions { get; }

Gets the retry options used by all retry policy blocks. This value is read-only because the value is driven by a combination of other setting values such as PermissionErrorsRetry.

bool SuppressServerCertificateValidation { get; set; }

Gets or sets a value indicating whether to suppress server certificate validation errors. This is false by default.

string TapiAsperaBcpRootFolder { get; set; }

Gets or sets the name of the root folder associated with the BCP share.

int TapiAsperaDatagramSize { get; set; }

Gets or sets the size of the largest datagram size that will be used by Aspera.

int TapiAsperaNativeDocRootLevels { get; set; }

Gets or sets the number of levels that differ between the configured document root and the native file share.

bool TapiBadPathErrorsRetry { get; set; }

Gets or sets a value indicating whether Transfer API retries files that fail due to invalid paths. This is false by default.

bool TapiExportFileNotFoundErrorsDisabled { get; set; }

Gets or sets a value indicating whether Transfer API should disable treating missing files as errors in export. This is false by default and always true for exports.

bool TapiExportFileNotFoundErrorsRetry { get; set; }

Gets or sets a value indicating whether Transfer API should retry missing files in export. This is true by default and always false for exports.

bool TapiFileNotFoundErrorsDisabled { get; set; }

Gets or sets a value indicating whether Transfer API should disable treating missing files as errors in import. This is false by default and always true for exports.

bool TapiFileNotFoundErrorsRetry { get; set; }

Gets or sets a value indicating whether Transfer API should retry missing files in import. This is true by default and always false for exports.

bool TapiForceAsperaClient { get; set; }

Gets or sets a value indicating whether to force using the Aspera transfer client. This is false by default.

bool TapiForceBcpHttpClient { get; set; }

Gets or sets a value indicating whether to force using the HTTP transfer client client for all load file transfers. This is false by default.

string TapiForceClientCandidates { get; set; }

Gets or sets a semi-colon delimited list of transfer client candidates.

bool TapiForceFileShareClient { get; set; }

Gets or sets a value indicating whether to force the file share transfer client. This is false by default.

bool TapiForceHttpClient { get; set; }

Gets or sets a value indicating whether to force using the HTTP transfer client. This is false by default.

bool TapiLargeFileProgressEnabled { get; set; }

Gets or sets a value indicating whether to raise progress events for large files. This is false by default.

int TapiMaxInactivitySeconds { get; set; }

Gets or sets the maximum number of seconds in which no data movement occurs before treating the transfer inactive. When this occurs, the import or export job continues but performance may be degraded.

int TapiMaxJobParallelism { get; set; }

Gets or sets the Transfer API maximum degree of parallelism for a single transfer job.

int TapiMinDataRateMbps { get; set; }

Gets or sets the Transfer API minimum data rate in megabits per second units.

bool TapiPreserveFileTimestamps { get; set; }

Gets or sets a value indicating whether to preserve import and export file timestamps. This is false by default.

bool TapiSubmitApmMetrics { get; set; }

Gets or sets a value indicating whether Transfer API should submit APM metrics when each transfer job completes. This is true by default.

int TapiTargetDataRateMbps { get; set; }

Gets or sets the Transfer API target data rate in megabits per second units.

string TapiTransferLogDirectory { get; set; }

Gets or sets the directory where all Transfer API transfer logs are written.

int TelemetryMetricsThrottlingSeconds { get; set; }

Gets or sets a value indicating how often Import API should submit APM metrics during job execution.

bool TelemetrySubmitApmMetrics { get; set; }

Gets or sets a value indicating whether Import API should submit APM metrics periodically when executing a job and on job completion. This is true by default.

bool TelemetrySubmitSumMetrics { get; set; }

Gets or sets a value indicating whether Import API should submit SUM metrics on job start and on job completion. This is true by default.

string TempDirectory { get; set; }

Gets or sets the directory used for all temp storage.

bool? UseKepler { get; set; }

Gets or sets a value indicating whether the Kepler service should be used instead of WebApi service.

bool UsePipeliningForNativeAndObjectImports { get; set; }

Gets or sets a value indicating whether to execute native and object import tasks in parallel. This is true by default.

bool UseSearchablePdf { get; set; }

Gets or sets a value indicating whether the searchable PDF mode is active or not.

bool UseSynchronizedImportBatchMode { get; set; }

Gets or sets a value indicating whether Native File Transfer and Metadata import operations are synchronized in the batch. If set to True than Metadata import operation is not triggered until Native File transfer finishes.

int ValueRefreshThreshold { get; set; }

Gets or sets the the refresh frequency, in milliseconds, to be used for updating configuration settings.

int WaitBeforeReconnect { get; set; }

Gets or sets the time, in milliseconds, to wait before reconnecting.

int WebApiOperationTimeout { get; set; }

Gets or sets the timeout, in seconds, before a WebAPI service call throws a timeout exception.

string WebApiServiceUrl { get; set; }

Gets or sets the Relativity Web API service URL. This will always return ProgrammaticWebApiServiceUrl and then this value. If none are defined, a final check is made with the Windows Registry to determine if it has been set of the RDC.

int WebBasedFileDownloadChunkSize { get; set; }

Gets or sets the number of bytes used when downloading chunks using web mode.

IAppSettings DeepCopy()

Performs a deep copy of this instance.

string ValidateUriFormat(string value)

Validates that the URI is valid and returns a properly formatted URI string.