Dashboards & Visualizations

Escape < and > in the xml of dashboards

chris
Motivator

Hi

I got the following error when I tried to save a dashboard after editing its xml:

Encountered the following error while trying to update: In handler 'views': Not valid XML: <view template="dashboard.html....

< and > characters are part of my search String because I'm using the rex search command

..
<module name="HiddenSearch" autoRun="True">
  <param name="search">| savedsearch "Mysearch" | where isnotnull(Resource) | rex "r> (\[.*\] )*(?<Reason>.*)$" | fields host,hostname,Resource,Reason</param>
..
.

How do those characters have to be escaped?

Tags (2)
1 Solution

gkanapathy
Splunk Employee
Splunk Employee

There are two ways:

  • Use &lt; for < and &gt; for >. You should also use &amp; for any & and some people like to use &quot; for ".
  • Enclose the entire search string in a CDATA tag: `(?.)" | stats count ]]>'

I personally think that it's a lot clearer to just use CDATA so your search query is readable:

 <module name="HiddenSearch" autoRun="True">
    <param name="search"><![CDATA[
      | savedsearch "Mysearch" | where isnotnull(Resource) | rex "r> (\[.*\] )*(?<Reason>.*)$" | fields host,hostname,Resource,Reason
    ]]></param>
    ...
 ...
 ...

View solution in original post

gkanapathy
Splunk Employee
Splunk Employee

There are two ways:

  • Use &lt; for < and &gt; for >. You should also use &amp; for any & and some people like to use &quot; for ".
  • Enclose the entire search string in a CDATA tag: `(?.)" | stats count ]]>'

I personally think that it's a lot clearer to just use CDATA so your search query is readable:

 <module name="HiddenSearch" autoRun="True">
    <param name="search"><![CDATA[
      | savedsearch "Mysearch" | where isnotnull(Resource) | rex "r> (\[.*\] )*(?<Reason>.*)$" | fields host,hostname,Resource,Reason
    ]]></param>
    ...
 ...
 ...
Get Updates on the Splunk Community!

Infographic provides the TL;DR for the 2023 Splunk Career Impact Report

We’ve been shouting it from the rooftops! The findings from the 2023 Splunk Career Impact Report showing that ...

Splunk Lantern | Getting Started with Edge Processor, Machine Learning Toolkit ...

Splunk Lantern is Splunk’s customer success center that provides advice from Splunk experts on valuable data ...

Enterprise Security Content Update (ESCU) | New Releases

In the last month, the Splunk Threat Research Team (STRT) has had 2 releases of new security content via the ...