Dashboard Report Setup

A Dashboard report allows you select any reports and charts you have created in your project and show them in one single Dashboard report page, with links (for charts only) to the original reports.

After loading the database, the database objects (tables, views, Custom Views and reports) will be shown in the left pane (the database pane). To create a report, right click the database pane and select Add Dashboard Report. Alternatively, you can click Edit in the main menu and then select Add Dashboard Report.

The Dashboard Report Setup form will show up:

Name	Name of the Dashboard report
Type	Type of the report. Possible values are: Vertical - Items are displayed vertically Horizontal - Items are displayed horizontally Custom - Items are displayed with your own Custom Template (see below)
Item	Report or chart (from other reports) to be included in the Dashboard report
Width (px)	Min-width of the item container (pixels) in the Dashboard report.
Height (px)	Min-height of the item container (pixels) in the Dashboard report.

Notes

If you set the Type as Vertical or Horizontal, by default the layout is done by Bootstrap Grid System and AdminLTE Cards.
If you set the Type as Custom, it is recommended that you also use Bootstrap Grid System and AdminLTE Cards to layout the page.
If Vertical, there is no need to setup the widths.
If Horizontal, by default the widths of columns are equal for each item. If you want to adjust them by code, you can use Page_Load server event (see Server Events and Client Scripts) to change the page object's ItemClassNames property which is an array of class names for the columns.
If Custom, since the layout is provided by yourself, the widths/heights are ignored.
If Custom, you must provide your own Custom Template (see below). If no template is provided, the type will be considered as Vertical.

Press OK to finish setup. The Dashboard report will appear under Reports in the Database pane on the left.

To edit a report, right click the report in the database pane and select Edit Report. Alternatively, you can select the report first, then click Edit in the main menu and then select Edit Report.

If you have selected Custom as the report type, you must provide a Custom Template. Select the Dashboard report in the Database pane, you'll see the Code (Server Events, Client Scripts and Templates) tab on the right.

Select Custom Template > Table-Specific > Dashboard -> CustomTemplate and enter your HTML as the template of the Dashboard report page.

Custom Template is HTML, if you want to embed PHP code, you need to use <?php and ?> to enclose your code, if you want to use JavaScript, you need to use <script> and </script>.

Use {{{item<n>}}} to denote the nth item (report or chart) in your dashboard report where <n> is an integer, e.g. item1, item2, item3, etc.. There is no spaces between "item" and "<n>".

During script generation, {{{item<n>}}} will be replaced by the actual report or chart. See Tutorial - Dashboard Report for a real example.

Important Notes

Dashboard reports support searching via Query Builder (v2024+). To set up Query Builder for the dashboard report, please see description on Query Builder for Dashboard Report below.
Dashboard reports require the source reports' *.php scripts, when you generate or re-generate dashboard reports, make sure you have selected those reports to generate.
After a Dashboard report is created, if you rename or delete a source item, the Dashboard report will fail. Make sure you updated the Dashboard report settings after renaming or deleting a source item.
Dashboard reports support User ID and User Level. (See Security Settings.)

Query Builder for Dashboard Report (v2024+)

To set up Query Builder for a dashboard report, please perform the following steps:

Right click on the Dashboard Report, and click Searchable Fields. The popup for the list of Searchable Fields and Dashboard Items will be displayed:
Select the Searchable Field to be mapped for each Dashboard Item from the dropdown. If there is no mapping field, just leave the field blank.
Repeat for all Searchable Fields required. Click OK to confirm the settings
In the Table Options for the Dashboard Report, enable the Query Builder option, and optionally the Modal dialog (Advanced) option if you want the Query Builder to be a modal popup.

Important Notes

For fields to appear in Searchable Fields, you must enable Extended Search for the field in the original report.
Make sure that the fields mapped in Searchable Fields in the Dashboard Item are compatible and stored in the same format. For example, you should not map a string field to an integer field.
If there is no mapping field for a Dashboard Item, just leave the field blank so searching will not be performed for that Dashboard Item.

Also See

Tutorial - Dashboard Report