Click or drag to resize

ExportSettings Properties

The ExportSettings type exposes the following members.

Properties
 NameDescription
Public propertyAreBooleanFieldsYesNo If true (the default), boolean fields get output as "Yes" or "No" (if false, they get output as "True" or "False")
Public propertyControlNumbersToExportHashSet [Optional]: If non-null, this hash set contains all document control numbers to export from the document data archive.
Public propertyFields All fields to be exported. See GetSupportedExportFields to get a list of all supported export fields (see also ExportField).
Public propertyImportAPIPassword INTERNAL USE ONLY. Used for Relativity direct import API.
Public propertyImportAPIUrl INTERNAL USE ONLY. Used for Relativity direct import API.
Public propertyImportAPIUsername INTERNAL USE ONLY. Used for Relativity direct import API.
Public propertyImportAPIWorkspaceArtifactID INTERNAL USE ONLY. Used for Relativity direct import API.
Public propertyImportAPIWorkspaceArtifactTypeID INTERNAL USE ONLY. Used for Relativity direct import API.
Public propertyIncludeNistFiles Required user input: If true, include NIST documents in load file (default is false).
Public propertyIncludeRequeueAsSeparateTaskFiles 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).
Public propertyIncludeTopLevelInputContainers 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).
Public propertyLoadFileFullPath Required user input: The full path of the load file to create.
Public propertyMaxEntityItemsPerTypePerRecord 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.
Public propertyUseFilenameAsDocGuidField 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.
Public propertyUseImportAPI INTERNAL USE ONLY. Used for Relativity direct import API.
Top
See Also