If you're manually editing or creating new dashboard objects in White Cup BI, you'll need the syntax for the different object types.
Dashboard objects are the data presentations that make up dashboards and scorecards. These objects can be cells, grids, stoplights, charts, and more. By organizing these objects into columns and sections, you can create a dashboard that displays the data you want to see in your desired layout.
Typically, you'll create new objects using the dashboard object wizard when editing a dashboard. Below are listed the object types and their syntax for reference.
Tag Structure
Each object is called by a tag within the MWML (MITS Web Markup Language) of the dashboard. MWML tags are enclosed by {} characters. The tag statement structure is as follows:
{TAG OPTION ATTRIBUTE=’VALUE’}
| Tag Component | Description |
| TAG | Tag type, e.g. (Cell, Grid, Chart, etc.) |
| OPTION | Base option; these are options that do not require a value |
| ATTRIBUTE | Attributes are options that require a valueNote: The ‘=’ of an attribute must not be surrounded by spaces. |
Object Types
Cell
The cell tag is used to render the lower right cell returned from a report. This displays a single value with optional text before and/or after the value. You can specify a cell other than the lower right cell by using a filter on the flash screen or by selecting an alternate cell manually when creating a dashboard object.
Example Tag:
{CELL
FLASH='FLASH SALES R INVOICED.AMT.Y'
HREF='FLASH SALES R INVOICED.AMT.Y NOTAGS NOIDS HEADING "Sales Reps - Year-to-Date Sales Numbers"'
TEXT.BEFORE="Sales : "
TEXT.AFTER=""
}
| TAG | Values | Description |
| FLASH= | MQL | This is the flash command to generate the data. |
| HREF= | MQL | This is the report to display when the link is clicked. |
| TEXT.BEFORE | Text | Text inserted before the value returned from the flash statement. |
| TEXT.AFTER | Text | Text inserted after the value returned from the flash statement. |
Stoplight
The stoplight tag is used to display a color indicator based on where the lower right cell returned from a flash screen falls within the specified boundaries. You can specify a cell other than the lower right cell by using a filter on the flash screen or by selecting an alternate cell manually when creating a dashboard object.
{STOPLIGHT
FLASH='FLASH SALES R TREND_INVOICED.QTY.M-13_INVOICED.QTY.M-1'
HREF='FLASH SALES R TREND_INVOICED.AMT.M-13_INVOICED.AMT.M-1 NOTAGS NOIDS HEADING "Sales Reps - Trends Last Month vs. Same Month Last Year"'
TEXT.AFTER="Year over Year Monthly Units Trend : "
STOPLIGHT.BOUNDARIES="-10|0"
STOPLIGHT.IMAGES="redlight.png|yellowlight.png|greenlight.png"
}
| TAG | Values | Description |
| FLASH= | MQL | This is the flash command to generate the data. |
| HREF= | MQL | This is the report to display when the link is clicked. |
| TEXT.BEFORE | Text | Text inserted before the value returned from the flash statement. |
| TEXT.AFTER | Text |
Text inserted after the value returned from the flash statement. |
| STOPLIGHT.BOUNDRIES | Number delimited by a pipe | | Increasing order of numbers corresponding to the boundary values used to determine which image is displayed.The number of elements should be one less than the number of elements in STOPLIGHT.IMAGES(n-1). |
| STOPLIGHT.IMAGES | Text delimited by a | |
List of filenames corresponding to the boundaries defined by STOPLIGHT.BOUNDARIES. redlight.png, yellowlight.png, greenlight.png, and bluelight.png are the valid values |
Grid
The grid object is used to display a report grid on a dashboard. The grid can display some or all of the columns from a report, can include filtering and sorting, and be clipped to only display the first few lines. Like the other objects, the dashboard can link to a more in depth report.
{GRID
FLASH='FLASH SALES PT WITH INVOICED.AMT.POT.M-1..12 DROP.R.INVOICED.AMT.POT.M-13..24 DROP.R.PRIMARY.PROFIT.PCT.M-13..24 NOGRAND NOTAGS NOIDS CLIP 5'
HREF='FLASH SALES PT WITH INVOICED.AMT.POT.M-1..12 DROP.R.INVOICED.AMT.POT.M-13..24 DROP.R.PRIMARY.PROFIT.PCT.M-13..24 NOGRAND NOTAGS NOIDS'
HEADING="Product Groups with Low Sales"
COLUMN.OVERRIDE.HEADINGS="Sales<br />Last 12|Sales Rep<br />% of Sales|Company <br />% of Sales|Company<br />Profit %"
DISPLAYED.LOWEST.LEVELS="1"
DISABLE.DRILL.ACROSS="NO"
LINK.HEADING
}
| TAG | Values | Description |
| FLASH= | MQL | This is the flash command to generate the data. |
| HREF= | MQL | This is the report to display when the link is clicked. |
| HEADING | Text | The heading to display for the grid item. (Overrides MQL) |
| COLUMN.OVERRIDE.HEADINGS | Text delimited by a | |
The column headings to use in place of the standard column headings |
| DISPLAYED.LOWEST.LEVELS | Number | |
| DISABLE.DRILL.ACROSS | YES or NO | Enables the ability to drill across to available scorecards from identifiers in the displayed grid |
| LINK.HEADING | none |
Tells the engine to create links for the grid heading. |
TIME COMPARISON OBJECT
The TIME.COMPARISON.GRID dashboard object displays two timeframes (called “eons” in White Cup BI vocabulary), shows a trend or difference calculation between them for two time periods, and displays them on a grid.
Example Tag:
{TIME.COMPARISON.GRID
APP="CUBENAME"
GENERATE.ROOT.PATH="YES/NO"
HEADING="Display name of the object"
A.EON.ID="EON 1"
B.EON.ID="EON 2"
DIFFERENCE="YES/NO"
TREND="YES/NO"
{TIME.COMPARISON.ROW
{COLUMN.TEMPLATE.ITEM DESCRIPTION="Name of the type of metric"}
}
}
| TAG | Values | Description |
| APP= | Text | Name of the cube containing the data to display |
| GENERATE.ROOT.PATH= | YES or NO | Setting to use Root Path when applying security |
| HEADING= | Text | Text displayed as the name of the report |
| A.EON.ID= | MQL | First Eon to use in the comparison |
| B.EON.ID= | MQL | Second Eon to use in the comparison |
| DIFFERENCE= | YES or NO | Enable display of the difference column between Eon A and Eon B |
| TREND= | YES or NO | Enable display of the trend column between Eon A and Eon B |
| DESCRIPTION= | MQL | Name of the metric to display |
Comments
0 comments
Article is closed for comments.