Provides settings for imaging files.
Inheritance Hierarchy
kCura.Relativity.DataReaderClient.ImportSettingsBase
kCura.Relativity.DataReaderClient.ImageSettings
Namespace: kCura.Relativity.DataReaderClient
Assembly: Relativity.DataExchange.Client.SDK (in Relativity.DataExchange.Client.SDK.dll) Version: 1.5.0
Syntax
The ImageSettings type exposes the following members.
Properties
Name | Description | |
---|---|---|
![]() | ApplicationName |
Allows clients of Import API to identify themselves. This property is used for telemetry purpose.
(Inherited from ImportSettingsBase.) |
![]() | ArtifactTypeId |
TODO: Remove. Only here for the NUnit project.
|
![]() | AuditLevel |
Indicates the level of auditing for an import job.
(Inherited from ImportSettingsBase.) |
![]() | AutoNumberImages |
Determines whether a page number is automatically appended to a page-level identifier.
|
![]() | BatesNumberField |
Defines a column name in the source DataTable, which maps to a field used as a unique identifier.
|
![]() | BeginBatesFieldArtifactID |
Gets or sets the initial integer to be used in Bates Numbering.
|
![]() | Billable |
Indicates if imported files are subjects to being billable.
(Inherited from ImportSettingsBase.) |
![]() | CaseArtifactId |
Indicates the ArtifactID of the workspace used as the destination for an import job. This property is required.
(Inherited from ImportSettingsBase.) |
![]() | CopyFilesToDocumentRepository |
Gets or sets whether to copy files to the document repository. If False, files will be linked instead.
(Inherited from ImportSettingsBase.) |
![]() | DataGridIDColumnName |
Gets or sets the name of the column that identifies the record identifier
in DataGrid for documents.
(Inherited from ImportSettingsBase.) |
![]() | DestinationFolderArtifactID |
Indicates the Import Destination folder under which documents and objects, as well as folders containing documents or objects, are built.
(Inherited from ImportSettingsBase.) |
![]() | DisableExtractedTextEncodingCheck |
Enables or disables encoding checks for each file.
(Inherited from ImportSettingsBase.) |
![]() | DisableImageLocationValidation |
Enables or disables validation of image location for the current job.
|
![]() | DisableImageTypeValidation |
Enables or disables validation of the image type for the current job.
|
![]() | DisableUserSecurityCheck |
Enables or disables user permission checks per document or object.
(Inherited from ImportSettingsBase.) |
![]() | DocumentIdentifierField |
Name of the field in the data source corresponding to the DocumentIdentifier field.
|
![]() | ExtractedTextEncoding |
Sets the encoding of the extracted text files.
(Inherited from ImportSettingsBase.) |
![]() | ExtractedTextFieldContainsFilePath |
Indicates whether the Extracted Text field contains a path to the extracted text file or contains the actual extracted text.
(Inherited from ImportSettingsBase.) |
![]() | FileLocationField |
Indicates the column name in the source DataTable that maps to the FileLocation field in Relativity.
|
![]() | FolderPathSourceFieldName |
Indicates the Field name that contains the subfolder used for document imports.
|
![]() | ForProduction |
To load images into a production, set this property to True.
|
![]() | IdentityFieldId |
Represents a key field that is set only on Overwrite mode.
(Inherited from ImportSettingsBase.) |
![]() | ImageFilePathSourceFieldName |
Field name that contains the full path to and filename of an image file.
|
![]() | 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.
(Inherited from ImportSettingsBase.) |
![]() | MaximumErrorCount |
Determines the maximum number of errors displayed. This property is optional.
(Inherited from ImportSettingsBase.) |
![]() | MoveDocumentsInAppendOverlayMode |
Indicates if existing documents in case of Append/Overlay mode should be moved to new folder based on metadata
(Inherited from ImportSettingsBase.) |
![]() | NativeFileCopyMode |
Indicates whether native files are used as links or copied to the Relativity instance designated as the destination.
(Inherited from ImportSettingsBase.) |
![]() | ObjectFieldIdListContainsArtifactId |
Identifies a list of single or multiple object Fields that should be mapped by ArtifactID instead of by name.
(Inherited from ImportSettingsBase.) |
![]() | OverlayBehavior |
Indicates the method for overlay imports with multiple choice and multiple object fields.
(Inherited from ImportSettingsBase.) |
![]() | OverwriteMode |
Indicates whether records should be appended or overlayed. The default mode is Append.
(Inherited from ImportSettingsBase.) |
![]() | ParentObjectIdSourceFieldName |
Indicates the name of the Field that contains a unique identifier for the record of the parent object associated with the current record.
(Inherited from ImportSettingsBase.) |
![]() | ProductionArtifactID |
Indicates a valid ArtifactID for a production set. Used in conjunction with the ForProduction property.
|
![]() | RelativityPassword |
Provides the password for logging in to the Relativity instance used as a destination.
(Inherited from ImportSettingsBase.) |
![]() | RelativityUsername |
Provides the username for logging in to the Relativity instance used as a destination.
(Inherited from ImportSettingsBase.) |
![]() | SelectedCasePath |
Indiciates the Case's File Repository where the Images will be saved.
|
![]() | SelectedIdentifierFieldName |
Specifies the field to be used as an identifier while importing.
(Inherited from ImportSettingsBase.) |
![]() | SendEmailOnLoadCompletion |
Gets or sets whether to send an email to notify you of load completion.
(Inherited from ImportSettingsBase.) |
![]() | StartRecordNumber |
Gets or sets the record number from which to start the import.
(Inherited from ImportSettingsBase.) |
![]() | Telemetry |
Get class containing telemetry settings
(Inherited from ImportSettingsBase.) |
![]() | WebServiceURL |
Specifies the server where the Relativity WebAPI is installed. This property is optional.
(Inherited from ImportSettingsBase.) |
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