Admin Manual

ui-tour.conf

The following are the spec and example files for ui-tour.conf.

ui-tour.conf.spec

#   Version 6.3.7
#
# This file contains the tours available for Splunk Onboarding
#
# There is a default ui-tour.conf in $SPLUNK_HOME/etc/system/default. 
# To create custom tours, place a ui-tour.conf in
# $SPLUNK_HOME/etc/system/local/. To create custom tours for an app, place
# ui-tour.conf in $SPLUNK_HOME/etc/apps/<app_name>/local/.
#
# To learn more about configuration files (including precedence) see the
# documentation located at
# http://docs.splunk.com/Documentation/Splunk/latest/Admin/Aboutconfigurationfiles
#

GLOBAL SETTINGS

# GLOBAL SETTINGS
# Use the [default] stanza to define any global settings.
#   * You can also define global settings outside of any stanza, at the top of
#     the file.
#   * This is not a typical conf file for configurations. It is used to set/create
#   * tours to demonstrate product functionality to users.
#   * If an attribute is defined at both the global level and in a specific
#     stanza, the value in the specific stanza takes precedence.

[<stanza name>]
* Stanza name is the name of the tour

useTour = <string>
nextTour = <string>
intro = <string for the introduction if needed>
type = <image || interactive>
label = <string>
tourPage = <string>
viewed = <boolean>

# For image based tours
imageName<int> = image_name_of_first_image.png
imageCaption<int> = <optional text to accompany the above image>
imgPath = <path to images if outside the main "img" folder>
context = <system || <specific app name>>

# For interactive tours
urlData = <string>
stepText<int> = <string for step n>
stepElement<int> = <selector for step n>
stepPosition<int> = <bottom || right || left || top>
stepClickEvent<int> = <click || mousedown || mouseup> for step n
stepClickElement<int> = <selector post click for step n>

ui-tour.conf.example

#   Version 6.3.7
#
# This file contains the tours available for Splunk Onboarding
#
# To update tours, copy the configuration block into
# ui-tour.conf in $SPLUNK_HOME/etc/system/local/. Restart the Splunk software to
# see the changes.
#
# To learn more about configuration files (including precedence) see the
# documentation located at
# http://docs.splunk.com/Documentation/Splunk/latest/Admin/Aboutconfigurationfiles
#

# Image Tour
[tour-name]
type = image
imageName1 = TourStep1.png
imageCaption1 = This is the first caption
imageName2 = TourStep2.png
imageCaption2 = This is the second caption
imgPath = /testtour
context = system

# Interactive Tour
type = interactive
tourPage = reports
urlData = 
label = Interactive Tour Test
stepText1 = Welcome to this test tour
stepText2 = This is the first step in the tour
stepElement2 = .test-selector
stepText3 = This is the second step in the tour
stepElement3 = .test-selector
stepClickEvent3 = mousedown
stepClickElement3 = .test-click-element
viewed = 0