Versions Compared

Old Version 2

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

Search pages are the xml files that contain database query definitions. To refer to a search page from the code the <searchpage_folder>.<searchpage_filename> is usedDashboard 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. 

Child pages (Children Display)

Attributes

Name
Description
Value
searchcaptionA title which is displayed on the screen.Any
sqltypeThe type of SQL script.SELECT or SELECT DISTINCT
tablesA list of tables to be used in the joins and fields sections.Any table name that exists in the database
joinsA list of elements to join the tables.Join
fieldsThe fields that are used in the select and where clauses.Field Item
wheregroupsA wheregroup groups together where conditions in the search file.Wheregroup
groupbyCollects data across multiple records and groups the results by one or more fields.Any field name
orderbySorts the query result set based on one or more fields.Order By

Example

...

titleSearch Page

...

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
methodThe method to call from the ejb.Any
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
orientationThe dashboard component orientation.vertical, horizontal
settingThe dashboard component settings.Settings
fieldsThe dashboard component fields.Fields

 

Examples

Expand
titleBar Chart
Image Added

 

<?xml version="1.0" encoding="UTF-8"?> <dataset xmlns="http://www.crm.com/xmlschema/dataset.rng"> <searchcaption>Search Products</searchcaption> <sqltype>Select</sqltype> <tables> <table><tablename>PRODUCTS</tablename></table> <table><tablename>PRODUCTTYPES</tablename></table> <table><tablename>PRODUCTBRANDS</tablename></table> <table><tablename>PRODUCTFAMILIES</tablename></table> </tables> <joins> <join> <indexorder>1</indexorder> <outertable>PRODUCTS</outertable> <innertable>PRODUCTTYPES</innertable> <jointype>RIGHT</jointype> <conditions> <conditionitem> <outerfield>PRODTYPEID</outerfield> <condition>=</condition> <innerfield>PRODTYPEID</innerfield> <andor>AND</andor> </conditionitem> </conditions> </join> <join> <indexorder>2</indexorder> <outertable>PRODUCTS</outertable> <innertable>PRODUCTBRANDS</innertable> <jointype>LEFT</jointype> <conditions> <conditionitem> <outerfield>PRODBRANDID</outerfield> <condition>=</condition> <innerfield>PRODBRANDID</innerfield> <andor>AND</andor> </conditionitem> </conditions> </join> <join> <indexorder>3</indexorder> <outertable>PRODUCTS</outertable> <innertable>PRODUCTFAMILIES</innertable> <jointype>LEFT</jointype> <conditions> <conditionitem> <outerfield>PRODFAMILYID</outerfield> <condition>=</condition> <innerfield>PRODFAMILYID</innerfield> <andor>AND</andor> </conditionitem> </conditions> </join> </joins> <fields> <fielditem> <field>PRODUCTS.PRODID</field> <expression>VALUE</expression> <datatype>ftXString</datatype> <fieldlen>32</fieldlen> <searchcriteria>0</searchcriteria> <visible>0</visible> <executable>1</executable> <indexorder>1</indexorder> </fielditem> <fielditem> <field>PRODUCTS.PRODCODE</field> <label>Product Code</label> <expression>VALUE</expression> <datatype>ftXString</datatype> <fieldlen>32</fieldlen> <searchcriteria>1</searchcriteria> <visible>1</visible> <executable>1</executable> <indexorder>2</indexorder> </fielditem> ... </fields> <wheregroups> <wheregroup> <wherefields> <wherefield> <field>PRODUCTS.PRODDELETED</field> <alias>Expr001</alias> <expression>VALUE</expression> </wherefield> <wherefield> <field>0</field> <alias>Expr002</alias> <expression>VALUE</expression> </wherefield> </wherefields> <wheremembers> <wheremember> <lparenth>0</lparenth> <lfield>PRODUCTS.PRODDELETED</lfield> <expression>=</expression> <rfield>0</rfield> <rparenth>0</rparenth> <andor>AND</andor> </wheremember> </wheremembers> </wheregroup> </wheregroups> <groupby/> <orderby/> </dataset>
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>