Dashboard Portlet

Overview

TEXT

Configuration

To make a layout available in the dashboard portlet, you must first create a Reporter Portlet Configuration record.

The easiest way to create such record is to open up the layout in view mode, navigate to Deployments > Portlet Configuration and click on New Reporter Portlet Configuration.

General Settings

  • Name: The name entered here will be displayed on the dashboard portlet as its title.

  • Parent Layout: The Reporter Layout Builder that should be displayed in the portlet.

  • Roles: In this field you can select a single or multiple roles that should be able to run and view this layout from their dashboard.

  • Inactive: If you do not want users to be able to select this record on their dashboard, use this check box to inactivate the record.

  • Schedule PDF Creation: To enable faster loading time you can enable the option to cache previously created PDFs and to update those PDFs using a schedule. If this check box is set to false, the PDF is generated each time the dashboard gets loaded.

Settings

  • Display Toolbar: If you want to

  • View: If you select "Full Page" the full height of the PDF will be shown as default in the portlet when displayed. If you select "Full Width" the full page might now show but it will be displayed in a more zoomed in state.

  • Zoom: If you want to zoom in the PDF, you can set a value between 10 and 500 in this field. Please note that this setting can not be combined with the View setting as that one always takes precedence.

  • Page Number: If your layout has multiple pages you can select which page to display first, e.g. the second page. Please note that this setting will not change the order of the pages in the pdf. Instead it will scroll down to the page number selected.

When you are done, save the record.

Custom portlet

Add a custom portlet on the dashboard.

Click on set up and select "Reporter Dashboard PDF Viewer".

Click on Save.

In the custom portlet, click on Edit.

In the Layout field, select the layout that you wish to display. Please note that the user role must be one of the roles selected on the Reporter Portlet Configuration record.

You can select which height you want to use for the portlet. The default value is set to 800.

Click on Save.

-----

The report should now load on the dashboard.