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.

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 valid ejb name
method	The method to call from the ejb.	Any valid method name
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>
primaryfieldlabel	The label that the primary field will have.	Any
groupbyfieldlabel	The label that the group by field will have.	Any
summarypage	The summary page name.	Any valid summary page
orientation	The dashboard component orientation.	vertical, horizontal
setting	The dashboard component settings.	Settings
fields	The dashboard component fields.	Fields

Examples

Bar Chart

participantsSignups.xml

<?xml version="1.0" encoding="UTF-8"?>
<dashboardcomponent>
	<name>Rewards Participants Signups</name>
	<description>Rewards Participants Signups Bar Chart</description>
	<ejb>CRMUIRewardDashboard</ejb>
	<method>loadParticipantsSignups</method>
	<type>bar</type>
	<orientation>horizontal</orientation>
	<primaryfieldlabel>Number of Rewards Participants</primaryfieldlabel>
	<summarypage>rewards/participants</summarypage>
</dashboardcomponent>

Pie Chart

subscriptionsPerLifeCycleState.xml

<?xml version="1.0" encoding="UTF-8"?>
<dashboardcomponent>
	<name>Subscriptions Per Life Cycle State</name>
	<description>Subscriptions Per Life Cycle State Pie Chart</description>
	<sql></sql>
	<ejb>CRMUISubscriptionDashboardComponent</ejb>
	<method>loadSubscriptionsPerLifeCycleState</method>
	<type>pie</type>
	<valuelabels>DRAFT:Draft;EFFECTIVE:Effective;NOT_EFFECTIVE:Not Effective;IN_RESTING:In Resting;REGRETTED:Regretted;CANCELLED:Cancelled;SHORT_TERM_EFFECTIVE:Short-Term Effective;SHORT_TERM_NOT_EFFECTIVE:Short-Term Not Effective</valuelabels>
	<summarypage>subscriptions/subscriptions</summarypage>
	<setting>
		<page>dashboards/subscriptionsPerLifeCycleStateSettings</page>
		<classname>ejb/CRMUISubscriptionDashboardComponent</classname>
		<method>loadSubscriptionsPerLifeCycleStateSettingsForm</method>
	</setting>
	<fields>
		
	
		<field>
			<fieldname>LIFECYCLESTATE_FILTER</fieldname>
			<fieldfunction>CURRENTSTATE.LIFECYCLESTATE</fieldfunction>
			<caption>Life Cycle State</caption>
			<filter>true</filter>
			<fixedlookup>ejb/CRMUISubLifeCycleStateHistory.getLifeCycleStateOptions:All</fixedlookup>
		</field>
		
	</fields>
</dashboardcomponent>

Stacked Bar Chart

accountsPerClassificationAndCreditLimitStatus.xml

<?xml version="1.0" encoding="UTF-8"?>
<dashboardcomponent>
	<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>
	<primaryfield>ACCOUNTSRECEIVABLE.ACCRECID</primaryfield>
	<primaryfieldlabel>Number of Accounts</primaryfieldlabel>
	<summarypage>accounts/accountsReceivable</summarypage>
</dashboardcomponent>

Summary

contactsSummary.xml

<?xml version="1.0" encoding="UTF-8"?>
<dashboardcomponent>
	<name>Contact Information Summary</name>
	<description>Contact Information Summary</description>
	<type>summary</type>
	<summarypage>contactinfo/contactInformation</summarypage>
</dashboardcomponent>