|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.|
The Module System exposes the core Splunk knowledge base for the purpose of building custom app customized for your application domain. A framework is inherently complex and requires suitable documentation and examples to be able to use it effectively. Here, you'll find documentation that covers the key concepts and reference material needed to begin creating apps.
You'll find this documentation to be applicable to different phases of the development lifecycle and different levels of expertise. For example, Getting Started is most useful for initial familiarization with the framework and development process, while the reference API might be consulted frequently to refresh your memory about programming details. Because examples and learn-by-doing provide the most effective techniques for learning complex topics, an example accompanies most discussion. In particular, the Cookbook includes a complete set of examples, in the menu above, that you can actually run in the context of this app.
Become familiar with terminology. If you are new to Module System development, read Getting Started. Consult the Cookbook and its associated examples to learn how to implement common use cases. You'll find the implementation details in the Reference useful after you've learned the basics of how to develop in the Module System environment.
The documentation set provides the various system views a developer needs to understand and use the Module System.
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.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.5.0, 6.5.1, 6.5.1612 (Splunk Cloud only), 6.5.2