All Apps and Add-ons

Tour Creation App for Splunk: How to search which users already completed the tours?

fabiocaldas
Contributor

Hi,

During the Tour feature presentation on .Conf 2015, it was said that there were some searches that could be done to know which users already did the tours.

Anyone know how?

1 Solution

MuS
Legend

Hi fabiocaldas,

introduced with 6.3, you can create a tour for apps. This is done in ui-tour.conf http://docs.splunk.com/Documentation/Splunk/6.3.0/Admin/Ui-tourconf . If a user has done the tour, like the one in the search app, a file /opt/splunk/etc/users/admin/search/local/ui-tour.conf for the user will be created and within this file the option viewed=1 will be set:

[search-tour]
viewed = 1

Since this is a .conf file you can search for it using the | rest command from the ui:

| rest /services/configs/conf-ui-tour | search viewed="1" | table eai:appName title eai:userName

This will give you a table of the App name, the tour name and which user has done the tour.

Hope this helps ...

cheers, MuS

View solution in original post

MuS
Legend

Hi fabiocaldas,

introduced with 6.3, you can create a tour for apps. This is done in ui-tour.conf http://docs.splunk.com/Documentation/Splunk/6.3.0/Admin/Ui-tourconf . If a user has done the tour, like the one in the search app, a file /opt/splunk/etc/users/admin/search/local/ui-tour.conf for the user will be created and within this file the option viewed=1 will be set:

[search-tour]
viewed = 1

Since this is a .conf file you can search for it using the | rest command from the ui:

| rest /services/configs/conf-ui-tour | search viewed="1" | table eai:appName title eai:userName

This will give you a table of the App name, the tour name and which user has done the tour.

Hope this helps ...

cheers, MuS

mbschriek
Explorer

Is there a way to start a self created tour from another dashboard? Better said, how to connect the ui-tour file to another app, other than launcher?

0 Karma

MuS
Legend

@mbschriek, as stated in the docs http://docs.splunk.com/Documentation/Splunk/6.3.3/Admin/Ui-tourconf on line 8:

To create custom tours for an app, place
# ui-tour.conf in $SPLUNK_HOME/etc/apps/<app_name>/local/.

cheers, MuS

fabiocaldas
Contributor

Yes it helps, thanks I'm already creating my first tours 🙂

0 Karma
Get Updates on the Splunk Community!

Introducing Splunk Enterprise 9.2

WATCH HERE! Watch this Tech Talk to learn about the latest features and enhancements shipped in the new Splunk ...

Adoption of RUM and APM at Splunk

    Unleash the power of Splunk Observability   Watch Now In this can't miss Tech Talk! The Splunk Growth ...

Routing logs with Splunk OTel Collector for Kubernetes

The Splunk Distribution of the OpenTelemetry (OTel) Collector is a product that provides a way to ingest ...