Export |
Defines export settings for legal review load files.
Inheritance HierarchySystemObject
OpenDiscoverSDK.Interfaces.Platform.LoadFileExportSettings
OpenDiscoverSDK.Interfaces.Platform.LoadFileExportSettings
Namespace: OpenDiscoverSDK.Interfaces.Platform.LoadFile
Assembly: OpenDiscoverSDK.Interfaces (in OpenDiscoverSDK.Interfaces.dll) Version: 2025.4.4.0 (2025.4.4)
SyntaxC#
public class ExportSettings
The ExportSettings type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ExportSettings | Constructor. |
Properties| Name | Description | |
|---|---|---|
 | AreBooleanFieldsYesNo | If true (the default), boolean fields get output as "Yes" or "No" (if false, they get output as "True" or "False") |
| ControlNumbersToExportHashSet | [Optional]: If non-null, this hash set contains all document control numbers to export from the document data archive. |
| Fields | All fields to be exported. See GetSupportedExportFields to get a list of all supported export fields (see also ExportField). |
| ImportAPIPassword | INTERNAL USE ONLY. Used for Relativity direct import API. |
| ImportAPIUrl | INTERNAL USE ONLY. Used for Relativity direct import API. |
| ImportAPIUsername | INTERNAL USE ONLY. Used for Relativity direct import API. |
| ImportAPIWorkspaceArtifactID | INTERNAL USE ONLY. Used for Relativity direct import API. |
| ImportAPIWorkspaceArtifactTypeID | INTERNAL USE ONLY. Used for Relativity direct import API. |
| IncludeNistFiles | Required user input: If true, include NIST documents in load file (default is false). |
| IncludeRequeueAsSeparateTaskFiles | Optional user input: If true, includes documents that have Result equal to RequeueAsSeparateTask or UserRequeueAsSeparateTask. If false, these documents are not written to load file (false is the default property value). |
| IncludeTopLevelInputContainers | Required user input: If true, includes top level input containers in load file. If false, they are not written to load file (false is the default property value). |
| LoadFileFullPath | Required user input: The full path of the load file to create. |
| MaxEntityItemsPerTypePerRecord | Required user input: Maximum number of entity items (per type) per document record to write as delimited field. This limit is to protected against writing potentially 10's of 1000's of items such as addresses to one document record. Default value is 200000. |
| UseFilenameAsDocGuidField | If true, replaces the Open Discover created DocGuid field with the file's input filename with no extension (default is false). This field SHOULD always be set to false unless the user is wanting to process extracted text/native files that have been exported with Document ID's as their file names. See remarks. |
| UseImportAPI | INTERNAL USE ONLY. Used for Relativity direct import API. |
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) |
 | GetSupportedExportFields | Gets a list of all supported ExportFields. |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ReadExportedFieldsFromCsvMappingFile | Reads (parses) all ExportField from a previously exported (and optionally modified) comma separated value (.csv) mapping file. See methods GetSupportedExportFields and WriteExportedFieldsToCsvMappingFile(String, ListExportField, Boolean) for exporting a .csv mapping file that can be edited by user. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| WriteExportedFieldsToCsvMappingFile | Writes a comma separated value (.csv) file of export fields. |
See Also