Overview

Ephesoft reporting feature enables the user to generate reports pertaining to the various components of Ephesoft. Reports can be generated of the following components:

  • Batch Execution Information
  • Server Status

All reports can be filtered on the basis of Batch Class, Start Date of Batches and End Date of the Batches. The reports can also be configured to be calculated Per Module, Per Batch Class etc. Performance of Batch Classes can be measured in seconds, minutes or hours.

Ephesoft Reports are broadly classified into 3 Sub-Reports:

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

Configuration

Property File Configurations

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

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

Configurable property Type of value Value options Description
reporting.password String NA Password of report database.
reporting.username String NA Username of report database.
reporting.url String NA Connection string for report database. Example: For MySQL , it shall be jdbc:mysql://localhost:3306/report
reporting.driverClassName String 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 String NA Dialects used by hibernate to use with database. E.g. org.hibernate.dialect.MySQL5InnoDBDialect
reporting.hostname String NA Hostname name of report database.

Example: localhost

reporting.dbname String NA Database name of report database.
reporting.port String NA Port Number of report database.
reportdata.path String NA Path to the folder containing files for all executed batches. For Example: D:\\Ephesoft\\SharedFolders/report-data
ephesoft.hostname String NA Hostname name of Ephesoft database.

Example: localhost

ephesoft.dbname String NA Database name of Ephesoft database.
ephesoft.username String NA Username of Ephesoft database.
ephesoft.password String NA Password of Ephesoft database.
ephesoft.port String NA Port Number for Ephesoft database.

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

Configurable property Type of value Value options Description
dcma.report.dashboard.cronExpression Cronjob Expression NA Frequency with which Report Dashboard data is refreshed. Recommended value: “0 0/5 * ? * *” (Every 5 minutes)
dcma.report.dashboard.serverStatus.cronExpression Cronjob Expression NA Frequency with which Server Status data is refreshed. Recommended value: “0 0/1 * ? * *” (Every minute)
dcma.report.standard.cronExpression Cronjob Expression NA Frequency with which Throughput Report data is refreshed. Recommended value: “0 0 0/2 ? * *” (Every 2 hours)
dcma.report.advanced.cronExpression Cronjob Expression NA Frequency with which Report Dashboard data is refreshed. Recommended value: “0 0 0/12 ? * *” (Every 12 hours)

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

Configurable property Type of value Value options 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/dcmabackup-service.properties’:

Configurable property Type of value Value options Description
backup.report_folder String NA Path to the folder containing back up files for all executed plugins for batches. For example: C:\\Ephesoft\\SharedFolders/report-data

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

This file contains connection details to connect with existing report database and error location path. The report database can either be in MariaDB or SqlServer. To establish connection following parameters must be defined: Connection Id, Type (SQL Server or MariaDB), Port Number, Username, Password, Database name, Server name. Error location path is specified as “{Ephesoft-Home}/EphesoftReports/logs/dcma-report.log”

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

  • ‘{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 have to be switched if the user would like to switch the Reporting Database from MS SQL to MariaDB or vice versa. The ETL Scripts for respective Database are at the following location:

  • ‘{Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-reporting/MSSQL’
  • ‘{Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-reporting/MariaDB’

Report Database Creation

A User can create Reports Database on MS SQL/MariaDB using the “report_create.sql” file.

Location of “report_create.sql”:

  • For creating Reports Database for MSSQL:
    • ‘{Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-reporting/MSSQL/ report_create.sql
  • For creating Reports Database for MariaDB:
    • ‘{Ephesoft-Home}/WEB-INF/classes/META-INF/dcma-reporting/MariaDB/ report_create.sql

User Interface Display

User Interface of Report Frame

  • Collapsible panel for Navigation Tree
  • Report Display Panel

Collapsible Panel for Navigation Tree

Collapsible Panel contains:

  • Expand/Collapse Button
  • Navigation Tree

Expand/collapse button expands and collapses the navigation tree hierarchy respectively.

Navigation Tree contains the types of reports that can be generated by user. The types of report that can be rendered are:

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

Some of the specified reports have further sub type reports that can be rendered by the user. On the selection of Dashboard Reports, Report Dashboard is rendered in the Report Display Panel. On the selection of Throughput Reports, by default Throughput by Batch Class Report is rendered in the Report Display Panel. On the selection of Advanced Reports, by default Document Correction Report is rendered in the Report Display Panel. On the selection of Analysis Grid, by default Document Correction Analysis Report is rendered in the Report Display Panel.

Report Display Panel

By default Dashboard Report is displayed on the load and reload of the Reports Link/Page. On the selection of any type of report in navigation tree present in collapsible panel, corresponding report is rendered in this panel.

Reports Dashboard

Overview

The foremost report presented to the user on accessing the Reporting Tab is the Dashboard.

The Ephesoft Reports Dashboard is an interactive and customizable panel which displays information about the current state of Ephesoft. The Dashboard is segmented into 3 tabs:

  • System Health
  • System Reporting
  • Batch Processing

System Health

This tab contains a widget that displays information about the Server Status of Ephesoft server/service (uptime) for the current Day.

Information about the Services that are being handled by a particular server is shown just below the main Server Status chart.

The Services monitored by this report are:

  • Pick-Up Service
  • Folder Monitor Service
  • License Service

System Reporting

The System Reporting tab shows information using Batches as a parameter. It consists of 3 widgets that are explained individually below:

Batches per Status

This widget presents the user with a Pie Chart that enlists all Batch Instances grouped by their Status. By default, the Pie Chart will show all possible Statuses and include data of all Batch Classes. The user can modify the widget using 2 parameters:

  • Batch Class Filter: By using the Drop Down list placed above the widget, the user can filter the data shown in the Pie Chart. By selecting a particular Batch Class from the list, the current Statuses of Batch Instances of only the selected Batch Class is rendered in the Pie Chart.
  • Batch Status Legend Filter: The user can select/deselect Statuses from the legend located below the widget to render the Pie Chart for selected Statuses and ignore the deselected ones.

Drill down Feature:

On clicking a particular section of the rendered Pie Chart, the user is shown another Pie Chart. This Pie Chart shows Batches grouped by Priority for selected Batch Status.

Review Validate Backlog

The Review Validate Backlog widget shows the number of Batches that are currently in a Wait State and need manual Operator input. The number of Batch Instances in Review and Validation are sorted on the basis on the time since they have been in that state.

Drill down Feature:

On clicking a particular bar rendered on the widget, details of Batches in Review or Validation State is shown.

Batches per Priority

This widget presents the user with a Pie Chart that enlists all Batch Instances grouped by their Priority. By default, the Pie Chart will show all possible Statuses and include data of all Batch Classes. Along with the Pie chart, the user can opt to render the data in a Bar Graph as well.

Drill down Feature:

On clicking a particular Section of the Pie Chart/Bar of the Bar Chart, the user is shown another Pie Chart. This Pie Chart shows Batches grouped by Statuses for selected Batch Priority.

Batch Processing

Batch Processing tab shows widgets that use Pages in a Batch as a parameter. It consists of 3 widgets that are explained individually below:

Pages Processed per Unit Time

This is a Line Graph depicting the number of Pages Processed per Selected Unit of Time. There are 2 parameters that can be tweaked to interact with the widget:

  • Unit of Time: There are 3 time spans for which data can be rendered: per Weekday, per Month, per Year. (Note: The count of Pages will be cumulative over a period of time for recurring entries. E.g. Pages Processed per the month of January will show Pages processed in January’15 along with January’16 and so on.)
  • Batch Class Filter: By using the Drop Down list placed above the widget, the user can filter the data shown in the Line Graph. By selecting a particular Batch Class from the list, the total Pages of Batch Instances of only the selected Batch Class are rendered in the Line Graph.

Pages Processed per Batch Class

This is a Line Graph depicting the number of Pages Processed per Selected Batch Classes per Week Day. There is one parameter that can be tweaked to interact with the widget:

  • Batch Class Legend Filter: The user can select/deselect Batch Classes from the legend located below the widget to render the Line Graph for selected Batch Classes and ignore the deselected ones.

Average Pages Processed

This widget is a gauge style widget which relays information about the average number of Pages Processed per Batch as well as the average number of Pages Processed per Document.

There is one parameter to configure the widget:

  • Batch Class Filter: By using the Drop Down list placed above the widget, the user can filter the data shown in the Gauges. By selecting a particular Batch Class from the list, the Average Pages per Batch of only the selected Batch Class are rendered in the Line Graph.

Configuring the Dashboard

The Dashboard is quite flexible and can be customized easily. All widgets available in the Ephesoft Reports 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.

The user also has the provision to 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 Reporting Dashboard later on, the changes are not lost.

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

Lgx file: ‘{Ephesoft-Home} /EphesoftReports/_Definitions/_Reports/Dashboard.Dashboard.lgx

File name to save the state of the dashboard is specified in this file.

Export Options

Types of export features provided

PDF Export

On clicking PDF Export Image, current report is exported in PDF format.

Excel Export

On clicking Excel Export Image, current report is downloaded as Excel Sheet.

Print

By clicking on Print icon, current report is copied to new tab/window and then print dialog appears on this new tab/window and prints the current report.

C:\Users\jasmeetkaur\Desktop\export.PNG

Fig:1 Export Icons

Throughput Reports

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

Filters used in Throughput Reports

The filters allow the user to specify the parameters to generate report and depending on the value selected in filters the result is maximized or minimized. The available filters include:

Filter Name Options Submit Type Description
Start Date Calendar On submit button Start Date of the period for which executed Batch report is to be generated
End Date Calendar On submit button End Date of the period for which executed Batch report is to be generated
Type
  • Page
  • Document
  • Batch
Auto submit Generates the processed report on the basis of type selected

Default Value: Page

Unit of Time
  • Per minute
  • Per second
  • Per hour
Auto submit Number of Batches processed in per selected unit of time

Default Value: Per minute

Include Operator Time
  • Yes
  • No
Auto submit Includes the operator time to review and validate the Document/Pages/Batch

Default Value: No

Batch Class ID All Batch Classes Id accessible to logged in user. Auto submit ID of the Batch Class.

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

Chart Type
  • Bar Chart
  • Line Chart
  • Pie Chart
Auto submit Chart type to represent the

Default Value: Bar Chart

Throughput Report by Weekdays

Overview

This module enables the user to generate an execution report for Finished Batches on the basis of the Batch Class, Start Date and End Date. Reports are rendered as Pages Processed per Weekday and Pages Processed per Unit Time for Weekdays.

Report Frame

  • Filters
  • Graphs/Charts
  • Data Grid

Graphs/Charts

This section contains two graphs:

  • Pages Processed per weekday
  • Pages Processed per Unit Time for weekdays.

Bar Chart (Rendered as default)

By default these graphs are represented as Bar Chart. User can also change the chart type to Line chart or Pie Chart.

Line Chart

Pie Chart

Data Grid

Data grid depicts the information about executed Batches in tabular format. Columns present in the grid are:

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
Batch Start Date Date when the Batch is picked up by Ephesoft for execution
Batch End Date Date When the batch has finished execution
No of Documents in Batch Number of Documents present in each Batch
No of Pages in Batch Number of Pages present in each Batch
Duration of Execution (Minutes) Execution time(in minutes) for each Batch
Operator Duration (Minutes) Time taken in minutes by the operator to Review and Validate the Document/Pages in Batch
Weekday Day of the week on which the Batches are executed.

Throughput Report for Weekly Processing

Overview

This module enables the user to generate Execution Report of Finished Batches on the basis of the Batch Class, Start Date and End Date. Reports are rendered as Pages Processed per Week and Pages Processed per Unit Time per Week

Report Frame

  • Filters
  • Graphs/Charts
  • Data Grid

Graphs/Charts

This section contains two graphs:

  • Pages Processed per Batch Size
  • Pages Processed per Unit Time per Batch Size.

Bar Chart (Rendered as default)

By default these graphs are represented as Bar Chart. User can also change the chart type to Line chart or Pie Chart.

Line Chart

Pie Chart

Data Grid

Data grid depicts the information about executed Batches in tabular format. Columns present in the grid are:

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
Batch Start Date Date when the Batch is picked up by Ephesoft for execution
Batch End Date Date When the batch has finished execution
No of Documents in Batch Number of Documents present in each Batch
No of Pages in Batch Number of Pages present in each Batch
Duration of Execution (Minutes) Execution time(in minutes) for each Batch
Operator Duration (Minutes) Time taken in minutes by the operator to review and validate the Document/Pages in Batch

Throughput Reports by Batch Size

Overview

This module enables the user to generate execution report of finished Batches on the basis of the Batch Class, start date and end date. Reports are rendered as Pages Processed per Batch size and Pages Processed per unit time per Batch size

Report Frame

  • Filters
  • Graphs/Charts
  • Data Grid

Graphs/Charts

This section contains two graphs:

  • Pages Processed per Batch Size
  • Pages Processed per Unit Time per Batch Size.

Bar Chart (Rendered as default)

By default these graphs are represented as Bar Chart. User can also change the chart type to Line chart or Pie Chart.

Line Chart

Pie Chart

Data Grid

Data grid depicts the information about executed Batches in tabular format. Columns present in the grid are:

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
Batch Start Date Date when the Batch is picked up by Ephesoft for execution
Batch End Date Date when the Batch is executed by Ephesoft
No of Documents in Batch Number of Documents present in each Batch
No of Pages in Batch Number of Pages present in each Batch
Duration of Execution (Minutes) Execution time(in minutes) for each Batch
Operator Duration (Minutes) Time taken in minutes by the operator to review and validate the Document/Pages in Batch

Throughput Reports by Batch Class

Overview

This module enables the user to generate execution report of finished Batches on the basis of the Batch Class, start date and end date. Reports are rendered as Pages Processed per Batch Class and Pages Processed per unit time per Batch

Report Frame

  • Filters
  • Graphs/Charts
  • Data Grid

Graphs/Charts

This section contains two graphs:

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

Bar Chart (Rendered as default)

By default these graphs are represented as Bar Chart. User can also change the chart type to Line chart or Pie Chart.

Line Chart

Pie Chart

Data Grid

Data grid depicts the information about executed Batches in tabular format. Columns present in the grid are:

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
Batch Start Date Date when the Batch is picked up by Ephesoft for execution
Batch End Date Date when the Batch is executed by Ephesoft
No of Documents in Batch Number of Documents present in each Batch
No of Pages in Batch Number of Pages present in each Batch
Duration of Execution (Minutes) Execution time(in minutes) for each Batch
Operator Duration (Minutes) Time taken in minutes by the operator to review and validate the Document/Pages in Batch

Throughput Reports by Module

Overview

This module enables the user to generate execution report of finished Batches on the basis of the Batch Class, start date and end date. Reports are rendered as Pages Processed per Module and Pages Processed per unit time per Module.

Report Frame

  • Filters
  • Graphs/Charts
  • Data Grid

Graphs/Charts

This section contains two graphs:

  • Pages Processed per Module
  • Pages Processed per Unit Time per Module.

Bar Chart (Rendered as default)

By default these graphs are represented as Bar Chart. User can also change the chart type to Line chart or Pie Chart.

Line Chart

Pie Chart

Data Grid

Data grid depicts the information about executed Batches in tabular format. Columns present in the grid are:

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
Batch Start Date Date when the Batch is picked up by Ephesoft for execution
Batch End Date Date when the Batch is executed by Ephesoft
No of Documents in Batch Number of Documents present in each Batch
No of Pages in Batch Number of Pages present in each Batch
Duration of Execution (Minutes) Execution time(in minutes) for each Batch
Module Name Modules in which Batch is executed through its entire execution lifecycle.

Throughput Reports of Monthly Processing

Overview

This module enables the user to generate execution report of finished Batches on the basis of the Batch Class, start date and end date. Reports are rendered as Pages processed monthly and Pages Processed per unit time monthly.

Report Frame

  • Filters
  • Graphs/Charts
  • Data Grid

Graphs/Charts

This section contains two graphs:

  • Pages Processed Monthly
  • Pages Processed per Unit Time Monthly.

Bar Chart (Rendered as default)

By default these graphs are represented as Bar Chart. User can also change the chart type to Line chart or Pie Chart.

Line Chart

Pie Chart

Data Grid

Data grid depicts the information about executed Batches in tabular format. Columns present in the grid are:

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
Batch Start Date Date when the Batch is picked up by Ephesoft for execution
Batch End Date Date when the Batch is executed by Ephesoft
No of Documents in Batch Number of Documents present in each Batch
No of Pages in Batch Number of Pages present in each Batch
Duration of Execution (Minutes) Execution time(in minutes) for each Batch
Operator Duration (Minutes) Time taken in minutes by the operator to review and validate the Document/Pages in Batch
Month Month in which the Batches are executed.

Throughput Reports for Hourly Processing

Overview

This module enables the user to generate execution report of finished Batches on the basis of the Batch Class, start date and end date. Reports are rendered as Pages Processed per hour and Pages Processed per unit time per hour.

Report Frame

  • Filters
  • Graphs/Charts
  • Data Grid

Graphs/Charts

This section contains two graphs:

  • Pages Processed per Batch Size
  • Pages Processed per Unit Time per Batch Size.

Bar Chart (Rendered as default)

By default these graphs are represented as Bar Chart. User can also change the chart type to Line chart or Pie Chart.

Line Chart

Pie Chart

Data Grid

Data grid depicts the information about executed Batches in tabular format. Columns present in the grid are:

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
Batch Start Date Date when the Batch is picked up by Ephesoft for execution
Batch End Date Date when the Batch is executed by Ephesoft
No of Documents in Batch Number of Documents present in each Batch
No of Pages in Batch Number of Pages present in each Batch
Duration of Execution (Minutes) Execution time(in minutes) for each Batch
Operator Duration (Minutes) Time taken in minutes by the operator to review and validate the Document/Pages in Batch

Processing By User Report

Overview

This module enables the user to generate User Oriented execution report of finished Batches on the basis of the time taken by the user during Review/Validation. Parameters that can be used to filter the report are Batch Class, start date and end date.

Report Frame

  • Filters
  • Data Grid

Filters

The filters allow the user to specify the parameters to generate report and – depending on the value selected in filters the result is maximized or minimized. The available filters include:

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

Example: BC1 for Mailroom Automation Template Batch Class

Default Value: All

Data Grid

Data grid depicts the information about executed Batches in tabular format. Columns present in the grid are:

Column Name Description
Batch Instance Id Id assigned to each Batch Instance
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

Duration of Execution (Minutes) Execution time(in minutes) for each Batch
Operator Duration (Minutes) Time taken in minutes by the operator to review and validate the Document/Pages in Batch

Consistency for Last Sync Time Format

Previous versions of Ephesoft (4.0.x) had inconsistent formatting of Last Sync Times in the Standard Reporting Module.

Default Filter Configuration

Default filter configurations for Throughput Reports based on Start Date and End Date have been made logically uniform. This makes sure data within proper and relevant range is loaded for the reports.

Changes in Default Configuration

By default, the following will be the configuration for Standard Reports:

  • Start Date = <current day> and End Date = <current day>
    • Batch Class Throughput
    • Batch Size Throughput
    • Module Throughput
    • User Operation Report
  • 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>
    • Weekday Throughput

Advanced Reports

Overview

Advanced Reports are insightful and highly informative reports used to analyze and optimize the parameters used by Ephesoft during Document Assembly and Extraction. These reports are generated for Batches which have Review or Validation Module present in their workflow.

It aids 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 in order to identify where potential bottlenecks may be. It generates detailed reporting on the performance of Ephesoft Document capture system to provide insight into needed adjustments 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 the ability of Ephesoft to correctly and efficiently classify Documents and Extract fields.

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 have the provision of being exported as a PDF or Excel File.

cid:image001.jpg@01D052A7.BD74AA20

Document Correction Report

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

Report allows the user to identify where the specific problem with the Document type occurs. The Ephesoft operator could have:

  • Modified the Document type during Classification (Classification Correction)
  • Split or merged different Documents (Separation Correction)
  • Not needed to modify Documents in Classification (Unnecessary Review)
  • Modified the Document type during Validation (False Positive)

Report Frame

  • Filters
  • Columns in Data Table
  • Charts
  • Drill Downs and Navigation

Filters

Filter Name Options Submit Type Description
Start Date Calendar On submit button Start Date of the period for which executed Batch report is to be generated
End Date Calendar On submit button End Date of the period for which executed Batch report is to be generated
Batch Class All Batch Classes present in Ephesoft On 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 On submit button Types of Documents defined in each Batch Class

Default Value: All

Columns in Data Table

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 correction made by the reviewer

(Classification Correction is equal to change in document type at Review Module)

Separation Correction Count Number of Page Separations made by the reviewer

(It is equal to change in page count due to Split/Merge/Delete)

Unnecessary Review Count Number of unnecessary reviews made by the reviewer

(It is Number of Document type or page count changed by user during review)

False Positive Count Change of Document type during validation when Batch did not stop for review, during review module
Total Correction Count The total number of all types of corrections made by the reviewer or validator.

Charts

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

Navigation and Drilldowns

The Document Correction Report is the default report rendered in Advanced Reports. This report can access the Classification Accuracy Report, the Separation Accuracy Report, the Unnecessary Review Report, and the False Positive Report from the Data Table as well as the Chart Rendered. The user is able to easily identify from the Document Correction Report where the issues corresponding to the Document types are located. From this report, it is most often found that Unnecessary Reviews and False Positive are the simplest and most efficient fixes.

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.

Report Frame

  • Filters
  • Columns in Data Table
  • Charts
  • Drill Downs and Navigation

Filters

Filter Name Options Submit Type Description
Start Date Calendar On submit button Start Date of the period for which executed Batch report is to be generated
End Date Calendar On submit button End Date of the period for which executed Batch report is to be generated
Batch Class All Batch Classes present in Ephesoft On 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 On submit button Types of Documents defined in each Batch Class

Default Value: All

Columns in Data Table

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.

Charts

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 user.

Navigation and Drilldowns

This report can access the Classification Correction Report from the Data Table as well as the Chart Rendered. The user can also return to the Parent Report (Document Correction Report) using the link provided on the Top Left corner of the report.

Classification Correction Detail Report

The Classification Correction 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.

Report Frame

  • Filters
  • Columns in Data Table
  • Charts
  • Drill Downs and Navigation

Filters

Filter Name Options Submit Type Description
Start Date Calendar On submit button Start Date of the period for which executed Batch report is to be generated
End Date Calendar On submit button End Date of the period for which executed Batch report is to be generated
Batch Class All Batch Classes present in Ephesoft On 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 On submit button Types of Documents defined in each Batch Class

Default Value: All

Columns in Data Table

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 is 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 also 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 will give the user more of an idea on what needs to be changed within the Ephesoft configurations.

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.

Report Frame

  • Filters
  • Columns in Data Table
  • Charts
  • Drill Downs and Navigation

Filters

Filter Name Options Submit Type Description
Start Date Calendar On submit button Start Date of the period for which executed Batch report is to be generated
End Date Calendar On submit button End Date of the period for which executed Batch report is to be generated
Batch Class All Batch Classes present in Ephesoft On 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 On submit button Types of Documents defined in each Batch Class

Default Value: All

Columns in Data Table

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.

Charts

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.

Navigation and Drilldowns

This report can access the Separation Correction Report from the Data Table as well as the Chart Rendered. The user can also return to the Parent Report (Document Correction Report) using the link provided on the Top Left corner of the report.

Separation Detail Report

The Separation Correction Report is a low-level report detailing corrections made to Page Counts within Review Module. A 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.

Report Frame

  • Filters
  • Columns in Data Table
  • Charts
  • Drill Downs and Navigation

Filters

Filter Name Options Submit Type Description
Start Date Calendar On submit button Start Date of the period for which executed Batch report is to be generated
End Date Calendar On submit button End Date of the period for which executed Batch report is to be generated
Batch Class All Batch Classes present in Ephesoft On 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 On submit button Types of Documents defined in each Batch Class

Default Value: All

Columns in Data Table

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 is 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 also return to the Parent Report (Separation Accuracy Report) using the link provided on the Top Left corner of the report. Utilizing the two lower level reports will give the user more of an idea on what needs to be changed within the Ephesoft configurations.

Unnecessary Review Report

A Document is labeled as an Unnecessary Review when it goes into Review (as the Confidence is below the Threshold for the Document), and the Operator simply confirms the auto-classified Document type. It is caused by thresholds that are set too high. By looking at the Unnecessary Review Report, a more appropriate threshold to set in Ephesoft can be determined. If Batches falling into the Unnecessary Review Report have a confidence level around 20.00 and a threshold closer to 50.00, the threshold for the Document type in Ephesoft should be decreased for more accurate processing.

Report Frame

  • Filters
  • Columns in Data Table
  • Charts
  • Drill Downs and Navigation

Filters

Filter Name Options Submit Type Description
Start Date Calendar On submit button Start Date of the period for which executed Batch report is to be generated
End Date Calendar On submit button End Date of the period for which executed Batch report is to be generated
Batch Class All Batch Classes present in Ephesoft On 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 On submit button Types of Documents defined in each Batch Class

Default Value: All

Columns in Data Table

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 is picked up by Ephesoft for execution
Document Id Id of the document
Confidence The score with which document is identified by Ephesoft.
Threshold The minimum value for the Batch to identified under specified document
Document Type Document type identified by Ephesoft.

Charts

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

Navigation and Drilldowns

The user can also return to the Parent Report (Document Correction Report) using the link provided on the Top Left corner of the report.

False Positive Report

A False Positive is the opposite of an Unnecessary Review. It occurs when a Document goes through Classification without issue (as the Confidence is higher than the Threshold for the Document Type), but is changed by an operator in Validation. It is caused by thresholds that are set too low. The False Positive report would provide the necessary data to determine if the threshold should be increased for a specific Document type. The Document’s Document type was changed AND the confidence is higher than the threshold, so it is a false positive.

Report Frame

  • Filters
  • Columns in Data Table
  • Charts
  • Drill Downs and Navigation

Filters

Filter Name Options Submit Type Description
Start Date Calendar On submit button Start Date of the period for which executed Batch report is to be generated
End Date Calendar On submit button End Date of the period for which executed Batch report is to be generated
Batch Class All Batch Classes present in Ephesoft On 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 On submit button Types of Documents defined in each Batch Class

Default Value: All

Columns in Data Table

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 is 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

Charts

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

Navigation and Drilldowns

The user can also return to the Parent Report (Document Correction Report) using the link provided on the Top Left corner of the report.

Extraction Correction Report

Extraction Correction Report 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.

Report Frame

  • Filters
  • Columns in Data Table
  • Charts
  • Drill Downs and Navigation

Filters

Filter Name Options Submit Type Description
Start Date Calendar On submit button Start Date of the period for which executed Batch report is to be generated
End Date Calendar On submit button End Date of the period for which executed batch report is to be generated
Batch Class All Batch Classes present in Ephesoft On 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 On submit button Types of Documents defined in each Batch Class

Default Value: All

Columns in Data Table

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 whose field is corrected.
Total Field Count Total number of fields whose value is extracted by Ephesoft
Average Confidence Average of confidence of all extracted values for all fields
Field Change Count Sum of field change for all batches of this Field, this Document Type and this Batch Class
Change Ratio Field change count/ number of fields

Charts

Document Type Vs Change Ratio Chart is a bubble chart that graphically represents the change ratio (i.e. the number of fields changed to total fields extracted) in the Document type. Size of the bubble indicates the frequency of corrections made by user.

Navigation and Drilldowns

The Extraction Correction Report can access the Field Correction Report from the Data Table as well as the Chart Rendered. The user is able to easily identify from the Extraction Correction Report where the issues corresponding to the Document Types are located.

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.

Report Frame

  • Filters
  • Columns in Data Table
  • Charts
  • Drill Downs and Navigation

Filters

Filter Name Options Submit Type Description
Start Date Calendar On submit button Start Date of the period for which executed batch report is to be generated
End Date Calendar On submit button End Date of the period for which executed Batch report is to be generated
Batch Class All Batch Classes present in Ephesoft On 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 On submit button Types of Documents defined in each Batch Class

Default Value: All

Columns in Data Table

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 whose field is corrected.
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 of confidence of all extracted values for all fields
Field Change Count Sum of field change for all batches of this Field, this Document Type and this Batch Class
Change Ratio Field change count/ number of fields

Charts

Field Name Vs Change Ratio 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 user.

Navigation and Drilldowns

The Field Correction Report can access the Field Correction Details Report from the Data Table as well as the Chart Rendered. The user can also return to the Parent Report (Extraction Correction Report) using the link provided on the Top Left corner of the report. The user is able to easily identify from the Extraction Correction Report where the issues corresponding to the Fields Types are located.

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 Detail Report provides field-by-field information on what field data was extracted from a Document (the old value) and what an operator entered during Validation (the new value).

Report Frame

  • Filters
  • Columns in Data Table
  • Drill Downs and Navigation

Filters

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

Example: BC1 for Mailroom Automation Template Batch Class

Default Value: All

Field Name All field name that can be extracted On submit button Name of the fields that can extracted

Default Value: All

Document Type All Types of documents defined in each Batch Class On submit button Types of Documents defined in each Batch Class

Default Value: All

Columns in Data Table

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
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 also return to the Parent Report (Field Correction Report) using the link provided on the Top Left corner of the report. The user is able to easily identify from the Extraction Correction Report where the issues corresponding to the Fields Types are located.

Analysis Grids

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 element is to provide a complete package of data analysis capabilities in a single element, providing Ephesoft Users with a lot of functionality.

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

Ephesoft provides users with 2 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

Columns in Data Table

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 the 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? Is the document typed changed by the reviewer during review module? 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

Columns in Data Table

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-Field Name Batch Class Id-Document Name-Field Name

Example:BC1-Us_Invoice-Pick Ticket

Where BC1 is Batch Class Id

Us_Invoice is Document Name

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? Is the field value changed by the Operator during Validate module? If yes then TRUE is displayed else 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 Grid

Refresh

This function fetches and updates the data in the grid without changing the customisations the User has made.

Restore

This function restores the Analysis Grid view to last saved point

Save

This function saves the current Analysis Grid view onto the disk.

Reset

This function resets the Analysis Grid back to original state provided by Ephesoft.

Export Options

Export to CSV

This Button exports the Data in .csv format.

Export to MS Excel

This Button exports the Data in .xls format.

Export to PDF

This Button exports the Data in .pdf format.

Add to Dashboard

This Button exports the Charts created by Analysis Grid to Reports Dashboard.

Functions

Columns

The User can select the columns that are to be rendered in the Data Grid.

Formula

The User can introduce any number of custom Columns that are a result of a set of operations defined as the “Formula”

Sort

User can define selected Columns based on which Data Grid can be sorted.

Filter

User can filter rows based on a specific filter.

Group

User can group rows based on a specific parameter.

Aggregate

User can aggregate rows based on a specific parameter.

Chart

User can create Charts based on specific parameters.

Cross Tab

Pivot and summarize by rows and columns.

Paging

Set the number of rows displayed per page.

Failover Mechanism for Reports

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

The Front-End (UI) 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 will run these scripts at a time. If that server shuts down for any reason, Ephesoft Heartbeat will trigger the failover mechanism and the ETL Scripts service will be assigned to one of the remaining Servers.

Shown below, the ETL Service is running on Ephe32 system.

[server_registry Table]

[service_status Table]

On server failure, when the Failover mechanism takes over, ETL Service is assigned to EphesoftSVR.

[server_registry Table]

[service_status Table]

Custom Reports

Third party Report Integration with Ephesoft

The user may use discard using Ephesoft Reports and use their own Reports UI by replacing the Reports.html file located at [EphesoftInstallationDirectory]\Application\* with their custom report’s HTML file. They need to rename their HTML as Reports.html, place it at [EphesoftInstallationDirectory]\Application\* , to render a page of their reports instead of default Reports HTML.

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

Custom Reports with Ephesoft Reports

Overview

User may integrate their custom Reports with Ephesoft Reports using Advanced Reports license with advanced Reports switch set ON.

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

Configuration of Custom Report Context

  • Context Loading of custom reports is configured by adding context path configuration on server.xml located at [EphesoftInstallationDirectory]\JavaAppServer\conf\*

Add following under Host tag:

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

  • Or, user may have 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

Some insert commands in Ephesoft database would integrate the custom report files within Ephesoft Reports.

Three tables involved are: reports_folder, report and sub_report:

  • Inserting Custom Report context path, if other than existing report contexts in 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 system name and port number as port number used by Ephesoft Application.
  • Otherwise, 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, in 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, say SubReport, with folder Report is named as Report.SubReport, hence default_folder_path would be Report in this example.
Parent_folder_id refers to a context path entry in reports_folder table

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

  • Inserting Custom Report’s name, in 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. (Continuing with the example used previously, Usually a custom report, say SubReport, with folder Report is named as Report.SubReport, hence default_report_path would be SubReport in this example.
Parent_folder_id Refers to parent folder entry in report table. (Report, with respect to above used example).
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 sub_report table.

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

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

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

Support for Batches executed of Encrypted Batch Classes:

Ephesoft 4.0.3.0 takes all Batch Instances into consideration while computing data for Reporting. This will help in more accurate reports than earlier.

Configuration

Filename: <Ephesoft Installation Directory>\Application\WEB-INF\classes\META-INF\dcma-reporting\etl-variables.properties

The following two properties are added with respect to Encrypted Batch Support:

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

User can use encryption for the above properties by using a combination of encrypted strings from Ephesoft Encryptor (<Ephesoft Installation Directory>\Application\native\encryption\Encryptor.bat) and encryption switch in <Ephesoft Installation Directory>\Application\WEB-INF\classes\META-INF \dcma-encryption\dcma-encryption.properties.

Print functionality in Ephesoft Reports

Print feature prints the document when the user clicks the print button then current report is copied to new tab/window and then print dialog appears on this new tab/window and prints the current report. A specified amount of delay is added before the report gets printed, so that the charts are fully rendered on the new tab/window before printing.

Was this article helpful to you?

Engineering

Comments are closed.