Settings Class

Relativity Import APIs
Provides settings to manage the import process.
Inheritance Hierarchy

Object
  kCura.Relativity.DataReaderClientImportSettingsBase
    kCura.Relativity.DataReaderClientSettings

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

public class Settings : ImportSettingsBase

The Settings 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
Indicates the ArtifactTypeId of the destination object. This property is required.
Public propertyAuditLevel
Indicates the level of auditing for an import job.
(Inherited from ImportSettingsBase.)
Public propertyBillable
Indicates if imported files are subjects to being billable.
(Inherited from ImportSettingsBase.)
Public propertyBulkLoadFileFieldDelimiter
Field delimiter to use when writing out the bulk load file.
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 propertyDisableControlNumberCompatibilityMode
Enables or disables the use of "Control Number" to override the SelectedIdentifierField.
Public propertyDisableExtractedTextEncodingCheck
Enables or disables encoding checks for each file.
(Inherited from ImportSettingsBase.)
Public propertyDisableExtractedTextFileLocationValidation
Enables or disables validation of the extracted text file location.
Public propertyDisableNativeLocationValidation
Enables or disables the validation of the native file location for the current import job.
Public propertyDisableNativeValidation
Enables or disables validation of the native file type for the current job.
Public propertyDisableUserSecurityCheck
Enables or disables user permission checks per document or object.
(Inherited from ImportSettingsBase.)
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 propertyFileNameColumn
Indicates the column that contains the name of the file on the SourceData property.
Public propertyFileSizeColumn
Indicates the column that contains the FileSize on the SourceData property.
Public propertyFileSizeMapped
To skip file size checking, set this property to True.
Public propertyFolderPathSourceFieldName
Indicates the name of a metadata field used to build the folder structure for the workspace.
Public propertyIdentityFieldId
Represents a key field that is set only on Overwrite mode.
(Inherited from ImportSettingsBase.)
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 propertyLongTextColumnThatContainsPathToFullText
Specify a column other than ExtractedText that contains a path to a full text file
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 propertyMultiValueDelimiter
Represents the delimiter used to separate multiple values, such as different single-choice field values.
Public propertyNativeFileCopyMode
Indicates whether native files are used as links or copied to the Relativity instance designated as the destination.
(Inherited from ImportSettingsBase.)
Public propertyNativeFilePathSourceFieldName
Indicates the name of the Field that contains the full path and filename for the native files.
Public propertyNestedValueDelimiter
Represents the delimiter used to separate nested values, such as choices or child choices on a multi-choice field.
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 propertyOIFileIdColumnName
Indicates the column that contains the OutsideInFileId on the SourceData property. Used in conjunction with the OIFileIdMapped and FileSizeMapped properties.
Public propertyOIFileIdMapped
To skip file identification, set this property to True.
Public propertyOIFileTypeColumnName
Indicates the column that contains the OutsideInFileType on the SourceData property. Used in conjunction with the OIFileIdMapped property.
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 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 propertyRowCount Obsolete.
This property is not used and will be unavailable in future releases.
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 propertySupportedByViewerColumn
Indicates the column that contains the SupportedByViewer on the SourceData property.
Public propertyTelemetry
Get class containing telemetry settings
(Inherited from ImportSettingsBase.)
Public propertyTimeKeeperManager
To allow a custom time logging method through out the API
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