DataExportHelper Class

A class that can be used to help aid the non-mapper-command-specific items when it comes to the DataExport services.

Inheritance Hierarchy

SystemObject
NetQuarry.DataDataExportHelper

Namespace: NetQuarry.Data
Assembly: EAP.Mapper (in EAP.Mapper.dll) Version: 2.0.0.0 (4.6.8.0)

Syntax

Copy

public class DataExportHelper

Public Class DataExportHelper

The DataExportHelper type exposes the following members.

Constructors

	Name	Description
	DataExportHelper	Initializes a new instance of the DataExportHelper class

Top

Methods

	Name	Description
	CleanExportFiles	Clean up the exported files for the given FilePath.
	ConvertAndTransmitFile	Convert a given mapper's content to a Data type as specified by the DataExportService, and then write the file out to the browser
	ConvertFile	Convert a given file / XML content to a file defined by the DataExportService.
	DoExport	Do the export for a given DataExportService. The results are written to the browser.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Export	Perform the export for a given mapper / DataExportService combo.
	ExportIsCancelled(IMapper)	Checks whether the export has been cancelled by the user
	ExportIsCancelled(IAppContext, Int32)	Checks whether the export has been cancelled by the user
	ExportIsCancelled(IAppContext, Int32, Int32)	Checks whether the export has been cancelled by the user
	ExportUnderSmartThreshold	Calculates the expected duration of the excel export and compares that against the threshold for offline execution. If the estimated duration is below the system threshold, it returns false (typically meaning the export will occur online)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GenFilename	Generate the Data filename.
	GetDefaultExportExtension	Get the default Export file Extension.
	GetDocStorage(IMapper)	Gets the DocStorageService for the Offline Export task.
	GetDocStorage(IAppContext, Properties)	Gets the DocStorageService for the Offline Export task.
	GetExportLife	Determines the amount of days an export can remain in the database after performing an Offline Export
	GetExportMode(IAppContext, IDataExportService, Boolean)	Inspects the feature property DataExportMode to determine the behavior for executing Data exports.
	GetExportMode(IMapper, IDataExportService, Boolean)	Inspects the feature property ExcelExportMode to determine the behavior for executing excel exports.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetRelatedDocMapper(IMapper)	Gets a reldoc mapper ready for insert. the person calling this method is reponsible to close the mapper once finished
	GetRelatedDocMapper(IAppContext, Properties)	Gets a reldoc mapper ready for insert. the person calling this method is reponsible to close the mapper once finished
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	LogExportMetric(IMapper, NullableExcelExportStatus, NullableInt32, NullableInt32, NullableInt64, String, String, NullableExcelExportAttrs, NullableExcelExportOfflineReasons)	Logs metrics for data exporting.
	LogExportMetric(IAppContext, Int32, ExcelExportStatus, NullableInt32, NullableInt32, NullableInt64, String, String, NullableExcelExportAttrs, NullableExcelExportOfflineReasons)	Logs metrics for data exporting.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NotifyRecipient	Notifies the recipient on completion of export
	PerformExport	Perform the export.
	SaveToDocStorage	Saves the exported file to doc storage
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Fields

	Name	Description
	csExportJobIDProperty	The name of the JobID responsible for the Offline Export.
	EXPORT_FEATURE_LOGGING_BEHAVIOR	The name of the Export feature containing the Logging Behavior.
	EXPORT_FEATURE_OFFLINE_ALERT_TEMPLATE	The name of the Export feature containing the Offline Alert Template.
	OFFLINE_TASK_DEF_MAX_ATTACH_SIZE	The property for the Offline task containing the default value for the maximum attachment size
	OFFLINE_TASK_DEF_MAX_EXPORT_THREADS	The property for the Offline task containing the default value for the maximum threads to use
	OFFLINE_TASK_DEFAULT_EXT	The property for the Offline task containing the Default file extension to be used when saving to the Related Documents mapper.
	OFFLINE_TASK_DOC_STORAGE	The property for the Offline task containing the DocStorageService to be used when exporting.
	OFFLINE_TASK_EMAIL_LOOKUP_SQL	The property for the Offline task containing the SQL used to look up a user's Email address.
	OFFLINE_TASK_EMAIL_MAX_ATTACH_SIZE	The property for the Offline task containing the Maximum attachment size
	OFFLINE_TASK_EMAIL_SERVICE	The property for the Offline task containing the Email Service.
	OFFLINE_TASK_EMAIL_TEMPLATE_NO_ATTACH	The property for the Offline task containing the Email Template for a notification without an Attachment.
	OFFLINE_TASK_EMAIL_TEMPLATE_WITH_ATTACH	The property for the Offline task containing the Email Template for a notification with an Attachment.
	OFFLINE_TASK_EXPORT_FILE_FOLDER	The property for the Offline task containing the File Folder intended to save the exports to.
	OFFLINE_TASK_EXPORT_HISTORY_PAGE	The property for the Offline task containing the MOP for the History page.
	OFFLINE_TASK_MAX_EXPORT_THREADS	The property for the Offline task containing the maximum count of Threads allowed to use.
	OFFLINE_TASK_RD_DEF_DESCRIPTION	The property for the Offline task containing the default value for the Description field on the Related Documents mapper.
	OFFLINE_TASK_RD_DEF_DOCTYPE	The property for the Offline task containing the default value for the DocType
	OFFLINE_TASK_RD_DEF_FIELD_DESCRIPTION	The property for the Offline task containing the default field name for the Description field on the Related Documents mapper.
	OFFLINE_TASK_RD_DEF_FIELD_DOCID	The property for the Offline task containing the default field name for the DocID field on the Related Documents mapper.
	OFFLINE_TASK_RD_DEF_FIELD_DOCTYPE	The property for the Offline task containing the default field name for the DocType field on the Related Documents mapper.
	OFFLINE_TASK_RD_DEF_FIELD_FILENAME	The property for the Offline task containing the default field name for the file name field on the Related Documents mapper.
	OFFLINE_TASK_RD_DEF_FIELD_RELATEDID	The property for the Offline task containing the default field name for the Related ID field on the Related Documents mapper.
	OFFLINE_TASK_RD_DESCRIPTION	The property for the Offline task containing the Descrption to be used when saving to the Related Documents mapper.
	OFFLINE_TASK_RD_DOCTYPE	The property for the Offline task containing the DocType to be used when saving to the Related Documents mapper.
	OFFLINE_TASK_RD_FIELD_DESCRIPTION	The property for the Offline task containing the Field name of the Discription on the Related Documents mapper.
	OFFLINE_TASK_RD_FIELD_DOCID	The property for the Offline task containing the Field name of the Document ID on the Related Documents mapper.
	OFFLINE_TASK_RD_FIELD_DOCTYPE	The property for the Offline task containing the Field name of the Doc Type on the Related Documents mapper.
	OFFLINE_TASK_RD_FIELD_FILENAME	The property for the Offline task containing the Field name of the File name on the Related Documents mapper.
	OFFLINE_TASK_RD_FIELD_RELATEDID	The property for the Offline task containing the Field name of the Related ID on the Related Documents mapper.
	OFFLINE_TASK_RELATED_DOC_MAPPER	The property for the Offline task containing the Related Documents mapper to be used.

Top

Extension Methods

	Name	Description
	EqualValue	Determines if the object value is equal to another object. If the two objects are null, then this returns true. There is special handling for guid comparisons (since a guid could be a string formatted in up to 3 different ways). If the special guid handling is not performed, then the object.Equals method is used. (Defined by EAPUtil.)

Top

Reference

NetQuarry.Data Namespace