Splunk® Enterprise

Module System Reference

Acrobat logo Download manual as PDF


Splunk Enterprise version 7.3 will no longer be supported as of June 4, 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. Click here for the latest version.
Acrobat logo Download topic as PDF

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:
  • 'resultStatusMessage empty_results No matching events found. More info...'
  • 'resultStatusMessage empty_results No results found. More info...'
  • 'resultStatusMessage empty_results Waiting for data...'
  • 'resultStatusMessage empty_results unknown search state: ...'

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.
Last modified on 12 August, 2019
PREVIOUS
Splunk.Module.DispatchingModule
  NEXT
ModuleHandler

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.3.12, 6.3.13, 6.3.14, 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.4.9, 6.4.10, 6.4.11, 6.5.0, 6.5.1, 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.5.6, 6.5.7, 6.5.8, 6.5.9, 6.5.10, 6.6.0, 6.6.1, 6.6.2, 6.6.3, 6.6.4, 6.6.5, 6.6.6, 6.6.7, 6.6.8, 6.6.9, 6.6.10, 6.6.11, 6.6.12, 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


Was this documentation topic helpful?

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