Refreshing Report Data Automatically Based on Portal Events

Last Updated: 05/03/2018 Introduced in Version: 2.0

The data displayed in Report Viewer or chart can be configured to refresh on one type of event, or multiple types of portal events.  The events include any folder changes, changes to an entity contained on the report, changes to the current folder, or changes to the Folders tree.

The report will refresh when a user is viewing the report.

To make reports refresh on a portal event, in the Page Designer, in the Properties Panel, select a checkbox in the Control Settings section.

Example

The goal of this example is to:

  1. Crate a portal page.
  2. Add a Report Viewer to the page.
  3. Configure the report to refresh when the current folder changes.

To begin, navigate to a Designer Folder and click the Create Page/Dashboard button.

Give the page a name and click Ok to open it in the Page Designer.

First, add an existing report to the page by going to the Toolbox Panel, and expand the category Report > [Existing Report] > [Current Folder] > Report: Folder Report and drag a Data View component to the workspace.

 

2017-01-06_110051

 

In the Properties Panel, in the Behavior > Refresh section, click the desired Refresh setting checkbox.  By default, report data refresh is not set to update on any Portal events.  Be careful to avoid too many updates based on events in high transaction systems.  Using the Auto Refresh option (time based) is recommended to avoid a high volume of processing that can burden the system.

  • On Any Folder Change – refreshes the data upon a change detected to any folder that is defined as a data source for the report.  (This is NOT recommended)
  • On Current Folder Change – refreshes data upon a change detected to the current folder that is defined as a data source for the report.
  • Auto Refresh – allows for a time to be specified for refreshing the data on a schedule. (Recommended)

 

2017-01-06_110333

 

This completes the page.  Save the page and close the Page Designer.

To view the page and see the report refresh, select the page and select View > Preview Page from its Action menu.

 

2017-01-06_110617 

 

The page opens.  After an update to the current folder occurs, the report refreshes.