ImageSettings Class

Relativity Import APIs
Provides settings for imaging files.
Inheritance Hierarchy

Object
  kCura.Relativity.DataReaderClientImportSettingsBase
    kCura.Relativity.DataReaderClientImageSettings

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

public class ImageSettings : ImportSettingsBase

The ImageSettings type exposes the following members.

Properties

  NameDescription
Public propertyApplicationName
Allows clients of Import API to identify themselves. This property is used for telemetry purpose.
(Inherited from ImportSettingsBase.)
Public propertyArtifactTypeId
TODO: Remove. Only here for the NUnit project.
Public propertyAuditLevel
Indicates the level of auditing for an import job.
(Inherited from ImportSettingsBase.)
Public propertyAutoNumberImages
Determines whether a page number is automatically appended to a page-level identifier.
Public propertyBatesNumberField
Defines a column name in the source DataTable, which maps to a field used as a unique identifier.
Public propertyBeginBatesFieldArtifactID
Gets or sets the initial integer to be used in Bates Numbering.
Public propertyBillable
Indicates if imported files are subjects to being billable.
(Inherited from ImportSettingsBase.)
Public propertyCaseArtifactId
Indicates the ArtifactID of the workspace used as the destination for an import job. This property is required.
(Inherited from ImportSettingsBase.)
Public propertyCopyFilesToDocumentRepository
Gets or sets whether to copy files to the document repository. If False, files will be linked instead.
(Inherited from ImportSettingsBase.)
Public propertyDataGridIDColumnName
Gets or sets the name of the column that identifies the record identifier in DataGrid for documents.
(Inherited from ImportSettingsBase.)
Public propertyDestinationFolderArtifactID
Indicates the Import Destination folder under which documents and objects, as well as folders containing documents or objects, are built.
(Inherited from ImportSettingsBase.)
Public propertyDisableExtractedTextEncodingCheck
Enables or disables encoding checks for each file.
(Inherited from ImportSettingsBase.)
Public propertyDisableImageLocationValidation
Enables or disables validation of image location for the current job.
Public propertyDisableImageTypeValidation
Enables or disables validation of the image type for the current job.
Public propertyDisableUserSecurityCheck
Enables or disables user permission checks per document or object.
(Inherited from ImportSettingsBase.)
Public propertyDocumentIdentifierField
Name of the field in the data source corresponding to the DocumentIdentifier field.
Public propertyExtractedTextEncoding
Sets the encoding of the extracted text files.
(Inherited from ImportSettingsBase.)
Public propertyExtractedTextFieldContainsFilePath
Indicates whether the Extracted Text field contains a path to the extracted text file or contains the actual extracted text.
(Inherited from ImportSettingsBase.)
Public propertyFileLocationField
Indicates the column name in the source DataTable that maps to the FileLocation field in Relativity.
Public propertyFolderPathSourceFieldName
Indicates the Field name that contains the subfolder used for document imports.
Public propertyForProduction
To load images into a production, set this property to True.
Public propertyIdentityFieldId
Represents a key field that is set only on Overwrite mode.
(Inherited from ImportSettingsBase.)
Public propertyImageFilePathSourceFieldName
Field name that contains the full path to and filename of an image file.
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.
(Inherited from ImportSettingsBase.)
Public propertyMaximumErrorCount
Determines the maximum number of errors displayed. This property is optional.
(Inherited from ImportSettingsBase.)
Public propertyMoveDocumentsInAppendOverlayMode
Indicates if existing documents in case of Append/Overlay mode should be moved to new folder based on metadata
(Inherited from ImportSettingsBase.)
Public propertyNativeFileCopyMode
Indicates whether native files are used as links or copied to the Relativity instance designated as the destination.
(Inherited from ImportSettingsBase.)
Public propertyObjectFieldIdListContainsArtifactId
Identifies a list of single or multiple object Fields that should be mapped by ArtifactID instead of by name.
(Inherited from ImportSettingsBase.)
Public propertyOverlayBehavior
Indicates the method for overlay imports with multiple choice and multiple object fields.
(Inherited from ImportSettingsBase.)
Public propertyOverwriteMode
Indicates whether records should be appended or overlayed. The default mode is Append.
(Inherited from ImportSettingsBase.)
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.
(Inherited from ImportSettingsBase.)
Public propertyProductionArtifactID
Indicates a valid ArtifactID for a production set. Used in conjunction with the ForProduction property.
Public propertyRelativityPassword
Provides the password for logging in to the Relativity instance used as a destination.
(Inherited from ImportSettingsBase.)
Public propertyRelativityUsername
Provides the username for logging in to the Relativity instance used as a destination.
(Inherited from ImportSettingsBase.)
Public propertySelectedCasePath
Indiciates the Case's File Repository where the Images will be saved.
Public propertySelectedIdentifierFieldName
Specifies the field to be used as an identifier while importing.
(Inherited from ImportSettingsBase.)
Public propertySendEmailOnLoadCompletion
Gets or sets whether to send an email to notify you of load completion.
(Inherited from ImportSettingsBase.)
Public propertyStartRecordNumber
Gets or sets the record number from which to start the import.
(Inherited from ImportSettingsBase.)
Public propertyTelemetry
Get class containing telemetry settings
(Inherited from ImportSettingsBase.)
Public propertyWebServiceURL
Specifies the server where the Relativity WebAPI is installed. This property is optional.
(Inherited from ImportSettingsBase.)
Top
Methods

  NameDescription
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.)
Top
See Also

Reference