RSS 2.0
RSS 0.91
ATOM 0.3
May 9, 2010

4.3 Treasure Trove: the Reports module

Category: Core

By: François Suter

Not only does the Reports module display useful information, it can also be easily extended with custom reports.

The Status report

The Installed Services report

Long-time TYPO3 users are familiar with the messages displayed in the About > About Modules module, warning them of various wrong or undesirable settings. As of TYPO3 4.3, this information also appears as a global overview in the "Status Report" of the Reports module. Not only does that offer a synthetic view, but it is an improvement as it also shows what's right and not only what's wrong. What's more there's an easy API to add statuses (for example, Extbase adds a status which checks some eAccelerator settings).

The required system extension "sv" also adds a report by default. The "Installed Services" report displays all installed services, grouped by service type, along with their related information. It also shows whether a given service is available or not. At the bottom of this report is a list of all the paths that will be searched for executables, and whether each path exists or not.

There's also an API for creating new reports and adding them to the Reports module. There are not many yet, but Dan Osipov recently released an extension providing an overview of a memcache server as a report (extension key: memcached_reports).

Unfortunately the documentation is missing for now, but we hope to have it in 4.4. However if you look at the "reports" extension itself, or at the report provided by the "sv" extension, it should be quite easy to understand how a report is built and registered.


comment #1
Gravatar: Sebastian Sebastian May 10, 2010 08:11
Hey François,
Thanks for the writeup! A small addition: Extbase adds a report as well, which checks if the PHP Accelerator (if you use one) is configured correctly, i.e. does not strip comments off.


comment #2
Gravatar: François François May 10, 2010 11:39
@Sebastian: actually it's not a full-fledged report, it's a status in the Status Report module, which is why I didn't mention it ;-) But I'll add it, it will make for a more complete article.

comment #3
Gravatar: Gry MMO Gry MMO May 12, 2010 07:04
It's very helpfull, give quick view on important parameters of installation and helps to maintain typo3 site. Thanks to developers!

comment #4
Gravatar: Reinhold Reinhold May 14, 2010 12:16
Thank you that you write a article about this process. It is very helpfull if you are a new typo3 user, thank you

comment #5
Gravatar: Unia Unia May 29, 2010 18:34
Sounds great! Looking forward to meeting you all.

Sorry, comments are closed for this post.