Overview

This plug-in is responsible for saving the data of document level fields for a particular batch instance to the external or same database. It takes the mapping file provided for the plugin and creates a SQL query to insert the mapped document level field into the mapped table.

Configuration

Configurable properties screenshot

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

400px-3.1_BCM_DB_EXPORT_10001

 

Configurable properties

Following are the configurable properties available with the plugin:

 

Configurable property Type of value Value options Description
Database Export Switch List of values ON

OFF
The switch that defines whether this plugin will run or not. Default value is 'OFF'
Database Connection URL String A valid database connection URL. The database connection URL corresponding to the selected driver.
Database Driver List of values net.sourceforge.jtds.jdbc.Driver

com.microsoft.jdbc.sqlserver.SQLServerDriver

com.mysql.jdbc.Driver
Type of driver to be used for database connection.
Database User Name String A valid username value to connect to database SQL account username.
Database Password String A valid password value to connect to database SQL account password.

 

Mapping File

  • Mapping file for this plugin is stored for each batch class at the following path:
    • <SHARED_FOLDER_PATH>\<BATCH_CLASS_IDENTIFIER>\db-export-plugin-mapping\db-export-mapping.properties
  • Its contents should in the following syntax:

 

DB Export mapping syntax for exporting DLF attribute:

DLF||<Document-Type>::<DLF-Name>=<Database-Table-Name>::<Column-Name>||<Optional-Parameter-1>||<Optional-Parameter-2>….||<Optional-Parameter-N>

DB Export mapping syntax for exporting table:

TABLE||<Document-Type>::<Table-Name>::<Column-Name>=<Database-Table-Name>::<Column-Name>||<Optional-Parameter-1>||<Optional-Parameter-2>….||<Optional-Parameter-N>

Optional Parameters:

 

Screen Shot 2014-09-07 at 2.57.57 PM

 

Dependency

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.

Troubleshooting

Following are few common error messages seen due to mal-functioning of the plugin:

 

S no. Error message Possible root cause
1 Error in parsing DB Export Plugin mapping file, FileNotFoundException The "db-export-mapping.properties" file is not located at the "(SHARED_FOLDER_PATH)\(BATCH_CLASS_IDENTIFIER)"
2 Error in parsing DB Export Plugin mapping file, NoSuchElementException One or more properties db-export-mapping.properties" is in incorrect syntax."
3 Conflict in database export. Column names of same database table are referred for same category of fields Two or more Document Level Fields of same Document type are referring to the same column of a database table.

Two or more columns of a same Ephesoft's Table are referring to the same column of database table.
4 Error in initialising Hibernate Connection Database connection settings are invalid.
5 No Field exist with name: Name of the field When there is any field (Document Type/ Document level field/Table/Table Column) in mapping that does not exist.

 

Was this article helpful to you?

wikiadmin