ModuleController
| 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. |
renderJobStatusMessage()
For the current job, the renderJobStatusMessage() method renders status information to display in search results containers, in response to a GET request.
Override renderJobStatusMessage() to generate custom job status messages for your module.
By default, the method returns either HTML status information, such as "No results found" and "Waiting for data" or an error message in response to an exception.
Synopsis
results = renderJobStatusMessage(kwargs)
Parameters
| kwargs | Dict | [optional] Dictionary of dictionary of keywords and values. |
Return Value
| String | Success: Status message. Error messages:
|
Exceptions
User-defined
renderModule()
The renderModule () method registers a modules controller and exposes the generateResults() method. Use generateResults() to control the content rendered by the module.
Warning: renderModule() should not be called or overridden.
Synopsis
results = renderModule(self, host_app, module, action, **args)
Parameters
| host_app | String | App where the module resides. Default: system |
| Module | String | Current module name. |
| action | String | Requested action. The value is always render. |
| args | Dict | TBD |
Return Value
| String | Content returned by the module controller, or any error message. |
| Splunk.Module.DispatchingModule | ModuleHandler |
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!