Represents an abstract object that provides thread-safe general import/export application settings.
Namespace: Relativity.DataExchange
Assembly: Relativity.DataExchange.Client.SDK (in Relativity.DataExchange.Client.SDK.dll) Version: 1.5.0
Syntax
The IAppSettings type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
 | ApplicationName |
Gets or sets the name of the application. This value is encoded within logs, metrics and potential transfer monitors.
|
| AuditLevel |
Gets or sets the audit level applied to import jobs.
Valid values include: FullAudit, NoSnapshot, and NoAudit.
|
| CreateErrorForEmptyNativeFile |
Gets or sets a value indicating whether to create an error when importing or exporting a zero byte file. This is false by default.
|
| CreateErrorForInvalidDate |
Gets or sets a value indicating whether to create an error when importing fields with invalid dates. This is true by default.
|
| CreateFoldersInWebApi |
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.
|
| DefaultMaxErrorCount |
Gets or sets the default maximum error count.
|
| DisableImageLocationValidation |
Gets or sets a value indicating whether to disable image location validation. This is false by default.
|
| DisableImageTypeValidation |
Gets or sets a value indicating whether to disable image type validation. This is false by default.
|
| DisableOutsideInFileIdentification |
Gets or sets a value indicating whether to disable file identification using Outside In technology. This is false by default.
|
| DisableTextFileEncodingCheck |
Gets or sets a value indicating whether to disable the text file encoding check. This is false by default.
|
| DisableThrowOnIllegalCharacters |
Gets or sets a value indicating whether to disable throwing exceptions when illegal characters are found within a path. This is false by default.
|
| DynamicBatchResizingOn |
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.
|
| EnableCaseSensitiveSearchOnImport |
Gets or sets a value indicating whether to use case-sensitive file matching during imports. This is true by default.
|
| EnforceMinRetryCount |
Gets or sets a value indicating whether to enforce minimum retry counts. This is true by default.
|
| EnforceMinWaitTime |
Gets or sets a value indicating whether to enforce minimum wait times. This is true by default.
|
| ExportBatchSize |
Gets or sets the max number of records to export per batch.
|
| ExportErrorNumberOfRetries |
Gets or sets the number of retry attempts for export related fault tolerant methods.
|
| ExportErrorWaitTimeInSeconds |
Gets or sets the number of seconds to wait between retry attempts for export related fault tolerant methods.
|
| ExportThreadCount |
Gets or sets the number of threads to use during export jobs.
|
| FileTypeIdentifyTimeoutSeconds |
Gets or sets the maximum number of seconds to identify a file type before reaching the timeout.
|
| ForceFolderPreview |
Gets or sets a value indicating whether to force a folder preview. This is true by default.
|
| ForceWebUpload |
Gets or sets a value indicating whether to force web-mode. This is false by default.
|
| HttpExtractedTextTimeoutSeconds |
Gets or sets the HTTP extracted text timeout in seconds. This is 900 seconds by default.
|
| HttpTimeoutSeconds |
Gets or sets the HTTP timeout in seconds. This is 300 seconds by default.
|
| ImportBatchMaxVolume |
Gets or sets the maximum number of metadata bytes for a single single batch.
|
| ImportBatchSize |
Gets or sets the max number of records to import per batch.
|
| IoErrorNumberOfRetries |
Gets or sets the number of retry attempts for I/O related fault tolerant methods.
|
| IoErrorWaitTimeInSeconds |
Gets or sets the number of seconds to wait between retry attempts for I/O related fault tolerant methods.
|
| JobCompleteBatchSize |
Gets or sets the total of bytes for a single batch.
|
| LoadImportedFullTextFromServer |
Gets or sets a value indicating whether to load full-text data during the import. This is false by default.
|
| LogAllEvents |
Gets or sets a value indicating whether to log all the I/O events. This is false by default.
|
| LogConfigXmlFileName |
Gets or sets the name of the Relativity Logging Xml configuration file.
|
| MaxReloginTries |
Gets or sets the maximum number of WebAPI login attempts.
|
| MinBatchSize |
Gets or sets the minimum number of records for a single batch.
|
| OAuth2ImplicitCredentialRedirectUrl |
Gets or sets the OAuth2 implicit credential redirect URL. This is only used for interactive processes like the RDC.
|
| ObjectFieldIdListContainsArtifactId |
Gets or sets the list of artifacts to use for object field mapping.
|
| OpenIdConnectHomeRealmDiscoveryHint |
Gets the Open ID Connect HRD or home realm discovery login hint.
|
| PermissionErrorsRetry |
Gets or sets a value indicating whether permission specific errors are retried. This is false by default.
|
| PreviewThreshold |
Gets or sets the preview threshold.
|
| ProcessFormRefreshRate |
Gets or sets the process form refresh-rate. This is a Relativity Desktop Client specific setting.
|
| ProgrammaticWebApiServiceUrl |
Gets or sets the programmatic Relativity Web API service URL.
|
| RetryOptions |
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.
|
| SuppressServerCertificateValidation |
Gets or sets a value indicating whether to suppress server certificate validation errors. This is false by default.
|
| TapiAsperaBcpRootFolder |
Gets or sets the name of the root folder associated with the BCP share.
|
| TapiAsperaNativeDocRootLevels |
Gets or sets the number of levels that differ between the configured document root and the native file share.
|
| TapiBadPathErrorsRetry |
Gets or sets a value indicating whether Transfer API retries files that fail due to invalid paths. This is false by default.
|
| TapiFileNotFoundErrorsDisabled |
Gets or sets a value indicating whether Transfer API should disable treating missing files as errors. This is false by default and always true for exports.
|
| TapiFileNotFoundErrorsRetry |
Gets or sets a value indicating whether Transfer API should retry missing files. This is true by default and always false for exports.
|
| TapiForceAsperaClient |
Gets or sets a value indicating whether to force using the Aspera transfer client. This is false by default.
|
| TapiForceBcpHttpClient |
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.
|
| TapiForceClientCandidates |
Gets or sets a semi-colon delimited list of transfer client candidates.
|
| TapiForceFileShareClient |
Gets or sets a value indicating whether to force the file share transfer client. This is false by default.
|
| TapiForceHttpClient |
Gets or sets a value indicating whether to force using the HTTP transfer client. This is false by default.
|
| TapiLargeFileProgressEnabled |
Gets or sets a value indicating whether to raise progress events for large files. This is false by default.
|
| TapiMaxInactivitySeconds |
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.
|
| TapiMaxJobParallelism |
Gets or sets the Transfer API maximum degree of parallelism for a single transfer job.
|
| TapiMinDataRateMbps |
Gets or sets the Transfer API minimum data rate in megabits per second units.
|
| TapiPreserveFileTimestamps |
Gets or sets a value indicating whether to preserve import and export file timestamps. This is false by default.
|
| TapiSubmitApmMetrics |
Gets or sets a value indicating whether Transfer API should submit APM metrics when each transfer job completes. This is true by default.
|
| TapiTargetDataRateMbps |
Gets or sets the Transfer API target data rate in megabits per second units.
|
| TapiTransferLogDirectory |
Gets or sets the directory where all Transfer API transfer logs are written.
|
| TelemetryMetricsThrottlingSeconds |
Gets or sets a value indicating how often Import API should submit APM metrics during job execution.
|
| TelemetrySubmitApmMetrics |
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.
|
| TelemetrySubmitSumMetrics |
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.
|
| TempDirectory |
Gets or sets the directory used for all temp storage.
|
| UseOldExport |
Gets or sets a value indicating whether to use the old export production implementation. This is false by default.
|
| UsePipeliningForNativeAndObjectImports |
Gets or sets a value indicating whether to execute native and object import tasks in parallel. This is true by default.
|
| ValueRefreshThreshold |
Gets or sets the the refresh frequency, in milliseconds, to be used for updating configuration settings.
|
| WaitBeforeReconnect |
Gets or sets the time, in milliseconds, to wait before reconnecting.
|
| WebApiOperationTimeout |
Gets or sets the timeout, in seconds, before a WebAPI service call throws a timeout exception.
|
| WebApiServiceUrl |
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.
|
| WebBasedFileDownloadChunkSize |
Gets or sets the number of bytes used when downloading chunks using web mode.
|
Methods
| Name | Description | |
|---|---|---|
 | DeepCopy |
Performs a deep copy of this instance.
|
| ValidateUriFormat |
Validates that the URI is valid and returns a properly formatted URI string.
|
Remarks
See Also