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
• JavaScript
• CSS
• Static HTML and image files imported by reference

File usage requirements

File system write access
You must have write access to the Splunk deployment file system to access the Simple XML files as well as supporting CSS and JavaScript files. If you do not have write access, check with an administrator.

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 /local directory.

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

The /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.

Permission type	Location
Shared in app	$SPLUNK_HOME/etc/apps/<app>/local/data/ui/views/<file_name>
Private	$SPLUNK_HOME/etc/users/<user>/<app>/local/data/ui/views/<file_name>

Legacy HTML files
The /html directory in an app contains source files for dashboards converted to HTML (conversion to HTML is no longer supported).

Put HTML files in the following locations for each permission type.

Permission type	Location
Shared in app	$SPLUNK_HOME/etc/apps/<app>/local/data/ui/html/<dashboard_file_name>
Private	$SPLUNK_HOME/etc/users/<user>/<app>/local/data/ui/html/<dashboard_file_name>

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 debug/refresh endpoint.

http://localhost:8000/debug/refresh

After refreshing the instance, reload the edited dashboard.

Importing CSS, JavaScript, and other static files

A dashboard can import CSS and JavaScript files as well as image files and static HTML files. These files are in the following location. The files cannot be in a subdirectory.

$SPLUNK_HOME/etc/apps/<app_name>/appserver/static/

By default, this directory contains the following two files:

• dashboard.css
• dashhboard.js

You can edit default files at this location or add additional CSS and JavaScript files. You can also add any HTML files that you want to reference from a dashboard.

Import JavaScript and CSS files

Use the script and stylesheet attributes in <dashboard> or <form> element to import a JavaScript or CSS file from the default location for an app. You can also reference script and CSS files from other apps.

Examples

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>