General Operator reports

General Operator reports are used to evaluate the productivity of each operator involved in the manual processing stages. For detailed information about various data collected by reports, please see General Operator reports.

Parameters

Name Corresponding UI option Type Description
users Operators int array List of user IDs for which the report should be generated. Use the GetAvailableUsers method to get information about available users. The default value is null, which means that data for all users will be included in the report.
roles Roles int array List of operator roles for which the report should be generated. See RoleType for possible values. The default value is null, which means that data for all roles will be included in the report.
dateFrom Interval datetime Date and time of the beginning of the time interval for which the report should be generated. The default value is calculated using the following formula: "date and time at the moment of the report generation minus one day".
dateTo datetime Date and time of the end of the time interval for which the report should be generated. The default value is the date and time at the moment of the report generation.
projects Projects int array List of project IDs for which the report should be generated. Use the GetProjects method to get information about all projects on the Application Server. The default value is null, which means that data for all projects will be included in the report.
stages Stages int array List of stages for which the report should be generated. See ProcessingStageType for possible values. The default value is null, which means that data for all stages will be included in the report.
batchTypes Batch types int array List of batch type IDs for which the report should be generated. Use the GetBatchTypes method to get information about all batch types within a project. The default value is null, which means that data for all batch types will be included in the report.
showBatchName Batch details int

Includes detailed information about each batch in the report. Possible values are:

  • 0=no
  • 1=yes

If the value is 1 (yes), the report will include additional columns containing batch names and the number of pages in each batch. The default value is 0.

grouping Group by string

Specifies how the data will be grouped in the report. Possible values are:

  • UserFullName
  • RoleName
  • ProjectName
  • BatchTypeName
  • StageName

The default value is UserFullName.

columns Show columns string array

List of columns that should be added to the report. Possible values are:

  • UserId
  • CompletedTasks
  • ToExceptionDocumentCount
  • ToExceptionPageCount
  • ProcessedDocuments
  • ProcessedPages
  • VerifiedFieldsCount
  • "VerifiedSymbolsCount
  • CorrectedErrorCount

The default value is null, which means that all possible columns will be added to the report.

showSummary Aggregate report boolean

Specifies whether the aggregate report should be generated. Possible values are:

  • 0=no
  • 1=yes

The default value is 0.

groupByType Time period int

The time period by which the data will be grouped in the report. Possible values are:

  • 1=hour
  • 2=day
  • 3=month

The default value is 1.

Example

[ { "Name": "dateFrom", "Value": "2021-10-31T21:00:00.000Z" },
{ "Name": "dateTo", "Value": "2022-04-05T21:00:00.000Z" },
{ "Name": "groupByType", "Value": 1 },
{ "Name": "showBatchName", "Value": 0 },
{ "Name": "grouping", "Value": "RoleName" },
{ "Name": "columns", "Value": [ "CompletedTasks", "ProcessedPages" ] },
{ "Name": "users", "Value": [ 1, 2, 3, 7, 10, 12 ] },
{ "Name": "roles", "Value": [ 2, 3, 4 ] },
{ "Name": "projects", "Value": [ 1, 3 ] },
{ "Name": "batchTypes", "Value": [ 1 ] },
{ "Name": "stages", "Value": [ 89, 130 ] } ]

1/16/2023 10:02:51 AM

Please leave your feedback about this article

Usage of Cookies. In order to optimize the website functionality and improve your online experience ABBYY uses cookies. You agree to the usage of cookies when you continue using this site. Further details can be found in our Privacy Notice.