DB Export Configuration

Overview

DB export plugin is responsible for saving the data of document level fields/tables for a particular batch instance to the external or same database.

User can select Export module and navigate to DB Export plugin configuration page as shown below:

$C:\Users\gajendrayadav\Desktop\Screen shots\4.0.0.0_DBExport_10001.jpg$

Following are the configurable properties available with the plugin:

Configurable property

Type of value

Value options

Description

Database Export Switch

List of values

The switch that defines whether this plugin will run or not. Default value is “OFF”

User can map the Document Level Fields with the Table column of a database table to export the document level fields of a batch class.

Upon clicking the ‘DLF Mapping’ button, following UI will be presented:

$C:\Users\gajendrayadav\Desktop\Screen shots\4.0.0.0_DBExport_10010.jpg$

To map the DLFs with the columns of a database table, User can follow the below given steps:

Select a database connection that can be configured from System Config Screen.
On clicking the ‘Add’ button, following UI will be presented to map the DLFs with columns of database table:

$C:\Users\gajendrayadav\Desktop\Screen shots\4.0.0.0_DBExport_10011.jpg$

On this screen, user can map a DLF with a column of database table of a particular database.

$C:\Users\gajendrayadav\Desktop\Screen shots\4.0.0.0_DBExport_10012.jpg$

User can map the columns of Tables of a batch class with the Table column of a database table to export the tables of a batch class.

Upon clicking the ‘Table Mapping’ button, following UI will be presented:

$C:\Users\gajendrayadav\Desktop\Screen shots\4.0.0.0_DBExport_10018.jpg$

To map the table columns with the columns of a database table, User can follow the below given steps:

Select a database connection that can be configured from System Config Screen.
On clicking the ‘Add’ button, following UI will be presented to map the table columns with columns of database table:

$C:\Users\gajendrayadav\Desktop\Screen shots\4.0.0.0_DBExport_10020.jpg$

On this screen, user can map a Table columns with a columns of database table of a particular database.

$C:\Users\gajendrayadav\Desktop\Screen shots\4.0.0.0_DBExport_10019.jpg$

User can configure some additional parameter with DLF/Table Mapping.

$C:\Users\gajendrayadav\Desktop\Screen shots\4.0.0.0_DBExport_10022.jpg$

User can map additional parameters with column of database Table.

$C:\Users\gajendrayadav\Desktop\Screen shots\4.0.0.0_DBExport_10023.jpg$

The plugin requires the following prerequisites:

Plugin does depend on any other plugin. But desired output comes only when the document level field has some extracted value.
If the “Database Export Switch” is ON, then the mapping provided should be correct. Invalid mapping will result in batch going to error.

*Note: DB Export limited to export of string data type