Skip to main content
Kofax

Queries Against the TotalAgility Product Databases

3022136

Question / Problem: 

Is it supported to query the TotalAgility product databases?

Answer / Solution: 

In general it is not supported to query the TotalAgility databases.  Data from the system should be retrieved only though documented and supported API calls.

Reporting and Analytics

There is a subset of tables and columns that are documented and supported specifically for use in context of analytics. The following links are for KTA 7.7, but the appropriate documents for each version of KTA are available from the full documentation list for that version.

  • Tables for Analytics - describes the Kofax TotalAgility tables and fields used by Kofax Analytics for TotalAgility.
  • Reporting Tables - describes the Dimension and Fact tables of the Kofax Reporting data warehouse.
  • Reporting Views - describes the sample views provided with Kofax Reporting

Documents Database

Consistent with statements above, it is not supported to query the documents database.  In the situation where someone is making unsupported queries against the documents database anyway, they should be aware that the structure of the database changes entirely in KTA 7.8 and previous queries will fail.  It remains unsupported to query the documents database, and the only supported way to work with document data is via the supported APIs on the CaptureDocumentService.

Diagnostic and Troubleshooting Queries

Knowledgebase articles and Technical Support cases will recommend queries to run as part of general troubleshooting or to diagnose specific issues.  These are meant to be run at the direction of Technical Support for troubleshooting/diagnosis, and do not imply any that they are supported in any other context.

Modification

Modification of the databases is not supported.

However, to work around or fix an issue, Technical Support may provide a script that modifies the database.  This is to be run only at the explicit direction of Technical Support.  The general recommendation is to take a backup of all KTA database before running a script that will make a modification.

 

Applies to:  

Product Version
KTA ALL