Overview

This is an example Splunk App to demonstrate how to use setup views that adhere to Splunk Application Certification standards.

Setup View Entry Point

Splunk will automatically try to redirect the user to the setup page if the app.conf's [install] stanza has its is_configured property set to false.

Program Flow

This program starts in the app.conf, where the [install] stanza's is_configured property is set to false. This causes Splunk to redirect to it's setup page that is specified so that an admin/user can configure it for use.

In the app.conf's, [ui] stanza there is a setup_view property that points to which resource should be used for the setup view. In this case it's pointing to default/data/ui/views/setup_view_dashboard.xml.

The dashboard view specifies its CSS and JavaScript resources and points to the two file in appserver/static/javascript/setup_page.js and appserver/static/styles/setup_page.css.

And finally the setup_page.js imports a custom Backbone view from the appserver/static/javascript/views/setup_view_example.js.

Resources

• Splunk Techniques Used
  • Splunk Dashboards
    • API Documentation (docs.splunk.com)
  • Splunk Setup View
    • app.conf Specification
  • Splunk Web Framework
    • API Documentation (docs.splunk.com)
    • Main Website (dev.splunk.com)
• Technology Used
  • CSS
  • HTML
  • JavaScript
    • Backbone JS
      • Main Website
      • On GitHub
      • Views are the only feature used
    • JQuery
      • Main Website
      • On GitHub
    • Splunk JavaScript Software Development Kit
      • API Documentation (docs.splunk.com)
      • On GitHub
      • Main Website (dev.splunk.com)

Screen Shots

Log In Screen

Select an App

Begin Setup

Setup View

Empty Inputs Used

Http:// Input Used

Valid Inputs Used

Completed Setup Landing Page