Applying the Implementations of the Dashboard Listener API

Dashboard Listener API defines the start and end events of adding and deleting library components for users to get dashboard related information at the event and to use the information in their own application.

Event types

The start action of adding a library component
The end action of adding a library component
The start action of deleting a library component
The end action of deleting a library component

Basic Information

Catalog information
Dashboard information
Library component information

For detailed usages about the Dashboard Listener API, see JReport Javadoc com.jinfonet.web.modules.dashboard package in <install_root>\help\api. Also, there is a sample implementation file DashboardListenerDemo.java in <install_root>\help\samples\APIDashboardListener.

Applying the Dashboard Listener API

Different uses should have different implementations of the Dashboard Listener API. The implementations can be managed on the server by administrators. After a new implementation is imported to the server and enabled, it will be able to take effect immediately without restarting the server.

Besides, after an implementation is uploaded to the server, you can apply it in the URL which is used for running dashboards. The URL way has higher priority than the enabled implementation on the JReport Administration page.

To import and enable an implementation on the JReport Administration page:

On the JReport Administration page, click Configuration on the system toolbar and select Dashboard Listeners from the drop-down menu. The Configuration - Dashboard Listeners page is displayed.
Click New Dashboard Listener.
In the New Dashboard Listener dialog, click the Browse button to locate the implementation file which could be a zip or a jar file. Then click Next.
From the Class Name drop-down list, choose a class name which is defined in the implementation file.
Click beside the Target box, then in the Select Target dialog specify the target dashboards you would like the implementation to apply to: all dashboard including the unsaved ones, the newly created dashboards that have not been saved, or dashboards in the specified folders.
Click OK and the specified dashboards will be listed in the Target box.
When all dashboards have been added, the button will be disabled. Later if you want to change the dashboards, you need to first delete the <All dashboards> item and then add other dashboards. To remove unwanted dashboards from the Target box, select them and then click .
In the Description text field, enter a description for the implementation if necessary.
Select the Enabled checkbox to make the implementation enabled.
Click Finish and the registered class will take effect right away.

The registered implementation class is added in the class table on the Dashboard Listener page which consists of the following columns.

Column Name	Description
Class Name	The implementation class name. Each is unique and cannot be null.
Target	Shows the resources that the implementation will take effect on. When a dashboard has been set as the target value of different implementations, the earliest implementation will take effect on the dashboard.
Description	The description of the implementation.
Enabled	Shows whether the implementation is enabled.

In the class table, the system admin can perform the following on the implementations:

To sort the table by certain column, click on the column name.
To modify the target value of an implementation, select it, then click Properties on the toolbar or right-click and then select Properties from the shortcut menu. Then in the displayed dialog, modify the target dashboards as required.
To enable implementations that are not enabled, select them, then click Enable on the toolbar or right-click and then select Enable from the shortcut menu.
To disable implementations that are enabled, select them, then click Disable on the toolbar or right-click and then select Disable from the shortcut menu.
To delete implementations, select them, then click Delete on the toolbar or right-click and then select Delete from the shortcut menu.

To apply an implementation via URL:

To apply the dashboard listener via URL, append the key-value pair jrd_dsh_listener=PackageName.ClassName in the URL which is used for running dashboards.

For example, if you want your implemented class TestListener to take effect on a new created dashboard (not the target defined on the JReport Administration page), you can define it in the URL. Such URL will not affect the setting on the JReport Administration page.

http://localhost:8888/dashboard/app/entry/run.jsp?jrs.authorization=YWRtaW46YWRtaW4%3D&jrd_dsh_listener=com.jinfonet.TestListener&jrd_resext={"active":0,"reslst":[{"name":"/USERFOLDERPATH/admin/Dashboard1.dsh","ver":"-1"}]}

Previous Page Next Page