LoadFileSettings Class

Open Discover export to load file configuration.

Inheritance Hierarchy

SystemObject
OpenDiscoverSDK.Interfaces.Platform.LoadFileLoadFileSettings

Namespace: OpenDiscoverSDK.Interfaces.Platform.LoadFile
Assembly: OpenDiscoverSDK.Interfaces (in OpenDiscoverSDK.Interfaces.dll) Version: 2025.4.4.0 (2025.4.4)

Syntax

Copy

public class LoadFileSettings

The LoadFileSettings type exposes the following members.

Constructors

	Name	Description
	LoadFileSettings	Constructor.

Top

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")
	CustodianName	[Optional] Custodian name that will be added as exported field if this value is not null, empty, or whitespace (default value is null).
	DocumentAttributes	INTERNAL USE ONLY, populated by method Initialize(String, Boolean). Field ID to standalone DocumentAttributes map (true/false flags).
	DocumentPropertyToFieldDisplayName	IINTERNAL USE ONLY, populated by method Initialize(String, Boolean). Document property name to load file display name mapper.
	EntityToFieldDisplayName	INTERNAL USE ONLY, populated by method Initialize(String, Boolean). Entity item type to load file display name mapper.
	EntityTypeHitList	INTERNAL USE ONLY, populated by method Initialize(String, Boolean). Want a field that has a list of all Entity types (deduped) it hit on, preferably semi colon delimited ie. IPv4Address;IPv6Address
	FieldDisplayNameToMultiItemMetadata	RESERVED. Load file field display name to multi-valued Open Discover metadata name check.
	ImportAPIPassword	INTERNAL USE ONLY.
	ImportAPIUrl	INTERNAL USE ONLY.
	ImportAPIUsername	INTERNAL USE ONLY.
	ImportAPIWorkspaceArtifactID	INTERNAL USE ONLY.
	ImportAPIWorkspaceArtifactTypeID	INTERNAL USE ONLY.
	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, UserRequeueAsSeparateTask, or RequeueAsOCRTask. 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).
	JobStartDate	INTERNAL USE ONLY, populated by method Initialize(String, Boolean). Job start date that is stored in .dda.
	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.
	MetadataPropertyFieldDisplayName	INTERNAL USE ONLY, populated by method Initialize(String, Boolean). Metadata property load file display name mapper.
	OpenDiscoverNameToLoadFileFieldNameMap	INTERNAL USE ONLY, populated by method Initialize(String, Boolean). Open Discover name to load file field display name map.
	RelativityCompatible	INTERNAL USE ONLY.
	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.

Top

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)
	Initialize	Parses the "Open Discover Document properties/metadata to load file export field display names" mapping file. A default mapping file that contains all possible Open Discover fields that can be exported is generated by [!:LoadFileCreator.CreateDefaultLoadFileFieldMapping]. "Custodian" should not be a field in the mappingFileString argument. To add a "Custodian" field see comments on 'wantCustodianName' argument.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Remarks

This class requires a "mapping file" that maps Open Discover field and metadata names to what user wants to name these fields in the load file. See method Initialize(String, Boolean) and also see LoadFileCreator.CreateDefaultLoadFileFieldMapping.

Reference

OpenDiscoverSDK.Interfaces.Platform.LoadFile Namespace