Developing dashboard components

Owned by Former user (Deleted)
Last updated: May 21, 2019 by Vasilis Kleanthous (Unlicensed)
2 min read

Dashboard components offer a visual representation of data to the user.

They can be implemented by a Java method that returns the data and a metadata XML file.

What does this section cover?

There are two types of dashboard components, chart and summary.

Chart Dashboard Components

To create a new Chart Dashboard Component, you need to create:

  1. An XML file that will define the component's data source, type, and various settings.
  2. A Java method that will retrieve the dashboard results.
  3. A summary page that the dashboard component will link to.

  4. A data entry page (definition and layout XML pages) that will give the user the ability to adjust the dashboard settings to apply an additional filtering. (optional)

Also, in order for the dashboard to be available to the user, it must be defined in metadata file modules.xml, which is located under ../metadata directory.

 Completed Activities Per Type And Month

Summary Dashboard Components

To create a new Summary Dashboard Component, you need to create:

  1. An XML file that will define the component's data source, type, and various settings.
  2. The embedded summary page that will retrieve and display the dashboard results.

Also, in order for the dashboard to be available to the user, it must be defined in metadata file modules.xml, which is located under ../metadata directory.

 Non completed activities of logged in user


For more information on creating dashboard components, go to Create Dashboard Components. For a full list of metadata dashboard attributes, go to Dashboards Metadata.