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:

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.serverStatus.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 up 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 Ephsoft 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 existing report database and error location path. The report database can either be in MariaDB or SQLServer.

To establish connection, the following parameters must be defined: Connection Id, Type (SQL Server or MariaDB), Port Number, Username, Password, Database name, and 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 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 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’

Accessing Reports

Reports can be accessed by clicking Reports from the Administrator menu on the DCMA Home page.

Clicking Reports displays the login page.

User can access the Reports home by entering valid user credentials.

Reports Home

The Reports Home page consists of the following:

Collapsible panel for navigation tree hierarchy

Report Display Panel

Collapsible Panel for Navigation Tree Hierarchy

The collapsible left pane of the reports page contains Expand All/Collapse All buttons along with the navigation tree hierarchy. Expand All/Collapse All button expands and collapses the navigation tree hierarchy respectively.

The navigation tree hierarchy contains the following types of reports:

Dashboard Reports

Throughput Reports

Advanced Reports

Analysis Grid.

Some of the above reports have further sub types.

Reports Display Panel

By default, Dashboard Report is displayed on selecting/refreshing the Reports Page. 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.

Internationalization Support

Ephesoft reports provides support for the following languages:

English

French

Turkish

Spanish

The required language can be changed from the browser settings.

Reports Dashboard

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

The Ephesoft Reports Dashboard is an interactive and customizable panel which displays information about the current state of Ephesoft. The Dashboard report is segmented into three parts.

System Health

System Reporting

Batch Processing

System Health

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

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

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

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

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

On clicking a particular section of the pie chart, the user is shown another pie chart displaying batches grouped by priority for selected batch status.

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 on the basis of the time since they have been in that state.

On clicking a particular status bar, details of batches in the corresponding state are displayed.

Batches per Priority

This widget, by default, displays a pie chart enlisting all batch instances grouped by their priority. By default, the pie chart displays data of all batch classes in all possible statuses.

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.

On clicking a particular section of the pie chart, the user is shown another pie chart displaying batches grouped by statuses for selected batch priority.

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 per 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. E.g. pages processed for the month of January will show pages processed in January 2016 along with January 2017 and so on.

Batch Class: By using the Batch Class drop-down list placed above the widget, the user can filter the data to be displayed. By selecting a batch class from the Batch Class drop-down list, the total pages of batch instances of only the selected batch class are displayed in the line graph.

Pages Processed per Batch Class

This is a bar chart displaying the number of pages processed per batch class. A marker line also displays the average number of pages processed by all batch classes.

Average Pages Processed

This widget displays the average number of pages processed batch-wise as well as document-wise.

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.

Export Options

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.

Configuring the Dashboard

The Dashboard is flexible and easily customizable. 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.

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.

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

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.

Throughput Reports Filters

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:

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 enables the user to generate a report of completed batches on the basis of batch class, start date and end date. Reports are displayed as pages processed per batch class and pages processed per unit time per Batch

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)

The Week Days Throughput Report contains the following two analyses displayed:

Batches by Batch Class: Pages processed per batch class

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

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

Data Grid

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

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

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 enables the user to generate a report of completed batches on the basis of 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 two analyses displayed:

Batches by Batch Size: Pages processed per batch size

Batches per Minute by Batch Size: Pages processed per unit time for the batch size.

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

Data Grid

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

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 enables the user to generate a report for completed batches on the basis of 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 two analyses displayed:

Batches by Day of the Week: Batches processed per weekday

Batches per Minute by Day of the Week: Batches processed per unit time for the day of the week.

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

Data Grid

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

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 enables the user to generate a report for completed batches on the basis of 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 two analyses displayed:

Batches by Hour of the Day: Pages processed per hour

Batches per Minute by Batch Class: Pages processed per unit time per hour.

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

Data Grid

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

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 enables the user to generate a report for completed batches on the basis of 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 two analyses displayed:

Pages by End Date: Pages processed by end date

Pages per Minute by End Date: Pages processed per unit time by end date.

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

Data Grid

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

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

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 enables the user to generate a report for completed batches on the basis of 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 two analyses displayed:

Batches by Month of the Year: Pages processed per hour

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

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

Data Grid

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

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 enables the user to generate a report for completed batches on the basis of 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:

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
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 two analyses displayed:

Batches by Module Name: Pages processed per module.

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

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

Data Grid

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

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 enables the user to generate a user-oriented report for completed batches on the basis of 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:

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

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

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.

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 standard reports are based on the 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

Advanced Reports

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 can be exported as a PDF or an Excel file.

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)

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

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:

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image77.png

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

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

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image78.png

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.

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:

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image80.png

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image82.png

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.

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:

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image84.png

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

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:

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image86.png

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

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image88.png

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.

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:

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image90.png

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. Utilizing the two lower level reports gives the user an idea on what needs to be changed within Ephesoft configurations.

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 is changed by an operator in Validation.

This is caused by thresholds that are set too low.

By looking at the False Positive Report, the user 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:

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image95.png

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

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image97.png

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.

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

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

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image92.png

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

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image93.png

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.

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:

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image99.png

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 whch 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 (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 the user.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image101.png

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.

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:

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image103.png

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

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image105.png

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.

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:

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image109.png

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image111.png

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

Field Correction Analysis Grid

Data Grid

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

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image113.png

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 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 Analysis Grid

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

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

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.

Columns

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

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

Sort

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

Filter

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

Group

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

Aggregate

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

Chart

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

Crosstab

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

Paging

Using this option, the user can set the number of rows to be 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 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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image120.png

The service_status table below displays the server_registry_id.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image122.png

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.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image124.png

The service_status table below displays updated server_registry_id.

http://wiki.ephesoft.com/wp-content/uploads/2015/11/word-image126.png

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 [EphesoftInstallationDirectory]\Application\* with their custom report’s HTML file.

They need to rename their HTML as Reports.html and place it at [EphesoftInstallationDirectory]\Application\* to display the new Reports page instead of default Reports HTML.

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

Custom Reports with Ephesoft Reports

Users have the option to 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\

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

Use the following commands to insert 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 entries in this table may point to one report context path.

Inserting Custom Report’s Name

Use the following commands to insert 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. 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.
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 entries in this table may point to one report folder.

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

Support for Batches executed of Encrypted Batch Classes:

Ephesoft v4.0.3.0 and higher take all batch instances into consideration while computing data for reporting. This results in enhanced report accuracy.

Configuration

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 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 the following:

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.

Printing Ephesoft Reports

Print feature enables the current report to be copied to new tab/window. The user can then use the print dialog on the new tab/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/window before being printed.

Was this article helpful to you?

Ravi Shankar