› Modules and plugins › Export module › CSV File Creation plugin

CSV File Creation plugin

This plugin is used for exporting the CSV file for a batch. It transforms the batch.xml file to a CSV file format acceptable and exports it to the final CSV export folder location configured in the CSV Creation Final Export Folder property. The CSV file is created using the batch.xml file for the document level fields present. If the switch is set to ON, a CSV file for the batch is created.

Configure the plugin

To configure the plugin, expand the Export module and select the CSV File Creation plugin configuration page.

The following table includes the configurable properties available for the CSV File Creation plugin.

Configurable property

Type of value

Value options

Description

CSV Creation Final Export Folder

String path to export folder

Example: C:ephesoft-datacsv-export-folder

Folder in which the created .csv file is exported.

CSV Creation Switch

List of values

  • ON

  • OFF

Determines whether the plugin runs or not. Default OFF.

Steps of execution

  • This plugin works in the export phase of the application when all the processing on the batch has been done and it is ready to be exported.

  • The plugin works to form a CSV file is the plugin switch is ON otherwise no CSV file is created.

  • The plugin uses the batch.xml file to create the CSV file for the batch. It exports the document level fields present in the batch.xml to CSV file.

  • After creation the file is copied to the final CSV Creation Final Export Folder configured.

Dependency

The plugin assumes the extraction for the incoming batch has been done properly and just changes the results of provided batch.xml in a desired format.

Troubleshooting

The following table lists a few common error messages that may occur from a plugin malfunction.

Error message

Possible root cause

CSV File Creation Export Folder value is null/empty from the database. Invalid initializing of properties.

If the configured path is not valid.

Batch Document List is null or empty.

If there are no documents in the batch.