textxport

(plugins.textxport)

Overview

The TextXport plugin provides functionality for exporting data from a foundset into text-based formats like .tab or .csv, enabling flexible data management. Exports can be customized with separators and headers depending on requirements.

TextXport supports two main approaches for exporting data. The createExporter method allows for setting up complex export configurations, while textExport methods provide simpler, direct options for exporting with various levels of customization.

The createExporter method generates an export setup for a specified foundset, allowing configuration of the data separator and the inclusion of headers. This is useful for more advanced export workflows. The textExport methods perform direct exports to text-separated formats, such as tab-separated or comma-separated values. These methods allow specifying the foundset, data providers, separator, and header options to customize the exported output.

Returned Types

TabExporter,DataProviderExport,

Properties Summarized

Methods Summarized

Type	Name	Summary
TabExporter	createExporter(foundSet, separator, exportHeader)	Create exporter for easier export set up.
String	textExport(foundSet, dataProviderIds)	Export to text 'separated value' data (*.
String	textExport(foundSet, dataProviderIds, separator)	Export to text 'separated value' data (*.
String	textExport(foundSet, dataProviderIds, separator, exportHeader)	Export to text 'separated value' data (*.

Properties Detailed

Methods Detailed

createExporter(foundSet, separator, exportHeader)

Create exporter for easier export set up. Can either use this method (for more complex exports) or textExport(...) API

Parameters

• JSFoundSet foundSet the foundset to export with
• String separator the separator of the data
• Boolean exportHeader export a header

Returns: TabExporter A TabExporter object for easier export setup.

Sample

//export with ';' separator and no header
var exporter = plugins.textxport.createExporter(forms.form1.foundset,';',false);

textExport(foundSet, dataProviderIds)

Export to text 'separated value' data (*.tab/*.csv)

Parameters

• JSFoundSet foundSet the foundset to export with
• Array dataProviderIds the ids of the dataproviders

Returns: String A String containing the exported text data with default separator (tab) and no header.

Sample

//export with default separator(tab) and no header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name']);

textExport(foundSet, dataProviderIds, separator)

Export to text 'separated value' data (*.tab/*.csv)

Parameters

• JSFoundSet foundSet the foundset to export with
• Array dataProviderIds the ids of the dataproviders
• String separator the separator of the data

Returns: String A string containing the exported data in the specified text-separated format.

Sample

//export with ';' separator and no header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name'],';');

textExport(foundSet, dataProviderIds, separator, exportHeader)

Export to text 'separated value' data (*.tab/*.csv)

Parameters

• JSFoundSet foundSet the foundset to export with
• Array dataProviderIds the ids of the dataproviders
• String separator the separator of the data
• Boolean exportHeader true for exporting with the table header, false for not

Returns: String A String containing the exported text data with the specified separator and header (if exportHeader is true).

Sample

//export with ';' separator and header
var dataToBeWritten = plugins.textxport.textExport(forms.form1.foundset,['id','name'],';',true);

---