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
| Splunk.Context |
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
Download manual
Feedback submitted, thanks!