Login

Reporting Basics

Recon.work reports can be created and modified by report administrator using Report and Chart Editor task from the user menu. Custom reports can be one of two types: charts and data tables. At the fundamental level, both operate exactly the same, and only differ in the way the final results are presented to the user. All reports are real-time and are dynamically generated at the moment when the reporting task is executed. The following sections go into more detail for each step in the process of configuring a new report.

Data Filters

The first step in setting up a new report is selecting a specific document collection that contains all the relevant information. After the data source is identified it is often necessary to utilize filters to return only a subset of documents that are matching our report requirements. The following table describes various functions that can be applied to any field in a collection in order to refine the number of documents that will be in scope.

FunctionParameter TypeDescription
IsStringReturn documents containing the specified string value for a given field.
InArrayCheck that a given document field has any of the values from the array provided.
Not InArrayCheck that a given document field has none of the values from the array provided.
AllArrayCheck that a given document field has all of the values from the array provided.
TypeNumberMake sure that a specified field is of a certain type: 1-double, 2-string, 3-object, 4-array, 8-boolean, 16-32bit integer, 18-64bit integer.
SizeNumberDocument field is an array that contains this many elements.
Greater ThanNumberDocument field contains a number that is greater than the comparison value provided.
Greater or EqualNumberDocument field contains a number that is greater than or equal to the comparison value provided.
Less ThanNumberDocument field contains a number that is less than the comparison value provided.
Less or EqualNumberDocument field contains a number that is less than or equal to the comparison value provided.
Not EqualStringReturn documents where a given field value is not equal to a string parameter provided.
Regular ExpressionStringReturn documents where field value matches the provided regular expression.
ExistsBooleanMatch documents where a given field is present.
TextStringPerform a text search against the collection. Field does not need to be specified. Collection needs to have proper text search indexes configured.
ModulusNumbersMatch only those documents where a numeric field can be divided by the supplied "Divisor" and will produce a required "Remainder".

Data Aggregation

Once the final list of relevant documents has been identified, it is quite trivial to display the results as a table. However, it is more likely that further data operations have to be performed before we can publish our results in a form of a table or a chart. In order to execute these data summarization functions we are required to identify a unique set of fields for which we will calculate the summarized result. Most common data aggregation functions are listed in the following table. Please note that more advanced aggregation functionality is only available to Process Administrators.

FunctionSecurity GroupDescription
sumReport AdminCalculate the sum of all the key values.
avgReport AdminCalculate the average of all the key values.
maxReport AdminCalculate the maximum of all the key values.
minReport AdminCalculate the minimum of all the key values.
countReport AdminCount the number of documents for this calculation.
stdDevPopProcess AdminCalculate population standard deviation of the input values.
stdDevSampProcess AdminCalculate sample standard deviation of the input values.
firstProcess AdminReturn the value from the first document in the list.
lastProcess AdminReturn the value from the last document in the list.

Output Sorting and Limiting

It is often desirable to display our calculated result rows in a specific order. Sorting data is optional, but if you choose to do so, report editor allows you to sort summarized records by more than one field. Additionally, you can set a limit on the number of records or datapoints that will be displayed on the final report.

Selecting Presentation Format

Determining the most appropriate presentation format is the very last step in the report configuration process. At this stage you will be asked to pick from the two presentation options available. Fortunately, report editor allows you to reconfigure your report and switch to a different output format even after it has been published. The table below can help you compare different configuration options when choosing between a chart or a data table as your presentation format.

CharacteristicChart/GraphData Table
Is most useful forVisually emphasizing one or more data trendsDisplaying lots of document properties at once
ParametersChart type, axis labels, data seriesTable orientation
Each output document becomesA data point on a chartA separate table row


Back to Main