This documentation corresponds to a historical version of Yellowfin

Icon

Access the latest release, or view a list of available versions of the documentation.

Skip to end of metadata
Go to start of metadata

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:

 

The full XML structure is outlined on the Widget XML page.

 

Dashboard Widget

Dashboard Widgets are used to define the contents of each page in order to produce a dashboard. The dashboard will hold all other widgets to be displayed, called, or used on a page. It can contain as many reports as required, each styled be its own CSS class, as well as allowing for styles to be applied to the dashboard as a whole.

Example Output

 

Example Elements

 Click here to expand...

 <dashboard>

ChildValueDescription
id 1

This is a unique number used to identify the tab within the XML. It’s also used in the URL in order to identify the tab. For example, if the id is 1 then the URL might look like:
http://localhost:7171/DashboardPortal/dashboard.jsp?id=1

filter 

This contains the details of filters used on the tab. In this scenario we had date filters controlling the dashboard content. See Dates for more detail.

exportlist This contains the details of any export buttons to be used on the dashboard or individual reports. See Export Button Widget for more detail
report 

This contains information around a single report to be displayed on the tab. See Chart for more detail.

Example XML

 Click here to expand...

 

 

Sub Tab Widget

Sub Tab Widgets are used for toggling between different sections of content, within a single dashboard definition - much like how sub tabs work within the standard Yellowfin interface. A button or drop down list allows the user to switch between tabs to display different content on the screen. 

Example Output

Example Elements

 Click here to expand...
<subtab>
ChildValueDescription
styleClass 

Contains a CSS class name used to apply styling to the component.

name 

This is a name of the sub tab for referencing within the XML.

options 

This contains nodes to define the contents of the display and reports within the sub tab. See <options> node description.

<options>

For within a sub tab.

ChildValueDescription
titleBooking Stats

This is the text label for the sub tab selector (how you toggle between the sub tab sets of reports).

descriptionEmail, Phone, and Website

This is the descriptive text displayed below the sub tab title in the sub tab selector.

icon<![CDATA[<div class="subtabBookingIcon"></div>]]>

This contains a reference to include an icon within the sub tab button. For example:

<![CDATA[<div class="subtabBookingIcon"></div>]]>

 

 

Example XML

 Click here to expand...

Example CSS

 Click here to expand...

 

 

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

 Click here to expand...

 <text>

ChildValueDescription
styleClassdashboardTitle

Contains a CSS class name used to apply styling to the component.

textSki Team DashboardThis contains text to be displayed on the dashboard as titles, descriptions, or for other uses.

Example XML

 Click here to expand...

Example CSS

 Click here to expand...

 

 

Export Button Widget

The Export Buttons allow you to export the dashboard and reports to various formats using the <exportlist> XML Widget. This will need to define which export formats you wish to allow, and which report to export (if you are using XLS).

Example Output

Example Elements

 Click here to expand...

<exportlist>

ChildValueDescription
export 

This contains nodes to define the export buttons to be displayed on the dashboard tab. In this example, we’ve displayed the Print, PDF, and XLS buttons. See <filterMap> node description.

 

<export> (Print)

ChildValueDescription
styleClassprintExport

Contains a CSS class name used to apply styling to the component. In this particular example, we’ve used a unique class per export type, as each button has a different icon.

exporttypePRINT

This specifies that the browser print function will be called to print the entire dashboard.

 

<export> (PDF)

ChildValueDescription
styleClass pdfExport

Contains a CSS class name used to apply styling to the component. In this particular example, we’ve used a unique class per export type, as each button has a different icon.

exporttype PDF

This specifies that the current dashboard will be exported to PDF format.

 

<export> (XLS)

ChildValueDescription
styleClass xlsExport

Contains a CSS class name used to apply styling to the component. In this particular example, we’ve used a unique class per export type, as each button has a different icon.

exporttype XLS

This specifies that a single report will be exported to XLS format.

reportuuid

39f8f49f-124b-4b36-a7f6-2f1ed9724c53

This is the UUID of the report to be exported to XLS.

Example XML

 Click here to expand...

Example CSS

 Click here to expand...

 

 

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

 Click here to expand...

<filter>

ChildValueDescription

sync

trueSetting this to true allows the values of this filter to be passed to other dashboards.
datatypeDATEThis specifies that the filter options need to return a date type in order to be applied.
namedateFilterThis contains the name of the filter, to be used to identify it for the <filterMap> node used on reports receiving the values.  
operatorBETWEEN

This specifies the operator for the filter, and must be compatible with the operators used in reports you wish to pass the filter values to.

BETWEEN means two values are expected. This option should be used for operators defined in the report including, but not limited to; Between, Not Between.

styleClasstopFilterThis contains a CSS class name used to apply styling to the component.
options This contains nodes to define the contents of the display and possible values. Each option to be presented to the user will need to have its own <option> node. In this example we’ve used a Year, Month, and Custom option. See <options> node description.

 

<options> (Custom)

ChildValueDescription
titleCustomThis is the label displayed on the filter. A text name describing the value that will be applied.
prompttrueThis specifies that the option doesn’t have a value predefined, but rather will ask the user to provide it. In this example, as we are using a prompt, there is no need for a <value> node. As the filter is defined as a date, the user will be presented with a calendar picker (which can be styled using css).

 

<options> (Year)

ChildValueDescription
title YearThis is the label displayed on the filter. A text name describing the value that will be applied.
typecodePREDEF This defines that the option will use a predefined filter, such as a predefined date range. You will then have to specify which definition to use in the <value> node.
valueYEARTODATE YEARTODATE uses the predefined date range that is the first date of the current year, to the current date.


<options> (Month)

ChildValueDescription
title MonthThis is the label displayed on the filter. A text name describing the value that will be applied.
typecodePREDEF This defines that the option will use a predefined filter, such as a predefined date range. You will then have to specify which definition to use in the <value> node.
valueMONTHTODATE MONTHTODATE uses the predefined date range that is the first date of the current month, to the current date.


<options> (All Time)

ChildValueDescription
title All Time This is the label displayed on the filter. A text name describing the value that will be applied.
value1900-01-01\|2100-01-01 This defines that the date range will be from 1st Jan 1900 to 1st Jan 2100, effectively covering all the data in this dataset.
defaultOption trueThis specifies this option as the default selection for the dashboard. Only one <option> node can be the default, the rest should be false or omit this node.


Example XML

 Click here to expand...

Example CSS

 Click here to expand...

 

 

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

 Click here to expand...

<report>

ChildValueDescription

display

HIDDENHIDDEN allows the results of the report to be used in other components of the page, rather than in its native tabular format. In this case, the report is a dual column report returning a list of filter options, and the matching summary value.
uuid73f732e8-7961-4925-9319-740dc4991de8This contains the Yellowfin UUID of the report in order to call it.
nameskiTeamFilterListThis names the report for use elsewhere in the XML. The <summary> node will call the report by this name, rather than having to call it by UUID, but either would work.
filterMap This contains nodes to define any filters that need to be passed to the report from elsewhere on the dashboard tab. See <filterMap> node description.

 

<filterMap>

ChildValueDescription

filterUUID

73f732e8-7961-4925-9319-740dc4991de8This is the UUID of the filter in the hidden report that will receive the <mapToFilter> value. In this case, it’s the date filter applied to the Position Improvement report.
mapToFilterskiTeamFilterThis is the name of the filter applied elsewhere on the dashboard tab. In this example, we’re linking to the skiTeamFilter filters.

 

<filter>

ChildValueDescription

sync

trueSetting this to true allows the values of this filter to be passed to other dashboards.
datatypeTEXTThis specifies that the filter options need to return a text type in order to be applied.
nameskiTeamFilterThis contains the name of the filter, to be used to identify it for the <filterMap> node used on reports receiving the values.  
operatorEQUAL

This specifies the operator for the filter, and must be compatible with the operators used in reports you wish to pass the filter values to. EQUAL means only one value is expected. This option should be used for operators including, but not limited to; Equal to, Greater than, Less than, Contains.

styleClassquickStatFilterThis contains a CSS class name used to apply styling to the component.
options This contains nodes to define the contents of the display and possible values. Each option to be presented to the user will need to have its own <option> node. In this example we’ve used a Booking Stats, Athletes, and Ski Camps options. See <options> node description.

 

<options> (Booking Stats)

ChildValueDescription
titleBooking StatsThis is the label displayed on the filter. A text name describing the value that will be applied.
descriptionEmail, Phone, and WebsiteThis is a descriptive label to be displayed on the filter. This is optional.
summary This specifies how to retrieve a value from a report in order to display it as a summary value on the filter button. See <summary> node description.
icon<![CDATA[<div class="filterIconBooking"></div>]]>This contains the HTML required to display a specific icon on the filter button.
valueBookingThis specifies the value of the filter. 
defaultOptionfalseThis specifies this option as the default selection for the dashboard. Only one <option> node can be the default, the rest should be false or omit this node.

 

<summary> (Booking Stats)

ChildValueDescription
reportIdskiTeamFilterListThis is the report name, specified where the report is included in the XML that you will use to retrieve and display the summary value. In this case, the report is a dual column report returning a list of filter options, and the matching summary value.
matchColumn0This is the number placement of the column in the tabular report you wish to match a value to in order to locate a specific row. In this case, the column that contains the descriptive labels is the first column in the report, and as we count from zero, use 0.
matchValueBookingThis is the value you wish to locate in the <matchColumn> column in order to locate a specific row. In this case, you need to locate the Booking value.
valueColumn1

This is the column you wish to retrieve data from, in the row located using <matchColumn> and <matchValue> nodes. This value starts at zero. In this case, the column with numeric values is second in the report, so use 1.

 

<options> (Athletes)

ChildValueDescription
titleAthletesThis is the label displayed on the filter. A text name describing the value that will be applied.
descriptionDemographic & SalesThis is a descriptive label to be displayed on the filter. This is optional.
summary This specifies how to retrieve a value from a report in order to display it as a summary value on the filter button. See <summary> node description.
icon<![CDATA[<div class="filterIconAthletes"></div>]]>This contains the HTML required to display a specific icon on the filter button.
valueAthletesThis specifies the value of the filter. 
defaultOptionfalseThis specifies this option as the default selection for the dashboard. Only one <option> node can be the default, the rest should be false or omit this node.

 

<summary> (Athletes)

ChildValueDescription
reportIdskiTeamFilterListThis is the report name, specified where the report is included in the XML that you will use to retrieve and display the summary value. In this case, the report is a dual column report returning a list of filter options, and the matching summary value.
matchColumn0This is the number placement of the column in the tabular report you wish to match a value to in order to locate a specific row. In this case, the column that contains the descriptive labels is the first column in the report, and as we count from zero, use 0.
matchValueAthletesThis is the value you wish to locate in the <matchColumn> column in order to locate a specific row. In this case, you need to locate the Athletes value.
valueColumn1

This is the column you wish to retrieve data from, in the row located using <matchColumn> and <matchValue> nodes. This value starts at zero. In this case, the column with numeric values is second in the report, so use 1.


<options>
(Ski Camps)

ChildValueDescription
titleSki CampsThis is the label displayed on the filter. A text name describing the value that will be applied.
descriptionStats for each SiteThis is a descriptive label to be displayed on the filter. This is optional.
summary This specifies how to retrieve a value from a report in order to display it as a summary value on the filter button. See <summary> node description.
icon<![CDATA[<div class="filterIconCamps"></div>]]>This contains the HTML required to display a specific icon on the filter button.
valueCampsThis specifies the value of the filter. 
defaultOptiontrueThis specifies this option as the default selection for the dashboard. Only one <option> node can be the default, the rest should be false or omit this node.

 

<summary> (Camps)

ChildValueDescription
reportIdskiTeamFilterListThis is the report name, specified where the report is included in the XML that you will use to retrieve and display the summary value. In this case, the report is a dual column report returning a list of filter options, and the matching summary value.
matchColumn0This is the number placement of the column in the tabular report you wish to match a value to in order to locate a specific row. In this case, the column that contains the descriptive labels is the first column in the report, and as we count from zero, use 0.
matchValueCampsThis is the value you wish to locate in the <matchColumn> column in order to locate a specific row. In this case, you need to locate the Camps value.
valueColumn1

This is the column you wish to retrieve data from, in the row located using <matchColumn> and <matchValue> nodes. This value starts at zero. In this case, the column with numeric values is second in the report, so use 1.

Example XML

 Click here to expand...

Example CSS

 Click here to expand...

 

 

Report Widget 

Chart

Reports and visualisations can be displayed using the <report> XML widget. This will need to call the required report, specify the format and styling, and pass through any filters.

Example Output

Example Elements

 Click here to expand...

<report>

ChildValueDescription
displayCHART

CHART allows the results of the report to be displayed as a chart, defined in Yellowfin. In this case, the report is a line chart.

titleAthlete Bookings over Time

This is the title of the report, to be displayed above the chart on the dashboard tab.

uuid

d1f779fb-7dbf-42e2-8e6a-bc7dc84ae04f

This contains the Yellowfin UUID of the report in order to call it.

styleClassfullWidthChart

This contains a CSS class name used to apply styling to the component.

filterMap 

This contains nodes to define any filters that need to be passed to the report from elsewhere on the dashboard tab. In this example, we’ve passed the main date filter from the tab to the report (dateFilter). See <filterMap> node description.

 

<filterMap>

ChildValueDescription
filterUUID

a0bfc7f6-1550-4f4d-a3c5-031b20c1a942

This is the UUID of the filter in the hidden report that will receive the <mapToFilter> value. 
mapToFilterdateFilter

This is the name of the filter applied elsewhere on the dashboard tab. In this example, we’re linking to the dateFilter filters.

Example XML

 Click here to expand...

Example CSS

 Click here to expand...

 

 

Table

Tables can be displayed using the <report> XML widget. This will need to call the required report, specify the format and styling, and pass through any filter values required.

Example Output

Note: the See All Camps link pictured above is called through this widget, but the contents and display of the modal is actually defined through a modal widget. See the Modal Widget section for details.

Example Elements

 Click here to expand...

<report>

ChildValueDescription
displayTABLE

TABLE displays the results of the report in a tabular format, which does not use standard Yellowfin styling.

titleTop 10 Rated Camps

This is the title of the report, to be displayed above the table on the dashboard tab.

uuid

d2769b31-5938-4b80-9573-bfe5720440a0

This contains the Yellowfin UUID of the report in order to call it.

styleClassfullTable

This contains a CSS class name used to apply styling to the component.

filterMap 

This contains nodes to define any filters that need to be passed to the report from elsewhere on the dashboard tab.

resultsPerPage25

This allows you to define how many rows are displayed per page. If the report exceeds this number, pagination will display unless disabled using the <hidePagination> node.

hidePaginationtrue

This allows you to hide the pagination that appears by default.

modalNameCampRatingListModal

This calls a modal widget defined elsewhere in the XML in order to display content within a modal popup display.

modalLinkText

See All Camps

This is the text to be displayed as a link which opens the modal.

 

<filterMap>

ChildValueDescription
filterUUID

d10848dc-b892-4890-9933-a463931b0828

This is the UUID of the filter in the hidden report that will receive the <mapToFilter> value. In this case, it’s the date filter applied to the report.

mapToFilterdateFilter

This is the name of the filter applied elsewhere on the dashboard tab. In this example, we’re linking to the dateFilter filters.

Example XML

 Click here to expand...

Example CSS

 Click here to expand...

 

 

Modal Window Widget

The Modal Widget displays a popup window with contents defined within the <subcontent> element. The modal itself is called outside of the <modal> definition, for example as part of a report. For the purpose of this scenario, we have defined the modal link as part of a report (see Table outline above).

Example Output

Example Elements

 Click here to expand...

<modal>

ChildValueDescription
titleCamp Rating List

This is the title displayed at the top of the modal window.

nameCampRatingListModal

This is the name of the modal, to be called by other widgets in the XML.

subcontent 

This defines the contents of the modal window. See <subcontent> node description.

 

<subcontent>

ChildValueDescription
report 

This is the report that will be displayed in the modal window. See <report> node description.

 

<report>

ChildValueDescription
displayTABLE

TABLE displays the results of the report in a tabular format, which does not use standard Yellowfin styling.

uuid

0d16ddf3-749f-4fac-b86e-73cc5dcb1db6

This is the title of the report, to be displayed above the table on the dashboard tab.

styleClassfullTable

This contains a CSS class name used to apply styling to the component.

filterMap 

This contains nodes to define any filters that need to be passed to the report from elsewhere on the dashboard tab.

resultsPerPage100

This allows you to define how many rows are displayed per page. If the report exceeds this number, pagination will display unless disabled using the <hidePagination> node.

 

<filterMap>

ChildValueDescription
filterUUID

61ccfce6-6c1b-4221-a5ce-561e1e71feb2

This is the UUID of the filter in the hidden report that will receive the <mapToFilter> value. In this case, it’s the date filter applied to the report.
mapToFilterdateFilter

This is the name of the filter applied elsewhere on the dashboard tab. In this example, we’re linking to the dateFilter filters.

Example XML

 Click here to expand...

Example CSS

 Click here to expand...

 

 

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

 Click here to expand...

<report>

ChildValueDescription
displayHIDDENHIDDEN allows the results of the report to be used in other components of the page, rather than in its native tabular format. In this case, the report is a single row report returning the Camp Start Date, filtered by the date filter on the tab.
uuid

b0ebacf2-c51d-41c6-8a3f-09cef22adb67

This contains the Yellowfin UUID of the report in order to call it.

filterMap 

This contains nodes to define any filters that need to be passed to the report from elsewhere on the dashboard tab. In this example, we’ve passed the main date filter from the tab to the report (dateFilter). See <filterMap> node description.

 

<filterMap>

ChildValueDescription
filterUUID

ea41ba19-6362-4e97-b607-cc66d22cc5cb

This is the UUID of the filter in the hidden report that will receive the <mapToFilter> value. In this case, it’s the date filter applied to the Camp Start Date report.
mapToFilter

dateFilter

This is the name of the filter applied elsewhere on the dashboard tab. In this example, we’re linking to the dateFilter filters, defined in the Filter section of this document.

 

<customhtml>

ChildValueDescription
styleClassdashboardDatesContains a CSS class name used to apply styling to the component.
html<![CDATA[<div>Your camp started on: <@- campStart @></div>]]>Contains the HTML to be used as the component, wrapped in a CDATA section. In this example, we have the CDATA tag containing static text, and the <@- campStart @> parameter which references the campStart replacement, defined in the <replacements> node.
replacements 

This allows you to place a parameter in the custom html that will be replaced with values of a filter or report, if required. In order to call the parameter, place the replaceName value in <@- ->. See <replacements> node description.

 

<replacements>

ChildValueDescription
replaceNamecampStart

This is the name given to the parameter in the <customhtml> node. In this example, we’ve called the replacement campStart.

reportName

b0ebacf2-c51d-41c6-8a3f-09cef22adb67

This is the UUID of the report. If you’ve used the report elsewhere on the dashboard, you could put the report name in this node. In this example, we’re only using the report to provide a value for the custom HTML, nothing else.

valueColumn0

This is the column of the report that the value will come from. If the report had multiple columns and rows, you would also need the <matchColumn> and <matchValue> nodes, but in this example our report is only one cell. The numbering of the columns starts at 0.

Example XML

 Click here to expand...

Example CSS

 Click here to expand...

 

 

  • No labels