Statistical Reporting Tool. Installation & Use Guide

Transcription

1 Statistical Reporting Tool For Kofax Ascent Capture V. 6.X / 7.X Version 2.6 Installation & Use Guide ImageTech Systems, Inc. Slate Hill Business Center 3913 Hartzdale Drive Suite 1300 Camp Hill, PA Last Updated: March 6, 2007

2 Table of Contents Table of Contents Introduction Additional Documentation System Requirements Kofax Ascent Capture Support Features View customized reports from Administration Module View customized reports from the Start Menu Integrated Report Setup Real-time Report Support Standard Reports Robust Report Viewer Installing the Statistical Reporting Tool Prerequisites Installation Instructions Confirm Installation Using the Statistical Reporting Tool Prerequisites User Instructions Changing the Company Name SQL query timeout configuration Ascent SQL Support Interpreting Standard Reports Document Throughput (Per Batch Class) Document Throughput (Per Document Class) Document Throughput (Per Form Type) Process History of Active Batches Validation Productivity by User Batches Processed Through QC Module User Productivity / Efficiency by Module Scan Volume Productivity by User Batch Processing by Module/User

3 1.0 Introduction This document provides information on the installation and use of ImageTech Systems Statistical Reporting Tool for Kofax Ascent Capture. Please read the following documentation, as it will assist in the installation, use and support of the Statistical Reporting product. 1.1 Additional Documentation For additional clarification on Ascent concepts discussed in this document, consult the documentation provided with your Ascent software. 2

4 2.0 System Requirements The Statistical Reporting Tool for Ascent Capture requires the following components to be installed prior to installation. 2.1 Kofax Ascent Capture Support Kofax Ascent Capture Version 6.x / 7.x 3

5 3.0 Features This section contains information about features provided by the Statistical Reporting Tool for Ascent Capture. 3.1 View customized reports from Administration Module The Statistical Reporting Tool seamlessly integrates with the Ascent Capture Administration module in the form of a menu bar. 3.2 View customized reports from the Start Menu The Statistical Reporting Tool is also available from a folder on the Start Menu that contains shortcuts to each Report Type. 3.3 Integrated Report Setup The Statistical Reporting Tool has an easy to use installer that installs the Reporting Module, and plugs it into Ascent. 3.4 Real-time Report Support The Statistical Reporting Tool allows the user to modify report criteria on the fly. Criteria such as date ranges and user names can be used to specify the type of data that is to be reported. The Statistical Reporting Tool defaults to building a report up to the current date in the current month. 3.5 Standard Reports The Statistical Reporting Tool comes pre-packaged with nine standard reports to choose from. Additional reports can be added if needed. 3.6 Robust Report Viewer The Statistical Reporting Tool uses Crystal Reports.NET to fully integrate valuable reports with your Ascent Capture Administration module. A parameter-based system is used to allow for the addition of new reports easily. 4

6 4.0 Installing the Statistical Reporting Tool The Statistical Reporting Tool must be installed on a machine running Kofax Ascent Capture 6.x / 7.x. 4.1 Prerequisites Kofax Ascent Capture version 6.x / 7.x 4.2 Installation Instructions Follow the installation order listed above for prerequisite software. Insert the installation CD or download the installer to disk. Run the "AscentStatsTool.msi" file on the CD or disk. This will launch the installation wizard for the Statistical Reporting Tool for Ascent Capture. On the Welcome screen, click Next. 5

7 On the Select Installation Folder screen, confirm the Folder and click Next. On the Confirm Installation screen, click Next. 6

8 Wait while the Statistical Reporting Tool is installed. On the Installation Complete screen, click Close. 7

9 4.3 Confirm Installation To confirm that the program installed correctly, open the Ascent Capture Administration module from the Start Menu. (Start Programs Ascent Capture 6.x / 7.x Administration) You should see a menu for Reports in the menu bar of your Ascent Capture Administration module. A number of standard reports should appear under this menu. 8

10 5.0 Using the Statistical Reporting Tool The Statistical Reporting Tool for Ascent Capture allows users to view reports on user activity and batch processing within the Ascent Capture system. The reports group and aggregate data from the Ascent User Tracking Data Tables. 5.1 Prerequisites In order to use the Statistical Reporting Tool for Ascent Capture, User Tracking must be enabled. You can enable User Tracking from the Ascent Capture Administration module. 5.2 User Instructions 1. To launch the Statistical Reporting Tool for Ascent Capture, open the Ascent Capture Administration module from the Programs menu on your system. (Start Programs Ascent Capture 6.x / 7.x Administration) Alternatively, you can select a report shortcut from the Start Menu. (Start Programs ImageTech Systems Statistical Reporting Tool for Ascent Capture) 9

11 2. Click on Reports in the menu bar of the Ascent Capture Administration module. 3. Click on the name of a report from the Reports menu to launch that report in the Report Viewer. 4. At the top of the Report Viewer, a number of entry boxes may appear to let you enter filter values for User, Start Date, and End Date. (The filter options that appear depend on the report) Click Show the Report to refresh the report with the newly specified filter. 10

12 5. You can use the controls in the tool bar just above the Main Report window to perform various operations on the report: a. Navigate through the various pages of a multi-page report. b. Go directly to a specified page in the report. c. Print the report. d. Save the report to a file. e. Zoom in or out of the report in the Main Report window. f. Search for text in the report. 5.3 Changing the Company Name As can be seen in the screen shot above, the reports include a Company Name field in each of the report headers. By default this value is set to Sample Company Name, but this can be changed locally, and it is recommended to do so. This setting is contained in the Statistical Reporting Tool configuration file Settings.xml. The file can be found in the programs installation directory: C:\Program Files\ImageTech Systems\Statistical Reporting Tool for Ascent Capture\ Note: The above path may be different if the program was installed in a different location, such as on a drive other than the "C" drive. Open Settings.xml and change To <CompanyName>Sample Company Name</CompanyName> <CompanyName>{Your Company Name}</CompanyName> Where the text between the brackets {} is the name of your company (excluding the brackets {}). Save and Close the file. 5.4 SQL query timeout configuration As the Ascent Statistics database fills with more user tracking data, and depending on the date range of the reports being run, the SQL queries may take longer to run, causing a SQL Timeout error. 11

13 The timeout for the SQL query to gather the statistics data can be increased by modifying the Statistical Reporting Tool configuration file Settings.xml. The file can be found in the programs installation directory: C:\Program Files\ImageTech Systems\Statistical Reporting Tool for Ascent Capture\ Note: The above path may be different if the program was installed in a different location, such as on a drive other than the "C" drive. Open Settings.xml and change To <SQLTimeOut>60</SQLTimeOut> <SQLTimeOut>{120}</SQLTimeOut> Where the text between the brackets {} is the new timeout value in seconds (excluding the brackets {}). Save and Close the file. 5.5 Ascent SQL Support If SQL server is used to hold the Ascent Statistics data, and Windows Authentication is NOT used to connect to the database, then the following user must have read access to the SQL database. Username: StatsMgr Password: Screen73 You can confirm the Ascent Database configuration by running the Ascent Capture Database Utility dbutil.exe. Open the Start Menu and select the Run command. Enter dbutil.exe and click OK. 12

14 If your screen looks similar to the following (but with a different Login ID) then you need to create the StatsMgr account in your SQL database, with the appropriate password. 13

15 6.0 Interpreting Standard Reports The Statistical Reporting Tool for Ascent Capture installs a number of standard reports. 1 - Document Throughput (Per Batch Class) This report displays aggregate statistics on the number of documents and pages released for each batch class during the specified period. The report is grouped by Batch Class. The name of the Batch Class will appear, followed by reported numbers for the total, average, minimum, and maximum number of first Documents, and then Pages, released for batches of that batch class during the specified period. The report header displays the total number of Documents and Pages released for all Batches during the specified period. The report user specifies a date range by which to filter the report. The report will only include counts from batches released within the range. 14

16 2 - Document Throughput (Per Document Class) This report displays aggregate statistics on the number of documents and pages released of each document class during the specified period. The report is grouped by Document Class. The name of the Document Class and its corresponding Batch Class appears in the header for each group. This is followed by reported numbers for the total, average, minimum, and maximum number of first Documents, and then Pages, released of that document class during the specified period. The report header displays the total number of Documents and Pages released for all Document Classes during the specified period. The report user specifies a date range by which to filter the report. The report will only include counts from batches released within the range. 15

17 3 - Document Throughput (Per Form Type) This report displays aggregate statistics on the number of documents and pages released of each form type during the specified period. The report is grouped by Form Type. The name of the Form Type and its corresponding Batch Class appears in the header for each group. This is followed by reported numbers for the total, average, minimum, and maximum number of first Documents, and then Pages, released of that document class during the specified period. The report header displays the total number of Documents and Pages released for all Form Types during the specified period. The report user specifies a date range by which to filter the report. The report will only include counts from batches released within the range. 16

18 4 Process History of Active Batches This report displays information about the processing that each batch still active in the system has undergone. The report is grouped by Batch Class. The name of the Batch Class appears in the header for each group. For each Batch Class, each currently active Batch is listed ( Batch Name column) with each module that the batch class has been processed through ( Module Name column) and the date and time that it was closed or suspended in that module ( Last Processed column). The process history is sorted by Last Processed time so that all the process records for a particular batch will appear in the order they occurred. There may be multiple entries for the same Batch and Module Name if the batch was processed multiple times in a given module. 17

19 5 Validation Productivity by User This report displays statistics on each user s Validation activities. The report is grouped by User, and sub-grouped by Document Class. The name of the User appears in the header for each group. This is followed by a sub-group for each Document Class for which the user processed batches in Validation, headed by the Document Class name and its corresponding Batch Class name. For each Document Class, a record appears for each time a batch was processed by this user in the validation module, recording the Batch Name, Date/Time, and keystroke counts for the Manual Entries made, OCR Repairs performed, ICR Repairs performed, OMR Repairs performed, Bar Code Repairs performed, and a total of all keystrokes the user made in performing these repairs and entries. At the end of each User sub-group, the Total entries, repairs, and overall keystrokes that the user made in processing all their batches through Validation are recorded. At the end of the report, aggregate Grand Totals of all entries, repairs, and overall keystrokes made in Validation by all users are recorded. The reporter can specify a date range by which to filter the report. The report will only include batches processed by users in validation within the range. The reporter can also specify an Ascent User Name by which to filter the report. The report will only include batches processed by the User name provided. If no User name is provided, the report will include batches processed by all users. 18

20 6 Batches Processed Through QC Module This report provides a list of all batches that were sent to the Quality Control module during the period specified, that were processed in Quality Control by the user specified. The report is grouped by Batch Class. The name of the Batch Class appears in the header for each group. This is followed by a record for each Batch of this Batch Class that was run through Quality Control, giving the Ascent User name of the user to process the batch in QC, the Batch Name, the name of the module that the batch was being processed in prior to being routed to QC ( Module Sent From column), and the Time Sent to QC. The reporter can specify a date range by which to filter the report. The report will only include batches processed by users in validation within the range. The reporter can also specify an Ascent User Name by which to filter the report. The report will only include batches processed in quality control by the User name provided. If no User name is provided, the report will include batches processed by all users. 19

21 7 User Productivity / Efficiency by Module This report displays aggregate statistics on the amount of time each user spent processing batches in each of the Ascent Capture modules. The report is grouped by User, and sub-grouped by the Module name. The name of the User appears in the header for each group. This is followed by a sub-group for each Module headed by the module name. For each Module, a record appears for each time a batch was processed by this user in the module, recording the Date/Time, the Batch Name, the Batch Class to which it belongs, the total amount of time the user spent processing the batch, the number of documents in the batch, and the average time spent on each document. At the end of each Module sub-group, there is a total for the Time the user spent processing batches, a total number of Documents processed, and an average of the Time spent processing each document. The reporter can specify a date range by which to filter the report. The report will only include batches processed by users in validation within the range. The reporter can also specify an Ascent User Name by which to filter the report. The report will only include batches processed by the User name provided. If no User name is provided, the report will include batches processed by all users. 20

22 8 Scan Volume Productivity by User This report displays aggregate statistics on the number of pages and documents of each Batch Class scanned by each user during the specified period. The report is grouped by User, and sub-grouped by the Batch Class name. The name of the User appears in the header for each group. This is followed by a sub-group for each Batch Class headed by the batch class name. For each Batch Class, records are listed for each time pages were scanned for a batch of this class by this user, recording the Batch Name, the Date/Time of scanning, the number of documents created ( Document Count ), and the total number of Pages Scanned. At the end of each Batch Class sub-group, the SubTotal number of pages and documents that the user scanned for batches of this batch class is recorded. The reporter can specify a date range by which to filter the report. The report will only include batches processed by users in validation within the range. The reporter can also specify an Ascent User Name by which to filter the report. The report will only include batches scanned by the User name provided. If no User name is provided, the report will include batches scanned by all users. 21

23 9 Batch Processing by Module/User This report displays aggregate statistics on the amount of time each user spent processing batches of all Batch Classes in each of the Ascent Capture modules. The report is grouped by User, then Module name, and sub-grouped by the Batch Class. The name of the User appears in the header for each group. This is followed by a subgroup for each Module headed by the module name. For each Module, there is a subgroup for each Batch Class processed through that module with the Batch Class name as its title. A record appears for each time a batch of this type was processed by this user in the module, recording the Batch Name, the total Time the user spent processing the batch, as well as the number of Documents in the batch, and the average time spent on each document. At the end of each Batch Class sub-group, there are Totals for the Time that the user spent processing batches, Total number of Documents processed, and the Average Time spent on each document. The reporter can specify a date range by which to filter the report. The report will only include batches processed by users in validation within the range. The reporter can also specify an Ascent User Name by which to filter the report. The report will only include batches processed by the User name provided. If no User name is provided, the report will include batches processed by all users. 22