The Word Cloud widget is a custom stencil widget. The widget requires a User Report with a “Words” column for text to appear in the widget. Use of REPLACE commands in a custom SQL Field is recommended to remove low-value words such as articles and conjunctions.
Functionality:
The widget will aggregate all words from all rows in the column and words with more occurrences will appear larger in the widget. Hovering over a word displays number of occurrences.
Click the
icon to export the data to Microsoft Excel in .xlsx format.
Adding a Word Cloud Widget
Select Word Cloud from the Add Widget Templates side panel and click the
Name: This is a mandatory field. Users should give the widget a specific name to differentiate it from other instances of the widget.
Description: Description of the widget which is only viewable by users editing the dashboard. Descriptions are limited to 500 characters.
Theme: Select a color using the color picker. This will be the background color of the widget title. If no color is selected, white will be the defaulted color used.
User Report: Specify a user report from the list. This is a mandatory field. An option to open the report via
which will happen on a new tab and run the report is available via
which will happen on a new tab. The selected user report must contain a column labelled "Words". The report uses all words from all rows in this column and all other columns in the report are ignored. Please consult the Things to Note section for more details including screenshot of the user report for this example.
Refresh Time Override (Hours): The number of hours to refresh the report data can be set to override the default dashboard refresh setting. A higher value improves general system performance by running reports less often. A lower value refreshes data more frequently. Certain widgets can override this setting. A user can always force a refresh in a widget to see the latest data and update their cache.
Max Word Count: Sets a maximum limit for the number of words shown on the widget (defaulted to 100 words). A user can configure this field to refine the output based on the maximum number that the user has set. Smaller sizes of widget can benefit from using smaller limits for optimal visibility.
Click
to finish configuration.
The newly added widget will be added. Widgets can be moved around and resized whilst in editing mode. You can change configuration with the
icon and delete it with
Things to note
Here is an example of the data fields used in the user report which uses the REPLACE command in a custom SQL Field for the "Words" column:
User Role security still limits report data however User Report filters must be used to further filter report data
User Report prompts are supported for context filters
After selecting a user report the user can run or edit the report for easy setup
The Refresh Time Override (Hours) can be set to override the default dashboard refresh time
The configuration report can have more rows when it is run but only the first row will be used to populate the widget
Leaving the Max Word Count field to blank or placing "0" will use the default value of 100 words
Other columns in the report are ignored, there is no need to hide any fields
No drill-in is supported
Widget is limited to the 100 most-common words
Widget removes all casing and punctuation. It does note remove words such as articles