Splunk® Enterprise

Dashboards and Visualizations

Download manual as PDF

Download topic as PDF

Editing Simple XML

You can use interactive editors to create and edit dashboards without having to edit Simple XML source code. However, some advanced dashboard features are not available from interactive editors. You can access these features by editing the underlying simple XML code.

Edit dashboard source code

Edit dashboard Simple XML source code to customize settings that are not accessible from the user interface. The dashboard source code editor provides interactive validation as you make updates.

Prerequisites
If you are unfamiliar with Simple XML, review the following information before you edit source code.

Steps

  1. From the Dashboards listing page, open the dashboard that you want to edit.
  2. Select Edit to open the dashboard editor.
  3. Click Source to open the source code editor.
  4. Edit the source code.
    The editor provides automatic tag closing and validation. It also displays warnings or error messages as needed. Hover over a warning or error icon next to a line of source code to view details.
  5. If the Save button is disabled, correct any code with validation warnings or errors. Otherwise, click Save to save your edits.

Special characters in XML files

Some characters have special meaning in Simple XML files. To prevent the source code parser from treating them as special characters, wrap them in <![CDATA[]]> tags.

<![CDATA[
<content_with_special_characters>
]]>

You can also escape these characters using HTML entities.

Character Description HTML Entity
' apostrophe &apos;
" quote &quot;
< left angle bracket &lt;
> right angle bracket &gt;
& ampersand &amp;

Read-only access to dashboard Simple XML code

Access a read-only version of dashboard source code by appending the showsource query parameter to the dashboard URL. See the following example.

https://host:port/en-US/app/my_app/my_dashboard?showsource

Note: Read-only source code access is available only for Simple XML dashboards. Read-only HTML or Advanced XML source code is not accessible using the URL.

Additional information

Before you edit Simple XML, review the following resources.


Splunk Enterprise users can edit Simple XML using a third-party editor. This option is not available in Splunk Cloud. See Using a third party XML editor.

PREVIOUS
Convert a dashboard to HTML
  NEXT
Searches power dashboards and forms

This documentation applies to the following versions of Splunk® Enterprise: 6.5.0, 6.5.1, 6.5.1612 (Splunk Cloud only), 6.5.2, 6.5.3, 6.6.0


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