README

Installation

composer require silverstripe/reports

Introduction

This module contains the API's for building Reports that are displayed in the Silverstripe backend.

There are also a few CMS reports that comes out of the box:

A "Users, Groups and Permissions" report allowing administrators to get a quick overview of who has access to the CMS.
A "Site-wide content report" report allowing CMS users to get a quick overview of content across the site.
An "External broken links report" allowing users with permissions to track broken external links.

Note

Note that for the "External broken links report" to show up you must install symbiote/silverstripe-queuedjobs.

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.

Included reports

This module comes with a few customisable reports out of the box. Details on how to customise these reports can be found in the [documentation] section(./docs/en/index.md).

silverstripe / reports

Maintainers

Details

README

Installation

Introduction

Troubleshooting

Included reports

Links