Reports List¶

Overview¶

List of configuration files¶

Filename	Short description	Format	Link to documentation
dashboard.view#ReportsListWidget	Defines the ReportsListWidget widget global settings	json	Link

List of examples¶

Short description	Link to documentation
Visualize generated reports in a dashboard	Visualize reports

Features¶

The ReportsList widget allows visualizing reports list available inside your database. This list can be shortened by using available filters :

search: Search based on report name
template: Selector to filter templates used for the report generation
date: Filter by date with multiple operation (equal, less, lessOrEqual, greaterThan, greaterThanOrEqual, between)

../../../_images/osp-reportslist-example.png

Settings¶

These settings can be applied to ReportsList widget:

Setting	Usage	Type	Default value
templateSelect	Template selector settings	ReportsTemplate

Example¶

{
    "type": "ReportsList",
    "id": "hrrT9pGM",
    "title": "",
    "menuReferences": [
        "root.reports.menus"
    ],
    "reportsListWidgetSettings": {
    "templateSelect": {
        "type": "ReportsTemplate",
        "multiple": true,
        "limitTags": 1,
        "icon": "picture_as_pdf"
    }
}

Actions¶

This widget supports menus usage. You can define an action to download a report from the list as follow :

{
    "label": "Download",
    "icon": "file_download",
    "context": [
        {
        "type": "ReportsList",
        "action": "root.reports.actions.download",
        "condition": "${reports.selected}.length === 0 && ${reports.clicked.templateFormat} === 'pdf'",
        "input": {
            "documentId": {
                "extract": "reports.clicked.documentId",
                "as": "string"
            }
        },
        "output": [
            {
            "operation": "download",
            "input": {
                "content": {
                    "extract": "result.content.report",
                    "as": "string"
                },
                "format": {
                    "extract": "result.content.format",
                    "as": "string"
                },
                "filename": {
                    "extract": "result.content.name",
                    "as": "string"
                }
            }
            }
        ]
        }
    ]
}

Events¶

emit¶

The ReportsList widget sends these events :

pdf: Sends selected pdf
template: Sends selected value for ReportsTemplate selector

listen¶

The ReportsList widget can process these events :

template: Sets value for ReportsTemplate selector