Splunk® Enterprise

Dashboards and Visualizations

Download manual as PDF

This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Download topic as PDF

Convert a dashboard to HTML

If you want to implement a dashboard with features not available in simple XML, you can export the dashboard as HTML. The generated HTML is based on SplunkJS stack. You can then edit the HTML and JavaScript to implement custom features.

Resources for editing HTML dashboards

Editing the HTML and JavaScript is out of scope for this manual. For information on editing dashboards based on SplunkJS Stack refer to the following topics from the Splunk Developer Portal:

Convert a simple XML dashboard to HTML

By default, Splunk software creates dashboards that are based on simple XML code. You can convert or export a dashboard so it is based on HTML derived from the SplunkJS Stack component of the Splunk Web Framework.

You cannot use Splunk software visual editors to edit the generated HTML source code. Instead, you can use the Splunk software's Source Editor or another third party editor.

Note: Integrated PDF generation is not available for HTML dashboards.

To convert the source code for a dashboard to HTML:

1. From a dashboard implemented in simple XML, select Edit > Convert to HTML. Complete the following details.

  • Select Create New or Replace Current.
    If you replace the current dashboard, the underlying simple XML is no longer available. You can create a new dashboard to preserve the original simple XML code.
  • Title and ID: When converting a dashboard to HTML, the dashboard ID is used as the name of the new HTML file. It is displayed in navigation menus. You can rename the file to adjust its appearance.
  • Description: Add a dashboard description.
  • Permissions: After converting the dashboard, you can continue to edit dashboard permissions.

2. Select Convert Dashboard.

Edit an HTML dashboard

When you edit a dashboard converted to HTML for SplunkJS Stack, in addition to editing the HTML you typically need access to the CSS and JavaScript files referenced by the HTML code.

Splunk software includes an HTML editor that you can use to edit the HTML source for a dashboard. However, you need access to the local file system for the Splunk server to access and edit supporting CSS and JavaScript files. Access to the local file system is also necessary to edit the source HTML code in a third party editor.

See Source files for dashboards and forms for more information on accessing source files.

See Resources for editing HTML dashboards for links to the Splunk Developer Portal documentation on editing HTML dashboards.

Key files for dashboard editing

Refer to Source files for dashboards and forms for the location of source files when converting a dashboard to HTML.

If you are using a third party editor for the HTML source files, remember to refresh your Splunk instance to view the dashboard with the edited source files. For example:

http://localhost:8000/en-US/debug/refresh

For updates to CSS, JavaScript, or static HTML files, you only need to refresh the browser paged displaying the edited dashboard.

PREVIOUS
Edit visualizations
  NEXT
Generate dashboard PDFs

This documentation applies to the following versions of Splunk® Enterprise: 6.1, 6.1.1, 6.1.2, 6.1.3, 6.1.4, 6.1.5, 6.1.6, 6.1.7, 6.1.8, 6.1.9, 6.1.10, 6.1.11, 6.1.12, 6.1.13, 6.2.0, 6.2.1, 6.2.2, 6.2.3, 6.2.4, 6.2.5, 6.2.6, 6.2.7, 6.2.8, 6.2.9, 6.2.10, 6.2.11, 6.2.12, 6.2.13, 6.2.14, 6.2.15, 6.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8, 6.3.9, 6.3.10, 6.3.11, 6.3.12, 6.3.13, 6.3.14, 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.4.9, 6.4.10, 6.4.11


Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

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