ImportSettingsBase Class

Relativity Import APIs
Defines the base class for the Settings and ImageSettings classes. Provides common properties.
Inheritance Hierarchy


Namespace:  kCura.Relativity.DataReaderClient
Assembly:  Relativity.DataExchange.Client.SDK (in Relativity.DataExchange.Client.SDK.dll) Version: 1.5.0

public class ImportSettingsBase

The ImportSettingsBase type exposes the following members.


Public propertyApplicationName
Allows clients of Import API to identify themselves. This property is used for telemetry purpose.
Public propertyAuditLevel
Indicates the level of auditing for an import job.
Public propertyBillable
Indicates if imported files are subjects to being billable.
Public propertyCaseArtifactId
Indicates the ArtifactID of the workspace used as the destination for an import job. This property is required.
Public propertyCopyFilesToDocumentRepository
Gets or sets whether to copy files to the document repository. If False, files will be linked instead.
Public propertyDataGridIDColumnName
Gets or sets the name of the column that identifies the record identifier in DataGrid for documents.
Public propertyDestinationFolderArtifactID
Indicates the Import Destination folder under which documents and objects, as well as folders containing documents or objects, are built.
Public propertyDisableExtractedTextEncodingCheck
Enables or disables encoding checks for each file.
Public propertyDisableUserSecurityCheck
Enables or disables user permission checks per document or object.
Public propertyExtractedTextEncoding
Sets the encoding of the extracted text files.
Public propertyExtractedTextFieldContainsFilePath
Indicates whether the Extracted Text field contains a path to the extracted text file or contains the actual extracted text.
Public propertyIdentityFieldId
Represents a key field that is set only on Overwrite mode.
Public propertyLoadImportedFullTextFromServer
Indicates whether the Extracted Text field data will be loaded directly from its file path, rather than as part of a bulk load file.
Public propertyMaximumErrorCount
Determines the maximum number of errors displayed. This property is optional.
Public propertyMoveDocumentsInAppendOverlayMode
Indicates if existing documents in case of Append/Overlay mode should be moved to new folder based on metadata
Public propertyNativeFileCopyMode
Indicates whether native files are used as links or copied to the Relativity instance designated as the destination.
Public propertyObjectFieldIdListContainsArtifactId
Identifies a list of single or multiple object Fields that should be mapped by ArtifactID instead of by name.
Public propertyOverlayBehavior
Indicates the method for overlay imports with multiple choice and multiple object fields.
Public propertyOverwriteMode
Indicates whether records should be appended or overlayed. The default mode is Append.
Public propertyParentObjectIdSourceFieldName
Indicates the name of the Field that contains a unique identifier for the record of the parent object associated with the current record.
Public propertyRelativityPassword
Provides the password for logging in to the Relativity instance used as a destination.
Public propertyRelativityUsername
Provides the username for logging in to the Relativity instance used as a destination.
Public propertySelectedIdentifierFieldName
Specifies the field to be used as an identifier while importing.
Public propertySendEmailOnLoadCompletion
Gets or sets whether to send an email to notify you of load completion.
Public propertyStartRecordNumber
Gets or sets the record number from which to start the import.
Public propertyTelemetry
Get class containing telemetry settings
Public propertyWebServiceURL
Specifies the server where the Relativity WebAPI is installed. This property is optional.

Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
See Also