Skip to main content

xSuite Archive Prism User Guide

The "Statistics" tool

The "Statistics" tool creates statistics as a CSV file. Quantities and volumes are calculated. You can define the calculation period in months, days or hours.

Parameters

Description

Archive

Archive

ResultType

Result

The following values are available:

  • DocumentCount: performs a count.

  • DocumentSize: sums up the size of the documents.

SizeUnit

Size unit

This parameter is only relevant if the value DocumentSize is selected in the ResultType parameter.

The following values are available:

  • KB: Kilobyte

  • MB: Megabyte

  • GB: Gigabyte

  • TB: Terrabyte

RangeType

Period for which counting or totaling is performed

The following values are available:

  • Year: year

  • Month: month

  • Day: day

  • Hour: hour

File

Output file in the repository

Locale

Locale for formatting date values in the CSV file

StartDate

Date or time on which the report starts

Default value: current time

EndDate

End date of the report

Default value: current time

Caution

The smaller the RangeType, the more queries will be generated. One search is generated for each unit of the RangeType. For a period from January 1, 2025 to December 31, 2025, and the RangeType Day, 365 queries will be generated.

In order not to overload the system, a maximum of 366 queries are possible.