Versions Compared

Old Version 4

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Panel
nameblue

Dashboard Components Documentation

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

Child pages (Children Display)

...

Name
Description
Value
nameThe dashboard component name.Any
descriptionThe dashboard component description.Any
sqlThe dashboard component SQL statement (In the case the SQL is very simple).Any valid SQL statement
ejbThe ejb name.Any valid ejb name
methodThe method to call from the ejb.Any valid method name
typeThe dashboard component type.pie, stack, bar, summary
valuelabelsThe label values that the group by elements will have.<label_name>:<label_value>, ejb/<method_name>
primaryfieldThe primary field name.Any
primaryfieldlabelThe label that the primary field will have.Any
groupbyfieldThe group by field name(s).Any
groupbyfieldlabelThe label that the group by field will have.Any
summarypageThe summary page name to link to.Any valid summary page
orientationThe dashboard component orientation.vertical, horizontal
settingThe dashboard component settings. Settings
fieldsThe dashboard component fields.Fields

 

...

Examples

Expand
titleBar ChartDashboard Component
Image Added

Image Removed 

<?xml version="1.0" encoding="UTF-8"?> <dashboardcomponent>
Code Block
themeEclipse
languagexml
titleSearch Page
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>
Expand
titlePie Chart
Image Added

 

Code Block
themeEclipse
languagexml
titleparticipantsPerSignupUnit.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>
Expand
titleStacked Bar Chart
Image Added

 

Code Block
themeEclipse
languagexml
titleaccountsPerClassificationAndCreditLimitStatus.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>