Defines the base class for the Settings and ImageSettings classes. Provides common properties.
Inheritance Hierarchy
kCura.Relativity.DataReaderClientImportSettingsBase
kCura.Relativity.DataReaderClientImageSettings
kCura.Relativity.DataReaderClientSettings
Namespace: kCura.Relativity.DataReaderClient
Assembly: Relativity.DataExchange.Client.SDK (in Relativity.DataExchange.Client.SDK.dll) Version: 1.5.0
Syntax
The ImportSettingsBase type exposes the following members.
Properties
Name | Description | |
---|---|---|
![]() | ApplicationName |
Allows clients of Import API to identify themselves. This property is used for telemetry purpose.
|
![]() | AuditLevel |
Indicates the level of auditing for an import job.
|
![]() | Billable |
Indicates if imported files are subjects to being billable.
|
![]() | CaseArtifactId |
Indicates the ArtifactID of the workspace used as the destination for an import job. This property is required.
|
![]() | CopyFilesToDocumentRepository |
Gets or sets whether to copy files to the document repository. If False, files will be linked instead.
|
![]() | DataGridIDColumnName |
Gets or sets the name of the column that identifies the record identifier
in DataGrid for documents.
|
![]() | DestinationFolderArtifactID |
Indicates the Import Destination folder under which documents and objects, as well as folders containing documents or objects, are built.
|
![]() | DisableExtractedTextEncodingCheck |
Enables or disables encoding checks for each file.
|
![]() | DisableUserSecurityCheck |
Enables or disables user permission checks per document or object.
|
![]() | ExtractedTextEncoding |
Sets the encoding of the extracted text files.
|
![]() | ExtractedTextFieldContainsFilePath |
Indicates whether the Extracted Text field contains a path to the extracted text file or contains the actual extracted text.
|
![]() | IdentityFieldId |
Represents a key field that is set only on Overwrite mode.
|
![]() | LoadImportedFullTextFromServer |
Indicates whether the Extracted Text field data will be loaded directly from its file path, rather than as part of a bulk load file.
|
![]() | MaximumErrorCount |
Determines the maximum number of errors displayed. This property is optional.
|
![]() | MoveDocumentsInAppendOverlayMode |
Indicates if existing documents in case of Append/Overlay mode should be moved to new folder based on metadata
|
![]() | NativeFileCopyMode |
Indicates whether native files are used as links or copied to the Relativity instance designated as the destination.
|
![]() | ObjectFieldIdListContainsArtifactId |
Identifies a list of single or multiple object Fields that should be mapped by ArtifactID instead of by name.
|
![]() | OverlayBehavior |
Indicates the method for overlay imports with multiple choice and multiple object fields.
|
![]() | OverwriteMode |
Indicates whether records should be appended or overlayed. The default mode is Append.
|
![]() | ParentObjectIdSourceFieldName |
Indicates the name of the Field that contains a unique identifier for the record of the parent object associated with the current record.
|
![]() | RelativityPassword |
Provides the password for logging in to the Relativity instance used as a destination.
|
![]() | RelativityUsername |
Provides the username for logging in to the Relativity instance used as a destination.
|
![]() | SelectedIdentifierFieldName |
Specifies the field to be used as an identifier while importing.
|
![]() | SendEmailOnLoadCompletion |
Gets or sets whether to send an email to notify you of load completion.
|
![]() | StartRecordNumber |
Gets or sets the record number from which to start the import.
|
![]() | Telemetry |
Get class containing telemetry settings
|
![]() | WebServiceURL |
Specifies the server where the Relativity WebAPI is installed. This property is optional.
|
Methods
Name | Description | |
---|---|---|
![]() | Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
![]() | GetHashCode | Serves as the default hash function. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also