2.90:Reports: Difference between revisions

From Grooper Wiki
← Older editNewer edit →
No edit summary
No edit summary
Line 36: Line 36:




{|style="margin:auto"
{|style="margin:auto" cellpadding=20
|-
|-
|style="width:33%"|
|style="width:33%"|
Line 59: Line 59:
::* All activities will have "Tasks Processed", "Run Time", "Processing Rate", and "Processing Time" values.
::* All activities will have "Tasks Processed", "Run Time", "Processing Rate", and "Processing Time" values.
|
|
[[file:Reports Batch Statistics 3.png|900px]]
[[file:Reports Batch Statistics 4.png|900px]]
|}
|}


Line 69: Line 69:




{|style="margin:auto"
{|style="margin:auto" cellpadding=20
|-
|-
|style="width:33%"|
|style="width:33%"|
Line 105: Line 105:


=== Create a New Report ===
=== Create a New Report ===
<tabs style="margin:20px">
<tab name="Step 1" style="margin:20px">
==== Add a New Report Instance ====
{|cellpadding=20
|-
|
1. Right click the '''Reports''' folder in the Node Tree.
2. Select "Add" and "Report Instance..."
3. A pop up window will appear to name the '''Report Instance'''.  Here, we chose to name it "Report Example".  Press the "OK" button to add the '''Report Instance''' to the '''Reports''' folder.
|
[[file:Reports Add Report 1.png|1000px]]
|}
</tab>
<tab name="Step 2" style="margin:20px">
==== Select the Report Type ====
{|style="margin:20px"
|-
|
4. Using the dropdown list on the '''''Report Type''''' property, select which report you would like to configure.
|
[[file:Reports Add Report 2.png|1000px]]
|}
</tab>
</tabs>
=== Using the Query Report to Generate Custom Repots ===
The ''Query Report'' allows you to perform a SQL query against any SQL database.  This includes the ability to query the Grooper SQL database.  If the information you want to is query-able in some way from the Grooper database tables, you can make a custom report targeting it!
<tabs style="margin:20px">
<tab name="Step 1" style="margin:20px">
==== Create a Data Connection to the Grooper Database ====
{|style="margin:20px"
|-
|
:1. Navigate to the '''Data Connections''' folder in the '''Infrastructure''' folder.  Traverse the Node Tree following this path.
:::<code>Root Node > Infrastructure > Data Connections</code>
:2. Right click the '''Data Connections''' folder. Select "Add" and "Data Connection..."
:3. A pop up window will appear to name the '''Data Connection'''.  Since we are connecting to the Grooper Database, we named ours "Grooper Database".  Press the "OK" button when finished to add the '''Data Connection''' to the Node Tree.
|
[[file:Reports Custom Query Report 1.png|1000px]]
|}
</tab>
<tab name="Step 2" style="margin:20px">
==== Enter Database Connection Settigns ====
{|style="margin:20px"
|-
|
:1. Expand the '''''Connection Settings''''' properties.  Use the '''''Server Name''''' property to point to the Grooper database's server.  For standard installs, this will be the server running Grooper followed by "\GROOPER" or
:::<code><Server Name>\GROOPER</code>
:2. Select the database name for the Grooper Repository.  This defaults to simply "Grooper".
:3. Enter the User Name and Password to access the database, if needed.
|
[[file:Reports Custom Query Report 2.png|1000px]]
|}
{|cellpadding="10" cellspacing="5" style="margin:auto"
|-style="background-color:#36b0a7; color:white"
|style="font-size:14pt"|'''FYI'''
|
If you are unsure what your Grooper Database's '''''Server Name''''' or '''''Database Name''''' is, open Grooper Config and select the Grooper Repository you are attempting to query.  The '''''Server Name''''' and '''''Database Name''''' will be listed in the property panel.
[[File:Reports Find Server and Database 1.png|center|800px]]
|}
Once connected,
</tab>
</tabs>
== Version Differences ==
There are no notable version differences at this time.

Revision as of 13:07, 3 June 2020

Reports are found and created in the "Reports" node.

Reports display information collected from various Grooper operations.

About

Individual Reports are created as Report Instances in Grooper. What information the Report Instance displays is defined by the Report Type property. There are several "System Reports" that ship with every Grooper install. Many of these are designed to track batch processing automation rates or the productivity of data entry clerks. For example, the "Keystrokes" report tracks the number of keystrokes logged during Data Review for Batches using a specified Batch Process.

There are twelve System Reports that are included in every Grooper installation.

  • Batch Statistics
  • Data Capture Automation
  • Data Review Operators
  • Event Log
  • Keystrokes
  • Pages Scanned
  • Production Batches
  • Project Billing
  • Query Report
  • Scan Operator Efficiency
  • Scan Volume
  • System Health

Each of these reports can be saved as a Word, PDF or Excel file.

Custom reports can also be generated in an Object Library using Microsoft Visual Studio and the Visual Studio Report Designer.

Report Types

The Batch Statistics report details information about each Activity in a Batch Process. This report will give different information, depending on the activity steps in the Batch Process fro a given date range. You can use this information to get a better idea of how good your accuracy, productivity and automation rates are.


1. To run a Batch Statistics report, first change the Report Type property to Batch Statistics

2. Select the Batch Process you wish to report. Here, it is a simple demo process named "Dummy Batch Process".

3. Select a date range for the reporting period using the Report Period property.

4. Press the "Run Report" button to run the report.
  • This will display various information about all batches using the selected process.
  • Each step will contain different information for the activity. For example, for the Recognize the total number of OCR characters recognized will be displayed. You can use this information to get a better idea of how good your accuracy, productivity and automation rates are. The Classify activity will show total folders classified and total folders confident. You can use the different between these values to see how well your Content Model is classifying your documents. The Extract activity will show you how many fields were extracted in error.
  • All activities will have "Tasks Processed", "Run Time", "Processing Rate", and "Processing Time" values.

Back to the top

The Data Capture Automation report returns information from the Data Review activity. This includes total records completed for a Batch Process and total records edited. The percentage of records edited of records completed gives you an "Automation Percentage". If you don't have to edit any field, your data extraction is perfect and your automation rate would be 100%. The report also displays the total number of keystrokes and keystrokes per record.


1. To run a Data Capture Automation report, first change the Report Type property to Data Capture Automation

2. Select the Batch Process you wish to report. Here, it is a simple demo process named "Dummy Batch Process".

3. Select a date range for the reporting period using the Report Period property.

4. Press the "Run Report" button to run the report.
  • This will display information about how many document records were edited during Data Review.
  • This will give you an idea about how well the data extraction portion of your Batch Process automates.
  • For this example, we didn't do too well. At least one field on every document had to be manually updated during data review (Either the field was blank and needed to be entered in, or the wrong value extracted and needed to be changed). So, the "Automation Percentage" is "0.00%". This gives me an idea that my extraction logic in my Content Model could be improved.

]

Sure enough, there was a Data Type extractor not picking up values for a field in my Content Model. After another batch runs through, the "Automation Percentage" changes to "33.33%", reflecting the change.

How To

Create a New Report

Add a New Report Instance

1. Right click the Reports folder in the Node Tree.

2. Select "Add" and "Report Instance..."

3. A pop up window will appear to name the Report Instance. Here, we chose to name it "Report Example". Press the "OK" button to add the Report Instance to the Reports folder.

Select the Report Type

4. Using the dropdown list on the Report Type property, select which report you would like to configure.

Using the Query Report to Generate Custom Repots

The Query Report allows you to perform a SQL query against any SQL database. This includes the ability to query the Grooper SQL database. If the information you want to is query-able in some way from the Grooper database tables, you can make a custom report targeting it!

Create a Data Connection to the Grooper Database

1. Navigate to the Data Connections folder in the Infrastructure folder. Traverse the Node Tree following this path.
Root Node > Infrastructure > Data Connections
2. Right click the Data Connections folder. Select "Add" and "Data Connection..."
3. A pop up window will appear to name the Data Connection. Since we are connecting to the Grooper Database, we named ours "Grooper Database". Press the "OK" button when finished to add the Data Connection to the Node Tree.

Enter Database Connection Settigns

1. Expand the Connection Settings properties. Use the Server Name property to point to the Grooper database's server. For standard installs, this will be the server running Grooper followed by "\GROOPER" or
<Server Name>\GROOPER
2. Select the database name for the Grooper Repository. This defaults to simply "Grooper".
3. Enter the User Name and Password to access the database, if needed.

FYI

If you are unsure what your Grooper Database's Server Name or Database Name is, open Grooper Config and select the Grooper Repository you are attempting to query. The Server Name and Database Name will be listed in the property panel.


Once connected,

Version Differences

There are no notable version differences at this time.

Retrieved from "https://wiki.grooper.com/index.php?title=2.90:Reports&oldid=3241"