Adding Report, Grid, and Dashboard Section Descriptions in White Cup BI

White Cup BI has the ability to display descriptions on reports, dashboard objects, and dashboard sections.  When a description is available, an icon like this will display on the report, section, or object.

Clicking on the information icon will display a description of that report, section, or object.  Here is an example.

If a report has a description, there is a link on in the Actions column of the report library for viewing it.

Adding a description to a dashboard section

While in the Visual Edit mode, hover over the section heading and click the gear icon.  This will open the section header editor.

In the Description box, enter the text you want to display when a user clicks on the information icon.  You can use standard web markup language to format your text.  Click on the question mark icon for an example.

See the section below on formatting the description for more detail.

Adding a description to a grid object

Similar to adding a description to a section header, adding a description to a grid is done by clicking the gear icon for the grid while in the Visual Edit mode.  Doing so will bring up the editor for the grid.  Enter the description in the box as highlighted below.

As of version 12.0.3, only grid objects support descriptions.  Other objects, like charts, time comparisons, cells, and stoplights do not currently have an option for adding descriptions.

Adding a description to a report

Adding a description to a report is done while saving the report.  In the save dialog, there will be a section for adding the description.

Formatting the description

The formatting style used is web markup language.  There are many guides available on the web describing the available options.  A list of the available options can be found here:  https://commonmark.org/help/

Here are three frequently used formats for underline, bold, and bullet.