Splunk® Enterprise

Module System Reference

Download manual as PDF

Download topic as PDF

Extension dictionary

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.

controllers.BaseController

Module System component: MVC controller

Parent: object

Mechanism: Subclass using the web.conf bootstrap name to hook into the framework

Usage: Overriding existing methods is not recommended; If you need to override the initialize() constructor, call the parent constructor using $super() first to ensure the parent is initialized; add additional methods as needed

SplunkAppObjModel

Module System component: MVC model

Parent: SplunkRESTModel

Mechanism: Subclass to hook your model into the framework

Usage: Overriding existing methods is not recommended; If you need to override the initialize() constructor, call the parent constructor using $super() first to ensure the parent is initialized; add additional model-specific methods

lib.html

Module System component: MVC view (template)

Mechanism: Dynamic binding

Usage: Import; way to include Import custom/3rd party JavaScript and CSS

Splunk.Module

Module System component: module

Parent: object

Mechanism: Subclass using module name

Usage: Override methods

Most common methods to override:

applyContext()
getModifiedContext()
getResultParams()
getResultsCompleteHandler()
getResultsErrorHandler()
initialize()
isReadyForContextPush()
onBeforeJobDispatched()
onContextChange()
onLoadStatusChange()
onResultsRendered()
onViewDataChange()
renderResults()
requiresAsynchonousLoading()
requiresDispatch()
resetUI()

Splunk.Module.DispatchingModule

Module System component: module

Parent: Splunk.Module

Mechanism: Subclass using module name

Usage: Override methods

Most common methods to override:
onJobDone()
onJobProgress()
onJobStatusChange()
requiresTransformedResults()

module.ModuleHandler

Module System component: module controller

Parent: object

Mechanism: Subclass using module name

Usage: Override methods

Most common methods to override:

generateResults()

application.js

Module System component: module

Mechanism: Dynamic binding

Usage: Override with custom JavaScript

  NEXT
Splunk.Context

This documentation applies to the following versions of Splunk® Enterprise: 6.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8, 6.3.9, 6.3.10, 6.3.11, 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.5.0, 6.5.1, 6.5.1612 (Splunk Cloud only), 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.6.0, 6.6.1, 6.6.2, 6.6.3


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