Splunk® Enterprise

Module System User Manual

Splunk Enterprise version 7.3 is no longer supported as of October 22, 2021. See the Splunk Software Support Policy for details. For information about upgrading to a supported version, see How to upgrade Splunk Enterprise.
This documentation does not apply to the most recent version of Splunk® Enterprise. For documentation on the most recent version, go to the latest release.

Checklist

Important notice: As part of Advanced XML deprecation, the Module System is officially deprecated beginning with Splunk Enterprise 6.3. For more information, see Advanced XML Deprecation.
Setup ...
Chkbx1.png Install Splunk.
Chkbx1.png Install firebug or similar JavaScript debugger, depending on your browser.
Define your presentation layer ...
Chkbx1.png Setup your app directory structure in a local directory.
Chkbx1.png Define your app in app.conf.
Chkbx1.png Define your app navigation in default.xml.
Chkbx1.png Define your app views in the /default/data/ui/views directory.
Implement your module(s) ...
Chkbx1.png Define the module class, base class and parameters.
Chkbx1.png (optional) Write your module HTML and stylesheet.
Chkbx1.png Write your client-side JavaScript code.
Chkbx1.png Write your server-side Python code.
Install and run your app ...
Chkbx1.png Copy your app directory structure to the $SPLUNK_HOME/etc/apps directory.
Chkbx1.pngStart Splunk and login.
Chkbx1.png Run the Module System Tutorial app.
Debug your app ...
Chkbx1.pngRestart Splunk.
Chkbx1.png Edit your code using your favorite editor, modifying the target app code or copying your modified code to the target directory.
Chkbx1.png Restart Splunk and login, or _bump version and /debug/refresh, as needed.

Last modified on 12 August, 2019
Testing your app   Get the tutorial app

This documentation applies to the following versions of Splunk® Enterprise: 7.0.0, 7.0.1, 7.0.2, 7.0.3, 7.0.4, 7.0.5, 7.0.6, 7.0.7, 7.0.8, 7.0.9, 7.0.10, 7.0.11, 7.0.13, 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.1.9, 7.1.10, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.2.8, 7.2.9, 7.2.10, 7.3.0, 7.3.1, 7.3.2, 7.3.3, 7.3.4, 7.3.5, 7.3.6, 7.3.7, 7.3.8, 7.3.9

Acrobat logo Download manual
Acrobat logo Download this page

Was this topic useful?







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