Report Viewer
Use the Report Viewer module to produce reports based on the Crystal Reports Viewer.
With Crystal Reports (purchased separately), you design and create your own reports using the visual report designer. The report designer is equipped with tools that support custom report development. This topic only covers information specific to customizing reports for Kofax Capture. It is assumed that you are familiar with both SQL Server and Crystal Reports.
Customizing the Standard Reports
The easiest modification you can make is to use your own logo in place of the Kofax Capture logo. The simplest way to create reports of your own is to modify the standard reports. For example, you can change the groups and/or data columns by modifying the queries used by these reports.
Using Your Own Logo
The Kofax Capture logo that appears in the upper right corner of the standard reports is easily replaced with your own logo.
Using a graphics editor of your choice, size your logo so that is it no larger than 300 pixels wide by 80 pixels high. Save your logo file as logo.bmp in <Kofax Capture installation folder>\Bin\Reports. You can use any color depth.
Making Your Own Custom Reports
If the standard reports cannot be modified to suit your needs, use Crystal Reports to create your own reports.
If you make your own reports, it may be helpful to understand how the logo graphic is integrated into the standard reports. The default logo is placed in the standard reports as an image with a dynamic Graphic Location based on a formula field named LogoLocation. The LogoLocation is specified by the Report Viewer at runtime.
The position of the bitmap image is determined by the location of the upper left corner of the bitmap. Therefore, to accommodate bitmaps of varying sizes, the Kofax Capture Report Viewer positions the CompanyLogo control so that its right edge lines up with the right edge of the PrintDateTime control. Both controls must be present; otherwise, the position of the image does not adjust properly.
Database Connection
The Report Viewer module can be used only with the Kofax Capture database. You cannot use it to generate or view reports based on data from other sources.
When creating custom reports, you need to create an OLE DB (ADO) connection using the Microsoft OLE DB Provider for SQL Server.
If you are using SQL Server database, use the database connection information provided by your database administrator.
If you are using the built-in Kofax Capture Standard database configuration, use the following connection information, where <KCServer> is the location of the Kofax Capture server.
-
Server: <KCServer>\AscentCapture
-
UserID: StatsMgr
-
Password: Screen73
-
Password when USGCB Compliance is selected: HDveq3XTgHS6%h$
-
Database: ACSystem
These reports are not based on the tables in the (deprecated) Stats.mdb database, which is provided for legacy compatibility only.
Database Views
The following database views make it easier to access data for the reports. You can use them with your custom reports.
ViewBatchList
This view includes one row for each batch currently in the system. These values are always available, even if user tracking is not enabled.
| Column | Description |
|---|---|
|
BatchGUID |
String that uniquely identifies a batch. |
|
ExternalBatchID |
External ID of the batch. |
|
BatchName |
Name of the batch. |
|
BatchClassName |
Name of the batch class. |
|
ModuleName |
Localized name of the current module. Same as Queue in Batch Manager. |
|
ModuleUniqueID |
Not localized unique ID for the current module. |
|
ModuleCustom |
True if the current module is a custom module. |
|
Description |
Batch description. |
|
Priority |
Current batch priority. |
|
StationID |
ID of the station processing the batch. |
|
ContainsErrors |
Same as the ! column in Batch Manager. |
|
ActualPages |
Number of pages in the batch as of the last time a session was closed. |
|
ActualDocs |
Number of documents in the batch as of the last time a session was closed. |
|
BatchStatus |
Same as StatsBatchModule.BatchStatus. |
|
BatchStatusName |
String equivalent of BatchStatus. |
|
InProgressString |
Descriptive information about the batch current state when it is being processed. Currently used only by Kofax Capture Network Server. |
|
NextSiteGUID |
Unique ID of the site where the batch is processed next. Same as the current site GUID if Kofax Capture Network Server is not used. |
|
NextSiteName |
Name of the site where the batch is processed next. |
|
CreationDate |
Date and time when the batch was created. |
|
CreationTimeZone |
Number of minutes that the creation time varies from GMT. |
|
CreationSiteGUID |
Unique ID of the site where the batch was created. |
|
CreationSiteName |
Name of the site where the batch was created. |
|
CreationSiteTZName |
String representing the time zone where the batch was created. |
viewStatsBatchSummary
This view includes one row for each row in Statsbatch that also has at least one row in StatsBatchModule. This is essentially one row for each batch. These values are only available if user tracking is enabled.
| Column | Description |
|---|---|
|
BatchName |
Same as in StatsBatch. |
|
CreationStationID |
Same as in StatsBatch. |
|
CreationStationID |
Same as in StatsBatch. |
|
CreationUserID |
Same as in StatsBatch. |
|
CreationUserName |
Same as in StatsBatch. |
|
BatchClass |
Same as in StatsBatch. |
|
BatchClassDescription |
Same as in StatsBatch. |
|
ExternalBatchID |
Same as in StatsBatchModule. |
|
LastSessionDateTime |
Latest EndDateTime for the batch from StatsBatchModule. |
|
FirstSessionDateTime |
Earliest EndDateTime for the batch from StatsBatchModule. |
|
ProcessingSeconds |
The difference between StatsBatchModule.EndDateTime and StatsBatchModule.StartDateTime added up for all sessions. |
|
EndToEndSeconds |
Difference between LastSessionDateTime and FirstSessionDateTime. |
|
Documents 1 |
Difference between StatsBatchModule.DocumentsCreated and StatsBatchModule.DocumentsDeleted added up for all sessions. |
|
Pages 1 |
Difference between StatsBatchModule.PagesCreated and StatsBatchModule.PagesDeleted added up for all sessions. |
|
Priority |
Priority of the batch. If the priority changed as the batch was processed, this is the average priority based on the number of sessions. |
|
ExpectedPages |
Same as in StatsBatchModule. |
|
ExpectedDocs |
Same as in StatsBatchModule. |
|
Deleted |
Greater than 0 if the batch has been deleted. |
|
Exported |
Greater than 0 if the batch has been exported. |
|
PagesPerDocument |
StatsBatchModule.PagesPerDocument. If the number of pages changed as the batch was processed, this is the average number of pages based on the number of sessions. |
|
PagesScanned 1 |
Total of StatsBatchModule.PagesScanned. |
|
PagesDeleted 1 |
Total of StatsBatchModule.PagesDeleted. |
|
DocumentsCreated 1 |
Total of StatsBatchModule.DocumentsCreated. |
|
DocumentsDeleted 1 |
Total of StatsBatchModule.DocumentsDeleted. |
|
ChangedFormTypes 1 |
Total of StatsBatchModule.ChangedFormTypes. |
|
PagesReplaced 1 |
Total of StatsBatchModule.PagesReplaced. |
1 If your custom module statistics attributes aren't properly set in the API, the data in these columns is undefined.
viewStatsSession
|
Column |
Description |
|---|---|
|
ModuleStartDateTime |
Same as in StatsModuleLaunch.StartDateTime. |
|
ModuleEndDateTime |
Same as in StatsModuleLaunch.EndDateTime. |
|
ModuleUniqueID |
Same as in StatsModuleLaunch. |
|
ModuleName |
Same as in StatsModuleLaunch. |
|
UserID |
Same as in StatsModuleLaunch. |
|
UserName |
Same as in StatsModuleLaunch. |
|
StationID |
Same as in StatsModuleLaunch. |
|
SiteID |
Same as in StatsModuleLaunch. |
|
SiteName |
Same as in StatsModuleLaunch. If this value is empty, then the SiteID is substituted. This is the case for an upgrade from versions of Ascent Capture 7.0 or earlier. |
|
OrphanedModule |
Same as in StatsModuleLaunch.Orphaned. |
|
BatchModuleID |
Same as in StatsBatchModule. |
|
ExternalBatchID |
Same as in StatsBatchModule. |
|
BatchDescription |
Same as in StatsBatchModule. |
|
NextModuleUniqueID |
Same as in StatsBatchModule.ModuleCloseUniqueID |
|
NextModuleName |
Same as in StatsBatchModuleModuleName. |
|
SessionStartDateTime |
Same as in StatsBatchModule.StartDateTime. |
|
SessionEndDateTime |
Same as in StatsBatchModule.EndDateTime. |
|
ProcessingSeconds |
Difference between StatsBatchModule.EndDateTime and StatsBatchModule.StartDateTime. |
|
BatchStatus |
Same as in StatsBatchModule. |
|
BatchStatusName |
String equivalent of BatchStatus. |
|
Priority |
Same as in StatsBatchModule. |
|
ExpectedPages |
Same as in StatsBatchModule. |
|
ExpectedDocs |
Same as in StatsBatchModule. |
|
Deleted |
Same as in StatsBatchModule. |
|
PagesPerDocument |
Same as in StatsBatchModule. |
|
PagesScanned 1 |
Same as in StatsBatchModule. |
|
PagesDeleted 1 |
Same as in StatsBatchModule. |
|
DocumentsCreated 1 |
Same as in StatsBatchModule. |
|
DocumentsDeleted 1 |
Same as in StatsBatchModule. |
|
ChangedFormTypes 1 |
Same as in StatsBatchModule. |
|
PagesReplaced 1 |
Same as in StatsBatchModule. |
|
ErrorCode |
Same as in StatsBatchModule. |
|
ErrorText |
Same as in StatsBatchModule. |
|
OrphanedBatch |
Same as in StatsBatchModule.Orphaned. |
1 If your custom module statistics attributes aren't properly set in the API, the data in these columns is undefined.
Saving Custom Reports
The standard report templates are stored in <Kofax Capture installation folder>\Bin\Reports. If you store your custom reports in the same location, they automatically appear in the Report Viewer menu and in the Select Report window.
Report template files must have an .rpt extension. Reports are added to the menu and the window in alphabetical order based on the file name. You can control the sort order by prefixing numbers to the file names, for example:
01_Special Report.rpt
02_Western Region Report.rpt
03_National Report.rpt
The leading numbers are removed from the name for display in the menu or window.
You can also add accelerators to your report names by inserting an ampersand (&) before the character you want to use. For example, you would do the following to make the first letter of each report the accelerator character:
01_&SpecialReport.rpt
02_&WesternRegionReport.rpt
03_&NationalReport.rpt
The Select Report window also has a brief description of each report. Crystal Reports allows you to add a comment about your report in the report summary information. This comment is used by the Select Report window as the report description.
Displaying the Report Settings window
If your custom report includes a text object named DateRangeTitle, the Report Viewer module displays the Report Settings window using the value assigned to DateRangeTitle as the title of the window. The Report Viewer also sets the ReportStart and ReportEnd parameters to the values selected in the window.
If your report does not include parameters named ReportStart and ReportEnd, the window appears and the report is generated, but with logged errors.
If your report does not include a text object named DateRangeTitle, the Report Settings window does not appear.
If the report has the named objects that trigger the Report Settings window as well as other parameters, the Report Settings window is displayed first, followed by the standard Crystal Reports window for only the remaining parameters.
If your custom report has only parameters other than ReportStart and ReportEnd, a standard Crystal Reports window appears instead.
Note that if the standard Crystal Reports parameters window is displayed, the Please Wait window closes before the report completely appears in full.
Paper Size
The Report Viewer module can automatically adjust your report margins so that a single report template can be printed correctly with both A4 and Letter size paper.
To have the Report Viewer module automatically adjust for these standard paper sizes, you should save your report template for Letter size paper with margins set as specified below. The values are selected so that both A4 and Letter have at least quarter-inch margins.
If you use other settings, the Report Viewer does not make automatic adjustments. This may work if you want to use different paper sizes.
The table lists the values are for Letter size paper.
|
Orientation |
Top and Bottom Margins |
Left and Right Margins |
|---|---|---|
|
Landscape |
0.617 inches |
0.500 inches |
|
Portrait |
0.500 inches |
0.617 inches |
When printing to A4, the margins are automatically adjusted to the values in the following table.
|
Orientation |
Top and Bottom Margins |
Left and Right Margins |
|---|---|---|
|
Landscape |
0.500 inches |
0.846 inches |
|
Portrait |
0.846 inches |
0.500 inches |