Skip to main content
All CollectionsFAQ's
How to utilize UI Messages
How to utilize UI Messages

Using UI Messages

B
Written by Blake Hester
Updated over 5 months ago

UI messages are textual or graphical notifications that appear on a user interface to inform, guide, or alert users during their interaction with a software application or website. These messages play a crucial role in enhancing user experience by providing feedback, instructions, warnings, and confirmations. VividCharts release 1.7.0 allows some messaging on the platform to utilizes UI Messages, which can be customized to reflect what a customer would like to have displayed to their users.

The Key and Messages can be found on the sys_ui_message table, where you can filter the list by Application, using Application is VividCharts.

For this example, the Vertical Bar Chart message will be changed from "Adjust your settings" to "Adjust your settings and conditions to try again".

To begin, in ServiceNow navigate to the sys_ui_message table to locate the desired Key. Let's look at a Key Example, and some general notes on Keys before we continue. The Key for this example is Editor - Chart - No Results Detail. Now, a few general notes on keys.

The first part of the key will identify what page the message is used. For example, 'Viewer - Viewer - Not Published Detail' is a message used on the 'Viewer' page.

The second part of the key will identify what element on the page the message will display. For example, 'Viewer - Chart - No Results' is a message that will display on the Viewer page, within the 'Chart' element.

The last part of the key identifies what component of the message the UI Message will be used for. For example, 'Editor - Chart - Error' is the title of a message, displayed in the Editor, on a chart when there is an error.

Once on the sys_ui_message table, locate the Key that corresponds with the message that you wish you customize. For this example the message that is going to be customized is in the VividCharts editor, the message is being displayed on the chart, and the message is displayed when the chart has no results so I know the Key is Editor - Chart - No Results Detail. Once the desired Key is located, click on the Key to open the record.

Here is a view of the open record. After the record is open, click into the Message box to be able to customize the message.

Once the desired changes are made to the Message, click update on the bottom left to reflect those changes in VividCharts. The Vertical Bar Chart now displays the updated message.

If edits are not reflecting in VividCharts, logout out of ServiceNow then login again, or clear your computer cache to empty stored cache keys.

Did this answer your question?