Using a third party XML editor
In most cases, you use the Splunk Web dashboard editor to edit Simple XML. See About the dashboard editor to learn more.
If you are using Splunk Enterprise, you can also use a third-party editor to work with dashboard source code files in your deployment.
Splunk Cloud Platform users cannot use a third-party editor because access to dashboard source code files is not available. If you have Splunk Cloud Platform, use the dashboard editor in Splunk Web.
Source code files for dashboards and forms
Dashboard and form source code files can include the following.
- Simple XML
- Static HTML and image files imported by reference
File usage requirements
File system write access
Dashboard source file permissions
After copying dashboard source files, makes sure that you can read and write to them. Read and write permissions on the files are defined separately from dashboard user access permissions.
File directories and locations
Use the local directory for source code files
When you edit Simple XML in the dashboard editor, source code file changes are written to the
/local directory. Put dashboard source code files that you edit with a third-party editor in the
Caution: Do not put Simple XML source files in the
/defaultdirectory. Files in the
/default directory are overwritten on deployment and app updates.
For more information on directories and file precedence, see Configuration file precedence.
File location and permissions
Source code file location depends on the file type and permissions.
Simple XML and prebuilt panel source files
/views directory of an app contains the following files.
- Simple XML files
- Panel files available by reference in a dashboard. See Create and add a panel by reference for more information.
- Legacy Advanced XML files
Put Simple XML and panel source code files in the following locations for each permission type.
|Shared in app||
/html directory in an app contains source files for dashboards converted to HTML.
Put HTML files in the following locations for each permission type.
|Shared in app||
Show source code file changes in Splunk Web
To display changes to dashboard source code files, refresh configurations on your Splunk deployment by using the
After refreshing the instance, reload the edited dashboard.
By default, this directory contains the following two files:
stylesheet attributes in
Import files from the same app
<dashboard script="myScript.js" stylesheet="myStyles.css"> . . . </dashboard>
Import files from another app
<dashboard script="myApp:myScript.js" stylesheet="myApp:myStyles.css"> . . . </dashboard>
Use drilldown for dashboard interactivity
This documentation applies to the following versions of Splunk Cloud Platform™: 8.2.2112, 8.2.2201, 8.2.2202, 8.2.2203, 9.0.2205, 9.0.2208, 9.0.2209 (latest FedRAMP release), 9.0.2303
Feedback submitted, thanks!