App Framework Reference

Module API

class Splunk.Module.DispatchingModule

The DispatchingModule class is an abstract base module for building modules used to dispatch a context search job.

Language Binding

JavaScript

Inheritance

Splunk.Module -> Splunk.Module.DispatchingModule

Implementation Location

$SPLUNK_HOME/etc/apps/ <appName> /appserver/modules/ <moduleName>

Constructor

Properties

isAbstract

Boolean

Test if module is an abstract module. Default = true .

Methods

onJobDone() Provides global notification that the current job has completed.
onJobProgress() Provides global job progress notifications.
onJobStatusChange() Provides global notification of job status changes.
requiresTransformedResults() Checks if the current module requires transformed results.