Table of Contents
...
Dashboard component offers a graphical representation of data on the page.
Note |
---|
Dashboard component is configured into an XML file. |
Getting Started
Component XML File
...
- <title> - is used to define a valid key defined in translation properties file. Its translation through the glossary will be used as the presentable name of the component.
<iconclass> - is used to define a font awesome icon class that will be used to render the icon of the component.
Note Use font awesome icon class supported by version 4.7.0.
- <ejb> - is used to define a process ejb class name in which the method that will be used to retrieved chart’s data is implemented.
- <method> - is used to define the method that will be used to retrieve chart's data.
<type> - is used to define the type of the chart.
Note Allowed values are BAR, DONUT, LINE, PIE, STACKED_BAR and SUMMARY.
<orientation> - is used to define the orientation of the chart's data.
Note Allowed values are VERTICAL and HORIZONTAL.
Applicable only for chart types BAR and STACKED_BAR.
<xaxislabel> - is used to define a valid key defined in translation properties file. Its translation through the glossary will be used as the X axis title.
Note Applicable only for chart types BAR, LINE and STACKED_BAR.
<yaxislabel> - is used to define a valid key defined in translation properties file. Its translation through the glossary will be used as the X axis title.
Note Applicable only for chart types BAR, LINE and STACKED_BAR.
<settings> - is used to defined the chart settings and should follow the below structure.
Code Block language xml <settings> <setting> <id></id> <label></label> <classname></classname> </setting> </settings>
Note Settings must have the same order as the ejb method parameters.
Each setting tag should consist of:
- <id> - is used to define a unique id for the setting that will be used to construct dashboard component's xml.
- <label> - is used to define a valid key defined in translation properties file. Its translation through the glossary will be used as the setting label.
<classname> - is used to define the class name of the data object that is mapping with the setting.
- <summarypage> - is used to define the summary page path that will be opened upon clicking on chart's data.
<summarypageparameters> - is used to define the parameters that will be passed to the summary page upon clicking on chart's data and should follow the below structure.
Code Block language xml <summarypageparameters> <summarypageparameter> <name></name> <classname></classname> <field></field> <axis></axis> </summarypageparameter> </summarypageparameters>
Note Summary Page Parameters must have the same order as Settings order.
Each summary page parameter tag should consist of:
- <name> - is used to define a valid summary criterion xpath of the specified summary page.
- <classname> - is used to define the class name of the data object that is mapping with the specified xpath.
<field> - is used to define the class field that will be used to load the data object.
Note Applicable only for CRMDO objects.
<axis> - is used to define the axis that will be used to get the parameter value.
Note Applicable only for chart types BAR, LINE and STACKED_BAR.
<columns> - is used to define the columns of a summary chart type and should follow the below structure.
Code Block language xml <columns> <column> <label></label> </column> </columns>
Note Applicable only for chart type SUMMARY.
Columns are mapping with the chart's data. For example, if the method that retrieves chart's data returns HashMap<CRMDOSubscriptionType, HashMap<CRMDOProduct, Integer>> then the columns should be associated with subscription type, product and number respectively.
Each column tag should consist of:
- <label> - is used to define a valid key defined in translation properties file. Its translation through the glossary will be used as the summary column header label.
...
Expand | ||||||||
---|---|---|---|---|---|---|---|---|
|
Expand | ||
---|---|---|
| ||
title | .xml |
---|
Code Block | ||||
---|---|---|---|---|
| ||||
<?xml version="1.0" encoding="UTF-8"?><dashboardcomponent xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../xsd/dashboards.xsd">
<title>key_effective_subscriptions_per_type_and_service</title>
<iconclass></iconclass>
<ejb>CRMProcessSubscriptionBean</ejb>
<method>loadSubscriptionsPerTypeAndProduct</method>
<type>BAR</type>
<orientation>VERTICAL</orientation>
<xaxislabel>key_subscription_services</xaxislabel>
<yaxislabel>key_number_of_subscriptions</yaxislabel>
<settings>
<setting>
<id>types</id>
<label>key_subscription_types</label>
<classname>com.crm.dataobject.subscriptions.CRMDOSubscriptionType</classname>
</setting>
<setting>
<id>serviceTypes</id>
<label>key_service_types</label>
<classname>com.crm.dataobject.products.CRMDOProductType</classname>
</setting>
</settings>
<summarypage>subscriptions/subscriptions</summarypage>
<summarypageparameters>
<summarypageparameter>
<name>types</name>
<classname>com.crm.dataobject.subscriptions.CRMDOSubscriptionType</classname>
<field>name</field>
<axis>Z_AXIS</axis>
</summarypageparameter>
<summarypageparameter>
<name>serviceTypes</name>
<classname>com.crm.dataobject.products.CRMDOProductType</classname>
<field>code</field>
<axis>X_AXIS</axis>
</summarypageparameter>
</summarypageparameters>
<columns>
<column>
<label></label>
</column>
</columns>
</dashboardcomponent>
|
title | .java |
---|
language | java |
---|---|
theme | Eclipse |
Expand | |||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||||
|
...