Custom Reports is a report engine directly integrated into Pimcore. With Custom Reports it is possible to create tabular or chart reports (or both) with further filtering and export functionality.
The data source for the reports is always a source adapter which is responsible for retrieving and preparing the report data. Currently two adapters ship with Pimcore:
- SQL: Retrieve Data based on a SQL statement
- Google Analytics: Retrieve Data from Google Analytics
Custom Report Permissions (since version 5.7.0)
With custom report permissions it is possible to define which users should be able to see a report. Following options are available:
Share globally: Custom report is visible to all users that have
Visible to users: Custom report is visible to all listed users.
Visible to roles: Custom report is visible to all listed roles.
Custom Data Source Adapters
It is easily possible to implement custom source adapters for special use cases. To do so following steps are necessary:
pimcore.report.custom.definition, named like the adapter (e.g.
pimcore.report.custom.definition.mySource) and implement the methods
getValues. As sample see analytics
PHP Class: This class is the server side implementation of the adapter. It is responsible for retrieving and preparing the options, columns and data. It has to be located in the namespace
Pimcore\Model\Tool\CustomReport\Adapter, named like the adapter (e.g.
MySource) and extend the abstract class
Pimcore\Model\Tool\CustomReport\Adapter\AbstractAdapter. As sample see analytics adapter.
PHP Class: This class is the server side implementation of the adapter. It is responsible for retrieving and preparing the options, columns and data. It needs to implement the interface
Pimcore\Model\Tool\CustomReport\Adapter\CustomReportAdapterInterface. As sample see Sql.
Register your Adapter Factory as Service. If you are using a very simple Adapter Source, you can use the DefaultCustomReportAdapterFactory
app.custom_report.adapter.factory.custom: class: Pimcore\Model\Tool\CustomReport\Adapter\DefaultCustomReportAdapterFactory arguments: - 'App\CustomReport\Adapter\Custom'
If you are using a more complex Adapter, you can create your own Factory by implementing the interface
Add your Adapter Factory to the configuration:
pimcore: custom_report: adapters: myAdapter: app.custom_report.adapter.factory.custom
Custom JS Class for Report Visualization
If you need to fully customize the appearance of the report, you can specify a custom java script class that should
be used when opening the report in Pimcore Backend. This class can be specified in
Report Class option and should extend
the default java script class for the reports which is `pimcore.report.custom.report``.