Creating Dashboard Components

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

1. An XML file that will define the method that will be called to retrieve the results and the various settings of the dashboard 
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 that will give the user the ability to adjust the dashboard settings. (optional)

Dashboard Component XML file

All dashboard component XML files must be placed under ../pages/dashboards/<module_name> directory.

In the following example completedActinitiesPerTypeAndMonth.xml is created under  ../pages/dashboards/activities

Defining Dashboard Components in Metadata

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

 <modules>
    <module>
        <moduleid>ACCOUNTS_RECEIVABLE</moduleid>
        <applicationid>FINANCE</applicationid>
        ...
        <features>
            <feature>
                ...
                <reports>
                    <report>
                        <id>ACCOUNTS_RECEIVABLE_BALANCE_REPORT</id>
                        <name>key_accounts_receivable_balance</name>
                        <description>key_view_the_accounts_receivable_balance</description>
                        <reportfilename>AccountsReceivable/Accounts_Receivable_Balance.xml</reportfilename>
                    </report>
                    ...
                </reports>
            </feature>
            ...
        </features>
    </module>
</modules>