# ABBYY FlexiCapture: Reporting Service and Cloud REST API

> The FlexiCapture Reporting Service and database model, and the FlexiCapture Cloud REST API.
> For the full ABBYY documentation index, see: https://docs.abbyy.com/llms.txt

## Reporting Service: Reporting Service

- [ABBYY FlexiCapture Reporting Service overview](https://docs.abbyy.com/flexi-capture/reporting-overview.md): ABBYY FlexiCapture Reporting Service collects document processing quality data and produces statistics on straight-through processing and verification time.
- [Automatic database cleanup](https://docs.abbyy.com/flexi-capture/reporting-db-clean-up.md): Purge outdated records from the ABBYY FlexiCapture Reporting database through partitioning and configure retention with appsettings.json cleanup parameters.
- [Sample reports](https://docs.abbyy.com/flexi-capture/reporting-samples.md): Ready-made ABBYY FlexiCapture 12 sample reports for verification reasons, field errors, and business rules, and how to refresh them with live data.
- [Upgrade the ABBYY Reporting Service](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-upgrade.md): Upgrade the ABBYY FlexiCapture Reporting service by uninstalling the previous version and running the installer, which reuses your existing database.
- [ABBYY FlexiCapture 12 Reporting Service FAQ](https://docs.abbyy.com/flexi-capture/reporting-faq.md): Answers to common questions about the ABBYY FlexiCapture 12 Reporting service: what the Reporting Database stores, report timing, and performance impact.

## Reporting Service: Installing and configuring

- [Install and configure the Reporting Service](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-install-common.md): Installation section for the ABBYY FlexiCapture 12 Reporting Service, covering system requirements, configuration, and command-line install and removal.
- [System requirements and installation](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-system-requirements.md): Hardware, software, and database requirements for the ABBYY FlexiCapture 12 Reporting Service, plus how to run the setup wizard and verify the install.
- [Configure the Reporting Service](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-configuring.md): Create the reporting database, set up the data access component, switch databases, and enable the ABBYY FlexiCapture 12 Reporting Service for tenants.
- [Install and remove the Reporting Service via a command line](https://docs.abbyy.com/flexi-capture/reporting-silent-install.md): Install, repair, or uninstall the ABBYY FlexiCapture 12 Reporting Service from a command line using the Writing, Reading, quiet, passive, and uninstall flags.

## Reporting Service: How ABBYY FlexiCapture 12 Reporting service works

- [How ABBYY FlexiCapture 12 Reporting Service works](https://docs.abbyy.com/flexi-capture/reporting-architecture.md): Understand how the ABBYY FlexiCapture 12 Reporting Service gathers processing events and computes statistics via the Writing and Reading services.
- [The data model used by the Reporting Database](https://docs.abbyy.com/flexi-capture/reporting-db-model.md): Overview of the ABBYY FlexiCapture Reporting database data model: processing logs, document state details, and document editing history tables.
- [Processing logs](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-db-processing-logs.md): The EventLog and DocumentEditingStatistic tables hold ABBYY FlexiCapture processing logs and per-document editing statistics until reporting stats are computed.
- [EventLog](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-event-log.md): Column reference for the EventLog table of the ABBYY FlexiCapture Reporting database, which logs document processing events such as batch and stage activity.
- [DocumentEditingStatistic](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-document-editing-statistic.md): Column reference for the DocumentEditingStatistic table, which records per-stage editing statistics such as corrected symbols, rule errors, and verified fields.
- [Document state details](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-db-document-state.md): Reporting tables that capture an ABBYY FlexiCapture document's final processing state: Document, DocumentSource, DocumentRegProperty, and DocumentField.
- [Document](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-document.md): Column reference for the Document table, which stores an ABBYY FlexiCapture document's batch, project, Document Definition, and tenant details.
- [DocumentField](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-document-field.md): Column reference for the DocumentField table, which records the fields of an ABBYY FlexiCapture document including field path, value, and index field flag.
- [DocumentRegProperty](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-document-reg-property.md): Column reference for the DocumentRegProperty table, which stores the registration parameter names and values for an ABBYY FlexiCapture document.
- [DocumentSource](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-document-source.md): Column reference for the DocumentSource table, which records the source of an ABBYY FlexiCapture document's images: source name, type, and page count.
- [Document editing details](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-db-document-editing.md): Reporting tables that capture the editing history of an ABBYY FlexiCapture document: DocumentProcessing, DocumentPage, FieldChange, and PageChange.
- [DocumentProcessing](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-document-processing.md): Column reference for the DocumentProcessing table, which records an ABBYY FlexiCapture document's processing events per stage, with timing and operator.
- [DocumentPage](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-document-page.md): Column reference for the DocumentPage table, which records the state of ABBYY FlexiCapture document pages: classification status, section, and image source.
- [DocumentRuleViolation](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-document-rule-violation.md): Column reference for the DocumentRuleViolation table, which records rule errors, warnings, and assembly errors detected during ABBYY FlexiCapture processing.
- [DocumentSuspiciousField](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-document-suspicious-field.md): Column reference for the DocumentSuspiciousField table, which records ABBYY FlexiCapture fields captured with low confidence that may need verification.
- [PageChange](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-page-change.md): Column reference for the PageChange table, which records changes made to an ABBYY FlexiCapture document's pages such as section moves and classification status.
- [FieldChange](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-field-change.md): Column reference for the FieldChange table, which records changes made to an ABBYY FlexiCapture document's fields, including the change type and field path.
- [Enumerations used in the database tables](https://docs.abbyy.com/flexi-capture/reporting-enumerations.md): Predefined values used across the ABBYY FlexiCapture Reporting database tables: field and page change types, classification statuses, and rule types.
- [Types of changes made to document fields](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-enumerations-field-change.md): Enumerated values for the ChangeType column of the FieldChange table, identifying how an ABBYY FlexiCapture field was created, modified, or deleted.
- [Page classification statuses](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-enumerations-page-change-classifications.md): Enumerated values for the ClassificationStatus column in ABBYY FlexiCapture reporting tables, marking pages as unclassified, low confidence, or classified.
- [Types of changes made to page](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-enumerations-page-change.md): Enumerated values for the ChangeType column of the PageChange table, identifying whether an ABBYY FlexiCapture page was added, deleted, or moved.
- [Types of rules](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-enumerations-types-rules.md): Reference for the rule-type enumeration in the ABBYY FlexiCapture Reporting service, listing values 0-5 for data format, region, and child document errors.
- [Types of rule errors](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-enumerations-types-rule-errors.md): Reference for the rule-error enumeration in the ABBYY FlexiCapture Reporting service, mapping codes 0-17 to format, merge, assembly, and key-field errors.
- [Types of image sources](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-enumerations-image-sources.md): Reference for the image-source enumeration in the ABBYY FlexiCapture Reporting service, listing values 0-4 for pages added via Verification Station or import.
- [Reporting service data access](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-data-access.md): Export ABBYY FlexiCapture reporting statistics as daily CSV zip archives so tenants and FlexiCapture Cloud users can analyze data without database access.
- [Local folder export](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-data-access-local-folder.md): Collect ABBYY FlexiCapture reporting data from CSV archives at the ReportingDataPath local folder, grouped per tenant into monthly zip files by table.
- [REST API data access](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-data-access-rest-api.md): Retrieve ABBYY FlexiCapture reporting archives through the data access REST API using DataFile methods and Bearer-token authentication, with a sample.
- [Authentication](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-data-access-authentication.md): Authenticate to the ABBYY FlexiCapture Reporting data access REST API with a Bearer token from the application server, using a Windows or FlexiCapture account.
- [DataFile method](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-data-file.md): The DataFile GET method of the ABBYY FlexiCapture Reporting data access REST API downloads a zip archive of CSV statistics for a given tenant, year, and month.
- [DataFile/GetFileList method](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-data-file-get-file-list.md): The DataFile/GetFileList GET method of the ABBYY FlexiCapture Reporting data access REST API lists all existing reporting archives for a specified tenant.
- [DataFile/CreateFile method](https://docs.abbyy.com/flexi-capture/reporting-service/reporting-data-file-create-file.md): The DataFile/CreateFile POST method of the ABBYY FlexiCapture Reporting data access REST API rebuilds a reporting archive for a period when export has failed.

## Cloud REST API: ABBYY FlexiCapture Cloud REST API

- [ABBYY FlexiCapture Cloud REST API](https://docs.abbyy.com/flexi-capture/rest-api.md): Integrate FlexiCapture Cloud features into ERP, ECM, and other systems with the REST API, and securely manage multiple end users in a single tenant.
- [Configure the FlexiCapture Cloud REST API](https://docs.abbyy.com/flexi-capture/rest-api-start.md): Get started with the FlexiCapture Cloud REST API: create a regional web portal account, explore the demo application, and build a new application.
- [The FlexiCapture Cloud REST API web portal](https://docs.abbyy.com/flexi-capture/rest-api-portal.md): Tour the FlexiCapture Cloud REST API web portal views: Document Capture, Processing and Usage Reports, Applications, Quick Start Guide, and API Description.
- [REST API overview](https://docs.abbyy.com/flexi-capture/rest-api-overview.md): Review the FlexiCapture Cloud REST API resource groups: File for uploading documents and results, Task for managing batches, and Training for extraction.
- [ABBYY FlexiCapture Cloud REST API task status](https://docs.abbyy.com/flexi-capture/rest-api-taskstatus.md): Track FlexiCapture Cloud REST API task statuses like New, Submitted, InProgress, Done, and Failed, and map each one to its batch processing stage.
- [Verification](https://docs.abbyy.com/flexi-capture/rest-api-verification.md): Open the FlexiCapture Cloud REST API verification UI for WaitForAction tasks, embed it via an iframe, and handle verification completion events.
- [Processing error diagnostics](https://docs.abbyy.com/flexi-capture/rest-api-tasks.md): Diagnose FlexiCapture Cloud REST API processing errors in the Administration and Monitoring Console by filtering the event log for the batch by task ID.
- [Request errors](https://docs.abbyy.com/flexi-capture/cloud/rest-api-errors.md): Understand the HTTP response codes returned by the ABBYY FlexiCapture Cloud API, including 400, 403, 404, 409, 429, 500, and 503, and how to handle each.
- [ABBYY FlexiCapture Cloud Developer’s Package](https://docs.abbyy.com/flexi-capture/cloud/cloud-developers-package.md): Install the ABBYY FlexiCapture Cloud Developer’s Package, a standalone tool for building Document Definitions and setting up, testing, and uploading projects.

## Cloud REST API: Get started with the ABBYY FlexiCapture Cloud REST API

- [Get started with the ABBYY FlexiCapture Cloud REST API](https://docs.abbyy.com/flexi-capture/rest-api-getstarted.md): Get started with the ABBYY FlexiCapture Cloud REST API: check prerequisites, activate your Developer's License, and adapt a sample project for integration.
- [Adapt the sample project for use with the ABBYY FlexiCapture Cloud REST API](https://docs.abbyy.com/flexi-capture/rest-api-sampleproject.md): Adapt the sample Banking Card Application project for the FlexiCapture Cloud REST API: configure workflow stages and export settings, and then upload it.

## Cloud REST API: Create applications using the FlexiCapture REST API interface

- [Create applications using the FlexiCapture REST API interface](https://docs.abbyy.com/flexi-capture/rest-api-apps.md): Create applications on the FlexiCapture Cloud REST API web portal that connect to existing cloud projects so users can run document processing tasks.
- [Set up FlexiCapture Cloud account permissions](https://docs.abbyy.com/flexi-capture/rest-api-apps-setup.md): Assign the Senior Verification Operator and External User roles in the Administration and Monitoring Console so an account can use the Cloud REST API.