Splunk SOAR App Wizard Overview

intro to using the App Wizard

The Splunk SOAR App Wizard is the original way to build a Splunk SOAR app. The App Wizard is a fully-functional code editor built into the Splunk SOAR web interface.

App Wizard app components

An app built using the App Wizard includes the following components:

Component Description
__init__.py Required to initialize and define a Python package. You can use an empty file.
sampleapp.json JSON metadata that describes the app and functionality that the app provides
sampleapp_connector.py The App Main Connector Module (Python script) that implements the actions that are provided by the app. This module is a class that is derived from the BaseConnector class.
sampleapp_view.py Optional widget view. This is a view, in the context of standard MVC framework. Splunk SOAR is built on Django, an open source Python-based MVC framework. Splunk SOAR will load views that you have specified within your JSON meta-data file dynamically. Full documentation on views and templates is available on the Django documentation website.
sampleapp_view.html Optional widget template. The template defines how the information within the view is to be rendered and displayed. The full complement of Django tags are available within a template.

This image shows how the various components interact with each other.

This scene image shows the relationship among the Splunk SOAR app components. The components are described in the table immediately preceding this image.

Next steps

To create Splunk SOAR apps with the Splunk SOAR App Wizard, read the following articles in this document:

Set up the dev environment

Create an app with the App Wizard