Grooper Help - Version 25.0
25.0.0017 2,127
  • Overview
  • Help Status

Stats Query

Embedded Object Grooper.Core

Defines a configurable query for retrieving and reporting on session statistics within Grooper.

Remarks

A Stats Query allows you to filter, group, and format statistics collected from Session Stats records, providing flexible reporting on batch processing activity.

Key Capabilities

  • Time Period Selection:
    Use the 'Time Frame' property to select a predefined period (such as Today, Last Month, or Year-To-Date), or specify a custom date range.
    For relative periods, such as Older Than or Newer Than, set the 'Age' property to define the reference interval.

  • Filtering:
    Limit results to specific Batch Processes, Batch Process Steps, Activities, users, or machines by configuring the corresponding filter properties.
    If no values are specified for a filter, all values are included by default.

  • Grouping and Output:
    Use the 'Group By' property to organize results by activity, step, process, user, machine, or time period (day, week, month, quarter, year).
    The 'Transpose' option inverts the output, grouping by statistic name instead.

  • Sorting and Formatting:
    Control the order of results using 'Order By' and 'Sort Direction'.
    Format numeric and timespan values using the 'Number Format' and 'Time Format' properties, which accept standard or custom .NET format strings.

  • Scaling:
    Apply a multiplier to all numeric values using the 'Scale' property.

Usage Example

To create a report showing the number of tasks processed per user for the last month:

  1. Set 'Time Frame' to Last Month.
  2. Set 'Group By' to User.
  3. Optionally, filter by specific processes or steps.
  4. Choose the desired statistics and formatting options.

Notes

  • If no filters are applied, all available data is included.
  • The available statistics and grouping options are determined by the underlying Session Stats and Custom Stats data stored in the Grooper database.
  • For details on format string options, see the official .NET numeric format documentation and .NET timespan format documentation.

Stats Queries are typically saved and reused to support consistent reporting across different time periods or operational scopes.

Properties

NameTypeDescription
General
Time Period
Filtering
Output
Notification