Splunk Cloud Platform

Dashboards and Visualizations with Simple XML

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

Manage dashboards that need jQuery updates

All Simple XML dashboards require a version attribute set to 1.1 to certify that they are compatible with jQuery 3.5 or higher. You must update user-created dashboards with a version attribute. However, do not update dashboards that are packaged with Splunk Cloud Platform, Splunk Enterprise, or a Splunk app. Dashboards associated with third party and private apps must be updated by the app developers. For more information about identifying which apps need updates, see Act on jQuery scan results with the Upgrade Readiness App.

Beginning with Splunk Cloud Platform 8.2.2022 and higher, only dashboards that are version 1.1 are valid. If you load a version 1.0 dashboards, Splunk Cloud Platform redirects you to view the dashboard in version 1.1. You must update all version 1.0 dashboards to version 1.1.

For a list of dashboards that might be affected by the security update that requires jQuery 3.5 or higher, Splunk admins can see the jQuery Upgrade dashboard. Dashboards that are on those lists might need to be adjusted or rebuilt.

Certify that Simple XML dashboards work with jQuery 3.5 and higher with a version attribute

Some dashboards that use custom JavaScript might not be fully compatible with jQuery 3.5 or higher. After you update your dashboards to be fully compatible with jQuery 3.5 or higher, and you verify that they are working in the new dashboard view, you must then certify that they are updated by adding a version 1.1 attribute. After you certify the dashboards, they disappear from the jQuery Upgrade dashboard.

Complete the following steps to update, verify, and then certify your dashboards.

  1. If necessary, update the dashboard to rely only on jQuery 3.5 and higher.
  2. Check the dashboard to verify that it's working in your Splunk instance.
  3. Add the version="1.1" attribute to the root node in the Simple XML file for the dashboard. The root node is either <dashboard> or <form>.
    <dashboard version="1.1" script="myCustomJS.js">
    ...
    </dashboard>
    
    <form version="1.1" script="myCustomJS.js">
    ...
    </form>

    Don't add version="1.0" to the dashboard root node.

  4. Check the dashboard again to verify that it is working. Dashboards that are certified to work with the newest dashboard view don't appear in the list of v1.0 dashboards viewed in the jQuery Upgrade dashboard.

For more information about the version attribute, see the Simple XML Reference. For more information about editing Simple XML, see Editing Simple XML.

Update HTML dashboards

HTML dashboards are deprecated. However, you can rebuild your HTML dashboards in Dashboard Studio. For more information about Dashboard Studio, see What is the Splunk Dashboard Studio? in the Splunk Dashboard Studio manual.

Last modified on 04 March, 2022
PREVIOUS
Configure dashboard permissions
  NEXT
Generate dashboard PDFs

This documentation applies to the following versions of Splunk Cloud Platform: 8.2.2202, 8.2.2203


Was this documentation topic helpful?


You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters