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:

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

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

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

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

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

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

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

Scripts have to be switched if the user would like to switch the Reporting Database from MS SQL to MariaDB or vice versa. The ETL Scripts for respective Database are at the following location:

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

Report Database Creation

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

Location of “report_create.sql”:

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

User Interface Display

User Interface of Report Frame

• Collapsible panel for Navigation Tree
• Report Display Panel

Collapsible Panel for Navigation Tree

Collapsible Panel contains:

• Expand/Collapse Button
• Navigation Tree

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

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

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

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

Report Display Panel

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

Reports Dashboard

Overview

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

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

• System Health
• System Reporting
• Batch Processing

System Health

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

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

The Services monitored by this report are:

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

System Reporting

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

Batches per Status

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

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

Drill down Feature:

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

Review Validate Backlog

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

Drill down Feature:

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

Batches per Priority

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

Drill down Feature:

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

Batch Processing

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

Pages Processed per Unit Time

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

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

Pages Processed per Batch Class

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

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

Average Pages Processed

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

There is one parameter to configure the widget:

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

Configuring the Dashboard

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

The user also has the provision to create their own custom widgets and add them onto the Reports Dashboard. Dashboards are saved individually for each Ephesoft User.

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

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

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

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

Export Options

Types of export features provided

PDF Export

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

Excel Export

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

Print

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

Fig:1 Export Icons

Throughput Reports

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

Filters used in Throughput Reports

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

Throughput Report by Weekdays

Overview

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

Report Frame

• Filters
• Graphs/Charts
• Data Grid

Graphs/Charts

This section contains two graphs:

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

Bar Chart (Rendered as default)

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

Line Chart

Pie Chart

Data Grid

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

Throughput Report for Weekly Processing

Overview

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

Report Frame

• Filters
• Graphs/Charts
• Data Grid

Graphs/Charts

This section contains two graphs:

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

Bar Chart (Rendered as default)

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

Line Chart

Pie Chart

Data Grid

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

Throughput Reports by Batch Size

Overview

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

Report Frame

• Filters
• Graphs/Charts
• Data Grid

Graphs/Charts

This section contains two graphs:

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

Bar Chart (Rendered as default)

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

Line Chart

Pie Chart

Data Grid

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

Throughput Reports by Batch Class

Overview

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

Report Frame

• Filters
• Graphs/Charts
• Data Grid

Graphs/Charts

This section contains two graphs:

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

Bar Chart (Rendered as default)

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

Line Chart

Pie Chart

Data Grid

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

Throughput Reports by Module

Overview

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

Report Frame

• Filters
• Graphs/Charts
• Data Grid

Graphs/Charts

This section contains two graphs:

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

Bar Chart (Rendered as default)

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

Line Chart

Pie Chart

Data Grid

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

Throughput Reports of Monthly Processing

Overview

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

Report Frame

• Filters
• Graphs/Charts
• Data Grid

Graphs/Charts

This section contains two graphs:

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

Bar Chart (Rendered as default)

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

Line Chart

Pie Chart

Data Grid

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

Throughput Reports for Hourly Processing

Overview

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

Report Frame

• Filters
• Graphs/Charts
• Data Grid

Graphs/Charts

This section contains two graphs:

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

Bar Chart (Rendered as default)

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

Line Chart

Pie Chart

Data Grid

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

Processing By User Report

Overview

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

Report Frame

• Filters
• Data Grid

Filters

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

Data Grid

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

Consistency for Last Sync Time Format

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

Default Filter Configuration

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

Changes in Default Configuration

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

• Start Date = <current day> and End Date = <current day>
  • Batch Class Throughput
  • Batch Size Throughput
  • Module Throughput
  • User Operation Report
• Start Date = <1 Year Ago> and End Date = <current day>
  • Monthly Throughput
  • Time – Based Throughput
• Start Date = <Start of current week> and End Date = <current day>
  • Weekday Throughput

Advanced Reports

Overview

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

It aids administrators in achieving the goal of reducing manual data corrections. To do this, the Reporting Tool monitors Ephesoft performance over time and captures information about the correction process in order to identify where potential bottlenecks may be. It generates detailed reporting on the performance of Ephesoft Document capture system to provide insight into needed adjustments to the system’s classification, extraction rules, and thresholds. As a result the system can be fine-tuned for maximum performance and increased ROI.

Advanced Reports provide an analysis of the ability of Ephesoft to correctly and efficiently classify Documents and Extract fields.

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

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

All Advanced Reports have the provision of being exported as a PDF or Excel File.

Document Correction Report

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

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

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

Report Frame

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

Filters

Columns in Data Table

Charts

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

Navigation and Drilldowns

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

Classification Accuracy Report

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

Report Frame

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

Filters

Columns in Data Table

Charts

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

Navigation and Drilldowns

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

Classification Correction Detail Report

The Classification Correction Report is a low-level report detailing corrections made to Document types within Classification. A Classification Correction is the result of a change in the Document Type of Documents in Review State by the User.

Report Frame

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

Filters

Columns in Data Table

Navigation and Drilldowns

The user can also return to the Parent Report (Classification Accuracy Report) using the link provided on the Top Left corner of the report. Utilizing the two lower level reports will give the user more of an idea on what needs to be changed within the Ephesoft configurations.

Separation Accuracy Report

The Separation Accuracy Report is a mid-level report which aggregates corrections made to Page Counts in Review Module with respect to all Batches run. This gives the user a measure of accuracy for each Document type of every Batch Class.

Report Frame

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

Filters

Columns in Data Table

Charts

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

Navigation and Drilldowns

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

Separation Detail Report

The Separation Correction Report is a low-level report detailing corrections made to Page Counts within Review Module. A Separation Correction is the result of a split, merge, or deletion of a Page in a Document during Classification. These result in the modification of the number of Pages within a Document.

Report Frame

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

Filters

Columns in Data Table

Navigation and Drilldowns

The user can also return to the Parent Report (Separation Accuracy Report) using the link provided on the Top Left corner of the report. Utilizing the two lower level reports will give the user more of an idea on what needs to be changed within the Ephesoft configurations.

Unnecessary Review Report

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

Report Frame

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

Filters

Columns in Data Table

Charts

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

Navigation and Drilldowns

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

False Positive Report

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

Report Frame

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

Filters

Columns in Data Table

Charts

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

Navigation and Drilldowns

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

Extraction Correction Report

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

Report Frame

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

Filters

Columns in Data Table

Charts

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

Navigation and Drilldowns

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

Field Correction Report

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

Report Frame

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

Filters

Columns in Data Table

Charts

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

Navigation and Drilldowns

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

Field Correction Details Report

Field Correction Details Reports are low-level reports that provide the user with all Fields of All Document Types and the number of manual corrections during Extraction. Users are able to easily identify which Fields of Document types (if any) require further investigation. The Field Correction Detail Report provides field-by-field information on what field data was extracted from a Document (the old value) and what an operator entered during Validation (the new value).

Report Frame

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

Filters

Columns in Data Table

Navigation and Drilldowns

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

Analysis Grids

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

The purpose of the Analysis Grid element is to provide a complete package of data analysis capabilities in a single element, providing Ephesoft Users with a lot of functionality.

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

Ephesoft provides users with 2 Analysis Grids:

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

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

Document Correction Analysis Grid

Columns in Data Table

Field Correction Analysis Grid

Columns in Data Table

Saving Changes in Analysis Grid

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

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

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

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

Interaction with Grid

Refresh

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

Restore

This function restores the Analysis Grid view to last saved point

Save

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

Reset

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

Export Options

Export to CSV

This Button exports the Data in .csv format.

Export to MS Excel

This Button exports the Data in .xls format.

Export to PDF

This Button exports the Data in .pdf format.

Add to Dashboard

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

Functions

Columns

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

Formula

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

Sort

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

Filter

User can filter rows based on a specific filter.

Group

User can group rows based on a specific parameter.

Aggregate

User can aggregate rows based on a specific parameter.

Chart

User can create Charts based on specific parameters.

Cross Tab

Pivot and summarize by rows and columns.

Paging

Set the number of rows displayed per page.

Failover Mechanism for Reports

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

The Front-End (UI) of Reports is present and hosted on all servers. Hence, it can be assumed that if Ephesoft is running on a machine, Ephesoft Reports will be accessible via localhost Ephesoft Application.

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

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

[server_registry Table]

[service_status Table]

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

[server_registry Table]

[service_status Table]

Custom Reports

Third party Report Integration with Ephesoft

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

Custom Reports with Ephesoft Reports

Overview

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

Configuration of Custom Report Context

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

Add following under Host tag:

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

• Or, user may have an external server that loads the context of their custom reports and ensure the context is preloaded when integrated custom Reports are accessed.

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

Integration of Custom Report

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

Three tables involved are: reports_folder, report and sub_report:

• Inserting Custom Report context path, if other than existing report contexts in reports_folder table:

Columns in Data Table

• Inserting Custom Report parent folder name, in report table:

Columns in Data Table

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

• Inserting Custom Report’s name, in sub_report table:

Columns in Data Table

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

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

Support for Batches executed of Encrypted Batch Classes:

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

Configuration

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

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

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

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

Print functionality in Ephesoft Reports

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

Known Issues Articles

Known Issue#: 9318

Topic/Category: Reporting

Ephesoft version(s) Affected:

Issue:  No New Batch Information is Getting Written to the Report Database

Root Cause: Time on all the serves in cluster is not in sync.

Solution: Ensure that all Ephesoft severs and DB server are in time sync to ensure that reporting updates accordingly 

< Back| Known Issues Main Page | Next Known Issue #? >

Ephesoft Community, Linux Edition Version 4.0 is a Intelligent Document Capture and Mailroom Automation program developed by Ephesoft, Inc. Copyright (C) 2015 Ephesoft Inc.

This is a free version of Ephesoft’s Enterprise Software for Linux based corporate and government document capture applications.   It is an easy-to-use and powerful Enterprise Content Management system.

Ephesoft’s Linux Community Edition is the open source alternative for Enterprise Content Management, distributed under GNU Affero General Public License version 3.

It is free to download and use forever, making it best suited for developers and technical enthusiasts in non business-critical environments.  Interested parties can Request the Software at Ephesoft.com

***Community Release is available for Linux Only.

Below are some tools and insights to help get you started

Benefits

Ephesoft Community, Linux Edition Version 4.0 provides the following benefits:

1. Open Source
2. Ease-of-use
3. Extensible
4. Scalable
5. Standards-based
6. Battle-tested

Core Installation File

Download –  Ephesoft Community Release

Resource Files for Running Ephesoft Community

• source-code.zip
• ephesoft.zip
• database-update.zip
• db-scripts.zip
• javadocs-community.zip
• META-INF.zip
• m2.zip
• jars.zip
• ReadMe.txt
• HowToBuild.txt

Feature comparison between community and enterprise release :

Feature Changes	Community	Enterprise
External Application Support on RV
Function Key Support on RV
Unlimited Document Type Support
HOCR Signature Support
Encryption Support
Support for processing of Office files
Multithreading support for processing multiple batches at a time
Ephesoft Watermark on exported images
Tesseract OCR
Advanced Recostar OCR
Classify
Extract
Bar code recognition
Module Changes
Reporting
Logi, ETL
Web Scanner
Mobile API/SnapDoc
Web Services Support
Batch Class copy, delete, import/export, unlock
Document Type add, copy, delete, import/export
Index Field add, copy, export/import
Test Extraction, Test Classification
Advanced KV
KV Extraction,  Table Extraction,  Regular Regex Extraction,  Barcode Extraction
Batch execution, deletion, restart
Troubleshoot feature
Regex Pool, Regex Builder
Workflow Management
List of batches in Review & Validation state
Batch Review, Batch Validation
Batch uploading and execution
Plugin Changes
Nuance Plugin
Fuzzy DB Plugin
DB Export Plugin
Export To HPII Filenet Plugin
Filebound Plugin
NSI Export Plugin
IBM-CM Plugin
Docushare Export Plugin
Scripting Plugins
Advanced DA
Folder Monitor Plugin
Email import Plugin
CMIS Import Plugin
CMIS Export Plugin
UI Changes
License Info: System Config screen
Charts on Batch Class & Batch Instance screen	Static	Dynamic
Fuzzy DB configuration
Scanner Profile configuration
License Generator
Web Scanner link on navigator
Licensing information added in footer
Licensing page opens on click of licensing link

Learn more about Ephesoft’s Enterprise Software Product Suite

<Back| 4.0.0.0 Release Documentation

Overview

Fuzzy DB plugin is used to extract the document level fields of a document from records in the database on the basis of the matched value of the HOCR content or the previously extracted value of a document level field. This plug-in involves creation of search engine based indexing and extracting document level field value based on fuzzy match of HOCR content against index. User can configure any Vendor database in order to capture Vendor name, Vendor ID or any other field from the incoming invoices. This can be done simply by mapping the document to the Vendor database table and the index fields of the document to the columns in the database table. The plugin will find the matching vendor from the database and update the fields in the document. Now user can configure different database for different document types of a batch class.

Mapping Configuration

User can map the Document Level Fields with the column of a database table on Fuzzy DB Extraction Configuration Screen under document type of a batch class. When User click on Fuzzy DB Extraction Configuration node, following UI will be presented:

DLF Mapping

To map the DLFs with the columns of a database table, User can follow the below given steps:

• Select a database connection.
• Select a Table.
• Select a Row ID, Row Id drop down will show only columns that follows unique constraint.
• On clicking the ‘Add’ button, following UI will be presented to map the DLFs with columns of database table:

• Now User can map a DLF with the column of database table.

Search Specific Column

Fuzzy DB Extraction Configuration Screen has a column ‘Is Searchable’. It specifies that indexes will be created for those DLF for which Is Searchable is checked when learn DB is clicked. This DLF will be used for searching and generating output at RV screen for fuzzy text search.

Learn Database

Once the mapping is defined, the user can click on “Learn DB” to create indexes of all the records present in the database.

• • Lucene indexing is generated against all database records belonging to all document types which have been mapped for current batch class. Only mapped columns are indexed.
  • Indexes are built on a string which is the combined text of all the fields mapped to various columns of the database table.
  • Separate index directories are created to store indexes per document type per batch class. The hierarchy used for storing index files against each document level field is: <Shared-Folder-Path>\<Batch-Class>\fuzzydb-index\<Document-Type>\<Database-Name>\<Table-Name>.

Dependency

• Fuzzy DB Extraction configuration depends on Database connection that can be configured from System Config Screen.

User can configure the database connection on the following UI:

Refresh button in Fuzzy DB & DB Export

A Refresh button is provided next to connection dropdown both in Fuzzy DB and DB Export. By clicking refresh, newly added connections will also appear in connections drop down.

Need for a common connection pool

With the introduction of Advanced Reporting which is a data-intensive operation, there was a considerable increase in the number of database connections created for both Ephesoft and reports database. Since the maximum number of connections have an upper limit in the database, there was a need to reduce and reuse the already created connections to reduce the overhead of connection generation. To counter this, an implementation has been made where a connection pool will be maintained for Ephesoft and reports database (one-each) at the tomcat container itself and a JNDI connection can be made either by the Ephesoft application or the components in the reporting module(LogiInfo and ETL).

Made Available in v4.0.3.0 and Higher.

Advantages

This approach gave us the following advantages-

1. A shared connection pool could be shared between the Ephesoft and Advanced Reporting as reporting module needs database connection to Ephesoft database for reading data.
2. A single point of configuration for reporting and Ephesoft database. Earlier, database connection information for Ephesoft application had to be specified redundantly in the Ephesoft\Application\WEB-INF\classes\META-INF\dcma-reporting\etl-variables.properties file.
3. Reduce the possibility of exhaustion of database connections since the connections are managed in a controlled way by maintaining a connection pool.
4. HikariCP – A “state-of-the-art” connection pool implementation has been used considering the performance improvements we are aiming at in the future. It is much faster as compared to the earlier connection pool implementation C3p0.

Figure 1-Charts comparing the performance of HIkariCP with other connection pools

Reference- http://brettwooldridge.github.io/HikariCP/

Sample Configuration

Add the following to <Context> tag in the context.xml located at JavaAppServer\conf

<ResourceLink name=”jdbc/ephesoft“

global=”jdbc/ephesoft”

type=”javax.sql.DataSource”/>

<ResourceLink name=”jdbc/reports”

global=”jdbc/reports”

type=”javax.sql.DataSource”/>

The data source configuration will be maintained in the server.xml located at JavaAppServer\conf as shown below:

MariaDB

<Resource name=”jdbc/ephesoft” auth=”Container”

factory=” com.zaxxer.hikari.HikariJNDIFactory ”

type=”javax.sql.DataSource”

minimumIdle=”5″

maximumPoolSize=”100″

connectionTimeout=”300000″

driverClassName=”org.mariadb.jdbc.Driver”

jdbcUrl=”jdbc:mysql://localhost:3306/ephesoft”

dataSource.implicitCachingEnabled=”true”

dataSource.user=”root”

dataSource .password=”root”

connectionTestQuery=”Select 1″ />

<Resource name=”jdbc/reports” auth=”Container”

factory=” com.zaxxer.hikari.HikariJNDIFactory ”

type=”javax.sql.DataSource”

minimumIdle=”5″

maximumPoolSize=”100″

connectionTimeout=”300000″

driverClassName=”org.mariadb.jdbc.Driver”

jdbcUrl=”jdbc:mysql://localhost:3306/report”

dataSource.user=”root”

dataSource .password=”root”

dataSource.implicitCachingEnabled=”true”

connectionTestQuery=”Select 1″ />

MSSQL

<Resource name=”jdbc/ephesoft” auth=”Container”

factory=”com.zaxxer.hikari.HikariJNDIFactory”

type=”javax.sql.DataSource”

minimumIdle=”5″

maximumPoolSize=”50″

connectionTimeout=”300000″

driverClassName=”net.sourceforge.jtds.jdbc.Driver”

jdbcUrl=”jdbc:jtds:sqlserver://localhost:1433;databaseName=ephesoft;sendStringParametersAsUnicode=false;prepareSQL=3″

dataSource.implicitCachingEnabled=”true”

dataSource.user=”sa”

dataSource.password=”Passw0rd”

connectionTestQuery=”Select 1″

/>

<Resource name=”jdbc/reports” auth=”Container”

factory=”com.zaxxer.hikari.HikariJNDIFactory”

type=”javax.sql.DataSource”

minimumIdle=”5″

maximumPoolSize=”50″

connectionTimeout=”300000″

driverClassName=”net.sourceforge.jtds.jdbc.Driver”

jdbcUrl=”jdbc:jtds:sqlserver://localhost:1433;databaseName=report;sendStringParametersAsUnicode=false;prepareSQL=3″

dataSource.implicitCachingEnabled=”true”

dataSource.user=”sa”

dataSource.password=”Passw0rd”

connectionTestQuery=”Select 1″/>

Password Encryption

To enable password encryption for database connection, change the factory attribute in the Resource tag to “com.zaxxer.hikari.encryption.EncryptedHikariJNDIFactory” and provide the encrypted password in the datasource.password attribute.

Windows Authentication

To enable windows authentication with MSSQL change the jdbcUrl as shown below and prove the suitable domain name-

jdbcUrl=”jdbc:jtds:sqlserver://localhost:1433;databaseName= report11111;domain=xyz”;

set datasource.username=”” and datasource.password=””.

Named Instance

To create a MSSQL connection using a named instance set the jdbcUrl property for both Ephesoft and report database connection configuration as-

jdbcUrl=”jdbc:jtds:sqlserver://localhost:1433;databaseName=ephesoft;instance=instance_name;

Replace the instance_name with the name of the MSSQL service.

Overview

This screen defines the operations that can be done on a batch in review state. During this stage, the user can perform various operations on the batch like classifying, splitting, copying, deleting the document etc. The document also explains the various plugin properties that can be set for batches that are in review state. Whenever batch comes to review state, its status is changed to “READY_FOR_REVIEW” and it needs to be reviewed by the user manually, if it is not reviewed automatically (i.e. its confidence score is less than the specified threshold). After the review, the batch processing continues until it reaches validation stage.

To access a Batch in Review state, user needs to hit the URL {http://localhost:8080/dcma/ BatchList.html}, Click on Review subtab and then click on a batch displayed in the grid.

This will open a batch on Review screen (see below screenshot)

Configuration

Please follow the below steps to set Review plugin properties:

• Login to the Ephesoft Admin Module (Batch Class Management).
• Navigate to Batch Class -> Modules -> Review Document module -> Review Document plugin.

Properties:

Review screen with External Application switch ON will look something like this:

Features List

There are three panels in the review screen.

• Left-most-panel or 1^st panel – showing document tree having all classified and unclassified Ephesoft documents in a batch.
• Middle-panel or 2^nd panel – contains the review button and the thumbnail images of pages in document. It also contains the list of document types and the list of documents available for merging.
• Right-most-panel or 3^rd panel shows the enlarged image of the selected document

In the document tree, there are classified as well as unclassified documents. Classified documents are marked by a green border line on its left. Unclassified documents are marked by a red border line on its left.

• Clicking on More menu will open further options for Function Key, External Application, Scanning and Shortcuts.

Function Key

This functionality aims at providing the application user (mainly review operators) the flexibility of customizing the shortcuts for specific operations on the RV screen. The user can run some code script as per the need which will be fired just by pressing a key.

User can define the Function Key from the following UI by clicking on Add menu.

Review screen with Function Key defined will look something like this

External Application

This functionality is used to fire the specified External Application for a batch on the Review screen.

For configuration of External Applications please refer Configuration section.

Scanning

This functionality aims at providing the application user to Re-Scan and Insert pages in a document using a Web scanner.

• Rescan

This feature will redirect user to web scanner screen from where user can only rescan the selected page. On clicking Finish user will be redirected to Review screen again.

Web scanner screen for Rescanning will look like this.

• Insert

This feature will redirect user to web scanner screen from where user can only insert a page which will be added before the selected page. User can insert multiple pages one by one. On clicking Finish user will be redirected to Review screen again.

Web scanner screen for Insert will look like this.

Shortcuts

Clicking on Shortcuts will open a list of shortcuts for operations like Saving, Splitting, Merging, Deleting the document etc.

• User can drag and drop a page from one document to other document on Review screen.

Select the page which has to be moved to other document.

Drag the page over the Document in the left most panel in the which the page has to be moved. The details of the Document on which page is dragged will open on Review screen.

Drop the Page on the middle panel at the desired position.

• User can suppress the Popups on Validation screen by clicking on don’t ask me again checkbox. Next time user performs that operation popup will not come for the current session.

The right-most-panel contains the buttons/shortcuts for splitting, deleting, rotating the document, etc.

Navigation Icons:

Indication on RV screen UI in case drag and drop is not to the correct location.

Highlight Image panel on Review and Validate Screen when Image is dragged from one document to another. This is to remove any ambiguity that user may face while dropping any dragged image on RV screen. Please find below illustrative screenshot.

Support for deletion of multiple pages in Review

This enhancement provides user the ability to delete multiple pages on Review Validate screen. Multiple pages can be selected by pressing Ctrl key and selecting identified pages for deletion. Multi selection of pages for deletion can be made intra document only. Please find below illustrative screenshot:

Multiple Select

This enhancement provides user the ability to merge multiple documents on Review Validate screen. Multiple documents can be selected by pressing Ctrl key and selecting identified documents for merging. Short Cut added for documents merging operation is Ctrl + Shift +/. Please find below illustrative screenshot:

Current Selected Document will automatically be selected with the ones selected with Ctrl. Current Selected Document can be identified with different background color ( Blue in the screenshot) compared to the selected images with color ( Grey in the screenshot).

Review Document

Overview

This screen defines the operations that can be done on a batch in review state. During this stage, the user can perform various operations on the batch like classifying, splitting, copying, deleting the document etc. The document also explains the various plugin properties that can be set for batches that are in review state. Whenever batch comes to review state, its status is changed to “READY_FOR_REVIEW” and it needs to be reviewed by the user manually, if it is not reviewed automatically (i.e. its confidence score is less than the specified threshold). After the review, the batch processing continues until it reaches validation stage.

To access a Batch in Review state, user needs to hit the URL {http://localhost:8080/dcma/ BatchList.html}, Click on Review subtab and then click on a batch displayed in the grid.

This will open a batch on Review screen (see below screenshot)

Configuration

Please follow the below steps to set Review plugin properties:

• Login to the Ephesoft Admin Module (Batch Class Management).
• Navigate to Batch Class -> Modules -> Review Document module -> Review Document plugin.

Properties:

Review screen with External Application switch ON will look something like this:

Features List

There are three panels in the review screen.

• Left-most-panel or 1^st panel – showing document tree having all classified and unclassified Ephesoft documents in a batch.
• Middle-panel or 2^nd panel – contains the review button and the thumbnail images of pages in document. It also contains the list of document types and the list of documents available for merging.
• Right-most-panel or 3^rd panel shows the enlarged image of the selected document

In the document tree, there are classified as well as unclassified documents. Classified documents are marked by a green border line on its left. Unclassified documents are marked by a red border line on its left.

• Clicking on More menu will open further options for Function Key, External Application, Scanning and Shortcuts.

Function Key

This functionality aims at providing the application user (mainly review operators) the flexibility of customizing the shortcuts for specific operations on the RV screen. The user can run some code script as per the need which will be fired just by pressing a key.

User can define the Function Key from the following UI by clicking on Add menu.

Review screen with Function Key defined will look something like this

External Application

This functionality is used to fire the specified External Application for a batch on the Review screen.

For configuration of External Applications please refer Configuration section.

Scanning

This functionality aims at providing the application user to Re-Scan and Insert pages in a document using a Web scanner.

• Rescan

This feature will redirect user to web scanner screen from where user can only rescan the selected page. On clicking Finish user will be redirected to Review screen again.

Web scanner screen for Rescanning will look like this.

• Insert

This feature will redirect user to web scanner screen from where user can only insert a page which will be added before the selected page. User can insert multiple pages one by one. On clicking Finish user will be redirected to Review screen again.

Web scanner screen for Insert will look like this.

Shortcuts

Clicking on Shortcuts will open a list of shortcuts for operations like Saving, Splitting, Merging, Deleting the document etc.

• User can drag and drop a page from one document to other document on Review screen.

Select the page which has to be moved to other document.

Drag the page over the Document in the left most panel in the which the page has to be moved. The details of the Document on which page is dragged will open on Review screen.

Drop the Page on the middle panel at the desired position.

• User can suppress the Popups on Validation screen by clicking on don’t ask me again checkbox. Next time user performs that operation popup will not come for the current session.

The right-most-panel contains the buttons/shortcuts for splitting, deleting, rotating the document, etc.

Navigation Icons:

Indication on RV screen UI in case drag and drop is not to the correct location.

Highlight Image panel on Review and Validate Screen when Image is dragged from one document to another. This is to remove any ambiguity that user may face while dropping any dragged image on RV screen. Please find below illustrative screenshot.

Support for deletion of multiple pages in Review

This enhancement provides user the ability to delete multiple pages on Review Validate screen. Multiple pages can be selected by pressing Ctrl key and selecting identified pages for deletion. Multi selection of pages for deletion can be made intra document only. Please find below illustrative screenshot:

Multiple Select

This enhancement provides user the ability to merge multiple documents on Review Validate screen. Multiple documents can be selected by pressing Ctrl key and selecting identified documents for merging. Short Cut added for documents merging operation is Ctrl + Shift +/. Please find below illustrative screenshot:

Current Selected Document will automatically be selected with the ones selected with Ctrl. Current Selected Document can be identified with different background color ( Blue in the screenshot) compared to the selected images with color ( Grey in the screenshot).

Review Document

Overview

This screen defines the operations that can be done on a batch in review state. During this stage, the user can perform various operations on the batch like classifying, splitting, copying, deleting the document etc. The document also explains the various plugin properties that can be set for batches that are in review state. Whenever batch comes to review state, its status is changed to “READY_FOR_REVIEW” and it needs to be reviewed by the user manually, if it is not reviewed automatically (i.e. its confidence score is less than the specified threshold). After the review, the batch processing continues until it reaches validation stage.

To access a Batch in Review state, user needs to hit the URL {http://localhost:8080/dcma/ BatchList.html}, Click on Review subtab and then click on a batch displayed in the grid.

This will open a batch on Review screen (see below screenshot)

Configuration

Please follow the below steps to set Review plugin properties:

• Login to the Ephesoft Admin Module (Batch Class Management).
• Navigate to Batch Class -> Modules -> Review Document module -> Review Document plugin.

Properties:

Review screen with External Application switch ON will look something like this:

Features List

There are three panels in the review screen.

• Left-most-panel or 1^st panel – showing document tree having all classified and unclassified Ephesoft documents in a batch.
• Middle-panel or 2^nd panel – contains the review button and the thumbnail images of pages in document. It also contains the list of document types and the list of documents available for merging.
• Right-most-panel or 3^rd panel shows the enlarged image of the selected document

In the document tree, there are classified as well as unclassified documents. Classified documents are marked by a green border line on its left. Unclassified documents are marked by a red border line on its left.

• Clicking on More menu will open further options for Function Key, External Application, Scanning and Shortcuts.

Function Key

This functionality aims at providing the application user (mainly review operators) the flexibility of customizing the shortcuts for specific operations on the RV screen. The user can run some code script as per the need which will be fired just by pressing a key.

User can define the Function Key from the following UI by clicking on Add menu.

Review screen with Function Key defined will look something like this

External Application

This functionality is used to fire the specified External Application for a batch on the Review screen.

For configuration of External Applications please refer Configuration section.

Scanning

This functionality aims at providing the application user to Re-Scan and Insert pages in a document using a Web scanner.

• Rescan

This feature will redirect user to web scanner screen from where user can only rescan the selected page. On clicking Finish user will be redirected to Review screen again.

Web scanner screen for Rescanning will look like this.

• Insert

This feature will redirect user to web scanner screen from where user can only insert a page which will be added before the selected page. User can insert multiple pages one by one. On clicking Finish user will be redirected to Review screen again.

Web scanner screen for Insert will look like this.

Shortcuts

Clicking on Shortcuts will open a list of shortcuts for operations like Saving, Splitting, Merging, Deleting the document etc.

• User can drag and drop a page from one document to other document on Review screen.

Select the page which has to be moved to other document.

Drag the page over the Document in the left most panel in the which the page has to be moved. The details of the Document on which page is dragged will open on Review screen.

Drop the Page on the middle panel at the desired position.

• User can suppress the Popups on Validation screen by clicking on don’t ask me again checkbox. Next time user performs that operation popup will not come for the current session.

The right-most-panel contains the buttons/shortcuts for splitting, deleting, rotating the document, etc.

Navigation Icons:

Indication on RV screen UI in case drag and drop is not to the correct location.

Highlight Image panel on Review and Validate Screen when Image is dragged from one document to another. This is to remove any ambiguity that user may face while dropping any dragged image on RV screen. Please find below illustrative screenshot.

Support for deletion of multiple pages in Review

This enhancement provides user the ability to delete multiple pages on Review Validate screen. Multiple pages can be selected by pressing Ctrl key and selecting identified pages for deletion. Multi selection of pages for deletion can be made intra document only. Please find below illustrative screenshot:

Multiple Select

This enhancement provides user the ability to merge multiple documents on Review Validate screen. Multiple documents can be selected by pressing Ctrl key and selecting identified documents for merging. Short Cut added for documents merging operation is Ctrl + Shift +/. Please find below illustrative screenshot:

Current Selected Document will automatically be selected with the ones selected with Ctrl. Current Selected Document can be identified with different background color ( Blue in the screenshot) compared to the selected images with color ( Grey in the screenshot).

Topic/Category: Pickup

Pickup settings have changed in the 4.0 release of Ephesoft from what they were in previous 3.x based versions.

In 3.x series, the pickup service was executed on each server in the cluster and the pickup capacity was set to a value based on the max process capacity on that particular service. For example if the max process capacity for a server is 5, the pickup capacity for the server was usually set to 3. Each of the server therefore could  have a configuration of its own.

3.x:

Beginning from 4.0. The pickup service is executed on single server in a cluster with failover functionality. This is an automatic service that assigns a random server in the cluster to execute the pickup service. The server on which the pickup service is being executed is responsible for picking up all the batches for the cluster while keeping check on the total execution capacity of the cluster.

Thus server.instance.pick.capacity should be set to total max pickup value that one wants to pick up on the cluster, thus when compared to 3.x example the value should be 5+5+5 = 15.

Whereas server.instance.max.process.capacity is independent and must be set to the value which user wants to execute on corresponding server when compared to 3.x example user would like to execute 5 batches on each server thus execution capacity must be set to 5 in 4.x on each server as well.

NOTE: It is recommended that all servers in the cluster be configured using the same max process capacity and pick capacity values. This is because any server in the cluster can be assigned to run the pickup service in case of a failover.

4.x:

It is required that all cron settings for the pickup service be offset per server.
Example of cron setttings:
Server1:

dcma.pickUp.cronjob.expression=30 0/1 * ? * *
dcma.resume.cronjob.expression=30 0/1 * ? * *

Server2:

dcma.pickUp.cronjob.expression=45 0/1 * ? * *
dcma.resume.cronjob.expression=45 0/1 * ? * *

It is recommended that there be a minimum of 15 seconds difference per server.

Note: Release 4120 onwards batch pickup algorithm has been optimized which will help to pick larger number of batches for processing irrespective of the batch class size, earlier batch pick up time was directly proportional to size of batch class.

Overview

This screen defines the operations that can be done on a batch in validation state. During this stage, the user can perform various operations on the batch like classifying, splitting, copying, deleting the document etc., along with the ability to change the value of the document level fields which have been extracted. The document also explains the various plug-in properties that should be set for batches that are in validation state. With the help of these properties Ephesoft facilitates fuzzy search option, suggestion box facility, and development of external modules or applications and integrate them to work together with Ephesoft. Whenever batch comes to validate state, its status is changed to “READY_FOR_VALIDATION” and it needs to be validated by the user manually, if it is not validated automatically.

Below is the screen shot of the Batch List page which contains a tab for the list of all the batches present in “READY_FOR_VALIDATION” state.

Configuration

Please follow the below steps to set the validation plug-in properties:

• Login to the Ephesoft Admin Module (Batch Class Management).
• Navigate to Batch Class -> Modules -> Validate Document module -> Validate Document plugin.

Properties:

External application on Validation Screen

Features List

There are three panels in this screen.

• Left-most-panel or 1^st panel – contains a document tree for the classified and unclassified Ephesoft documents.
• Middle-panel or 2^nd panel – contains the validation button and facilitates fuzzy search option. It also contains the list of document types and the list of documents for merging. Below validation panel document level fields (with their extracted value) are present for the corresponding document.
• Right-most-panel or 3^rd panel shows the enlarged image of the selected document.

Left-most-panel

In the document tree, there are valid as well as invalid documents. Valid documents are marked by a green border line on its left. Invalid documents are marked by a red border line on its left.

User will be redirected to Review view panel on clicking the Review view button at top left of Left most panel. On Review view panel all the pages of selected document will be displayed as thumbnails. On clicking again on Review view button user will be redirected to Document tree panel.

User can change the order of the page in a Document by simply dragging the page to the desired location. When user drags the page to left then remaining pages will shift to right and vice versa.

Middle-panel

Document level fields with their extracted values are displayed in the middle panel. In the below UI document level field is Part Number and extracted value is 998100000015.

Clicking on the table view button opens another panel that contains a table corresponding to the selected document. This option only comes when there is some table configuration given for the document type. The table should contain valid data. If any cell in the table contains any invalid data, then the document is not validated.

Values in table can also be populated by selecting overlay from Right-most-panel.

Table on Review Validate Screen

• Insert: Inserts a new row below the selected row in the table.
• Delete: Deletes the selected rows. A row can be selected for deletion by selecting its check box.
• Delete All: Deletes all the table rows.
• Row Extraction – On clicking on Row extraction a temporary row will be inserted. In the new row user will populate the value from the page on right most panel by drawing overlays which will act as column coordinates x0,x1. Depending upon the coordinate, table extraction will be done. On the basis of extraction results new rows will be inserted in the table.

• Column Extraction – is done to extract values of some specific column. In column extraction user needs to draw overlay for a specific column on the basis of which table extraction is performed as in Row extraction but here instead of adding new rows existing rows get merged with the extracted data for the specified column value. This merging is done by finding the nearest row on the basis of row coordinates within a specified threshold which is 1.5 times the height of extracted row.
• Empty column can be populated by performing manual extraction for the column. For this, user has to select the Column checkbox present on the right of manual extraction button.
• Invalid data extracted during Manual extraction for rows can be discarded by selecting the header checkboxes of a column. Any row with invalid value for the checked column will not be added on performing manual extraction.
• Field View: Navigates to the document level field view.
• This functionality aims at providing the application user (mainly review operators) the flexibility of customizing the shortcuts for specific operations on the RV screen. The user can run some code script as per the need which will be fired just by pressing a key.

Table contains data validated using the table validation rules and column validation patterns defined for it.

In case Table validation rule fails then entire row is highlighted. In case column pattern validation fails then that particular column is highlighted. User can break column validation pattern for a column by hitting Ctrl + B on the column’s cell.

User can define the Validation rules from the following UI by clicking on Add menu.

User can define validation pattern for a column from the following UI. User is also provided an option to use Regex Builder or Regex pool for defining a regex pattern.

User can move between the different columns in a table using Up, Down, Left and Right arrow keys.

User can also copy and paste the values of a column in multiple columns by making overlay using right click.

Fuzzy Search Box

Fuzzy search option returns table data that match a pattern approximately. Every document is mapped to a table in database. Data from the table in database is returned corresponding to the pattern specified in the fuzzy search textbox. User can specify the pattern in fuzzy search textbox in following ways:-

• By typing text in the fuzzy search textbox.
• By single click population from image in right most panel.
• By making overlay on the image in right most panel.

A particular row from that table can be selected for populating data into document level fields.

On Click arrow present in right of a column header user can perform sorting operation and on hovering mouse over columns List of column is displayed along with checkbox in front of every column. When any checkbox is unchecked then that column is removed from Fuzzy search popup for the current session.

User can sort the column by clicking on the column header.

User can change the column ordering by simply dragging the column to the desired position. The change in ordering is maintained for the current session.

Categories

Document level fields can be categorized into different categories. User can define the category from the following UI in Category column. Document level fields will be categorized in Group1 category by default.

Document type with categories defined for document level fields will look like this on Validation screen

Category with all valid document level fields will have a green dot on top left of category tab. Category with any one invalid document field will have a red dot with exclamation mark on the top left of category tab.

Field Types

Document level fields can be of following Field Type

• Text
• List
• Checkbox
• Date
• Multiline
• Combo

User can define the Field type on the following UI from the Field Type dropdown.

Document level fields with different field types will appear as following on UI.

• Ephesoft 4.0 RV provides a feature to soft validate document level fields value in pre validation stage using java script code. It can be used to validate fields or inject any custom js on RV screen. If the custom client side script returns false it is considered to be an invalid state. Ephesoft makes sure that no validation task (UI validation/Script) is done until the operator validates the fields. It can be configured using any js file and including it in ReviewValidate.html. For sample we have provided the function signature in utility.js file.

Case 1 – when function returns false then a popup on Validation screen shows that Validation will not be done as script returns false. No validation operation is performed in this case.

Case 2 – When function returns true then popup on validation screen shows that validation will be done ad script returns true. Validation operation is performed in this case.

• User can configure category of document level field and can also define them as read only with help of batch.xml using scripts. Default value of tags in batch.xml will be same as that defined on UI.
• User can specify any message with a document level field in batch.xml using scripts.

User can copy/cut and paste using Ctrl + X/C/V or using context menu after right click to enter value in Document level field from a word document.

User can perform split operation to split a multipage document. While performing this operation user has option to split retain only document level fields value or only values in tables or both or none.

• For invalid document level field a tooltip will specify the reason for why the document level field is specified as invalid.

• User can suppress the Popups on Validation screen by clicking on don’t ask me again checkbox. Next time user performs that operation popup will not come for the current session.

• Clicking on More menu will open further options for Function Key, External Application, Scanning and Shortcuts.

Function Key

This functionality aims at providing the application user (mainly review operators) the flexibility of customizing the shortcuts for specific operations on the RV screen. The user can run some code script as per the need which will be fired just by pressing a key.

User can define the Function Key from the following UI by clicking on Add menu.

Review screen with Function Key defined will look something like this

External Application

This functionality is used to fire the specified External Application for a batch on the Review screen.

For configuration of External Applications please refer Configuration section.

Scanning

This functionality aims at providing the application user to Re-Scan and Insert pages in a document using a Web scanner.

• Rescan

This feature will redirect user to web scanner screen from where user can only rescan the selected page. On clicking Finish user will be redirected to Review screen again.

Web scanner screen for Rescanning will look like this.

• Insert

This feature will redirect user to web scanner screen from where user can only insert a page which will be added before the selected page. User can insert multiple pages one by one. On clicking Finish user will be redirected to Review screen again.

Web scanner screen for Insert will look like this.

Shortcuts

Clicking on Shortcuts will open a list of shortcuts for operations like Saving, Splitting, Merging, Deleting the document etc.

User can enable/disable page jumping on field change by using a shortcut Ctrl+Shift+\. On enabling page jumping when user navigates between document level fields in a document, page from which the document level field is extracted will be loaded on right most panel. On disabling page jumping when user moves to any document level field in a document, the page on the right most panel will not change.

User can resize the dialogue box using the edges and can reposition it by dragging it to desired position. This change will be maintained for the current session.

Right-most-panel

The right-most-panel contains the buttons for splitting, deleting, rotating the document, etc. These buttons can be used to perform some functionality given in the shortcuts tab. We can select any page from any document and use these buttons to perform the functionality shown in the screen shot below:

Shortcut key to ‘toggle multipage previewer’ in the upper left corner of Validation screen

Shortcut has been added to open multipage previewer.

Shortcut: Ctrl + Shift + o

Please find below illustrative screenshot.

Support for deletion of multiple pages in Validation

This enhancement provides user the ability to delete multiple pages on Review Validate screen. Multiple pages can be selected by pressing Ctrl key and selecting identified pages for deletion. Multi selection of pages for deletion can be made intra document only. Please find below illustrative screenshot:

Assumptions:

1. Since the image enhancements like deskew, etc. is being done in Page Process module in case of Recostar, therefore image enhancement is done in Page Process module only in case of Nuance as well.

2. Despeckling is done by default in pre-processing of image by Nuance. Despeckling means detecting and removing halftone or dithering type noises.

3. Line removal means removing lines. If this feature is enable, then before HOCRing horizontal and vertical rule lines are removed.

4. Line removal is governed from a switch on UI side as auto rotate is governed by switch ‘Nuance Auto Rotate/ deskew Switch’. This will be specific with respect to Batch Class. Please find the screenshot below:

Description

A significant amount of execution data and the backup XML files in the report-data folder get accumulated over a period of time. This piling up of data may hamper the overall application performance in the long run. The clean-up ETL script is responsible for cleaning up the batch execution data from the database and backup xml folder for the batch instance in the report-data folder. The clean-up is performed only for the batches which are in FINISHED state and for which each (DASHBOARD, STANDARD, ADVANCED) type of reporting has been performed.

Configuration

The script is executed in the form a cron job governed by a cron expression named dcma.report.cleanup.cronExpression in the Ephesoft\Application\WEB-INF\classes\META-INF\dcma-reporting\dcma-reporting.properties file. The default cron expression for the execution of clean-up job is set to 0 0 0/12 ? * * which means that the cleanup operation will be performed every 12th hour.

Cleaned Up Components

The Clean-up ETL script removes the following relevant information for the batch instance-

• ACT_HI_ACTINST table
• ACT_HI_PROCINST table
• ACT_HI_VARINST table
• Folder for batch instance backup XMLs in report-data folder

Batch Instance Cleanup

This query removes all the FINISHED batch instance records from the database for which reporting has been completed.

Following are the steps to be followed-

1. Stop Ephesoft server
2. Take a backup of the Ephesoft database.
3. Execute the following SQL query

(For MYSQL\MariaDB and MSSQL)

Delete from batch_instance where last_modified< (select min(last_execution_at) from [REPORT_DB_NAME].last_execution where job in (‘DASHBOARD’,’STANDARD’,’ADVANCED’)) and batch_status=’FINISHED’

4. Restart Ephesoft Server

Description:

Nuance has been upgraded to version 19.0 from 18.6.5.

Nuance v 19 change logs:

OmniPage Capture SDK Change Log

2014-11-22 Version 19.0 (14572.2000)

——————————-

A major release!

=========================================================================

2014-07-21 Version 18.6.7 (14371.1400)

——————————-

Bug fixes:

– Crashes due to PNG files without DPI information fixed (bug #51342)

– Image specific buffer overrun fixed (bug #51342)

– Image specific stack overflow fixed (bug #53934)

Improvements:

– The barcode type Patch Code added

2014-05-12 Version 18.6.6 (14263.100)

——————————-

Bug fixes:

– Image specific floating point exception and crash fixed (bug #51342)

– Fixed handling very small (few pixel) images (bug #52999)

– Image specific infinite loop and crash fixed (bug #53013)

Improvements:

– Handling zone files created with version 19 added

2013-11-11 Version 18.6.5 (13561.1637)

——————————-

– Fixed a bug at zip file handling causing sigsegv mostly when used from Java

– Small fixes in Zoning, PDF font handling, FireWrx, and Mng subline handling

2013-01-22 oplicmgr

——————————-

Fixed a bug in oplicmgr that removed the license file if append failed

2012-12-12 Version 18.6 (12612.1800)

——————————-

A major release!

Most important addition is 64 bit support

2012-12-10 Version 18.6-Beta4 (12610.1316)

——————————-

It’s a 32-bit release

– BAR and OMR modules supported in Linux, too

– COLOR_ARGB supported

– PDF glyph rendering warns if the correct font is not installed

2012-11-19 Version 18.6-Beta (12563.1227)

——————————-

External beta of the 64-bit release of 18.6

===================================================================

2012-11-20 Version 18.5.3 (12570.100)

——————————-

– Zone detection fixed when forced to return small zones

2012-11-06 Version 18.5.2 (12556.1115)

——————————-

Bug fixes:

– Color space handling in JPEG compressed TIFF files fixed

Improvements:

– Zone order returned by kRecLocateZones improved

2012-09-25 Version 18.5.1 (12475.100)

——————————-

– Small fixes in deskew and jbig2

2012-09-19 Version 18.5 (12469.100)

——————————-

A major release! Most important additions:

– The Plus3W (and MOR) engines are supported

– The RecPDF module is added

===================================================================

2011-01-20 Version 15.6.1.2 (11070.100)

——————————

Bug fixes:

– Black and White PNG file input inverted the image; fixed

– Some memory leaks when recognizing a particular Asian image fixed

– Segmentation fault caused by a particular image with a single Korean character fixed

Improvements:

– Some Asian accuracy improvements

2010-12-9 Version 15.6.1.1 (10609.100)

——————————

Bug fixes:

– Handling of JBIG2 compressed PDF images fixed (Incident #56901)

– Some memory leaks fixed (Incident #60579)

– Removed a global symbol “filename” that collided with the libinifile library (Incident #57925)

Improvements:

– DTXT_PDFIOT output supports saving the original (not rotated) image when the

Kernel.Img.KeepOriginalImage setting is true. (Incident #58157)

– Small Korean recognition accuracy improvements

2010-8-17 Version 15.6.1 (10417.100)

—————————-

Improvements:

– Improved detection of Simplified Chinese / Traditional Chinese / Japanese

languages when the input is a single line of Asian text. This functionality

can be enabled with the Kernel.OcrMgr.Asian.EnableCCJRecognition setting.

2010-7-9 Version 15.6.0 (10359.100)

—————————-

Bug fixes:

– Segmentation fault during recognition of a particular, heavily broken, image

(Incident #53800)

– Image only PDF containing some empty lines of text is treated as textual and

generated no output (Incident #56901)

– Segmentation fault during recognition of different Japanese, English, French,

Spanish and German images.

– Arithmetic exception during recognition of different Japanese and English images.

– Page Description is not used with Asian languages

– Some gridded tables an Asian documents are not processed correctly

– PDF text with strangely named embedded font is not detected as italic

Improvements:

– JBIG2 compression added, JBIG2 compressed PDF images are handled now

– kRecSetLicense can load the license file from a relative path

– New API functions: kRecManageLanguages, kRecFindLanguageEx

– New functionality: kRecSetLanguageDetection, kRecGetPageLanguages

2009-7-13 Version 15.5.4 (9359.100)

—————————-

Bug fixes:

– Race condition between two CSDK processes could result in deletion of all files

in the current working directory

– Segmentation fault during recognition of a specific Japanese image

– Segmentation fault during recognition of a specific English image

– Divide by zero error during recognition of a specific Japanese image

– API_GPFAULT_ERR returned during recognition of a specific Japanese image

– DTXT_XMLCOORD output containing an unpaired </dd> tag for an empty image

– DTXT_TXTF missing text (mostly following a bullet)

– DTXT_TXTF second half of text is garbage (many NULL characters)

– IMF_COMP_ERR due to a 260 byte limit in PDF file names (limit increased to 4096)

Improvements:

– Zones are re-ordered after recognition to follow basic text reading order rules.

Affects DTXT_TXTS output mostly.

– Asian output can be in UTF-8 format as well

– Automatic zoning of an empty image returns a warning, not an error.

Consequence: empty output file is created

– The Linux RPM packages are relocatable. Prefix = /usr/local

Following file contains Nuance v 19 change logs:

This API helps to decrypt the batch xml file present in the final drop folder. The batch xml to be decrypted contains a key which is required for decrypting the same. This batch XML can only be decrypted on the server on which the batch was executed because of the uniqueness in the Signature which is determined by Ephesoft application in use

Request Method: POST

Web Service URL: http://{serverName}:{port}/dcma/rest/decryptBatchXml

Sample client code using apache commons http client:-

private static void decryptBatchXml() {
		HttpClient client = new HttpClient();
		String url = "http://localhost:8080/dcma/rest/decryptBatchXml";
		PostMethod mPost = new PostMethod(url);
		mPost.setDoAuthentication(true);
		File file1 = new File("F:\\Ephesoft\\SharedFolders\\BC5\\Final-drop-folder\\BI2\\BI2_batch.xml");
		Part[] parts = new Part[1];
		try {
			parts[0] = new FilePart(file1.getName(), file1);
			MultipartRequestEntity entity = new MultipartRequestEntity(parts, mPost.getParams());
			mPost.setRequestEntity(entity);
			int statusCode = client.executeMethod(mPost);
			if (statusCode == 200) {
				System.out.println("Batch XML decrypted successfully");
				System.out.println(mPost.getResponseBodyAsString());
			} else if (statusCode == 403) {
				System.out.println("Invalid username/password.");
			} else {
				System.out.println(mPost.getResponseBodyAsString());
			}
		} catch (FileNotFoundException e) {
			System.out.println("File not found for processing.");
		} catch (HttpException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		} finally {
			if (mPost != null) {
				mPost.releaseConnection();
			}
		}
	} 

Applies to: v4.0 or Higher

Dashboard reports provides export functionality with following types:

PDF Export:

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

Excel Export:

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

Print:

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

Fig:1 Export Icons

This API helps to decrypt the xml file present in the report-data contained in Ephesoft Installation directory. The xml to be decrypted contains a key which is required for decrypting the batch xml.

Web Service URL: http://{serverName}:{port}/dcma/rest/decryptReportingBatchXml/ {BatchInstanceIdentifier}/{Module}

Request Method: GET

Sample client code using apache commons http client:-

private static void decryptReportingBatchXml() {
		HttpClient client = new HttpClient();
		String url = "http://localhost:8080/dcma/rest/decryptReportingBatchXml/BI2/Folder_Import";
		GetMethod getMethod = new GetMethod(url);
		int statusCode;
		try {
			statusCode = client.executeMethod(getMethod);

			if (statusCode == 200) {
				System.out.println("Web service executed successfully.");
				String responseBody = getMethod.getResponseBodyAsString();
				System.out.println(statusCode + " *** " + responseBody);
			} else if (statusCode == 403) {
				System.out.println("Invalid username/password.");
			} else {
				System.out.println(getMethod.getResponseBodyAsString());
			}
		} catch (HttpException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		} finally {
			if (getMethod != null) {
				getMethod.releaseConnection();
			}
		}
	}

Description:

Nuance has been upgraded to version 19.0 from 18.6.5.

Nuance v 19 change logs:

OmniPage Capture SDK Change Log

2014-11-22 Version 19.0 (14572.2000)

——————————-

A major release!

=========================================================================

2014-07-21 Version 18.6.7 (14371.1400)

——————————-

Bug fixes:

– Crashes due to PNG files without DPI information fixed (bug #51342)

– Image specific buffer overrun fixed (bug #51342)

– Image specific stack overflow fixed (bug #53934)

Improvements:

– The barcode type Patch Code added

2014-05-12 Version 18.6.6 (14263.100)

——————————-

Bug fixes:

– Image specific floating point exception and crash fixed (bug #51342)

– Fixed handling very small (few pixel) images (bug #52999)

– Image specific infinite loop and crash fixed (bug #53013)

Improvements:

– Handling zone files created with version 19 added

2013-11-11 Version 18.6.5 (13561.1637)

——————————-

– Fixed a bug at zip file handling causing sigsegv mostly when used from Java

– Small fixes in Zoning, PDF font handling, FireWrx, and Mng subline handling

2013-01-22 oplicmgr

——————————-

Fixed a bug in oplicmgr that removed the license file if append failed

2012-12-12 Version 18.6 (12612.1800)

——————————-

A major release!

Most important addition is 64 bit support

2012-12-10 Version 18.6-Beta4 (12610.1316)

——————————-

It’s a 32-bit release

– BAR and OMR modules supported in Linux, too

– COLOR_ARGB supported

– PDF glyph rendering warns if the correct font is not installed

2012-11-19 Version 18.6-Beta (12563.1227)

——————————-

External beta of the 64-bit release of 18.6

===================================================================

2012-11-20 Version 18.5.3 (12570.100)

——————————-

– Zone detection fixed when forced to return small zones

2012-11-06 Version 18.5.2 (12556.1115)

——————————-

Bug fixes:

– Color space handling in JPEG compressed TIFF files fixed

Improvements:

– Zone order returned by kRecLocateZones improved

2012-09-25 Version 18.5.1 (12475.100)

——————————-

– Small fixes in deskew and jbig2

2012-09-19 Version 18.5 (12469.100)

——————————-

A major release! Most important additions:

– The Plus3W (and MOR) engines are supported

– The RecPDF module is added

===================================================================

2011-01-20 Version 15.6.1.2 (11070.100)

——————————

Bug fixes:

– Black and White PNG file input inverted the image; fixed

– Some memory leaks when recognizing a particular Asian image fixed

– Segmentation fault caused by a particular image with a single Korean character fixed

Improvements:

– Some Asian accuracy improvements

2010-12-9 Version 15.6.1.1 (10609.100)

——————————

Bug fixes:

– Handling of JBIG2 compressed PDF images fixed (Incident #56901)

– Some memory leaks fixed (Incident #60579)

– Removed a global symbol “filename” that collided with the libinifile library (Incident #57925)

Improvements:

– DTXT_PDFIOT output supports saving the original (not rotated) image when the

Kernel.Img.KeepOriginalImage setting is true. (Incident #58157)

– Small Korean recognition accuracy improvements

2010-8-17 Version 15.6.1 (10417.100)

—————————-

Improvements:

– Improved detection of Simplified Chinese / Traditional Chinese / Japanese

languages when the input is a single line of Asian text. This functionality

can be enabled with the Kernel.OcrMgr.Asian.EnableCCJRecognition setting.

2010-7-9 Version 15.6.0 (10359.100)

—————————-

Bug fixes:

– Segmentation fault during recognition of a particular, heavily broken, image

(Incident #53800)

– Image only PDF containing some empty lines of text is treated as textual and

generated no output (Incident #56901)

– Segmentation fault during recognition of different Japanese, English, French,

Spanish and German images.

– Arithmetic exception during recognition of different Japanese and English images.

– Page Description is not used with Asian languages

– Some gridded tables an Asian documents are not processed correctly

– PDF text with strangely named embedded font is not detected as italic

Improvements:

– JBIG2 compression added, JBIG2 compressed PDF images are handled now

– kRecSetLicense can load the license file from a relative path

– New API functions: kRecManageLanguages, kRecFindLanguageEx

– New functionality: kRecSetLanguageDetection, kRecGetPageLanguages

2009-7-13 Version 15.5.4 (9359.100)

—————————-

Bug fixes:

– Race condition between two CSDK processes could result in deletion of all files

in the current working directory

– Segmentation fault during recognition of a specific Japanese image

– Segmentation fault during recognition of a specific English image

– Divide by zero error during recognition of a specific Japanese image

– API_GPFAULT_ERR returned during recognition of a specific Japanese image

– DTXT_XMLCOORD output containing an unpaired </dd> tag for an empty image

– DTXT_TXTF missing text (mostly following a bullet)

– DTXT_TXTF second half of text is garbage (many NULL characters)

– IMF_COMP_ERR due to a 260 byte limit in PDF file names (limit increased to 4096)

Improvements:

– Zones are re-ordered after recognition to follow basic text reading order rules.

Affects DTXT_TXTS output mostly.

– Asian output can be in UTF-8 format as well

– Automatic zoning of an empty image returns a warning, not an error.

Consequence: empty output file is created

– The Linux RPM packages are relocatable. Prefix = /usr/local

Following file contains Nuance v 19 change logs:

Description

A significant amount of execution data and the backup XML files in the report-data folder get accumulated over a period of time. This piling up of data may hamper the overall application performance in the long run. The clean-up ETL script is responsible for cleaning up the batch execution data from the database and backup xml folder for the batch instance in the report-data folder. The clean-up is performed only for the batches which are in FINISHED state and for which each (DASHBOARD, STANDARD, ADVANCED) type of reporting has been performed.

Configuration

The script is executed in the form a cron job governed by a cron expression named dcma.report.cleanup.cronExpression in the Ephesoft\Application\WEB-INF\classes\META-INF\dcma-reporting\dcma-reporting.properties file. The default cron expression for the execution of clean-up job is set to 0 0 0/12 ? * * which means that the cleanup operation will be performed every 12th hour.

Cleaned Up Components

The Clean-up ETL script removes the following relevant information for the batch instance-

• ACT_HI_ACTINST table
• ACT_HI_PROCINST table
• ACT_HI_VARINST table
• Folder for batch instance backup XMLs in report-data folder

Batch Instance Cleanup

This query removes all the FINISHED batch instance records from the database for which reporting has been completed.

Following are the steps to be followed-

1. Stop Ephesoft server
2. Take a backup of the Ephesoft database.
3. Execute the following SQL query

(For MYSQL\MariaDB and MSSQL)

Delete from batch_instance where last_modified< (select min(last_execution_at) from [REPORT_DB_NAME].last_execution where job in (‘DASHBOARD’,’STANDARD’,’ADVANCED’)) and batch_status=’FINISHED’

4. Restart Ephesoft Server

Introduction

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

Changes in Configuration

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

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

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

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

This API helps to decrypt the HOCR file present in lucene-search-classification-sample within the batch class folder located in the Shared Folders.

Web Service URL: http://{serverName}:{port}/dcma/rest/decryptLuceneClassificationHocrXml

Request Method: POST

Input Parameters

Sample client code using apache commons http client:-

private static void decryptLuceneClassificationHocrXml() {
		HttpClient client = new HttpClient();
		String url = "http://localhost:8080/dcma/rest/decryptLuceneClassificationHocrXml";
		PostMethod mPost = new PostMethod(url);
		mPost.setDoAuthentication(true);
		// Input zip file for importing batch class.
		Part[] parts = new Part[4];
		try {
			parts[0] = new StringPart("hocrFileName", "US-Invoice_HOCR.xml");
			parts[1] = new StringPart("batchClassIdentifier", "BC5");
			parts[2] = new StringPart("pageType", "First");
			parts[3] = new StringPart("documentType", "US Invoice");
			MultipartRequestEntity entity = new MultipartRequestEntity(parts, mPost.getParams());
			mPost.setRequestEntity(entity);
			int statusCode = client.executeMethod(mPost);
			if (statusCode == 200) {
				System.out.println("HOCR  XML decrypted successfully");
				String responseBody = mPost.getResponseBodyAsString();
				System.out.println(statusCode + " *** " + responseBody);
			} else if (statusCode == 403) {
				System.out.println("Invalid username/password.");
			} else {
				System.out.println(mPost.getResponseBodyAsString());
			}
		} catch (FileNotFoundException e) {
			System.out.println("File not found for processing.");
		} catch (HttpException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		} finally {
			if (mPost != null) {
				mPost.releaseConnection();
			}
		}
	} 

Overview & Purpose

Access Manager Screen is only visible to Super-Admin. Super-Admin uses this screen to restrict the logged-in user to view some of the Administrative and Operational screens on the basis of role of the logged-in user .This screen is visible on System Configuration screen.

Allowing & Restricting Screens

By default no screen is assigned to any role. Super-Admin can simply assign the screen to the role by just check-in the check-box displaying under the screen name and against the role name.

Only the assigned screen URL will be shown on the Screen Navigator of the logged-in user.

If logged-in user try to access the screen which is not assigned to the user, then below screen will display to the logged-in user

If none of the Administrative type screen (like Batch Class Management, Batch Instance Management, Folder Management, Reports) is assigned to the role then, Administrator tag will not be visible on screen navigator of the logged-in user.

If none of the Operational type screen (like Batch List, Upload Batch, Web Scanner, Review Validate) is assigned to the role then, operator tag will not be visible on screen navigator of the logged-in user.