Dashboard Components Documentation

Dashboard components offer a visual representation of data to the user. They consist of an SQL statement, which if needed, can be dynamically altered by adding certain filters and criteria.

Settings

Attributes

Name	Description	Value
name	The dashboard component name.	Any
description	The dashboard component description.	Any
sql	The dashboard component SQL statement (In the case the SQL is very simple).	Any valid SQL statement
ejb	The ejb name.	Any
method	The method to call from the ejb.	Any
type	The dashboard component type.	pie, stack, bar, summary
valuelabels	The label values that the group by elements will have.	<label_name>:<label_value>, ejb/<method_name>
primaryfield	The primary field name.	Any
primaryfieldlabel	The label that the primary field will have.	Any
groupbyfield	The group by field name(s).	Any
groupbyfieldlabel	The label that the group by field will have.	Any
summarypage	The summary page name to link to.	Any
orientation	The dashboard component orientation.	vertical, horizontal
setting	The dashboard component settings.	Settings
fields	The dashboard component fields.	Fields

Examples

Bar Chart

participantsSignups.xml

<dashboardcomponent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/dashboards.xsd">
	<name>Rewards Participants Signups</name>
	<description>Rewards Participants Signups Bar Chart</description>
	<ejb>CRMUIRewardDashboard</ejb>
	<method>loadParticipantsSignups</method>
	<type>bar</type>
	<orientation>horizontal</orientation>
	<primaryfield>REWARDPARTICIPANTS.REWPARTID</primaryfield>
	<primaryfieldlabel>Number of Rewards Participants</primaryfieldlabel>
	<groupbyfield>MONTH_SIGN_UP_DATE_FILTER</groupbyfield>
	<summarypage>rewards/participants</summarypage>
</dashboardcomponent>

Pie Chart

participantsPerSignupUnit.xml

<dashboardcomponent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/dashboards.xsd">
	<name>Rewards Participants Per Signup Unit</name>
	<description>Rewards Participants Per Signup Unit Pie Chart</description>
	<ejb>CRMUIRewardDashboard</ejb>
	<method>loadParticipantsPerSignupUnit</method>
	<type>pie</type>
	<groupbyfield>SIGNUP_BY_UNIT_FILTER</groupbyfield>
	<valuelabels>ejb/CRMUIUnit.getUnitOptions</valuelabels>
	<summarypage>rewards/participants</summarypage>
	<fields>
		<field>
			<fieldname>REWARDPARTICIPANTS.REWPARTSIGNUPDATE</fieldname>
			<caption>Sign Up Date</caption>
			<filter>true</filter>
			<fieldtype>date</fieldtype>
			<filtertextoption>range</filtertextoption>
		</field>
	</fields>
</dashboardcomponent>

Stacked Bar Chart

accountsPerClassificationAndCreditLimitStatus.xml

<dashboardcomponent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/dashboards.xsd">
	<name>Accounts Per Classification And Credit Limit Status</name>
	<description>Accounts Per Classification And Credit Limit Status Stacked Bar Chart</description>
	<ejb>CRMUIAccountReceivableDashboard</ejb>
	<method>loadAccountsPerClassificationAndCreditLimitStatus</method>
	<type>stack</type>
	<orientation>vertical</orientation>
	<primaryfield>ACCOUNTSRECEIVABLE.ACCRECID</primaryfield>
	<primaryfieldlabel>Number of Accounts</primaryfieldlabel>
	<groupbyfield>CLASSIFICATIONNAME_FILTER,CREDIT_LIMIT_FILTER</groupbyfield>
	<groupbyfieldlabel>Credit Limit, Accounts Receivable Classifications</groupbyfieldlabel>
	<valuelabels>ejb/CRMUIAccountReceivable.getCreditLimitStatusOptions,ejb/CRMUIAccountReceivableDashboard.getAllAccountClassifications</valuelabels>
	<summarypage>accounts/accountsReceivable</summarypage>
</dashboardcomponent>