silverstripe-reports/README.md
GuySartorelli 375c31904f
ENH Add configuration to cap report counts for large datasets. (#139)
Opted not to return the result from `getCount()` directly since the PHPDoc says this returns an int (even though it technically already returns a string if the report isn't set up correctly...)
2022-01-31 17:20:11 +13:00

1.4 KiB

Reports

Build Status SilverStripe supported module

Introduction

This module contains the API's for building Reports that are displayed in the SilverStripe backend. This module replaces the built-in reports API from earlier versions of SilverStripe (2.4 and 3.0).

Requirements

  • SilverStripe 4.0

Troubleshooting

The reports section will not show up in the CMS if:

  • There are no reports to show
  • The logged in user does not have permission to view any reports

For large datasets, the reports section may take a long time to load, since each report is getting a count of the items it contains to display next to the title.

To mitigate this issue, there is a cap on the number of items that will be counted per report. This is set at 10,000 items by default, but can be configured using the limit_count_in_overview configuration variable. Setting this to null will result in showing the actual count regardless of how many items there are.

SilverStripe\Reports\Report:
  limit_count_in_overview: 500

Note that some reports may have overridden the getCount method, and for those reports this may not apply.