{"id":35806,"date":"2019-12-13T14:22:51","date_gmt":"2019-12-13T21:22:51","guid":{"rendered":"https:\/\/ephesoft.com\/docs\/?page_id=35806"},"modified":"2020-05-19T12:23:47","modified_gmt":"2020-05-19T19:23:47","slug":"dashboard-and-throughput-reports","status":"publish","type":"docs","link":"https:\/\/ephesoft.com\/docs\/products\/transact\/features-and-functions\/administrator\/reporting\/dashboard-and-throughput-reports\/","title":{"rendered":"Dashboard and Throughput Reports"},"content":{"rendered":"
The following article describes Dashboard and Throughput Reports in Ephesoft Transact. These reports provide information to administrators about the performance of their instance.<\/p>\n
Note:\u00a0<\/strong>This document applies to Ephesoft Transact 2019.1 and above.<\/p>\n Access reports from either of the following methods:<\/p>\n <\/p>\n Figure 1. Ephesoft Transact Administrator and Operator Menus from Left-side Navigation<\/em><\/p>\n <\/p>\n Figure 2. Transact DCMA Home Page \u2014 Administrator > Reports<\/strong><\/em><\/p>\n <\/p>\n Figure 3. Ephesoft Transact Login Screen<\/em><\/p>\n The Reports<\/strong> home page has the following features:<\/p>\n The collapsible navigation pane on the left of the Reports<\/strong> page contains Expand All <\/strong>and Collapse All<\/strong> buttons along with the navigation tree hierarchy.<\/p>\n The Expand All <\/strong>and Collapse All<\/strong> buttons expand and collapse the navigation tree hierarchy respectively.<\/p>\n <\/p>\n Figure 4. Navigation Pane with Dashboard Reports<\/strong> Landing Screen \u2014 System Health<\/strong> Tab<\/em><\/p>\n The following screenshot illustrates the fully expanded navigation menu in Ephesoft Transact.<\/p>\n <\/p>\n Figure 5. Full Structure of the Reports Module, Administrator > Reports<\/strong><\/em><\/p>\n The navigation tree hierarchy contains the following types of reports:<\/p>\n There are many Ephesoft report sub-types.<\/p>\n By default, the Dashboard Report<\/strong> is displayed when the user selects or refreshes the Reports<\/strong> page.<\/p>\n <\/p>\n Figure 6. Three Tabs of Dashboard Reports<\/strong><\/em><\/p>\n Selecting any other type of report from the navigation tree displays the corresponding report.<\/p>\n Dashboard Reports<\/strong> is the first screen displayed to the user when accessing Ephesoft reports.<\/p>\n The Dashboard<\/strong> is an interactive and customizable panel that displays information about the current state of Ephesoft. The Dashboard<\/strong> has three tabs:<\/p>\n By default, the System Health<\/strong> tab is displayed when viewing the Dashboard Report<\/strong>.<\/p>\n This tab displays the date-wise uptime status of Ephesoft servers and services. By default, information for current date is displayed.<\/p>\n <\/p>\n Figure 7. Dashboard Reports \u2014 System Health<\/strong> Tab<\/em><\/p>\n Information about the services handled by a particular server is shown below the main Server Status<\/strong> chart.<\/p>\n <\/p>\n Figure 8. Dashboard Reports \u2014 System Health<\/strong> Tab<\/em><\/p>\n The following services are monitored by this report:<\/p>\n The System Reporting<\/strong> tab displays the following information by using batches as a parameter:<\/p>\n 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:<\/p>\n <\/p>\n Figure 9. System Reporting<\/strong> tab \u2014 Batch Class<\/strong> Drop-down<\/em><\/p>\n <\/p>\n Figure 10. System Reporting<\/strong> Tab \u2014 Batch Status<\/strong> Legend<\/em><\/p>\n 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.<\/p>\n <\/p>\n Figure 11. System Reporting<\/strong> Tab \u2014 Clicking the Pie Chart<\/em><\/p>\n The Review Validate Backlog <\/strong>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.<\/p>\n <\/p>\n Figure 12. Review Validate Backlog<\/strong> Widget<\/em><\/p>\n Click a status bar to display details of batches in the corresponding state.<\/p>\n <\/p>\n Figure 13. Review Validate Backlog<\/strong> Widget<\/em><\/p>\n 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.<\/p>\n <\/p>\n Figure 14. Batches Per Priority<\/strong> Widget<\/em><\/p>\n 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.<\/p>\n <\/p>\n Figure 15. Batches Per Priority<\/strong> Widget \u2014 Alternate Bar Chart View<\/em><\/p>\n 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.<\/p>\n <\/p>\n Figure 16. Batches Per Priority<\/strong> Widget \u2014 Batches Grouped by Status<\/em><\/p>\n The Batch Processing<\/strong> tab displays the following information using number of pages in a batch as a parameter.<\/p>\n 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:<\/p>\n Note<\/strong>: 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.<\/p>\n <\/p>\n Figure 17. Batch Processing Widget \u2014 Pages Process Per Unit of Time<\/em><\/p>\n The Pages Processed per Batch Class<\/strong> 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.<\/p>\n <\/p>\n Figure 18. Pages Processed Per Batch Class Widget<\/em><\/p>\n The Average Pages Processed<\/strong> widget displays the average number of pages processed, according to batch and according to document.<\/p>\n <\/p>\n Figure 19. Average Pages Processed Widget<\/em><\/p>\n The user can modify the widget using the following parameter:<\/p>\n The Ephesoft Reports Dashboard<\/strong> 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.<\/p>\n Users can create their own custom widgets and add them onto the Reports Dashboard<\/strong>. Dashboards are saved individually for each Ephesoft user.<\/p>\n 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.<\/p>\n Saved dashboards are stored in the {Ephesoft SharedFolders}\/SavedDashboards <\/strong>folder. The location can be configured.<\/p>\n The user can specify a file name to save the state of dashboard in a Lgx file stored at the following location:<\/p>\n Use Throughput Reports <\/strong>to measure the performance of Ephesoft and its modules. Throughput Reports can be configured using numerous parameters to analyze different aspects of Ephesoft performance.<\/p>\n The rp_throughput_module_data<\/strong> 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.<\/p>\n 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.<\/p>\n The available filters are illustrated and defined as follows:<\/p>\n <\/p>\n Figure 20. Throughput Reports Filters \u2014 Drop-down Menu Options<\/em><\/p>\n The following filters are available in Ephesoft Transact:<\/p>\n<\/a>Accessing Reports<\/h2>\n
\n
\n
\n
\n
<\/a><\/a>Reports Home<\/h2>\n
\n
<\/a><\/a>Collapsible Panel for Navigation Tree Hierarchy<\/h2>\n
\n
<\/a><\/a>Reports Display Panel<\/h2>\n
\n
<\/a>Dashboard Reports<\/h1>\n
\n
<\/a><\/a>System Health<\/h2>\n
\n
<\/a><\/a>System Reporting<\/h2>\n
\n
<\/a><\/a>Batches per Status<\/h3>\n
\n
\n
<\/a><\/a>Review Validate Backlog<\/h3>\n
<\/a><\/a>Batches per Priority<\/h3>\n
<\/a><\/a>Batch Processing<\/h2>\n
\n
<\/a><\/a>Pages Processed per Unit Time<\/h3>\n
\n
\n
\n
<\/a><\/a>Pages Processed per Batch Class<\/h3>\n
<\/a><\/a>Average Pages Processed<\/h3>\n
\n
<\/a><\/a>Configuring the Dashboard<\/h2>\n
\n
<\/a><\/a>Throughput Reports<\/h1>\n
<\/a><\/a>Throughput Reports Filters<\/h2>\n