Overview
The following sections outline sample dashboard content developed with DashXML and Yellowfin content. It will explore each of the avilalbe widget types, how they were set up in the XML, and how they were styled through custom CSS.
Note: this is merely a guide in order to walk you through using the DashXML framework for your own dashboard requirements.
The main XML widget types consist of the following:
<application-definition> <sourcefilter></sourcefilter> <dashboard> <text></text> <exportlist> <export><export> </exportlist> <filter> <options> <summary><summary> </options> </filter> <report> <modal> <subcontent></subcontent> </modal> <filterMap></filterMap> </report> <modal> <subcontent></subcontent> </modal> <customhtml> <replacements></replacements> </customhtml> <subtab> <options> <subcontent></subcontent> <summary></summary> </options> <subtab> </dashboard> </application-definition>
The full XML structure is outlined on the Widget XML page.
Dashboard Widget
Text Widget
The Dashboard Title can be implemented using the<text>
XML Widget. This will simply need to contain the text to be displayed as the title, and a css class name to be used for styling that text.Example Output
Example Elements
Example XML
Example CSS
Filter Widget - Dates
These can be implemented using the<filter>
XML widget. Each filter widget requires at least one option to be defined, allowing the user to select a value to apply. This particular filter has four options; Custom, Year, Month, and All Time. The Year, Month, and All Time filters have been set up using pre-defined date ranges, while the Custom option was specified as user prompt in order to allow users to specify a custom range.Example Output
Example Elements
Example XML
Example CSS
Filter Widget - Buttons
The filter widget displays possible filter value options that the user can select from. Each option has the capacity to display a title, description, icon, and summary value – all except the title are optional.Example Output
Example Elements
Example XML
Example CSS
Custom HTML Widget - Text & Report Data
The data from a report can be used within a<customHTML>
XML Widget along with other elements to produce a combined output. In this scenario, we wanted to display the first date we have records for within the user selected filter date range. To do this we wanted to combine some static text with a date record from a report. The widget needed to contain HTML to display the static text, such as "Your camp started on: ", and the dynamic date element that comes from the result of a Yellowfin report. In order to do this, you will also need to include the report that returns the date as a hidden report.Example Output
Example Elements
Example XML
Example CSS
<!-- Report to return Camp Start Date -->
<report>
<display>HIDDEN</display>
<uuid>b0ebacf2-c51d-41c6-8a3f-09cef22adb67</uuid>
<filterMap>
<filterUUID>ea41ba19-6362-4e97-b607-cc66d22cc5cb</filterUUID>
<mapToFilter>dateFilter</mapToFilter>
</filterMap>
</report>
<!-- Custom HTML to display Camp Start Date -->
<customhtml>
<styleClass>dashboardDates</styleClass>
<html><![CDATA[<div>Your camp started on: <@- campStart @></div>]]></html>
<replacements>
<replaceName>campStart</replaceName>
<reportName>b0ebacf2-c51d-41c6-8a3f-09cef22adb67</reportName>
<valueColumn>0</valueColumn>
</replacements>
</customhtml>