Splunk® Enterprise

Developing Dashboards, Views, and Apps for Splunk Web

Download manual as PDF

Splunk version 4.x reached its End of Life on October 1, 2013. Please see the migration information.
This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Download topic as PDF

Add a list

The list panel displays search results in a list. It's particularly useful if you have a search that generates a set of fields you want to link to.

Configure the list panel

The following example creates a list of links for the to field in the Top recipients search. The <list> tag specifies a list visualization. You must also specify the field to generate labels for the list and the field to populate the values. Use the <option name="labelField"> to create a label for each item in the list and <option name="valueField"> to generate values for each item.

<dashboard>
 <label>My dashboard</label>
  <row>
   <list>
    <searchName>Top recipients</searchName>
    <option name="labelField">to</option>
    <option name="valueField">to</option>
   </list>
  </row>
</dashboard>

This example references a saved search called Top recipients. Make sure this saved search is shared with all users and roles who access this dashboard. Any saved search referenced in searchName must exist in savedsearches.conf in the App's default or local directory or be set as global.

Configure list specific options

You can set other configuration options that are only available for list panels, such as the sort direction of the list and the search and view the list links to. For example, the following example sets the initial sort in descending order and links to another view from which to launch the search:

<dashboard>
 <label>My dashboard</label>
  <row>
   <list>
    <title>Top users</title>
    <searchString>host=production | top users</searchString>
    <option name="labelField">users</option>
    <option name="valueField">users</option>
    <option name="initialSortDir">desc</option>
    <option name="labelFieldTarget">My custom search view</option>
   </list>
  </row>
</dashboard>

For basic configuration of lists, refer to the "List panel entry" in the Panel reference for Simplified XML.

PREVIOUS
Add a table
  NEXT
Add HTML

This documentation applies to the following versions of Splunk® Enterprise: 4.3, 4.3.1, 4.3.2, 4.3.3, 4.3.4, 4.3.5, 4.3.6, 4.3.7


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