This widget type is actually a feature that you add to a column, bar, or pie widget. However, the setup is easier if you start knowing that you want drill-down capability. You can use drill-down only with custom widgets. A standard widget might use drill-down but you cannot add it to a standard widget.
Drill-down is useful when you want your widget to initially display summary data but then enable users to drill down for more detail. Examples include:
- Message volume by mobile operator, then drilling down to see the number of delivered messages per operator
- Percentage of messages failing, then drilling down to see specific delivery receipt codes
- Percentage of delivered messages by country, then drilling down to see delivered messages by originator, and drilling down again to see delivery receipt codes
You select this icon in the widget editor to display the drill-down properties:
Example drill-down widget
How to build it
In the procedure below we will create the example widget shown above, and we'll use drill-down so that you can look at a specific day to see the number of messages by status, and then drill down further into status to see specific delivery receipt codes. We'll base our widget on the report, SMS Daily Summary - This Month. The steps assume you've already created a dashboard to hold the widget.
Set required properties
From your dashboard, select Add Widget and then select Custom.
This displays the Add Custom Widget pop-up, which lets you create widgets based on the reports available to you.
- Select the plus sign (+) next to the report you want to use for the widget. You can add multiple widgets to the dashboard at once, but in this example we're going to add just one.
Since we added just one widget, the Edit Widget page displays next. If we had added multiple widgets, then we would be returned to the dashboard and the widgets would be added in the default List style.
Under Properties and Type, select the drill-down icon.
Note that the widget inherits the name of the report you based it on. You can change this if you like. The widget name will eventually display in the upper left. This can function as the only name for the widget or you can also give the widget a title. See step 1 under "Set Optional Properties".
- For Style, select Column.
- For Layout, select Stacked.
- For Data Series, select Values in aggregate column(s).
- For Series Values, select Messages Accepted.
Set drill-down levels
You must set two drill-down levels and, if you wish, you can set a third. The first level of data is the top level, which displays by default on the dashboard.
- For Level 1 (the top level), select the report column to use for the X-axis.
- For Level 2, select the report column to use for the X-axis.
For Level 3, select the report column to use for the X-axis.
Set optional properties
- Give your widget a Title. This will display in the center of the widget. We'll call our example, Message Drill-down by Day.
- Specify whether the widget will span the Full width of the page or Half width.
- Apply a specific Color Theme to the chart.
- Specify which Report Instance to use. By default this is set to Most Recent, meaning the data displayed by the widget is based on the most recent run of the report.
Once you click Save, you will be returned to the dashboard and your widget will display at the bottom. You can drag it to another position on the dashboard or move it to another dashboard if you wish.
Finished widget - level 1
Level 2 showing messages accepted by status
Level 3 showing message status by delivery receipt code