Ephesoft Reporting

Introduction to Ephesoft Transact Reporting

Document Overview

This document provides a comprehensive reference for reporting operations and capabilities in Ephesoft Transact 4.5.x.x.

Reporting Capabilities

The Ephesoft Transact administrator can generate reports for the following components:

  • Batch execution information
  • Server Status

Reports in Ephesoft Transact are available with the following sub-reports:

  • Dashboard Reports
  • Throughput Reports
  • Advanced Reports — This section of reporting requires an additional license.
  • Analysis Grid

Administrator Options for Reporting

  • Filtering — The administrator can filter reports by multiple parameters, such as:
    • batch class
    • start date of batches
    • end date of the batches
  • Calculation — The administrator can configure reports to be calculated in multiple ways, such as Per Module, Per Batch Class, and so on.
  • Performance — The administrator can track performance metrics in seconds, minutes, or hours.
  • Customization — The administrator can adjust certain reporting functions or settings in the Transact properties files. The general scope of configuration on this level includes the following:
    • enabling or disabling reporting on each server
    • batch processing settings, such as server connection, data storage, encryption, and more
    • multiple cron job settings for specific functions in reports calculations
    • database and data backup operations, data management settings
    • ETL scripts and database settings
  • User Interface — The user interface provides the administrator with report access in a very thorough and clearly organized hierarchy. The following snapshot illustrates the expandable navigation in Transact version 4.5.x.x.

Full Structure of the Reports Module, Administrator > Reports

Accessing Reports

Access reports from either of the following methods:

  • If you have already logged into Ephesoft Transact, expand the navigation pane on the left, then select Administrator > Reports.

Ephesoft Transact Administrator and Operator menus from left-side navigation

  • During initial access to the DCMA home page, navigate to Administrator home screen > Reports

Transact DCMA Home Page — Administrator > Reports

  • Click Reports to display the login screen.

Ephesoft Transact Login Screen

  • Access the Reports home page by entering valid user credentials.

Reports Home

The Reports home page consists of the following:

  • Expandable navigation panel with tree hierarchy on the left
  • Reports display in the main portion of the screen, often with additional tabs

Collapsible Panel for Navigation Tree Hierarchy

The collapsible navigation pane on the left of the Reports page contains Expand All/Collapse All buttons along with the navigation tree hierarchy.

The Expand All/Collapse All button expands and collapses the navigation tree hierarchy respectively.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-3.png

Navigation Pane with Dashboard Reports landing screen — System Health tab

The following snapshot illustrates the fully expanded navigation menu in Ephesoft Transact 4.5.x.x. This example includes Advanced Reports:

Full Structure of the Reports Module, Administrator > Reports

The navigation tree hierarchy contains the following types of reports:

  • Dashboard Reports
  • Throughput Reports
  • Advanced Reports
  • Analysis Grid

There are many Ephesoft report sub-types.

Reports Display Panel

By default, the Dashboard Report is displayed when the user selects or refreshes the Reports page.

Three tabs of Dashboard Reports

Selecting any other type of report from the navigation tree displays the corresponding report.

  • Selecting Throughput Reports displays the Batch Class Throughput Report.
  • Selecting Advanced Reports displays the Document Correction Report.
  • Selecting Analysis Grid displays the Document Correction Analysis Report.

Dashboard Reports

Dashboard Report is the first report displayed to the user when accessing Ephesoft reports.

The Ephesoft Reports Dashboard is an interactive and customizable panel that displays information about the current state of Ephesoft.

The Dashboard report has 3 parts or tabs:

  • System Health
  • System Reporting
  • Batch Processing

System Health

By default, the System Health tab is displayed when viewing the Dashboard Report.

This tab displays date-wise uptime status of Ephesoft server(s) and service(s). By default, information for current date is displayed.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-4.png

Dashboard Reports — System Health tab

Information about the services handled by a particular server is shown just below the main Server Status chart.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-5.png

Dashboard Reports — System Health tab

The following services are monitored by this report:

  • Pick-Up Service
  • License Service
  • Folder Monitor

System Reporting

The System Reporting tab displays the following information, using batches as a parameter:

  • Batches per Status
  • Review Validate Backlog
  • Batches per Priority

Batches per Status

This widget displays a pie chart that lists all batch instances grouped by their status. By default, the pie chart displays data of all batch classes in all possible statuses. The user can modify the widget using 2 parameters:

  • Batch Class — By using the Batch Class drop-down list placed above the pie chart, the user can filter the data to be displayed. By selecting a batch class from the Batch Class drop-down list, the current statuses of batch instances of only the selected batch class are displayed in the pie chart.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-7.png

System Reporting tab — Batch Class dropdown

  • Batch Status legend: The user can select or deselect status from the legend below the pie chart to display information related to the selected statuses and ignore the deselected ones.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-8.png

System Reporting tab — Batch Status legend

On clicking a particular section of the pie chart, the widget displays another pie chart that conveys batches grouped by priority, for the selected batch status.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-9.png

System Reporting tab — clicking the pie chart

Review Validate Backlog

The Review Validate Backlog widget displays the number of batches that are awaiting manual operator input. The number of batch instances in review and validation are sorted according to the time duration they have been in that state.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-10.png

Review Validate Backlog widget

Click a status bar to display details of batches in the corresponding state.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-11.png

Review Validate Backlog widget

Batches per Priority

By default, this widget displays a pie chart listing all batch instances grouped by their priority.

By default, the pie chart displays data of all batch classes in all possible statuses.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-12.png

Batches Per Priority widget

The user can choose to view the information as a bar chart instead of a pie chart by selecting the respective option located above the widget.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-13.png

Batches Per Priority widget — alternate bar chart view

When clicking a particular section of the pie chart, the widget shows another pie chart that displays batches grouped by status, for the selected batch priority.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-14.png

Batches Per Priority widget — batches grouped by status

Batch Processing

The Batch Processing tab displays the following information using number of pages in a batch as a parameter.

  • Pages Processed per Unit Time
  • Pages Processed per Batch Class
  • Average Pages Processed

Pages Processed per Unit Time

This widget displays a line graph depicting the number of pages processed, according to the unit of time that has been selected. The user can modify the widget using 2 parameters:

  • Unit of Time — The user can select one of the following time spans:
    • Date Time
    • Day (Day of the Week)
    • Month (Month of the Year)
    • Year

Note: The page count is cumulative over a period of time for recurring entries. For example, pages processed for the month of January will show pages processed in January 2017 along with January 2018, and so on.

  • Batch Class — By using the Batch Class drop-down list located above the widget, the user can filter the data to be displayed. By selecting a batch class from the Batch Class drop-down list, only information for that selected batch class is displayed in the line graph, to include the total pages of batch instances.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-15.png

Batch Processing widget — Pages Process Per Unit of Time

Pages Processed per Batch Class

The Pages Processed per Batch Class widget is a bar chart that displays the number of pages processed per batch class. A marker line also displays the average number of pages processed by all batch classes.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-16.png

Pages Processed Per Batch Class widget

Average Pages Processed

The Average Pages Processed widget displays the average number of pages processed, according to batch and according to document.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-17.png

Average Pages Processed widget

The user can modify the widget using the following parameter:

  • Batch Class — By using the Batch Class drop-down list placed above the gauges, the user can filter the data to be displayed. By selecting a batch class from the Batch Class drop-down list, the average number of pages of batch instances of only the selected batch class are displayed in the gauges.

Configuring the Dashboard

The Ephesoft Reports Dashboard is flexible and easily customizable. All widgets available in the dashboard are interactive. These widgets can be dragged, dropped, resized, renamed within their respective tabs or be moved across different tabs. All widgets can be added as many times as the user desires. The tabs themselves are also configurable. Tabs can be renamed, deleted and added.

Users can create their own custom widgets and add them onto the Reports Dashboard. Dashboards are saved individually for each Ephesoft user.

The changes a user makes to the Dashboard are saved in Ephesoft so that when the user returns to the Reports Dashboard, the changes are not lost.

Saved Dashboards are stored in the {Ephesoft SharedFolders}/SavedDashboards folder. The location can be configured.

The user can specify a file name to save the state of dashboard in a Lgx file stored at the following location:

  • {Ephesoft-Home}/EphesoftReports/_Definitions/_Reports/Dashboard.Dashboard.lgx

Throughput Reports

Use the Throughput Reports to measure the performance of Ephesoft and its modules. Throughput Reports can be configured using numerous parameters to analyze different aspects of Ephesoft performance.

Throughput Reports Filters

Throughput Reports Filters allow the user to set the parameters that generate reports. Depending on the value selected in filters, the result is maximized or minimized.

The available filters are illustrated and defined as follows:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-18.png

Throughput Reports Filters — drop-down menu options

The following filters are available in Ephesoft Transact:

Filter Name Option Submit Type Description
Start Date Calendar Submit button Start date of the period for which executed batch report has to be generated
End Date Calendar Submit button End date of the period for which executed batch report has to be generated
Unit of Time Per Second

Per Minute

Per Hour

Auto submit The selected unit of time taken to process the batches.

Default Value: Per Minute

Include Operator Time Yes

No

Auto submit Option to select whether to include the operator time to review and validate the documents/pages/batches or not.

Default Value: No

Batch Class Batch Class IDs of all batches accessible to logged in user. Auto submit IDs of the batch classes.

Example: BC1 for Mailroom Automation Template Batch Class. Default Value: All

Chart Type Pie

Bar

Heatmap

Auto submit Chart type to represent the report.

Default Value: Pie

Label Column Batch Class Auto submit
Data Column Batches

Pages

Documents

Auto submit Generates the processed report on the basis of type selected.

Default Value: Batches

Batch Class Throughput

This module generates a report of completed batches, based on the batch class, start date and end date.

The following components are included in the reports display panel for the Batch Class Throughput Report:

  • Throughput Report Filters
  • Report Body (Pie/Bar/Heatmap)
  • Data Grid

Report Body (Pie/Bar/Heatmap)

Reports are displayed as pages processed per batch class and pages processed per unit time per batch. The Week Days Throughput Report contains the following 2 analysis methods:

  • Batches by Batch Class — Pages processed per batch class

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-19.png

Analysis of Batches by Batch Class widget — Pie Chart

  • Batches per Minute by Batch Class — Pages processed per unit time for the batch class.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-20.png

Analysis of Batches per Minutes by Batch Class widget — Pie Chart

By default, this information is displayed as pie chart. The user can change the chart type to bar graph or heatmap as well.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-21.png

Analysis of Batches by Batch Class widget — Bar Chart

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-22.png

Analysis of Batches Per Minute, Analysis of Pages Per Minute by Batch Class widget — Heatmap

Data Grid

The data grid of the Batch Class Throughput Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-23.png

Batch Instance Report Data, Release 4.5.x.x and previous releases

The Batch Instance Report Data grid contains the following columns:

Filter Name Description
Batch Class ID ID of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Batch Instance ID ID assigned to the batch instance
Start Time Date and time when the batch was picked up by Ephesoft for execution
End Time Date and time when the batch was completed
Pages Number of pages present in the batch
Documents Number of documents present in the batch
Execution Time without Operator Duration (Unit of Time) Execution time for each batch
Operator Duration (Unit of Time) Time taken by the operator to review and validate the documents/pages in the batch

Batch Size Throughput

This module generates a report of completed batches, based on the batch class, start date and end date. Reports are displayed as pages processed per batch size and pages processed per unit time per batch size.

The following components are included in the reports display panel for the Batch Size Throughput Report:

  • Throughput Report Filters
  • Report Body (Pie/Bar/Heatmap)
  • Data Grid

Report Body (Pie/Bar/Heatmap)

The Batch Size Throughput Report contains the following 2 analysis methods:

  • Batches by Batch Size — Pages processed per batch size

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-24.png

Analysis of Batches by Batch Size — Pie Chart

  • Batches per Minute by Batch Size — Pages processed per unit time for the batch size

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-25.png

Analysis of Batches Per Minute by Batch Size — Pie Chart

By default, this information is displayed as a pie chart. The user can change the chart type to bar graph or heatmap, as illustrated in the following snapshots:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-26.png

Analysis of Batches by Batch Size — Bar Chart

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-27.png

Analysis of Batches Per Minute — Heatmap

Data Grid

The data grid of the Batch Size Throughput Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-28.png

Batch Instance Report Data

The following columns are present in the Batch Instance Report Data grid:

Filter Name Description
Batch Size The size of the batch
Batch Class ID ID of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Batch Instance ID ID assigned to the batch instance
Start Time Date and time when the batch was picked up by Ephesoft for execution
End Time Date and time when the batch was completed
Pages Number of pages present in the batch
Documents Number of documents present in the batch
Execution Time without Operator Duration (Unit of Time) Execution time for each batch
Operator Duration (Unit of Time) Time taken by the operator to review and validate the documents/pages in the batch

Week Days Throughput

This module generates a report for completed batches, based on the batch class, start date and end date. Reports are displayed as batches processed by day of the week and batches processed per unit time for the day of the week.

The following components are included in the reports display panel for the Week Days Throughput Report.

  • Throughput Report Filters
  • Report Body (Pie/Bar/Heatmap)
  • Data Grid

Report Body (Pie/Bar/Heatmap)

The Week Days Throughput Report contains the following 2 analysis methods:

  • Batches by Day of the Week — Batches processed per weekday

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-29.png

Analysis of Batches by Day of the Week — Pie Chart

  • Batches per Minute by Day of the Week — Batches processed per unit time for the day of the week

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-30.png

Analysis of Batches Per Hour by Day of the Week — Pie Chart

By default, this information is displayed as pie chart. The user can change the chart type to bar graph or heatmap as well.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-31.png

Analysis of Batches by Day of the Week — Bar Chart

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-32.png

Analysis of Batches Per Hour and Pages Per Hour — Heatmap

Data Grid

The data grid of the Week Days Throughput Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-33.png

Batch Instance Report Data

The following columns are present in the Batch Instance Report Data grid:

Filter Name Description
Day of the Week Day of the week on which the batch was executed.
Batch Class ID ID of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Batch Instance ID ID assigned to the batch instance
Start Time Date and time when the batch was picked up by Ephesoft for execution
End Time Date and time when the batch was completed
Pages Number of pages present in the batch
Documents Number of documents present in the batch
Execution Time without Operator Duration (Unit of Time) Execution time for each batch
Operator Duration (Unit of Time) Time taken by the operator to review and validate the documents/pages in the batch

Hourly Throughput

This module generates a report for completed batches, based on batch class, start date and end date. Reports are displayed as pages processed by hour and pages processed per unit time per hour.

The following components are included in the reports display panel for the Hourly Throughput Report:

  • Throughput Report Filters
  • Report Body (Pie/Bar/Heatmap)
  • Data Grid

Report Body (Pie/Bar/Heatmap)

The Hourly Throughput Report contains the following 2 analysis methods:

  • Batches by Hour of the Day — Pages processed per hour

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-34.png

Analysis of Batches by Hour of the Day

  • Batches per Minute by Batch Class — Pages processed per unit time per hour

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-35.png

Analysis of Batches Per Minute by Batch Class — Pie Chart

By default, this information is displayed as pie chart. The user can change the chart type to bar graph or heatmap as well.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-36.png

Analysis of Batches by Hour of the Day— Bar Chart

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-37.png

Analysis of Batches Per Minute and Pages Per Minute by Batch Class — Heatmap

Data Grid

The data grid of the Hourly Throughput Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-38.png

Batch Instance Report Data — data grid

The following columns are present in the Batch Instance Report Data grid:

Filter Name Description
Hour of the Day Hour of the day when the batch was executed.
Batch Class ID ID of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Batch Instance ID ID assigned to the batch instance
Start Time Date and time when the batch was picked up by Ephesoft for execution
End Time Date and time when the batch was completed
Pages Number of pages present in the batch
Documents Number of documents present in the batch
Execution Time without Operator Duration (Unit of Time) Execution time for each batch
Operator Duration (Unit of Time) Time taken by the operator to review and validate the documents/pages in the batch

Time-Based Throughput

This module generates a report for completed batches, based on batch class, start date and end date. Reports are displayed as pages processed by end date and pages processed per unit time by end date on a daily/monthly/quarterly/yearly basis.

The following components are included in the reports display panel for the Time-Based Throughput Report:

  • Throughput Report Filters
  • Report Body (Line/Curved Line/Scatter Plot)
  • Data Grid

Report Body (Line/Curved Line/Scatter Plot)

The Time-Based Throughput Report contains the following 2 analysis methods:

  • Pages by End Date — Pages processed by end date

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-39.png

Analysis of Pages by End Date — Line

  • Pages per Minute by End Date — Pages processed per unit time by end date

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-40.png

Analysis of Pages per Minute by End Date — Line

By default, this information is displayed as line graph. The user can change the chart type to curved line or scatter plot as well.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-41.png

Analysis of Pages by End Date — Curved Line

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-42.png

Pages Per Minute by End Date — Scatter Plot

Data Grid

The data grid of the Time-Based Throughput Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-43.png

The Batch Instance Report Data grid contains the following columns:

Filter Name Description
Batch Class ID ID of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Batch Instance ID ID assigned to the batch instance
Start Time Date and time when the batch was picked up by Ephesoft for execution
End Time Date and time when the batch was completed
Pages Number of pages present in the batch
Documents Number of documents present in the batch
Execution Time without Operator Duration (Unit of Time) Execution time for each batch
Operator Duration (Unit of Time) Time taken by the operator to review and validate the documents/pages in the batch

Monthly Throughput

This module generates a report for completed batches, based on batch class, start date and end date. Reports are displayed as pages processed monthly and pages processed per unit time monthly.

The following components are included in the reports display panel for the Monthly Throughput Report:

  • Throughput Report Filters
  • Report Body (Pie/Bar/Heatmap)
  • Data Grid

Report Body (Pie/Bar/Heatmap)

The Monthly Throughput Report contains the following 2 analysis methods:

  • Batches by Month of the Year — Pages processed per hour

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-44.png

Analysis of Batches by Month of the Year

  • Batches per Minute by Month of the Year — Pages processed per unit time monthly.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-45.png

Analysis of Batches by Month of the Year — Pie Chart layout

By default, this information is displayed as pie chart. The user can change the chart type to bar graph or heatmap as well.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-46.png

Analysis of Batches by Month of the Year — Bar Chart layout

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-47.png

Heatmap Layout

Data Grid

The data grid of the Monthly Throughput Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-48.png

Batch Instance Repot Data — Data Grid

The following columns are present in the Batch Instance Report Data grid:

Filter Name Description
Month of the Year Month in which the batch was executed.
Batch Class ID ID of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Batch Instance ID ID assigned to the batch instance
Start Time Date and time when the batch was picked up by Ephesoft for execution
End Time Date and time when the batch was completed
Pages Number of pages present in the batch
Documents Number of documents present in the batch
Execution Time without Operator Duration (Unit of Time) Execution time for each batch
Operator Duration (Unit of Time) Time taken by the operator to review and validate the documents/pages in the batch

Module Throughput

This module generates a report for completed batches, based on batch class, start date and end date. Reports are displayed as pages processed per module and pages processed per unit time per module.

The following components are included in the reports display panel for the Module Throughput Report.

  • Throughput Report Filters
  • Report Body (Pie/Bar/Heatmap)
  • Data Grid

Module Throughput Report Filters

Module Throughput Reports filters allow the user to specify the parameters to generate reports. Depending on the value selected in filters, the result is maximized or minimized. The available filters are illustrated and defined as follows:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-49.png

Filters for Module Throughput Report

Filter Name Option Submit Type Description
Start Date Calendar Submit button Start date of the period for which the executed batch report has to be generated
End Date Calendar Submit button End date of the period for which the executed batch report has to be generated
Batch Class Batch Class IDs of all batches accessible to logged in user. Auto submit IDs of the batch classes.

Example: BC1 for Mailroom Automation Template Batch Class. Default Value: All

Unit of Time Per Second

Per Minute

Per Hour

Auto submit The selected unit of time taken to process the batches.

Default Value: Per Minute

Chart Type Pie

Bar

Heatmap

Auto submit Chart type to represent the report.

Default Value: Pie

Label Column Module Name Auto submit
Data Column Batches

Pages

Documents

Auto submit Generates the processed report on the basis of type selected.

Default Value: Batches

Report Body (Pie/Bar/Heatmap)

The Module Throughput Report contains the following 2 analysis methods:

  • Batches by Module Name — Pages processed per module.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-50.png

Analysis of Batches by Module Name — Pie Chart

  • Batches per Minute by Module Name — Pages processed per unit time per module.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-51.png

Analysis of Batches by Module Name — Pie Chart

By default, this information is displayed as pie chart. The user can change the chart type to bar graph or heatmap as well.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-52.png

Analysis of Batches by Module Name — Bar Chart

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-53.png

Analysis of Batches by Module Name — Heat Map

Data Grid

The data grid of the Module Throughput Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-54.png

Batch Instance Report Data

The following columns are present in the Batch Instance Report Data grid:

Filter Name Description
Module Name Modules in which batch was executed through its entire execution lifecycle.
Batch Class ID ID of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Batch Instance ID ID assigned to the batch instance
Start Time Date and time when the batch was picked up by Ephesoft for execution
End Time Date and time when the batch was completed
Pages Number of pages present in the batch
Documents Number of documents present in the batch
Execution Time without Operator Duration (Unit of Time) Execution time for each batch

User Throughput

This module generates a user-oriented report for completed batches, based on the time taken by user during review/validation. Batch class, start date, and end date can be used as the filtering parameters.

The following components are included in the reports display panel for the Module Throughput Report:

  • Throughput Report Filters
  • Report Body (Table/Chart/Heatmap)

Filters

User Throughput Reports filters allow the user to specify the parameters to generate reports. Depending on the value selected in filters, the result is maximized or minimized. The available filters are illustrated and defined below:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-55.png

User Operation Report Filters

Filter Name Options
Start Date Calendar
End Date Calendar
Rows Batches

Operations Time

User Effort

Columns Batches

Operations Time

User Effort

Values Average Duration in milliseconds

Average Duration in Seconds

Total Duration in milliseconds

Total Duration in Seconds

Filter Batches

Operations Time

User Effort

View Table

Chart

Heatmap

Report Body

By default, the User Throughput Report is displayed in a tabular format based on the options selected for the various filters.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-56.png

Report Body Table

The user can choose to view the report as a chart and a heatmap as well.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-57.png

Chart Style Selection — Bar Chart

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-58.png

Chart Style Selection — Heatmap

Advanced Reports

Advanced Reports are insightful and highly informative tools that assist administrator users in analyzing and optimizing the parameters used by Ephesoft Transact in the Document Assembly and Extraction modules.

Ephesoft Transact generates reports for batches that have the Review or Validation module present in the workflow. The diagram below illustrates a sample workflow that contains both the Review and Validation modules:

Modules in the Ephesoft Transact Workflow

Advanced Reports aid administrators in achieving the goal of reducing manual data corrections. To do this, the Reporting Tool monitors Ephesoft performance over time and captures information about the correction process. The Reporting tool identifies where potential bottlenecks may occur.

The Reporting tool generates detailed information about the performance of the Ephesoft Document capture system. This tool provides insight into adjustments that the administrator can make to the system’s classification, extraction rules, and thresholds. As a result, the system can be fine-tuned for maximum performance and increased ROI.

Advanced Reports provide an analysis of how correctly and efficiently the Ephesoft Transact workflow classifies documents and performs extraction.

There are 10 Advanced Reports available, which are structured as follows:

  • Document Correction Report
  • Classification Accuracy Report
  • Classification Correction Details Report
  • Separation Accuracy Report
  • Separation Correction Details Report
  • Unnecessary Review Report
  • False Positive Report
  • Extraction Correction Report
  • Field Correction Report
  • Field Correction Details Report

All Advanced Reports can be exported as a PDF or an Excel file.

Advanced Reports | Document Correction Report

Document Correction Reports are top-level reports that provide the user with all document types and the number of manual corrections that the batch instance operator made during the Document Assembly phase. Users can easily identify which document types (if any) require further investigation.

The Document Correction Report allows the user to identify where a specific problem with the document type may have occurred. Examples of possible document type issues include the following:

  • The operator modified the document type during the Classification process (Classification Correction)
  • The operator split or merged different documents (Separation Correction)
  • Operator input was not needed to modify documents in Classification (Unnecessary Review)
  • The operator modified the document type during the Validation process (False Positive)

The following components are included in the reports display panel for the Document Correction Report:

  • Filters
  • Data Grid
  • Report Body
  • Drill Downs and Navigation

Filters

The Document Correction Report filters allow the user to specify the parameters to generate reports. Depending on the value selected in filters, the result is maximized or minimized. The available filters are illustrated and defined as follows:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-60.png

Document Correction Report Filters

Filter Name Options Submit Type Description
Start Date Calendar Submit button Start date of the period for which executed batch report is to be generated.
End Date Calendar Submit button End date of the period for which executed batch report is to be generated
Batch Class All Batch Classes present in Ephesoft Submit button Id of the Batch Class.

Example: BC1 for Mailroom Automation Template Batch Class

Default Value: All

Document Type All Types of Documents defined in each Batch Class Submit button Types of Documents defined in each Batch Class

Default Value: All

Data Grid

The data grid of the Document Correction Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image77.png

Document Correction Data Grid

Column Name Description
Batch Class Id Id of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Document Type Types of documents defined in batch class
Classification Correction Count Number of classification corrections made by the reviewer. Classification correction is the change in document type in the Review module.
Separation Correction Count Number of page separations made by the reviewer. Separation correction is the change in page count due to Split/Merge/Delete.
Unnecessary Review Count Number of unnecessary reviews made by the reviewer. It is the number of document types or pages changed by user during review.
False Positive Count Change of document type during validation when batch did not stop for review, in the Review module.
Total Correction Count The total number of all types of corrections made by the reviewer or validator.

Report Body

The Document Type Vs Correction Count Chart widget is a bar chart that graphically represents the type of correction count made in each document.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image78.png

Document Type vs Correction Count widget — Bar Chart

Navigation and Drilldowns

The Document Correction Report is the default report displayed in Advanced Reports. From this report the user can access the Classification Accuracy Report, the Separation Accuracy Report, the Unnecessary Review Report, and the False Positive Report from the data grid, as well as the displayed chart.

From the Document Correction Report, the user can identify the areas where the issues related to document types are located. Based on this report, it can be noted that unnecessary reviews and false positives are the simplest and most efficient fixes.

Advanced Reports | Classification Accuracy Report

The Classification Accuracy Report is a mid-level report which aggregates corrections made to document types within Classification with respect to all batches run. This gives the user a measure of accuracy for each document type of every batch class.

The following components are included in the reports display panel for the Classification Accuracy Report.

  • Filters
  • Data Grid
  • Report Body
  • Drill Downs and Navigation

Filters

Classification Accuracy Report filters allow the user to specify the parameters to generate reports. Depending on the value selected in filters, the result is maximized or minimized. The available filters are illustrated and defined as follows:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-61.png

Classification Accuracy Report filters

Filter Name Options Submit Type Description
Start Date Calendar Submit button Start date of the period for which executed batch report is to be generated.
End Date Calendar Submit button End date of the period for which executed batch report is to be generated
Batch Class All Batch Classes present in Ephesoft Submit button Id of the Batch Class.

Example: BC1 for Mailroom Automation Template Batch Class

Default Value: All

Document Type All Types of Documents defined in each Batch Class Submit button Types of Documents defined in each Batch Class

Default Value: All

Data Grid

The data grid of the Classification Accuracy Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image80.png

Classification Accuracy Report Data Grid

Column Name Description
Batch Class Id Id of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Document Type Types of documents defined in batch class
Accuracy The accuracy with which each document type of every batch class is classified. It Is measured in percentage.

Report Body

Document Type vs. Accuracy Chart is a bubble chart that graphically represents the percentage of accuracy with which each document type of every batch class in classified. The accuracy percentage is represented in the form a bubble. Size of the bubble indicates the frequency of corrections made by the user.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image82.png

Document Type vs. Accuracy Report

Navigation and Drilldowns

From this report, the user can access the Classification Correction Report from the data grid as well as the displayed chart. The user can also return to the parent report (Document Correction Report) using the link provided on the top left corner of the report.

Advanced Reports | Classification Correction Details Report

The Classification Correction Details Report is a low-level report detailing corrections made to document types within Classification. A classification correction is the result of a change in the document type of documents in Review state by the user.

The following components are included in the reports display panel for the Classification Correction Detail Report.

  • Filters
  • Data Grid
  • Report Body
  • Drill Downs and Navigation

Filters

Classification Correction Details Report filters allow the user to specify the parameters to generate reports. Depending on the value selected in filters, the result is maximized or minimized. The available filters are illustrated and defined as follows:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-62.png

Classification Correction Details Report Filters

Filter Name Options Submit Type Description
Start Date Calendar Submit button Start date of the period for which executed batch report is to be generated.
End Date Calendar Submit button End date of the period for which executed batch report is to be generated
Batch Class All Batch Classes present in Ephesoft Submit button Id of the Batch Class.

Example: BC1 for Mailroom Automation Template Batch Class

Default Value: All

Document Type All Types of Documents defined in each Batch Class Submit button Types of Documents defined in each Batch Class

Default Value: All

Data Grid

The data grid of the Classification Correction Detail Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image84.png

Classification Correction Data Grid

Column Name Description
Batch Class Id Id of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Batch Instance Id Id assigned to each batch instance
Start Date Date when the batch was picked up by Ephesoft for execution
Document Id Id of the document
Old Document Type Document type identified by Ephesoft.
New Document Type New document type assigned by reviewer
Threshold The minimum confidence for the Batch to identified under specified document
Confidence The score with which document is identified by Ephesoft.
Page Count Number of pages in each Document

Navigation and Drilldowns

The user can return to the parent report (Classification Accuracy Report) using the link provided on the top left corner of the report. Utilizing the two lower level reports gives the user an idea on what needs to be changed within Ephesoft configurations.

Advanced Reports | Separation Accuracy Report

The Separation Accuracy Report is a mid-level report which aggregates corrections made to page counts in Review module with respect to all batches run. This gives the user a measure of accuracy for each document type of every batch class.

The following components are included in the reports display panel for the Separation Accuracy Report.

  • Filters
  • Data Grid
  • Report Body
  • Drill Downs and Navigation

Filters

Separation Accuracy Report filters allow the user to specify the parameters to generate reports. Depending on the value selected in filters, the result is maximized or minimized. The available filters are:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-63.png

Separation Accuracy Report filters

Filter Name Options Submit Type Description
Start Date Calendar Submit button Start date of the period for which executed batch report is to be generated.
End Date Calendar Submit button End date of the period for which executed batch report is to be generated
Batch Class All Batch Classes present in Ephesoft Submit button Id of the Batch Class.

Example: BC1 for Mailroom Automation Template Batch Class

Default Value: All

Document Type All Types of Documents defined in each Batch Class Submit button Types of Documents defined in each Batch Class

Default Value: All

Data Grid

The data grid of the Separation Accuracy Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image86.png

Separation Accuracy Report Data Grid

Column Name Description
Batch Class Id Id of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Document Type Types of documents defined in batch class
Separation Accuracy The accuracy with which each page of the document type of every batch class is separated. It Is measured in percentage.

Report Body

The Document Type Vs Accuracy chart is a bubble chart that graphically represents the percentage of accuracy with which each document type of every batch class is separated. The accuracy percentage is represented in the form a bubble. Size of the bubble indicates the frequency of corrections made by user.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image88.png

Document Type vs Accuracy

Navigation and Drilldowns

From this report, the user can access the Separation Correction Report from the data grid as well as the displayed chart. The user can also return to the parent report (Document Correction Report) using the link provided on the top left corner of the report.

Advanced Reports | Separation Correction Details Report

The Separation Correction Details Report is a low-level report detailing corrections made to page counts within Review module. Separation correction is the result of a split, merge, or deletion of a page in a document during Classification. These result in the modification of the number of pages within a document.

The following components are included in the reports display panel for the Separation Correction Details Report.

  • Filters
  • Data Grid
  • Report Body
  • Drill Downs and Navigation

Filters

Separation Correction Details Report filters allow the user to specify the parameters to generate reports. Depending on the value selected in filters, the result is maximized or minimized. The available filters are illustrated and defined as follows:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-64.png

Separation Correction Details Report Filters

Filter Name Options Submit Type Description
Start Date Calendar Submit button Start date of the period for which executed batch report is to be generated.
End Date Calendar Submit button End date of the period for which executed batch report is to be generated
Batch Class All Batch Classes present in Ephesoft Submit button Id of the Batch Class.

Example: BC1 for Mailroom Automation Template Batch Class

Default Value: All

Document Type All Types of Documents defined in each Batch Class Submit button Types of Documents defined in each Batch Class

Default Value: All

Data Grid

The data grid of the Separation Correction Details Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image90.png

Separation Correction Details Report Data Grid

Column Name Description
Batch Class Id Id of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Batch Instance Id Id assigned to each batch instance
Start Date Date when the batch was picked up by Ephesoft for execution
Document Id Id of the document
Document Type The document to which the batch belongs
Old Page Count The number of pages identified by Ephesoft
New Page Count The number of pages identified and updated by the reviewer

Navigation and Drilldowns

The user can return to the parent report (Separation Accuracy Report) using the link provided on the top left corner of the report. Using the two lower-level reports gives the user an idea on what needs to be changed within Ephesoft configurations.

Advanced Reports | False Positive Report

False Positive is the opposite of an Unnecessary Review. It occurs when a document goes through Classification without any issue, such as the document confidence being higher than the threshold for the document type, but the document is changed by an operator in Validation.

This issue is caused by thresholds that are set too low.

By looking at the False Positive Report, the administrator can determine if the threshold should be increased for a specific document type. If the document type for the document was changed even when the confidence was higher than the threshold, it was a false positive.

The following components are included in the reports display panel for the False Positive Report:

  • Filters
  • Data Grid
  • Report Body
  • Drill Downs and Navigation

Filters

False Positive Report filters allow the user to specify the parameters to generate reports. Depending on the value selected in filters, the result is maximized or minimized. The available filters are illustrated and defined as follows:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-65.png

False Positive Report Filters

Filter Name Options Submit Type Description
Start Date Calendar Submit button Start date of the period for which executed batch report is to be generated.
End Date Calendar Submit button End date of the period for which executed batch report is to be generated
Batch Class All Batch Classes present in Ephesoft Submit button Id of the Batch Class.

Example: BC1 for Mailroom Automation Template Batch Class

Default Value: All

Document Type All Types of Documents defined in each Batch Class Submit button Types of Documents defined in each Batch Class

Default Value: All

Data Grid

The data grid of the False Positive Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image95.png

False Positive Report Data Grid

Column Name Description
Batch Class Id Id of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Batch Instance ID Id assigned to each batch instance
Start Date Date when the batch was picked up by Ephesoft for execution
Document Id Id of the document
Old Doc Type Document type identified by Ephesoft
New Doc Type New document type selected by validator
Confidence The score with which document is identified by Ephesoft.
Old Doc Type Threshold Document threshold value of old document type

Report Body

Document Type Vs Confidence Chart is a floating bar chart that graphically represents the confidence and threshold value on Y axis and document type on the X axis; smaller the bar better is the threshold assigned.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image97.png

Document Type vs Confidence

Navigation and Drilldowns

The user can return to the parent report (Document Correction Report) using the link provided on the top left corner of the report.

Advanced Reports | Unnecessary Review Report

A document is labeled as an unnecessary review if it goes into review when the document confidence is below threshold, and the operator simply confirms the auto-classified document type.

This issue is caused by thresholds that are set too high. By looking at the Unnecessary Review Report, the user can determine a more appropriate threshold to be set in Ephesoft Transact.

If batches being reported in the Unnecessary Review Report have a confidence level of around 20.00 and a threshold closer to 50.00, the threshold for the document type in Ephesoft Transact should be decreased for more accurate processing.

The following components are included in the reports display panel for the Unnecessary Review Report:

  • Filters
  • Data Grid
  • Report Body
  • Drill Downs and Navigation

Filters

Unnecessary Review Report filters allow the user to specify the parameters to generate reports. Depending on the value selected in filters, the result is maximized or minimized. The available filters are illustrated and defined as follows:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-66.png

Unnecessary Review Report filters

Filter Name Options Submit Type Description
Start Date Calendar Submit button Start date of the period for which executed batch report is to be generated.
End Date Calendar Submit button End date of the period for which executed batch report is to be generated
Batch Class All Batch Classes present in Ephesoft Submit button Id of the Batch Class.

Example: BC1 for Mailroom Automation Template Batch Class

Default Value: All

Document Type All Types of Documents defined in each Batch Class Submit button Types of Documents defined in each Batch Class

Default Value: All

Data Grid

The data grid of the Unnecessary Review Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image92.png

Unnecessary Review Report Data Grid

Column Name Description
Batch Class Id Id of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

Batch Instance Id Id assigned to each batch instance
Start Date Date when the batch was picked up by Ephesoft for execution
Document Id Id of the document
Document Type Document type identified by Ephesoft.
Confidence The score with which document is identified by Ephesoft.
Threshold The minimum confidence for the batch to identified under specified document

Report Body

Document Type Vs Confidence Chart is a floating bar chart that graphically represents the confidence and threshold value on Y axis and document type on the X axis.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image93.png

Document Type vs Confidence

Navigation and Drilldowns

The user can return to the parent report (Document Correction Report) using the link provided on the top left corner of the report.

Advanced Reports | Extraction Correction Report

Extraction Correction Reports are top level reports that provide the user with all document types and the number of manual corrections during Extraction. Users are able to easily identify which document types (if any) require further investigation.

The following components are included in the reports display panel for the Extraction Correction Report.

  • Filters
  • Data Grid
  • Report Body
  • Drill Downs and Navigation

Filters

Extraction Correction Report filters allow the user to specify the parameters to generate reports. Depending on the value selected in filters, the result is maximized or minimized. The available filters are illustrated and defined as follows:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-67.png

Extraction Correction Report filters

Filter Name Options Submit Type Description
Start Date Calendar Submit button Start date of the period for which executed batch report is to be generated.
End Date Calendar Submit button End date of the period for which executed batch report is to be generated
Batch Class All Batch Classes present in Ephesoft Submit button Id of the Batch Class.

Example: BC1 for Mailroom Automation Template Batch Class

Default Value: All

Document Type All Types of Documents defined in each Batch Class Submit button Types of Documents defined in each Batch Class

Default Value: All

Data Grid

The data grid of the Extraction Correction Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image99.png

Extraction Correction Report

Column Name Description
Batch Class Id Id of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class.

Example: Mailroom Automation

Document Type Document type to which the corrected field belongs to.
Total Field Count Total number of fields for which values are extracted by Ephesoft
Average Confidence Average confidence of all extracted values for all fields.
Field Change Count Sum of field changes for all batches of this field, this document type and this batch class
Change Ratio Change ratio=(field change count/number of fields)

Report Body

Document Type vs Change Ratio chart is a bubble chart that graphically represents the change ratio (that is, the number of fields changed to total fields extracted) in the document type. The size of the bubble indicates the frequency of corrections made by the user.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image101.png

Document Type vs Change Ratio Chart

Navigation and Drilldowns

From this report the user can access the Field Correction Report from the data grid as well as the displayed chart. From the Extraction Correction Report, the user can easily identify where the issues corresponding to document types are located.

Advanced Reports | Field Correction Report

Field Correction Reports are mid-level reports that provide the user with all fields of all document types and the number of manual corrections during Extraction. Users are able to easily identify which fields of document types (if any) require further investigation.

The following components are included in the reports display panel for the Extraction Correction Report:

  • Filters
  • Data Grid
  • Report Body
  • Drill Downs and Navigation

Filters

Extraction Correction Report filters allow the user to specify the parameters to generate reports. Depending on the value selected in filters, the result is maximized or minimized. The available filters are illustrated and defined as follows:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-68.png

Extraction Correction Report Filters

Filter Name Options Submit Type Description
Start Date Calendar Submit button Start date of the period for which executed batch report is to be generated.
End Date Calendar Submit button End date of the period for which executed batch report is to be generated
Batch Class All Batch Classes present in Ephesoft Submit button Id of the Batch Class.

Example: BC1 for Mailroom Automation Template Batch Class

Default Value: All

Document Type All Types of Documents defined in each Batch Class Submit button Types of Documents defined in each Batch Class

Default Value: All

Data Grid

The data grid of the Field Correction Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image103.png

Field Correction Report Data Grid

Column Name Description
Batch Class Id Id of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class.

Example: Mailroom Automation

Document Type Document type to which the corrected field belongs to.
Field Name Field name for which the value is corrected
Total Count Sum of documents with this document type in all batches of this field, this document Type and this batch class
Average Confidence Average confidence of all extracted values for all fields.
Field Change Count Sum of field changes for all batches of this field, this document type and this batch class
Change Ratio Change ratio=(field change count/number of fields)

Charts

Field Name vs Change Ratio chart graphically represents change ratio of the field value vs field. The frequency of corrections done by the user is represented in the form a bubble. Size of the bubble indicates the frequency of corrections made by the user.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image105.png

Field Name vs Change Ratio Chart

Navigation and Drilldowns

From this report the user can access the Field Correction Details Report from the data grid as well as the displayed chart. The user can also return to the parent report (Extraction Correction Report) using the link provided on the top left corner of the report.

From the Extraction Correction Report, the user can easily identify where the issues corresponding to the fields types are located.

Advanced Reports | Field Correction Details Report

Field Correction Details Reports are low-level reports that provide the user with all fields of all document types and the number of manual corrections during Extraction. Users are able to easily identify which fields of document types (if any) require further investigation.

The Field Correction Details Report provides field-by-field information on what field data was extracted from a document (the original value) and what an operator entered during Validation (the corrected value).

The following components are included in the reports display panel for the Field Correction Details Report.

  • Filters
  • Data Grid
  • Report Body
  • Drill Downs and Navigation

Filters

Field Correction Details Report filters allow the user to specify the parameters to generate reports. Depending on the value selected in filters, the result is maximized or minimized. The available filters are illustrated and defined as follows:

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-69.png

Field Correction Details Report Filters

Filter Name Options Submit Type Description
Start Date Calendar Submit button Start date of the period for which executed batch report is to be generated.
End Date Calendar Submit button End date of the period for which executed batch report is to be generated
Batch Class All Batch Classes present in Ephesoft Submit button Id of the Batch Class.

Example: BC1 for Mailroom Automation Template Batch Class

Default Value: All

Document Type All Types of Documents defined in each Batch Class Submit button Types of Documents defined in each Batch Class

Default Value: All

Field Name All field names that can be extracted Submit button Name of the fields that can extracted

Default Value: All

Data Grid

The data grid of the Field Correction Details Report displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image109.png

Field Correction Details Report Data Grid

Column Name Description
Batch Class Id Id of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class.

Example: Mailroom Automation

Batch Instance Id Id assigned to the batch instance
Batch Start Date Date when the batch is picked up by Ephesoft for execution
Document Id Id of the document
Document Type Document type whose field is corrected.
Field Name Field name for which the value is corrected
Field Old Value Value of the field extracted by Ephesoft
Field New Value Value updated by the validator for the field
Extraction Confidence The confidence with which value is extracted

Navigation and Drilldowns

The user can return to the parent report (Field Correction Report) using the link provided on the top left corner of the report. From the Extraction Correction Report, the user can easily identify where the issues corresponding to the field types are located.

Analysis Grid

The Analysis Grid is a dynamic analysis tool that allows users to manipulate Ephesoft data, create charts, change table layouts, and much more, at runtime. Analysis Grid has its own built-in user interface and functionality.

The purpose of the Analysis Grid is to provide a complete package of data analysis capabilities in a single element, providing Ephesoft users with multiple functionalities.

An Analysis Grid consists of separate panels for controls, configuration, tables, charts, and crosstabs, users can manipulate the controls, creating data analysis and presentation on the fly.

Ephesoft provides users with the following Analysis Grids:

  • Document Correction Analysis — This Analysis Grid contains the data with classification (document type) changes made by a user in REVIEW Plugin.
  • Field Correction Analysis — This Analysis Grid contains the document level field data of batches that passed through Validation Module.

The users can create their own charts/widgets from the data in the Grid. These charts can also be added to the Report Dashboard.

Document Correction Analysis Grid

Data Grid

The data grid of the Document Correction Analysis Grid displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image111.png

Data Grid of the Document Correction Analysis Grid

Column Name Description
Batch Class Id Id of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class.

Example: Mailroom Automation

Batch Start Date Date when the batch is picked up by Ephesoft for execution
Document Id Id of the document
Old Document Type Document type identified by Ephesoft
New Document Type Document type corrected by the reviewer
Batch Class Document Type Label Batch Class Id-Document Name

Example:BC1-Us_Invoice

Old Document Confidence Confidence score of old document type
Old Document Confidence Threshold Confidence threshold of old document type
Is Document Type Changed Has the document typed been changed by the reviewer during Review? If yes, then TRUE is displayed else FALSE.
Old Page Count Number of pages separated by Ephesoft
New Page Count Number of pages separated, updated by user
Page Count Change The Confidence with which value is extracted

Field Correction Analysis Grid

Data Grid

The data grid of the Field Correction Analysis Grid displays information about executed batches in tabular format.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image113.png

Data Grid of the Field Correction Analysis Grid

Column Name Description
Batch Class Id Id of the batch class.

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class.

Example: Mailroom Automation

Batch Start Date Date when the batch is picked up by Ephesoft for execution
Document Id Id of the document
Document Type Document type identified by the Ephesoft
Batch Class Document Type Label Batch Class Id-Document Name

Example:BC1-Us_Invoice

Batch Class-Document Type-Field Name Label Batch Class Id-Document Name Type-Field Name

Example:BC1-Us_Invoice-Pick Ticket

Where BC1 is batch class Id

Us_Invoice is document type

Pick Ticket is field name

Field Name The field whose value is extracted
Field Old Value Value of the field extracted by Ephesoft
Field New Value Value updated by the validator
Extraction Confidence The confidence with which value of the key is extracted
Is Field Value Changed? Has the field value been changed by the operator during Validate? If yes then this displays TRUE. Otherwise, this displays FALSE.

Saving Changes in Analysis Grid

  • Lgx file: {Ephesoft-Home}/EphesoftReports/_Definitions/_Processes/AGTasks.lgx

This file defines the tasks to save Document Correction Analysis Grid and Field Correction analysis grid. It defines the folder path and file name to save the analysis grid.

<Procedure Type=”SaveAnalysisGrid” AnalysisGridID=”documentCorrectionAnalysisGrid” Filename=”D:\Ephesoft\SharedFolders\SavedAnalysisGrid\Document_Correction_Analysis_Grid_@Request.userName~.xml” ID=”procSaveDocumentCorrectionAnalysisGrid” />

<Procedure Type=”SaveAnalysisGrid” AnalysisGridID=”fieldCorrectionAnalysisGrid” Filename=”D:\Ephesoft\SharedFolders\SavedAnalysisGrid\Field_Correction_Analysis_Grid_@Request.userName~.xml” ID=”procSaveFieldCorrectionAnalysisGrid” />

Interaction with Analysis Grid

The user has the following options to interact with the Analysis Grid.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-70.png

Analysis Grid Controls

Refresh

Using this option, the user can refresh the grid data from the data source while maintaining any customizations made during this session

Save

Using this option, the user can save the Analysis Grid customization to a file onto the disk so that they may be recalled later in a different session

Restore

Using this option, the user can restore and load the saved grid customizations.

Reset

Using this option, users can clear the settings that are automatically maintained during their sessions. This function resets the Analysis Grid back to original state provided by Ephesoft.

Print

Using this option, the user can print the Analysis Grid.

Export Options

The user has the following options to export the Analysis Grid.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-71.png

Analysis Grid Export Options

  • Excel — Using this option, the user can export the data in .xls format. Maximum 10000 rows can be exported.
  • PDF — Using this option, the user can export the data in .pdf format. Maximum 10000 rows can be exported.
  • Add to Dashboard — Using this option, the user can export the charts created by Analysis Grid to Reports Dashboard.

Functions

The user has the following options to control to the data displayed in the Analysis Grid.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-72.png

Field Correction Data Control Options

  • Columns — Using this option, the user can select the columns that are to be displayed in the data grid.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-73.png

Field Correction Data — Columns

  • Formula — Using this option, the user can introduce any number of custom columns that are a result of a set of operations defined as the “Formula”.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-74.png

Field Correction Data — Formula

  • Sort — Using this option, the user can define the order of appearance and sorting direction of columns that appear in the data grid.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-75.png

Field Correction Data — Sort

  • Filter — Using this option, the user can filter rows based on a specific filter.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-76.png

Field Correction Data — Filter

  • Group — Using this option, the user can group rows based on a specific parameter.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-77.png

Field Correction Data — Group

  • Aggregate — Using this option, the user can aggregate rows based on a specific parameter.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-78.png

Field Correction Data — Aggregate

  • Chart — Using this option, the user can choose the type of charts/gauges to display the data.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-79.png

Field Correction Data — Chart

  • Crosstab — Using this option, the user can pivot and summarize by rows and columns.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-80.png

Field Correction Data — Crosstab

  • Paging — Using this option, the user can set the number of rows to be displayed per page.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-81.png

Field Correction Data — Paging

Custom Reports

Third party Report Integration with Ephesoft

The user can replace Ephesoft Reports and use their own Reports UI by replacing the Reports.html file located at {Ephesoft Installation Directory}\Application\* with their custom report’s HTML file.

To display the new Reports page instead of default Reports HTML, the user must rename the HTML file as Reports.html and place it at the following location:

  • {Ephesoft Installation Directory}\Application\*

C:\Users\anika2078\Desktop\CustomExternal.png

My custom reports example

Custom Reports with Ephesoft Reports

Users have the option to integrate their custom Reports with Ephesoft Reports using the Advanced Reports license with the Advanced Reports switch set to ON.

Custom Report

Configuration of Custom Report Context

Context Loading of custom reports is configured by adding context path configuration on server.xml in the following location:

  • {Ephesoft Installation Directory}\JavaAppServer\conf\

The user needs to add the following under the Host tag:

  • <Context path=”/Custom_Reports_Context” docBase=”[system_directory_path]\\Custom_Reports_Folder_Name” privileged=”false”/>

The user can use an external server that loads the context of their custom reports and ensure the context is preloaded when integrated custom Reports are accessed.

Either of above must be executed on all servers in a multi-server environment.

Integration of Custom Report

The user can integrate the custom report files within Ephesoft Reports by using certain insert commands in Ephesoft database.

The tables involved are: reports_folder, report and sub_report.

Inserting Custom Report Context Path

Use the following commands to insert the Custom Report context path, if it differs from the existing report contexts in the reports_folder table:

MSSQL MariaDB
insert into reports_folder (creation_date, last_modified, host_uri_path, default_context_path) values (GETDATE(), GETDATE(), ‘<hostname:port_number>’, ‘/ Context_Path_of_folder_containing_custom_reports’); insert into reports_folder (creation_date, last_modified, host_uri_path, default_context_path) values (NOW(), NOW(), ‘<hostname:port_number>’, ‘/Context_Path_of_folder_containing_custom_reports’);

Columns in Data Table

Column Name Description
host_uri_path Null if the custom report is deployed using Ephesoft’s JavaAppServer Context path loading. The reports will automatically take hostname as the system name and port number as the port number used by the Ephesoft Transact application.

Otherwise, this is a composed host_uri_path with host server name and port number.

Default_context_path Common URL path of reports those are part of a custom report context.

For example: /EphesoftReports/rdPage.aspx?rdReport=

Inserting Custom Report Parent Folder Name

Use the following commands to insert the Custom Report parent folder name in the report table:

MSSQL MariaDB
insert into report (creation_date, last_modified, report_name, default_folder_path, parent_folder_id) values (GETDATE(), GETDATE(), ‘Report_UI_display_name’, ‘Report_folder_name’, (select id from reports_folder where default_context_path = ‘parent_default_context_path’)); insert into report (creation_date, last_modified, report_name, default_folder_path, parent_folder_id) values (NOW(), NOW(),Report_UI_display_name ‘, ‘Report_folder_name’, (select id from reports_folder where default_context_path = “‘parent_default_context_path “));

Columns in Data Table

Column Name Description
Report_name UI display name of Report parent folder name.
default_folder_path Name of a parent folder containing reports. Usually a custom report, such as SubReport, with the folder Report is named as Report.SubReport. Therefore, default_folder_path would be Report in this example.
Parent_folder_id Refers to a context path entry in the reports_folder table.

Multiple entries in this table may point to one report context path.

Inserting Custom Report’s Name

Use the following commands to insert the Custom Report’s name, in the sub_report table.

MSSQL MariaDB
insert into sub_report (creation_date, last_modified, report_name, default_report_path, parent_folder_id, parent_id) values (GETDATE(), GETDATE(), ‘False Positive’, ‘False_Positive_Report’, (select id from report where default_folder_path = ‘Advanced_Reports’), (select id from sub_report where default_report_path = ‘Document_Correction_Report’)); insert into sub_report (creation_date, last_modified, report_name, default_report_path, parent_folder_id, parent_id) values (NOW(), NOW(), ‘Unnecessary Review’, ‘Unnecessary_Review_Report’, (select id from report where default_folder_path = “Advanced_Reports”), (select id from sub_report sr where default_report_path = “Document_Correction_Report”));

Columns in Data Table

Column Name Description
Report_name UI display name of Report name.
default_ report _path Name of a report in its filename. Usually a custom report, such as SubReport, with the folder Report is named as Report.SubReport. Therefore, the default_report_path would be SubReport in this example.
Parent_folder_id Refers to parent folder entry in report table.
Parent_id Defines the level of report in hierarchy within a report folder. Set to null if it a direct child of a parent folder in report table else if it is a child of a sub_report in hierarchy, it refers to a sub_report in the sub_report table.

For example: The Document Correction Report has parent_id as null because it a direct child of Advanced Reports, but the False Positive Report has parent_id as the ID of the Document Correction Report.

Multiple entries in this table may point to one report folder.

Multiple entries in this table may be children of one sub_report.

Additional Reporting Features and Operations

This section provides the following additional information about Ephesoft Transact Reports:

Configuring Reports

Ephesoft Transact allows administrators to adjust system-level configurations for Ephesoft reports, as follows:

Properties, .lgx and Script Files

Administrators may wish to adjust the Ephesoft Transact properties files, .lgx file or ETL scripts for certain report functions and parameters. Possible configurations include the following:

  • etl-variables.properties
  • dcma-reporting.properties
  • application.properties
  • dcma-backup-service.properties
  • _Settings.lgx
  • ETL scripts

Property File: {Ephesoft-Home}/WEB-INF/classes/META-INF/dcma- reporting/etl-variables.properties

This property file needs to be configured for connecting to the report database. By default, it is configured to point to the report database created by Ephesoft. If the administrator wishes to use a different database, this property file needs to be configured accordingly:

All properties are of type string.

Configurable Property Value Option Description
reporting.driverClassName For MySQL: com.mysql.jdbc.Driver

For MSSQL: jdbc:jtds:sqlserver://localhost; databaseName=report; user=<databaseUsername>; password=<databasePassword>

Driver class for database connection.

Example: for MySQL, it should be set to com.mysql.jdbc.Driver

reporting.dialect NA Dialects used by hibernate to use with database.

Example: org.hibernate.dialect.MySQL5InnoDBDialect

reportdata.path NA Path to the folder containing files for all executed batches.

Example: D:\\Ephesoft\\SharedFolders/report-data

Ephesoft.loginUserName NA This property is used to decrypt report data for encrypted Batches. Please enter SuperUser Name. If encryption of property file values is enabled, this value should also be encrypted.
Ephesoft.loginPassword NA This property is used to decrypt report data for encrypted Batches. Please enter SuperUser Password. If encryption of property file values is enabled, this value should also be encrypted.

Property file: {Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-reporting/dcma-reporting.properties

Configurable Property Type of Value Value Option Description
dcma.report.dashboard.cronExpression Cronjob Expression NA Frequency with which Report Dashboard data and Throughput Report data is refreshed. Recommended value: “0 0/15 * ? * *” (Every 15 minutes)
dcma.report.dashboard.server
Status.cronExpression
Cronjob Expression NA Frequency with which Server Status data is refreshed. Recommended value: “0 0/1 * ? * *” (Every minute)
dcma.report.advanced.cronExpression Cronjob Expression NA Frequency with which Report Dashboard data is refreshed. Recommended value: “0 0 0/12 ? * *” (Every 12 hours)
dcma.report.cleanup.cronExpression Cronjob Expression NA This cron expression governs the time period with which Batches will be cleaned from Ephesoft. Any batch instance for which all three Reports have been generated, will be cleaned up when the cron triggers. (Report Data Folder, Database, Activiti Tables)
application.last.version DO NOT alter this property. This property is managed by Ephesoft to govern the upgrade status of Reports database. As an indicator, the presence of a Dollar sign($) before the application version confirms that upgrade process completed successfully

Property file: {Ephesoft-Home}/WEB-INF/classes/META-INF/application.properties

Configurable Property Type of Value Value Option Description
enable.reporting String True

False

Whether back up report-data files would be created.

Property file: {Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-util/dcma-backup-service.properties

Configurable Property Type of Value Value Option Description
backup.report_folder String NA Path to the folder containing back up files for all executed plugins for batches.

Example: C:\\Ephesoft\\SharedFolders/report-data

Lgx file: {Ephesoft-Home}/EphesoftReports/_Definitions/_Settings.lgx

This file contains connection details to connect with the existing report database and the error location path. The report database can either be in MariaDB or SQLServer. Follow these steps to configure this file:

  • To establish the connection, define the following parameters:
    • Connection Id
    • Type (SQL Server or MariaDB)
    • Port Number
    • Username
    • Password
    • Database name
    • Server name
  • Specify the error location path as follows:
    • {Ephesoft-Home}/EphesoftReports/logs/dcma-report.log

ETL Scripts: ETL Scripts (running in the background to process data) are stored in the following locations:

  • {Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-reporting/Dashboard
  • {Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-reporting/Standard
  • {Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-reporting/Advanced

Scripts must be switched if the administrator needs to change the Reporting Database from MS SQL to MariaDB, or vice versa.

The ETL scripts for each respective database are at the following locations on the Transact server:

  • MS SQL — {Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-reporting/MSSQL
  • MariaDB — {Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-reporting/MariaDB

Report Database Creation — report_create.sql

The administrator can create the Reports database on MS SQL or MariaDB using the report_create.sql file.

  • Location of report_create.sql:
    • For creating the Reports database for MSSQL: {Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-reporting/MSSQL/report_create.sql
    • For creating the Reports database for MariaDB: {Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-reporting/MariaDB/report_create.sql

Cron Job for Advanced Reporting

In Ephesoft Transact releases prior to Release 4.5.x.x, the cron jobs for Dashboard and Advanced reporting coincided. This could increase the CPU consumption for such software releases.

  • The Dashboard reporting job was performed every 15 minutes, while the Advanced Reporting job was executed every 6 hours.
  • Therefore, every 6 hours, both jobs would run simultaneously, and there could be a noticeable reduction of system efficiency.

In Ephesoft Transact Release 4.5.0.0, the cron job for Advanced Reporting has been readjusted so that it never overlaps with the Dashboard reporting job. In Ephesoft Transact 4.5.0.0 and later releases, this is set to 6 hours and 5 minutes in the dcma-reporting.properties file, at the following location:

{Ephesoft Installation Directory}\Application\WEB-INF\classes\META-INF\dcma-reporting

The cron job will run 5 minutes after the Dashboard reporting job.

https://wikidev.ephesoft.com/wp-content/uploads/2018/03/word-image-91.png

dcma-reporting Folder

https://wikidev.ephesoft.com/wp-content/uploads/2018/03/word-image-92.png

dcma-reporting.properties File

Data Archival Scripts for Advanced Reports

Overview

This topic describes how to manually acquire scripts for Archiving Data from advanced reports. This can be done to improve performance of ETL scripts when a large amount of data is accumulated in database tables.

Required Configuration

There are 2 scripts provided below, based on whether the customer database is SQL Server or MariaDB. In both cases, the user must replace the following placeholders with values from their database:

  • @@ARCHIVE_REPORT_DB_NAME@@: Name of the Archive Database that will be created when script is run
  • @@REPORT_DB_NAME@@: Name of the current Reports database that is used by Ephesoft

These scripts will need root/administrator access because a new Database must be created.

Archival Scripts — MariaDB

CREATE DATABASE IF NOT EXISTS `@@ARCHIVE_REPORT_DB_NAME@@` /*!40100 DEFAULT CHARACTER SET utf8 */;

USE `@@ARCHIVE_REPORT_DB_NAME@@`;

— Table structure for table `global_data`

CREATE TABLE if not exists global_data (

id bigint(20) NOT NULL ,

batch_class_id varchar(255) NOT NULL,

batch_class_name varchar(255) NULL,

batch_id varchar(255) NOT NULL,

batch_start_date datetime NULL,

start_date date NOT NULL,

document_id varchar(255) NOT NULL,

is_reviewed bit(1) NOT NULL,

old_doc_type varchar(255) NULL,

new_doc_type varchar(255) NULL,

document_type_label varchar(280) NULL,

is_doc_type_change bit(1) NULL,

confidence decimal(10,2) NULL,

confidence_threshold decimal(10,2) NULL,

old_page_count int NULL,

new_page_count int NULL,

page_count_change int NULL,

is_doc_type_change_text varchar(20) NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

— Table structure for table `field_details`

CREATE TABLE if not exists field_details (

id bigint(20) NOT NULL ,

batch_class_id varchar(255) NOT NULL,

batch_class_name varchar(255) NULL,

batch_id varchar(255) NOT NULL,

batch_start_date datetime NULL,

start_date date NOT NULL,

document_id varchar(255) NOT NULL,

document_type varchar(255) NULL,

document_type_label varchar(280) NULL,

field_type_label varchar(550) NULL,

field_name varchar (255) NULL,

field_old_value varchar(700) NULL,

field_new_value varchar(700) NULL,

confidence decimal(10,2) NULL,

isFieldChange bit(1) NULL,

is_field_change_text varchar(20) NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

— Table structure for table `field_correction_details`

CREATE TABLE if not exists field_correction_details (

id bigint(20) NOT NULL ,

batch_class_id varchar(255) NOT NULL,

batch_class_name varchar(255) NULL,

batch_id varchar(255) NOT NULL,

batch_start_date datetime NULL,

start_date date NOT NULL,

document_id varchar(255) NOT NULL,

document_type varchar(255) NULL,

field_name varchar (255) NULL,

field_old_value varchar (700) NULL,

field_new_value varchar (700) NULL,

confidence decimal (10,2) NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

— Table structure for table `field_correction`

CREATE TABLE if not exists field_correction(

id bigint(20) NOT NULL ,

batch_class_id varchar(255) NOT NULL,

batch_class_name varchar(255) NULL,

batch_id varchar(255) NOT NULL,

batch_start_date datetime NULL,

start_date date NOT NULL,

document_type varchar(255) NULL,

field_type_label varchar(550) NULL,

field_name varchar (255) NULL,

number_of_documents int NULL,

average_confidence decimal (10,2) NULL,

weighted_confidence decimal (10,2) NULL,

field_change_count int NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

— Table structure for table `extraction_correction`

CREATE TABLE if not exists extraction_correction(

id bigint(20) NOT NULL ,

batch_class_id varchar(255) NOT NULL,

batch_class_name varchar(255) NULL,

batch_id varchar(255) NOT NULL,

batch_start_date datetime NULL,

start_date date NOT NULL,

document_type varchar(255) NULL,

document_type_label varchar(280) NULL,

number_of_fields int NULL,

average_confidence decimal (10,2) NULL,

weighted_confidence decimal (10,2) NULL,

field_change_count int NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

— Table structure for table `classification_correction`

CREATE TABLE if not exists classification_correction(

id bigint(20) NOT NULL ,

batch_class_id varchar(255) NOT NULL,

batch_class_name varchar(255) NULL,

batch_id varchar(255) NOT NULL,

batch_start_date datetime NULL,

start_date date NOT NULL,

document_id varchar(255) NOT NULL,

old_doc_type varchar(255) NULL,

new_doc_type varchar(255) NULL,

confidence decimal (10,2) NULL,

confidence_threshold decimal (10,2) NULL,

page_count int NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

— Table structure for table `classification_correction_accuracy`

CREATE TABLE if not exists classification_correction_accuracy(

id bigint(20) NOT NULL ,

batch_class_id varchar(255) NOT NULL,

batch_class_name varchar(255) NULL,

batch_id varchar(255) NOT NULL,

batch_start_date datetime NULL,

start_date date NOT NULL,

document_type varchar(255) NULL,

document_type_label varchar(280) NULL,

page_count int NULL,

correction_page_count int NULL,

correct_classification_page_count int NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

— Table structure for table `seperation_correction`

CREATE TABLE if not exists seperation_correction(

id bigint(20) NOT NULL ,

batch_class_id varchar(255) NOT NULL,

batch_class_name varchar(255) NULL,

batch_id varchar(255) NOT NULL,

batch_start_date datetime NULL,

start_date date NOT NULL,

document_id varchar(255) NOT NULL,

document_type varchar(255) NULL,

old_page_count int NULL,

new_page_count int NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

— Table structure for table `seperation_correction_accuracy`

CREATE TABLE if not exists seperation_correction_accuracy(

id bigint(20) NOT NULL ,

batch_class_id varchar(255) NOT NULL,

batch_class_name varchar(255) NULL,

batch_id varchar(255) NOT NULL,

batch_start_date datetime NULL,

start_date date NOT NULL,

document_type varchar(255) NULL,

document_type_label varchar(280) NULL,

page_count int NULL,

correction_page_count int NULL,

correct_seperation_page_count int NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

— Table structure for table `unnecessary_review`

CREATE TABLE if not exists unnecessary_review(

id bigint(20) NOT NULL ,

batch_class_id varchar(255) NOT NULL,

batch_class_name varchar(255) NULL,

batch_id varchar(255) NOT NULL,

batch_start_date datetime NULL,

start_date date NULL,

document_id varchar(255) NOT NULL,

document_type varchar(255) NULL,

document_type_label varchar(280) NULL,

confidence decimal (10,2) NULL,

confidence_threshold decimal (10,2) NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

— Table structure for table `false_positive`

CREATE TABLE if not exists false_positive(

id bigint(20) NOT NULL ,

batch_class_id varchar(255) NOT NULL,

batch_class_name varchar(255) NULL,

batch_id varchar(255) NOT NULL,

batch_start_date datetime NULL,

start_date date NOT NULL,

document_id varchar(255) NOT NULL,

old_doc_type varchar(255) NULL,

new_doc_type varchar(255) NULL,

document_type_label varchar(280) NULL,

confidence decimal (10,2) NULL,

confidence_threshold decimal (10,2) NULL

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

— Table structure for table `document_correction`

CREATE TABLE if not exists document_correction(

id bigint(20) NOT NULL ,

batch_class_id varchar(255) NOT NULL,

batch_class_name varchar(255) NULL,

batch_id varchar(255) NOT NULL,

batch_start_date datetime NULL,

start_date date NOT NULL,

document_type varchar (255) NULL,

document_type_label varchar(280) NULL,

classification_correction_count bigint NULL DEFAULT 0,

seperation_correction_count bigint NULL DEFAULT 0,

unnecessary_review_count bigint NULL DEFAULT 0,

false_positive_count bigint NULL DEFAULT 0,

total_correction_count bigint NULL DEFAULT 0

) ENGINE=InnoDB DEFAULT CHARSET=latin1;

insert into @@ARCHIVE_REPORT_DB_NAME@@.document_correction select * from @@REPORT_DB_NAME@@.document_correction;

insert into @@ARCHIVE_REPORT_DB_NAME@@.false_positive select * from @@REPORT_DB_NAME@@.false_positive;

insert into @@ARCHIVE_REPORT_DB_NAME@@.unnecessary_review select * from @@REPORT_DB_NAME@@.unnecessary_review;

insert into @@ARCHIVE_REPORT_DB_NAME@@.seperation_correction_accuracy select * from @@REPORT_DB_NAME@@.seperation_correction_accuracy;

insert into @@ARCHIVE_REPORT_DB_NAME@@.seperation_correction select * from @@REPORT_DB_NAME@@.seperation_correction;

insert into @@ARCHIVE_REPORT_DB_NAME@@.classification_correction_accuracy select * from @@REPORT_DB_NAME@@.classification_correction_accuracy;

insert into @@ARCHIVE_REPORT_DB_NAME@@.classification_correction select * from @@REPORT_DB_NAME@@.classification_correction;

insert into @@ARCHIVE_REPORT_DB_NAME@@.extraction_correction select * from @@REPORT_DB_NAME@@.extraction_correction;

insert into @@ARCHIVE_REPORT_DB_NAME@@.field_correction select * from @@REPORT_DB_NAME@@.field_correction;

insert into @@ARCHIVE_REPORT_DB_NAME@@.field_correction_details select * from @@REPORT_DB_NAME@@.field_correction_details;

insert into @@ARCHIVE_REPORT_DB_NAME@@.field_details select * from @@REPORT_DB_NAME@@.field_details;

insert into @@ARCHIVE_REPORT_DB_NAME@@.global_data select * from @@REPORT_DB_NAME@@.global_data;

truncate table @@REPORT_DB_NAME@@.document_correction;

truncate table @@REPORT_DB_NAME@@.false_positive;

truncate table @@REPORT_DB_NAME@@.unnecessary_review;

truncate table @@REPORT_DB_NAME@@.seperation_correction_accuracy;

truncate table @@REPORT_DB_NAME@@.seperation_correction;

truncate table @@REPORT_DB_NAME@@.classification_correction_accuracy;

truncate table @@REPORT_DB_NAME@@.classification_correction;

truncate table @@REPORT_DB_NAME@@.extraction_correction;

truncate table @@REPORT_DB_NAME@@.field_correction;

truncate table @@REPORT_DB_NAME@@.field_correction_details;

truncate table @@REPORT_DB_NAME@@.field_details;

truncate table @@REPORT_DB_NAME@@.global_data;

Archival Scripts — MSSQL Server

IF NOT EXISTS (SELECT name FROM master.dbo.sysdatabases WHERE name = ‘@@ARCHIVE_REPORT_DB_NAME@@’)

Begin

CREATE Database [@@ARCHIVE_REPORT_DB_NAME@@];

End

GO

USE [@@ARCHIVE_REPORT_DB_NAME@@]

GO

/****** Object: Table [dbo].[global_data] Script Date: 01/13/2015 14:42:56 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

SET ANSI_PADDING ON

GO

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[global_data]’) AND type in (N’U’))

BEGIN

CREATE TABLE [dbo].[global_data](

[id] [bigint] NOT NULL,

[batch_class_id] [varchar](255) NOT NULL,

[batch_class_name] [varchar](255) NULL,

[batch_id] [varchar](255) NOT NULL,

[batch_start_date] [datetime] NULL,

[start_date] [date] NOT NULL,

[document_id] [varchar](255) NOT NULL,

[is_reviewed] [bit] NOT NULL,

[old_doc_type] [varchar](255) NULL,

[new_doc_type] [varchar](255) NULL,

[document_type_label] [varchar](280) NULL,

[is_doc_type_change] [bit] NULL,

[confidence] [decimal] (10,2) NULL,

[confidence_threshold] [decimal] (10,2) NULL,

[old_page_count] [int] NULL,

[new_page_count] [int] NULL,

[page_count_change] [int] NULL,

is_doc_type_change_text varchar(20) NULL)

END

GO

SET ANSI_PADDING OFF

GO

IF NOT EXISTS (SELECT * FROM ::fn_listextendedproperty(N’MS_SSMA_SOURCE’ , N’SCHEMA’,N’dbo’, N’TABLE’,N’global_data’, NULL,NULL))

EXEC sys.sp_addextendedproperty @name=N’MS_SSMA_SOURCE’, @value=N’reporting.global_data’ , @level0type=N’SCHEMA’,@level0name=N’dbo’, @level1type=N’TABLE’,@level1name=N’global_data’

GO

/****** Object: Table [dbo].[field_details] Script Date: 01/13/2015 14:42:56 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

SET ANSI_PADDING ON

GO

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[field_details]’) AND type in (N’U’))

BEGIN

CREATE TABLE [dbo].[field_details](

[id] [bigint] NOT NULL,

[batch_class_id] [varchar](255) NOT NULL,

[batch_class_name] [varchar](255) NULL,

[batch_id] [varchar](255) NOT NULL,

[batch_start_date] [datetime] NULL,

[start_date] [date] NOT NULL,

[document_id] [varchar](255) NOT NULL,

[document_type] [varchar](255) NULL,

[document_type_label] [varchar](280) NULL,

[field_type_label] [varchar](550) NULL,

[field_name] [varchar] (255) NULL,

[field_old_value] [varchar] (700) NULL,

[field_new_value] [varchar] (700) NULL,

[confidence] [decimal] (10,2) NULL,

[isFieldChange] [bit] NULL,

[is_field_change_text] [varchar] (20) NULL)

END

GO

SET ANSI_PADDING OFF

GO

IF NOT EXISTS (SELECT * FROM ::fn_listextendedproperty(N’MS_SSMA_SOURCE’ , N’SCHEMA’,N’dbo’, N’TABLE’,N’field_details’, NULL,NULL))

EXEC sys.sp_addextendedproperty @name=N’MS_SSMA_SOURCE’, @value=N’reporting.field_details’ , @level0type=N’SCHEMA’,@level0name=N’dbo’, @level1type=N’TABLE’,@level1name=N’field_details’

GO

/****** Object: Table [dbo].[field_correction_details] Script Date: 01/13/2015 14:42:56 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

SET ANSI_PADDING ON

GO

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[field_correction_details]’) AND type in (N’U’))

BEGIN

CREATE TABLE [dbo].[field_correction_details](

[id] [bigint] NOT NULL,

[batch_class_id] [varchar](255) NOT NULL,

[batch_class_name] [varchar](255) NULL,

[batch_id] [varchar](255) NOT NULL,

[batch_start_date] [datetime] NULL,

[start_date] [date] NOT NULL,

[document_id] [varchar](255) NOT NULL,

[document_type] [varchar](255) NULL,

[field_name] [varchar] (255) NULL,

[field_old_value] [varchar] (700) NULL,

[field_new_value] [varchar] (700) NULL,

[confidence] [decimal] (10,2) NULL)

END

GO

SET ANSI_PADDING OFF

GO

IF NOT EXISTS (SELECT * FROM ::fn_listextendedproperty(N’MS_SSMA_SOURCE’ , N’SCHEMA’,N’dbo’, N’TABLE’,N’field_correction_details’, NULL,NULL))

EXEC sys.sp_addextendedproperty @name=N’MS_SSMA_SOURCE’, @value=N’reporting.field_correction_details’ , @level0type=N’SCHEMA’,@level0name=N’dbo’, @level1type=N’TABLE’,@level1name=N’field_correction_details’

GO

/****** Object: Table [dbo].[field_correction] Script Date: 01/13/2015 14:42:56 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

SET ANSI_PADDING ON

GO

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[field_correction]’) AND type in (N’U’))

BEGIN

CREATE TABLE [dbo].[field_correction](

[id] [bigint] NOT NULL,

[batch_class_id] [varchar](255) NOT NULL,

[batch_class_name] [varchar](255) NULL,

[batch_id] [varchar](255) NOT NULL,

[batch_start_date] [datetime] NULL,

[start_date] [date] NOT NULL,

[document_type] [varchar](255) NULL,

[field_type_label] [varchar](550) NULL,

[field_name] [varchar] (255) NULL,

[number_of_documents] [int] NULL,

[average_confidence] [decimal] (10,2) NULL,

[weighted_confidence] [decimal] (10,2) NULL,

[field_change_count] [int] NULL)

END

GO

SET ANSI_PADDING OFF

GO

IF NOT EXISTS (SELECT * FROM ::fn_listextendedproperty(N’MS_SSMA_SOURCE’ , N’SCHEMA’,N’dbo’, N’TABLE’,N’field_correction’, NULL,NULL))

EXEC sys.sp_addextendedproperty @name=N’MS_SSMA_SOURCE’, @value=N’reporting.field_correction’ , @level0type=N’SCHEMA’,@level0name=N’dbo’, @level1type=N’TABLE’,@level1name=N’field_correction’

GO

/****** Object: Table [dbo].[extraction_correction] Script Date: 01/13/2015 14:42:56 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

SET ANSI_PADDING ON

GO

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[extraction_correction]’) AND type in (N’U’))

BEGIN

CREATE TABLE [dbo].[extraction_correction](

[id] [bigint] NOT NULL,

[batch_class_id] [varchar](255) NOT NULL,

[batch_class_name] [varchar](255) NULL,

[batch_id] [varchar](255) NOT NULL,

[batch_start_date] [datetime] NULL,

[start_date] [date] NOT NULL,

[document_type] [varchar](255) NULL,

[document_type_label] [varchar](280) NULL,

[number_of_fields] [int] NULL,

[average_confidence] [decimal] (10,2) NULL,

[weighted_confidence] [decimal] (10,2) NULL,

[field_change_count] [int] NULL)

END

GO

SET ANSI_PADDING OFF

GO

IF NOT EXISTS (SELECT * FROM ::fn_listextendedproperty(N’MS_SSMA_SOURCE’ , N’SCHEMA’,N’dbo’, N’TABLE’,N’extraction_correction’, NULL,NULL))

EXEC sys.sp_addextendedproperty @name=N’MS_SSMA_SOURCE’, @value=N’reporting.extraction_correction’ , @level0type=N’SCHEMA’,@level0name=N’dbo’, @level1type=N’TABLE’,@level1name=N’extraction_correction’

GO

/****** Object: Table [dbo].[classification_correction] Script Date: 01/13/2015 14:42:56 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

SET ANSI_PADDING ON

GO

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[classification_correction]’) AND type in (N’U’))

BEGIN

CREATE TABLE [dbo].[classification_correction](

[id] [bigint] NOT NULL,

[batch_class_id] [varchar](255) NOT NULL,

[batch_class_name] [varchar](255) NULL,

[batch_id] [varchar](255) NOT NULL,

[batch_start_date] [datetime] NULL,

[start_date] [date] NOT NULL,

[document_id] [varchar](255) NOT NULL,

[old_doc_type] [varchar](255) NULL,

[new_doc_type] [varchar](255) NULL,

[confidence] [decimal] (10,2) NULL,

[confidence_threshold] [decimal] (10,2) NULL,

[page_count] [int] NULL)

END

GO

SET ANSI_PADDING OFF

GO

IF NOT EXISTS (SELECT * FROM ::fn_listextendedproperty(N’MS_SSMA_SOURCE’ , N’SCHEMA’,N’dbo’, N’TABLE’,N’classification_correction’, NULL,NULL))

EXEC sys.sp_addextendedproperty @name=N’MS_SSMA_SOURCE’, @value=N’reporting.classification_correction’ , @level0type=N’SCHEMA’,@level0name=N’dbo’, @level1type=N’TABLE’,@level1name=N’classification_correction’

GO

/****** Object: Table [dbo].[classification_correction_accuracy] Script Date: 01/13/2015 14:42:56 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

SET ANSI_PADDING ON

GO

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[classification_correction_accuracy]’) AND type in (N’U’))

BEGIN

CREATE TABLE [dbo].[classification_correction_accuracy](

[id] [bigint] NOT NULL,

[batch_class_id] [varchar](255) NOT NULL,

[batch_class_name] [varchar](255) NULL,

[batch_id] [varchar](255) NOT NULL,

[batch_start_date] [datetime] NULL,

[start_date] [date] NOT NULL,

[document_type] [varchar](255) NULL,

[document_type_label] [varchar](280) NULL,

[page_count] [int] NULL,

[correction_page_count] [int] NULL,

[correct_classification_page_count] [int] NULL)

END

GO

SET ANSI_PADDING OFF

GO

IF NOT EXISTS (SELECT * FROM ::fn_listextendedproperty(N’MS_SSMA_SOURCE’ , N’SCHEMA’,N’dbo’, N’TABLE’,N’classification_correction_accuracy’, NULL,NULL))

EXEC sys.sp_addextendedproperty @name=N’MS_SSMA_SOURCE’, @value=N’reporting.classification_correction_accuracy’ , @level0type=N’SCHEMA’,@level0name=N’dbo’, @level1type=N’TABLE’,@level1name=N’classification_correction_accuracy’

GO

/****** Object: Table [dbo].[seperation_correction] Script Date: 01/13/2015 14:42:56 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

SET ANSI_PADDING ON

GO

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[seperation_correction]’) AND type in (N’U’))

BEGIN

CREATE TABLE [dbo].[seperation_correction](

[id] [bigint] NOT NULL,

[batch_class_id] [varchar](255) NOT NULL,

[batch_class_name] [varchar](255) NULL,

[batch_id] [varchar](255) NOT NULL,

[batch_start_date] [datetime] NULL,

[start_date] [date] NOT NULL,

[document_id] [varchar](255) NULL,

[document_type] [varchar](255) NULL,

[old_page_count] [int] NULL,

[new_page_count] [int] NULL)

END

GO

SET ANSI_PADDING OFF

GO

IF NOT EXISTS (SELECT * FROM ::fn_listextendedproperty(N’MS_SSMA_SOURCE’ , N’SCHEMA’,N’dbo’, N’TABLE’,N’seperation_correction’, NULL,NULL))

EXEC sys.sp_addextendedproperty @name=N’MS_SSMA_SOURCE’, @value=N’reporting.seperation_correction’ , @level0type=N’SCHEMA’,@level0name=N’dbo’, @level1type=N’TABLE’,@level1name=N’seperation_correction’

GO

/****** Object: Table [dbo].[seperation_correction_accuracy] Script Date: 01/13/2015 14:42:56 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

SET ANSI_PADDING ON

GO

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[seperation_correction_accuracy]’) AND type in (N’U’))

BEGIN

CREATE TABLE [dbo].[seperation_correction_accuracy](

[id] [bigint] NOT NULL,

[batch_class_id] [varchar](255) NOT NULL,

[batch_class_name] [varchar](255) NULL,

[batch_id] [varchar](255) NOT NULL,

[batch_start_date] [datetime] NULL,

[start_date] [date] NOT NULL,

[document_type] [varchar](255) NULL,

[document_type_label] [varchar](280) NULL,

[page_count] [int] NULL,

[correction_page_count] [int] NULL,

[correct_seperation_page_count] [int] NULL)

END

GO

SET ANSI_PADDING OFF

GO

IF NOT EXISTS (SELECT * FROM ::fn_listextendedproperty(N’MS_SSMA_SOURCE’ , N’SCHEMA’,N’dbo’, N’TABLE’,N’seperation_correction_accuracy’, NULL,NULL))

EXEC sys.sp_addextendedproperty @name=N’MS_SSMA_SOURCE’, @value=N’reporting.seperation_correction_accuracy’ , @level0type=N’SCHEMA’,@level0name=N’dbo’, @level1type=N’TABLE’,@level1name=N’seperation_correction_accuracy’

GO

/****** Object: Table [dbo].[unnecessary_review] Script Date: 01/13/2015 14:42:56 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

SET ANSI_PADDING ON

GO

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[unnecessary_review]’) AND type in (N’U’))

BEGIN

CREATE TABLE [dbo].[unnecessary_review](

[id] [bigint] NOT NULL,

[batch_class_id] [varchar](255) NOT NULL,

[batch_class_name] [varchar](255) NULL,

[batch_id] [varchar](255) NOT NULL,

[batch_start_date] [datetime] NULL,

[start_date] [date] NOT NULL,

[document_id] [varchar](255) NOT NULL,

[document_type] [varchar](255) NULL,

[document_type_label] [varchar](280) NULL,

[confidence] [decimal] (10,2) NULL,

[confidence_threshold] [decimal] (10,2) NULL)

END

GO

SET ANSI_PADDING OFF

GO

IF NOT EXISTS (SELECT * FROM ::fn_listextendedproperty(N’MS_SSMA_SOURCE’ , N’SCHEMA’,N’dbo’, N’TABLE’,N’unnecessary_review’, NULL,NULL))

EXEC sys.sp_addextendedproperty @name=N’MS_SSMA_SOURCE’, @value=N’reporting.unnecessary_review’ , @level0type=N’SCHEMA’,@level0name=N’dbo’, @level1type=N’TABLE’,@level1name=N’unnecessary_review’

GO

/****** Object: Table [dbo].[false_positive] Script Date: 01/13/2015 14:42:56 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

SET ANSI_PADDING ON

GO

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[false_positive]’) AND type in (N’U’))

BEGIN

CREATE TABLE [dbo].[false_positive](

[id] [bigint] NOT NULL,

[batch_class_id] [varchar](255) NOT NULL,

[batch_class_name] [varchar](255) NULL,

[batch_id] [varchar](255) NOT NULL,

[batch_start_date] [datetime] NULL,

[start_date] [date] NOT NULL,

[document_id] [varchar](255) NOT NULL,

[old_doc_type] [varchar](255) NULL,

[new_doc_type] [varchar](255) NULL,

[document_type_label] [varchar](280) NULL,

[confidence] [decimal] (10,2) NULL,

[confidence_threshold] [decimal] (10,2) NULL)

END

GO

SET ANSI_PADDING OFF

GO

IF NOT EXISTS (SELECT * FROM ::fn_listextendedproperty(N’MS_SSMA_SOURCE’ , N’SCHEMA’,N’dbo’, N’TABLE’,N’false_positive’, NULL,NULL))

EXEC sys.sp_addextendedproperty @name=N’MS_SSMA_SOURCE’, @value=N’reporting.false_positive’ , @level0type=N’SCHEMA’,@level0name=N’dbo’, @level1type=N’TABLE’,@level1name=N’false_positive’

GO

/****** Object: Table [dbo].[document_correction] Script Date: 01/13/2015 14:42:56 ******/

SET ANSI_NULLS ON

GO

SET QUOTED_IDENTIFIER ON

GO

SET ANSI_PADDING ON

GO

IF NOT EXISTS (SELECT * FROM sys.objects WHERE object_id = OBJECT_ID(N'[dbo].[document_correction]’) AND type in (N’U’))

BEGIN

CREATE TABLE [dbo].[document_correction](

[id] [bigint] NOT NULL,

[batch_class_id] [varchar](255) NOT NULL,

[batch_class_name] [varchar](255) NULL,

[batch_id] [varchar](255) NOT NULL,

[batch_start_date] [datetime] NULL,

[start_date] [date] NOT NULL,

[document_type] [varchar] (255) NOT NULL,

[document_type_label] [varchar](280) NULL,

[classification_correction_count] [bigint] NULL DEFAULT 0,

[seperation_correction_count] [bigint] NULL DEFAULT 0,

[unnecessary_review_count] [bigint] NULL DEFAULT 0,

[false_positive_count] [bigint] NULL DEFAULT 0,

[total_correction_count] [bigint] NULL DEFAULT 0)

END

GO

SET ANSI_PADDING OFF

GO

IF NOT EXISTS (SELECT * FROM ::fn_listextendedproperty(N’MS_SSMA_SOURCE’ , N’SCHEMA’,N’dbo’, N’TABLE’,N’document_correction’, NULL,NULL))

EXEC sys.sp_addextendedproperty @name=N’MS_SSMA_SOURCE’, @value=N’reporting.document_correction’ , @level0type=N’SCHEMA’,@level0name=N’dbo’, @level1type=N’TABLE’,@level1name=N’document_correction’

GO

insert into [@@ARCHIVE_REPORT_DB_NAME@@].[dbo].[document_correction] select * from [@@REPORT_DB_NAME@@].[dbo].[document_correction];

insert into [@@ARCHIVE_REPORT_DB_NAME@@].[dbo].[false_positive] select * from [@@REPORT_DB_NAME@@].[dbo].[false_positive];

insert into [@@ARCHIVE_REPORT_DB_NAME@@].[dbo].[unnecessary_review] select * from [@@REPORT_DB_NAME@@].[dbo].[unnecessary_review];

insert into [@@ARCHIVE_REPORT_DB_NAME@@].[dbo].[seperation_correction_accuracy] select * from [@@REPORT_DB_NAME@@].[dbo].[seperation_correction_accuracy];

insert into [@@ARCHIVE_REPORT_DB_NAME@@].[dbo].[seperation_correction] select * from [@@REPORT_DB_NAME@@].[dbo].[seperation_correction];

insert into [@@ARCHIVE_REPORT_DB_NAME@@].[dbo].[classification_correction_accuracy] select * from [@@REPORT_DB_NAME@@].[dbo].[classification_correction_accuracy];

insert into [@@ARCHIVE_REPORT_DB_NAME@@].[dbo].[classification_correction] select * from [@@REPORT_DB_NAME@@].[dbo].[classification_correction];

insert into [@@ARCHIVE_REPORT_DB_NAME@@].[dbo].[extraction_correction] select * from [@@REPORT_DB_NAME@@].[dbo].[extraction_correction];

insert into [@@ARCHIVE_REPORT_DB_NAME@@].[dbo].[field_correction] select * from [@@REPORT_DB_NAME@@].[dbo].[field_correction];

insert into [@@ARCHIVE_REPORT_DB_NAME@@].[dbo].[field_correction_details] select * from [@@REPORT_DB_NAME@@].[dbo].[field_correction_details];

insert into [@@ARCHIVE_REPORT_DB_NAME@@].[dbo].[field_details] select * from [@@REPORT_DB_NAME@@].[dbo].[field_details];

insert into [@@ARCHIVE_REPORT_DB_NAME@@].[dbo].[global_data] select * from [@@REPORT_DB_NAME@@].[dbo].[global_data];

truncate table [@@REPORT_DB_NAME@@].[dbo].[document_correction];

truncate table [@@REPORT_DB_NAME@@].[dbo].[false_positive];

truncate table [@@REPORT_DB_NAME@@].[dbo].[unnecessary_review];

truncate table [@@REPORT_DB_NAME@@].[dbo].[seperation_correction_accuracy];

truncate table [@@REPORT_DB_NAME@@].[dbo].[seperation_correction];

truncate table [@@REPORT_DB_NAME@@].[dbo].[classification_correction_accuracy];

truncate table [@@REPORT_DB_NAME@@].[dbo].[classification_correction];

truncate table [@@REPORT_DB_NAME@@].[dbo].[extraction_correction];

truncate table [@@REPORT_DB_NAME@@].[dbo].[field_correction];

truncate table [@@REPORT_DB_NAME@@].[dbo].[field_correction_details];

truncate table [@@REPORT_DB_NAME@@].[dbo].[field_details];

truncate table [@@REPORT_DB_NAME@@].[dbo].[global_data];

Default Filter Configuration

Default filter configurations for Throughput Reports are based on Start Date and End Date. These are logically uniform. This ensures that data within the proper and relevant range is loaded for the reports.

Changes in Default Configuration

By default, the standard reports are based on the following configurations:

  • Start Date = <current day> and End Date = <current day>
  • Batch Class Throughput
  • Batch Size Throughput
  • Module Throughput
  • User Throughput
  • Start Date = <1 Year Ago> and End Date = <current day>
  • Monthly Throughput
  • Time-Based Throughput
  • Start Date = <Start of current week> and End Date = <current day>
  • Week Days Throughput

Encrypted Batch Class Configuration

Ephesoft Transact Release 4.0.3.0 and later releases take all batch instances into consideration while computing data for reporting. This results in enhanced report accuracy.

The configurations are stored in the following file:

  • {Ephesoft Installation Directory}\Application\WEB-INF\classes\META-INF\dcma-reporting\etl-variables.properties

The following two properties are added for Encrypted Batch support:

  • ephesoft.loginusername=<Username for which Ephesoft Web Services are authorized>
  • ephesoft.loginpassword=<Password for the above Username>

The user can support encryption for the above properties by using the following settings:

  • A combination of encrypted strings from Ephesoft Encryptor (<Ephesoft Installation Directory>\Application\native\encryption\Encryptor.bat)
  • Encryption switch in <Ephesoft Installation Directory>\Application\WEB-INF\classes\META-INF \dcma-encryption\dcma-encryption.properties.

Export Options for Reports

The following export options are available at the bottom of the widgets for all Ephesoft Reports:

  • Export PDF: User can export the report in PDF format.
  • Export Excel: User can export the report in excel format.
  • Print Report: User can open the report to a new tab/window and then print the report.

Failover Mechanism for Reports

Reports are supported for a multi-server Ephesoft environment as well. Reporting is accessible on all servers.

The user interface of Reports is present and hosted on all servers. Hence, it can be assumed that if Ephesoft is running on a machine, Ephesoft Reports will be accessible via localhost Ephesoft Application.

The Back-End (ETL Scripts) is governed by Ephesoft’s failover mechanism. ETL Scripts are stored at a shared location and only one server can run these scripts at a time. If that server shuts down for any reason, Ephesoft Heartbeat is triggered the failover mechanism and the ETL Scripts service are assigned to one of the remaining servers.

The server_registry table below displays the ETL Service running on Ephe32 system.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image120.png

server_registry table example

The service_status table below displays the server_registry_id.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image122.png

service_status table example

In case of server failure, when the failover mechanism takes over, ETL Service is assigned to EphesoftSVR as displayed in the server_registry table below.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image124.png

ETL Service assigned to EphesoftSVR in server_registry table

The service_status table below displays updated server_registry_id.

https://wikidev.ephesoft.com/wp-content/uploads/2015/11/word-image126.png

service_status table displaying updated server_registry_id

Guidelines for Running Ephesoft Transact Reports

This topic provides guidelines and recommendations for running reports in Ephesoft Transact:

  • It is advisable to run the Ephesoft Reporting Service on a UI Server.
    • Running the Reporting Service on an executing server may cause delays in the Report ETL Job execution due to high CPU utilization by batches.
  • Dashboard and Standard report scripts and cron jobs have been merged into a single entity. This means both Dashboard and Throughput Reports will be updated at the same time in the UI. The Cron for this common ETL Script (Dashboard) should be frequent — every 15 to 20 minutes (the default setting is every 15 minutes).
  • The clean-up algorithm will delete data for FINISHED batches for which all reports have been successfully run (as per the license).
    • Along with this, XML files from SharedFolders/report-data and Activiti tables for the same batch instances will also be cleared.
  • Ephesoft recommends that all cron jobs should be configured so that minimal collisions occur.
    • For example, the cleanup cron could be set at the 45th/50th minute of every “n” hours to ensure that chances of another cron being fired at the same instance are less.
  • ETL scripts are memory intensive due to frequent sorting and aggregation of data. Hence, as per load of batches, the JVM heap memory should be configured accordingly.

Low-Load Customers

The following specific recommendations apply for low-load customers (below 1000 pages/day):

  • The Dashboard Cron job can be set to more frequent interval (every 5 minutes).
  • JVM Heap memory does not need to be adjusted or notably increased for the reporting to function properly.
  • Cron timings should be exclusive of each other by ensuring they do not get fired at the same time. This can be achieved by specifying the exact minute for the cron to be triggered.
    • For example: 0 23 0/5 * * * denotes a cron that will be executed 23 minutes after every 5 hours.

Medium and High-Load Customers

The following specific recommendations apply for medium-load customers (1000-10,000 pages/day) and high-load customers (above 10,000 pages/day):

  • Multi Server Setup is recommended with the Reporting Service running on a UI server.
  • The Dashboard Cron (which will update data for Dashboard and Throughput Reports) should be set to a slightly longer interval — every 15 minutes to allow scripts more time to complete.
  • JVM Heap memory should be increased in cases where extremely high numbers of batches are being processed regularly.
  • Cron timings should be exclusive of each other by making sure they do not get fired at the same time. This can be achieved by specifying the exact minute for the cron to be triggered.
    • Example: 0 23 0/5 * * * denotes a cron that will be fired in the 23rd minute after every 5 hours.

Internationalization Support

Effective with Ephesoft Transact Release 4.5.x.x, the user interface supports the following languages:

  • Dutch
  • English
  • French
  • German
  • Italian
  • Spanish

The user can adjust the language configuration from the browser settings.

Last Sync Time

All Ephesoft reports display the last sync time with the Ephesoft server/services in the following format:

  • YYYY/MM/DD HH:MM:SS.

https://wikidev.ephesoft.com/wp-content/uploads/2016/10/word-image-59.png

User Throughput Report as a sample format

Performance and Reliability Improvements

Ephesoft Transact Release 4.0.6.0 and later releases improve the performance and long-term reliability in the Reporting module. Enhancements to the back-end workflow for the Reporting module included the following:

  • Advanced Reporting Clean-up Logic
  • ETL Engine Version Upgrade
  • Transactional Behavior for Maria DB and MySQL
  • New Purging Mechanism

Advanced Reporting Clean Up Logic

Based on the types of Batches being run, a large amount of data is processed and stored in the Database during the calculation of Advanced Reports. There are certain final tables where processed data is stored in its final form. And there are some intermediate tables which are used by the scripts while processing.

These intermediate tables tend to become extremely large and contain data that will not be used by the scripts in the future. Hence, these tables are now periodically cleaned up to make the database as clean as possible.

ETL Engine Version Upgrade

Ephesoft Transact 4.0.6.0 upgrades the ETL engine from version 5 to version 6. This provides a significant boost in overall performance and memory/CPU consumption.

Transactional Behavior for Maria DB and MySQL

Improvements have been made for scripts running with MariaDB and MySQL so that in the case of the server being shut down in the middle of any job execution, data consistency is maintained.

Purging Mechanism

A Purging mechanism has been introduced to the Ephesoft Reporting Module. This feature will archive data periodically. It was observed that a heavy usage customer with a large cluster would generate a huge amount of Reporting Data. Over a period of several months, this dataset can be large enough to slow down the reporting scripts.

Hence, a mechanism has been developed that will periodically archive the data from the working Database to an archival Database. The frequency of this archival can be controlled by the user.

Also, the user can decide the extent of archival. This means the user can control the amount of data to be archived based on how old it is.

Configurations

The user can control the Purging mechanism using the following parameters:

  • Location: <Ephesoft_Home>\Application\WEB-INF\classes\META-INF\dcma-reporting
  • Filename: dcma-reporting.properties
  • Property name: dcma.report.purging.cronExpression (Default Value=Every Third month on the 1st Day at 12am)

This property can be configured to schedule the Purging Job using regular cron expressions.

  • Filename: etl-variables.properties
  • Property Name: reporting.purge_duration (Default Value = 90 days)

As an example, if the value of this property is set to 90, this means that at every scheduled purge cycle, data OLDER than 90 days will be archived. Recent Data (<90 days) will be retained.

  • If a user wants to archive the complete data every time, they can set the value of the property to 0.

The “reporting.purge_duration” property denotes the time period (in days) prior to which all data will be purged.

  • As an example, if the purge_duration = 5 days, batches with creation_date older than Current date will be purged.
    • Taking current date as 06-06-2016 5:00pm.
    • Batch Instance with creation date = 30-04-2016 1:00pm will be Purged
    • Batch Instance with creation date = 31-04-2016 1:00pm will be Purged
    • Batch Instance with creation date = 31-04-2016 8:00pm will NOT be Purged (number of days = 5, taking difference of 06-06-2016 5:00pm and 31-04-2016 8:00pm)
    • Batch Instance with creation date = 01-06-2016 1:00pm will NOT be Purged (number of days = 5, not greater than 5)
    • Batch Instance with creation date = 01-06-2016 5:30pm will NOT be Purged
    • Batch Instance with creation date = 03-06-2016 1:00pm will NOT be Purged
    • After purging, the Dashboard data is recalculated for remaining data.

Note: Batches that are in non-FINISHED state and are purged will be added back into original report DB. This is because the Status of these batches may change later on and reporting jobs need to process these changes. E.g. For a batch in the READY_FOR_REVIEW state, purging will copy the data into archive DB. But, in the next run of Dashboard job, this batch will be repopulated into Report DB. This is to make sure that once the state of batch changes to RUNNING, correct data is displayed on the reporting UI.

Steps to Use the Purging Mechanism

Perform these steps to use the Purging mechanism:

  1. Configure purge_duration according to this requirement.
  2. Configure dcma.report.purging.cronExpression according to this requirement.

As a result of these configurations, the following processes are enabled:

  • After every Purge Cycle, data will be moved to archive Database.
  • All remaining reports will be recalculated on the basis of the remaining data in the original Reports database.

Printing Ephesoft Reports

The Print feature enables the current report to be copied to new tab or window. The user can then use the print dialog on the new tab or window to print the current report.

A specified time delay is added before the report gets printed so that the charts are fully displayed on the new tab or window before being printed.

Conclusion

This document provides a reference for reporting operations and functions in Ephesoft Transact 4.5.x.x. For more information about Ephesoft Transact 4.5.x.x. features, refer to the documentation available here.