silverstripe-reports/README.md

37 lines
1.4 KiB
Markdown
Raw Normal View History

2013-01-17 01:22:13 +01:00
# Reports
2022-07-05 06:04:25 +02:00
[![CI](https://github.com/silverstripe/silverstripe-reports/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-reports/actions/workflows/ci.yml)
2022-07-31 23:59:34 +02:00
[![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/)
2013-03-29 10:19:52 +01:00
2023-04-19 06:25:28 +02:00
## Installation
2013-01-17 01:22:13 +01:00
2023-04-19 06:25:28 +02:00
```sh
composer require silverstripe/reports
```
2013-01-17 01:22:13 +01:00
2023-04-19 06:25:28 +02:00
## Introduction
2013-01-17 01:22:13 +01:00
2023-04-19 06:25:28 +02:00
This module contains the API's for building Reports that are displayed in the
Silverstripe backend.
## 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.
```yml
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.
## Links ##
* [License](./LICENSE)