Dashboard and Throughput Reports

Introduction

The following article describes Dashboard and Throughput Reports in Ephesoft Transact. These reports provide information to administrators about the performance of their instance.

Note: This document applies to Ephesoft Transact 2019.1 and above.

Accessing Reports

Access reports from either of the following methods:

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

Figure 1. Ephesoft Transact Administrator and Operator Menus from Left-side Navigation

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

Figure 2. Transact DCMA Home Page — Administrator > Reports

  • Click Reports and Ephesoft Transact prompts you to log in.

Figure 3. Ephesoft Transact Login Screen

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

Reports Home

The Reports home page has the following features:

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

Collapsible Panel for Navigation Tree Hierarchy

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

The Expand All and Collapse All buttons expand and collapse the navigation tree hierarchy respectively.

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

Figure 4. Navigation Pane with Dashboard Reports Landing Screen — System Health Tab

The following screenshot illustrates the fully expanded navigation menu in Ephesoft Transact.

Figure 5. Full Structure of the Reports Module, Administrator > Reports

The navigation tree hierarchy contains the following types of reports:

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

There are many Ephesoft report sub-types.

Reports Display Panel

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

Figure 6. Three Tabs of Dashboard Reports

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

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

Dashboard Reports

Dashboard Reports is the first screen displayed to the user when accessing Ephesoft reports.

The Dashboard is an interactive and customizable panel that displays information about the current state of Ephesoft. The Dashboard has three tabs:

  • System Health
  • System Reporting
  • Batch Processing

System Health

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

This tab displays the date-wise uptime status of Ephesoft servers and services. By default, information for current date is displayed.

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

Figure 7. Dashboard Reports — System Health Tab

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

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

Figure 8. Dashboard Reports — System Health Tab

The following services are monitored by this report:

  • Pick-Up Service
  • License Service
  • Folder Monitor

System Reporting

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

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

Batches per Status

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

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

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

Figure 9. System Reporting tab — Batch Class Drop-down

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

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

Figure 10. System Reporting Tab — Batch Status Legend

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

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

Figure 11. System Reporting Tab — Clicking the Pie Chart

Review Validate Backlog

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

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

Figure 12. Review Validate Backlog Widget

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

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

Figure 13. Review Validate Backlog Widget

Batches per Priority

By default, this widget displays a pie chart listing all batch instances grouped by their priority. The pie chart displays data of all batch classes in all possible statuses.

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

Figure 14. Batches Per Priority Widget

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

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

Figure 15. Batches Per Priority Widget — Alternate Bar Chart View

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

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

Figure 16. Batches Per Priority Widget — Batches Grouped by Status

Batch Processing

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

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

Pages Processed per Unit Time

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

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

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

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

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

Figure 17. Batch Processing Widget — Pages Process Per Unit of Time

Pages Processed per Batch Class

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

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

Figure 18. Pages Processed Per Batch Class Widget

Average Pages Processed

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

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

Figure 19. Average Pages Processed Widget

The user can modify the widget using the following parameter:

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

Configuring the Dashboard

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

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

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

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

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

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

Throughput Reports

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

The rp_throughput_module_data table is used internally and stores the number of pages and documents available in a batch instance at the end of a module execution. This table can be used to track where pages are added or deleted in a batch instance by the operator.

Throughput Reports Filters

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

The available filters are illustrated and defined as follows:

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

Figure 20. Throughput Reports Filters — Drop-down Menu Options

The following filters are available in Ephesoft Transact:

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

Per Minute

Per Hour

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

Default Value: Per Minute

Include Operator Time Yes

No

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

Default Value: No

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

Example: BC1 for Mailroom Automation Template Batch Class.

Default Value: All

Chart Type Pie

Bar

Heatmap

Auto submit Chart type to represent the report.

Default Value: Pie

Label Column Batch Class Auto submit
Data Column Batches

Pages

Documents

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

Default Value: Batches

Default Filter Configuration

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

Changes in Default Configuration

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

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

Batch Class Throughput

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

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

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

Report Body (Pie/Bar/Heatmap)

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

  • Batches by Batch Class — Pages processed per batch class

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

Figure 21. Analysis of Batches by Batch Class Widget — Pie Chart

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

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

Figure 22. Analysis of Batches per Minutes by Batch Class Widget — Pie Chart

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

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

Figure 23. Analysis of Batches by Batch Class Widget — Bar Chart

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

Figure 24. Analysis of Batches Per Minute, Analysis of Pages Per Minute by Batch Class Widget — Heatmap

Data Grid

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

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

Figure 25. Batch Instance Report Data, Release 4.5.x.x and Previous Releases

The Batch Instance Report Data grid contains the following columns:

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

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

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

Batch Size Throughput

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

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

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

Report Body (Pie/Bar/Heatmap)

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

  • Batches by Batch Size — Pages processed per batch size

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

Figure 26. Analysis of Batches by Batch Size — Pie Chart

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

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

Figure 27. Analysis of Batches Per Minute by Batch Size — Pie Chart

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

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

Figure 28. Analysis of Batches by Batch Size — Bar Chart

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

Figure 29. Analysis of Batches Per Minute — Heatmap

Data Grid

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

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

Figure 30. Batch Instance Report Data

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

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

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

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

Week Days Throughput

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

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

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

Report Body (Pie/Bar/Heatmap)

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

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

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

Figure 31. Analysis of Batches by Day of the Week — Pie Chart

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

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

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

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

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

Figure 33. Analysis of Batches by Day of the Week — Bar Chart

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

Figure 34. Analysis of Batches Per Hour and Pages Per Hour — Heatmap

Data Grid

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

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

Figure 35. Batch Instance Report Data

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

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

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

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

Hourly Throughput

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

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

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

Report Body (Pie/Bar/Heatmap)

The Hourly Throughput Report contains the following two analysis methods:

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

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

Figure 36. Analysis of Batches by Hour of the Day

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

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

Figure 37. Analysis of Batches Per Minute by Batch Class — Pie Chart

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

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

Figure 38. Analysis of Batches by Hour of the Day — Bar Chart

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

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

Data Grid

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

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

Figure 40. Batch Instance Report Data — Data Grid

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

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

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 or pages in the batch

Time-Based Throughput

This module generates a report for completed batches, based on batch class, start date and end date. Reports are displayed as pages processed by end date and pages processed per unit time by end date on a daily, monthly, quarterly, or 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 analysis methods:

  • Pages by End Date — Pages processed by end date

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

Figure 41. Analysis of Pages by End Date — Line

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

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

Figure 42. Analysis of Pages per Minute by End Date — Line

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

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

Figure 43. Analysis of Pages by End Date — Curved Line

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

Figure 44. Pages Per Minute by End Date — Scatter Plot

Data Grid

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

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

Figure 45. Batch Instance Report Data

The Batch Instance Report Data grid contains the following columns:

Filter Name Description
Batch Class ID ID of the batch class

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

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

Monthly Throughput

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

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

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

Report Body (Pie/Bar/Heatmap)

The Monthly Throughput Report contains the following two analysis methods:

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

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

Figure 46. Analysis of Batches by Month of the Year

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

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

Figure 47. Analysis of Batches by Month of the Year — Pie Chart layout

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

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

Figure 48. Analysis of Batches by Month of the Year — Bar Chart Layout

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

Figure 49. Heatmap Layout

Data Grid

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

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

Figure 50. Batch Instance Repot Data — Data Grid

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

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

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

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

Module Throughput

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

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

  • 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 defined as follows:

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

Figure 51. Filters for Module Throughput Report

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

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

Unit of Time Per Second

Per Minute

Per Hour

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

Default Value: Per Minute

Chart Type Pie

Bar

Heatmap

Auto submit Chart type to represent the report.

Default Value: Pie

Label Column Module Name Auto submit
Data Column Batches

Pages

Documents

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

Default Value: Batches

Report Body (Pie/Bar/Heatmap)

The Module Throughput Report contains the following two analysis methods:

  • Batches by Module Name — Pages processed per module.

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

Figure 52. Analysis of Batches by Module Name — Pie Chart

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

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

Figure 53. Analysis of Batches by Module Name — Pie Chart

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

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

Figure 54. Analysis of Batches by Module Name — Bar Chart

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

Figure 55. Analysis of Batches by Module Name — Heat Map

Data Grid

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

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

Figure 56. Batch Instance Report Data

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

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

Example: BC1 for Mailroom Automation Template Batch Class

Batch Class Name Name of the batch class

Example: Mailroom Automation

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

User Throughput

This module generates a user-oriented report for completed batches, based on the time taken by user during the review and validation process. 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 defined below:

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

Figure 57. User Operation Report Filters

Filter Name Options
Start Date Calendar
End Date Calendar
Rows Batches

Operations Time

User Effort

Columns Batches

Operations Time

User Effort

Values Average Duration in milliseconds

Average Duration in Seconds

Total Duration in milliseconds

Total Duration in Seconds

Filter Batches

Operations Time

User Effort

View Table

Chart

Heatmap

Report Body

By default, the User Throughput Report displays as a table based on the options selected for the various filters.

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

Figure 58. Report Body Table

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

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

Figure 59. Chart Style Selection — Bar Chart

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

Figure 60. Chart Style Selection — Heatmap