How to convert a Simple XML dashboard to HTML

  1. In Splunk Web, open the dashboard you want to convert.
  2. Click Edit and select Convert to HTML.
  3. Set the properties for the converted dashboard:
  4. Converting to HTML Dashboard

    • To create an HTML version of the dashboard, click Create New. Or, to replace and write over the existing dashboard, click Replace Current.
      1. Note  Replacing the current dashboard makes the HTML version of the dashboard visible to users and hides the Simple XML version. You can revert to the Simple XML dashboard by deleting the HTML file. The file locations depend on the permissions (see below).
    • Optionally, change the title, ID (the filename), description, and permissions.
  5. Click Convert Dashboard.

 

Edit the HTML dashboard

You can now edit the HTML dashboard by opening the file in an HTML editor.

    Note  You need access to source files on your Splunk instance, so you might need to contact your Splunk administrator for permission and access.

The location of the HTML file depends on the permissions you chose:

  • Private: $SPLUNK_HOME/etc/users/username/appname/local/data/ui/html
  • Shared: $SPLUNK_HOME/etc/apps/appname/local/data/ui/html

The procedures in this documentation show the paths for shared permissions.

You can also the Simple XML Source Editor in Splunk Web:

  1. In Splunk, click Settings, then select User interface.
  2. Click Views.
  3. Select the App context and Owner filters as appropriate to list your dashboards.
  4. Find your HTML dashboard in the list and click it to display the source code.

Use JavaScript and SplunkJS Stack to customize HTML dashboards. The converted dashboard uses SplunkJS Stack to generate the underlying code. Each Simple XML visualization is converted into a search manager and a Splunk view, with a wrapper around the view that includes a panel implementation. Any customizations to the dashboard must be made using JavaScript.

For more about how Simple XML dashboards are converted to HTML, see Overview of converting to HTML.