ABBYY FlexiCapture Reporting Service collects information about the quality of document processing in ABBYY FlexiCapture.
ABBYY FlexiCapture Reporting Service consists of two services:
- A reporting service that collects information about modifications made to documents and calculates statistics for generating reports.
- A data access service that lets you retrieve data from the Reporting service via the Web API.
Reports generated by the service will show you how many documents have been processed straight through (i.e. without verification), how many documents have been verified, and how much time has been spent on their verification, as well as how the program’s performance has improved over time. Additionally, data collected by the service lets you evaluate the quality of document classification. The current Reporting Service version does not support the following: viewing SLA violations, collecting information for audit trails, comparing field values before and after verification.
Other specifics of ABBYY FlexiCapture Reporting Service for Cloud
ABBYY FlexiCapture Reporting Service database is not available in ABBYY FlexiCapture Cloud. However, you can export data collected using ABBYY Reporting service into tables in CSV format. This can be done using methods for retrieving the reporting data provided by REST API data access:
The sample code below calls all three Reporting Service data access for Cloud (PowerShell) methods
[String]$AppServer = "australia.flexicapture.com"
[string]$TenantName = "tenantName"
[string]$User = "user"
[string]$Password = "password"
[Int]$Year = 2021
[Int]$Month = 12
[string]$DownloadPath ="C:\temp"
[string]$BaseUrl = "api-au.flexicapture.com"
# Use the tenant name in the function parameters
$URI = "https://$AppServer/Flexicapture12/Server/FCAuth/API/wsdl?Tenant=$TenantName"
# Create a PSCredential object with the given username and password
$creds = New-Object System.Management.Automation.PSCredential -ArgumentList @($user,(ConvertTo-SecureString -String $password -AsPlainText -Force))
# Create a proxy web service that will authenticate with these credentials
$proxy = New-WebServiceProxy -Uri $URI -Credential $creds
$proxy.Url = "https://$AppServer/flexicapture12/Server/FCAuth/API/Soap?Tenant=$TenantName"
$proxy.Credentials = $creds
$proxy.Credentials = $creds
# And use it to ask FlexiCapture API for the token
$ticket = $proxy.GetCurrentUserAuthTicket()
$nameFile = $year.ToString() + "-" + $month.ToString()
# Create path for download file
$path = "$DownloadPath\$nameFile.zip"
# Create a request with Bearer authentication header containing the token
# and send it to Reporting data access service to get the archive for the specified tenant and period
$headers = @{
"Authorization" = "Bearer " + $ticket
}
Invoke-RestMethod -Uri "https://$BaseUrl/v1/datafile/createfile?tenantName=$TenantName&year=$year&month=$month" -Method 'POST' -Headers $headers
Invoke-RestMethod -Uri "https://$BaseUrl/v1/datafile/getfilelist?tenantName=$TenantName" -Method 'GET' -Headers $headers
Invoke-RestMethod -Uri "https://$BaseUrl/v1/datafile?tenantName=$TenantName&year=$year&month=$month" -Headers $headers -OutFile $path
For more information about this service and how it works, see Reporting service data access.