Usage and example

This example describes how to create a report with a notification banner in the header area. You can dismiss the banner. The banner re-appears each time the page is reloaded. The banner text contains a link to open a dialog box with the error log detains.

To configure the notification banner web extension, you must specify these parameters:

  • Theme: Defines the color theme. Specify "Vibrant" or "Subtle". "Subtle" is the default.
  • Mode: Defines the color. Specify "Light", "Dark", "High Contrast", or empty value "". The empty string value equals the "Light" value.
  • Status Type: Defines the status type of the notification. Specify "error", "warning", "info", "success", or "progress". "Info" is the default.
  • Message Text: Defines the text which is displayed on the banner. You can specify the message text as string or as HTML with formats. If you use a hyperlink in the text, then you must create a cell action to define what happens on link click.
  • Detailed Message: Shows an optional text as string.
  • Link Text: A hyperlink that appears at the end of the notification. A cell action is used to define what happens on link click. For example, to open a dialog, create an action with Type = "Open Dialog" and Mode = "Web Extension", and select the target report.
  • Visible: Defines if the notification banner is displayed. Specify "TRUE" or "FALSE". "TRUE" is the default.
  • Wrap Text: Defines the layout of the banner elements. Specify "TRUE" to align the elements underneath each other. Specify "TRUE" to align elements next to each other. "TRUE" is the default.
  • Close Action: Defines if the close button is displayed. Specify "TRUE" or "FALSE". "TRUE" is the default.