Versions Compared

Version Old Version 69 New Version 70
Changes made by

Christina Georgiou (Unlicensed)

Christina Georgiou (Unlicensed)

Saved on

Key

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

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
    languagexml
    <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. 

...