kCura.Relativity.DataReaderClient.ImportSettingsBase

ImportSettingsBase

public class ImportSettingsBase

Defines the base class for the Settings and ImageSettings classes. Provides common properties.

Documentation

public string ApplicationName { get; set; }

Allows clients of Import API to identify themselves. This property is used for telemetry purpose.

public ImportAuditLevel AuditLevel { get; set; }

Indicates the level of auditing for an import job.

public bool Billable { get; set; }

Indicates if imported files are subjects to being billable.

public int CaseArtifactId { get; set; }

Indicates the ArtifactID of the workspace used as the destination for an import job. This property is required.

public bool CopyFilesToDocumentRepository { get; set; }

Gets or sets whether to copy files to the document repository. If False, files will be linked instead.

public string DataGridIDColumnName { get; set; }

Gets or sets the name of the column that identifies the record identifier in DataGrid for documents.

public int DestinationFolderArtifactID { get; set; }

Indicates the Import Destination folder under which documents and objects, as well as folders containing documents or objects, are built.

public bool? DisableExtractedTextEncodingCheck { get; set; }

Enables or disables encoding checks for each file.

public bool DisableUserSecurityCheck { get; set; }

Enables or disables user permission checks per document or object.

public Encoding ExtractedTextEncoding { get; set; }

Sets the encoding of the extracted text files.

public bool ExtractedTextFieldContainsFilePath { get; set; }

Indicates whether the Extracted Text field contains a path to the extracted text file or contains the actual extracted text.

public int IdentityFieldId { get; set; }

Represents a key field that is set only on Overwrite mode.

public bool LoadImportedFullTextFromServer { get; set; }

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 int? MaximumErrorCount { get; set; }

Determines the maximum number of errors displayed. This property is optional.

public bool MoveDocumentsInAppendOverlayMode { get; set; }

Indicates if existing documents in case of Append/Overlay mode should be moved to new folder based on metadata

public NativeFileCopyModeEnum NativeFileCopyMode { get; set; }

Indicates whether native files are used as links or copied to the Relativity instance designated as the destination.

public IList<int> ObjectFieldIdListContainsArtifactId { get; set; }

Identifies a list of single or multiple object Fields that should be mapped by ArtifactID instead of by name.

public OverlayBehavior OverlayBehavior { get; set; }

Indicates the method for overlay imports with multiple choice and multiple object fields.

public OverwriteModeEnum OverwriteMode { get; set; }

Indicates whether records should be appended or overlaid. The default mode is Append.

public string ParentObjectIdSourceFieldName { get; set; }

Indicates the name of the Field that contains a unique identifier for the record of the parent object associated with the current record.

public string RelativityPassword { get; set; }

Provides the password for logging in to the Relativity instance used as a destination.

public string RelativityUsername { get; set; }

Provides the username for logging in to the Relativity instance used as a destination.

public string SelectedIdentifierFieldName { get; set; }

Specifies the field to be used as an identifier while importing.

public bool SendEmailOnLoadCompletion { get; set; }

Gets or sets whether to send an email to notify you of load completion.

public long StartRecordNumber { get; set; }

Gets or sets the record number from which to start the import.

public IMetricSinkConfig Telemetry { get; }

Get class containing telemetry settings

public string WebServiceURL { get; set; }

Specifies the server where the Relativity WebAPI is installed. This property is optional.