Transact

  1. Home
  2. Transact
  3. Features and Functions
  4. Administrator Role and Features
  5. Modules and Plugins
  6. Export Module
  7. DB Export Plugin

DB Export Plugin

Available: on-premises, cloud

Introduction

In this document, you will learn how to configure the DB Export plugin in Ephesoft Transact.

The DB Export plugin is responsible for saving the data of the document level fields for a particular batch instance to an external database. It uses a provided mapping file to create a SQL query to insert the mapped document level field into the mapped table.

Prerequisites

To configure and use the DB Export plugin, the following configurations must be in place:

  • You will need a batch class with a document type configured. For detailed steps, refer to Add New Document Type
  • You will need to add the DB_Export plugin to the Export module for the batch class. For more information on managing plugins, refer to Configuring Plugins.
  • The document level field must have some extracted value.
  • A database connection is configured in the System Configuration > Connection Manager.

Configure DB Export Plugin

This section provides information on how to configure the DB Export plugin. This plugin only needs to be configured once per batch class.

To enable the plugin:

  1. From the Batch Class Management screen, open your batch class.
  2. Go to Modules > Export > DB_Export.
  3. Set the Database Export Switch to “ON”.


Figure 1. Plugin Configuration

  1. Click Apply.

Configure DB Export for the Document Type

This section provides information on how to configure DB Export at the document type level. This must be configured multiple times per batch class, depending on how many document types you have.

To configure DB export:

  1. From your batch class, go to Document Types > [your document type] > DB Export Configuration.
  2. Map Document Level Fields.
  3. Map Tables.

Map Document Level Fields

You can map document level fields with the column of a database table to export the document level fields of a batch class.

  1. On the DB Export Configuration screen, select DLF Mapping.

Figure 2. DLF Mapping

  1. Select your database connection from the Connection dropdown.

Note: This connection can be configured in the Connection Manager of System Configuration.

  1. Click Add.

Figure 3. Add DLF Mapping

  1. In the Field Name dropdown, select a document level field.
  2. In the Database Table Name field, enter the appropriate database table name in which the extracted data should be filled.
  3. In the Database Column Name field, enter the appropriate database column name in which the extracted data should be filled.
  4. Map any additional parameters as needed.
  5. Click Apply.

Map Tables

You can export batch class tables by mapping the column of a batch class table with the column of a database table.

  1. In the DB Export Configuration screen, select Table Mappings.

Figure 4. Add Table Mapping

  1. Select your database connection from the Connection dropdown.
  2. Click Add.
  3. Repeat steps 4–6 from the section Map Document Level Fields, above.
  4. In the Columns field, select the table column corresponding to the selected Field Name.
  5. Map any additional parameters as needed.
  6. Click Apply.

Additional Parameters Mapping

Additional parameters are available in the bottom panel of the DB Export Configuration page for a document type. This includes parameters such as batch class ID, document type ID, and description.

Figure 5. Additional Parameters Mapping

Note: Additional Parameters Mapping doesn’t include the option to export the original file name. Exporting the original file name would require a custom script for the Export module.

To concatenate additional parameters:

  1. Select the desired parameters in the Available Parameters column.
  2. Right-click and select Append.

Figure 6. Appending Additional Parameters

The appended fields will appear in the order they were selected.

Was this article helpful to you? Yes No