Splunk® Enterprise

Developing Views and Apps for Splunk Web

Splunk Enterprise version 7.3 is no longer supported as of October 22, 2021. See the Splunk Software Support Policy for details. For information about upgrading to a supported version, see How to upgrade Splunk Enterprise.
This documentation does not apply to the most recent version of Splunk® Enterprise. For documentation on the most recent version, go to the latest release.

Use XML schemas

Important notice: The Advanced XML dashboard framework is officially deprecated. For more information, see Advanced XML Deprecation.

Starting with version 4.1, Splunk Enterprise provides RelaxNG formatted schemas for the view XML, including the simplified dashboards, simplified form searches, advanced dashboards and views. Also, there are schemas available for the navigation XML, the setup XML and manager pages XML. You can find all of these schemas off the info endpoint: 

http://localhost:8000/info

These schema files are in RelaxNG compact syntax (*.rnc). But you can convert to other formats with Trang. Trang is an open source tool that lets you convert between different XML schema formats.

Here's an example of using Trang to convert from Relax to RelaxNG 

java -jar trang.jar -O rng all.rnc all.rng

Files

Here's a descriptive list of all the files available from the info endpoint:

File Description
all.rnc Serves as a single entry point for all of the registered RelaxNG schemas. All of the schemas are written in RelaxNG compact syntax and are automatically converted to the full RelaxNG schema using Trang.
view.rnc Covers all 3 forms of view XML.
nav.rnc Covers the app nav XML,
manager.rnc Placeholder schemas for management XML files.
setup.rnc Covers the app setup XML.


Validation

Splunk Enterprise provides a validation script, validate_all.py, located at:

$SPLUNK_HOME/share/splunk/search_mrsparkle/exposed/schema/

This script inspects the UI XML files present here in Splunk installation: 

$SPLUNK_HOME/etc/

To validate your XML files, first navigate to the location listed below and then run the script: 

cd $SPLUNK_HOME/share/splunk/search_mrsparkle/exposed/schema/
$SPLUNK_HOME/bin/splunk cmd python validate_all.py
Last modified on 13 August, 2019
Build a form search using advanced XML   Advanced charting options

This documentation applies to the following versions of Splunk® Enterprise: 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9

Acrobat logo Download manual
Acrobat logo Download this page

Was this topic useful?







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