Manage automation dependencies

describes how to set up custom automation dependencies in SOAR admin guide

Automation dependencies describe which Python version your playbooks and custom functions use for automation. Some automation dependencies are pre-defined by Splunk, based on Python modules that are pre-installed, like the Python linter used in the Visual Playbook Editor. These modules, also called packages, are available to all playbooks and custom functions.

You can also import custom automation dependencies through PyPI and WHL packages. For example, if you want your custom playbooks and custom functions to have access to additional formatting functionality, you can import a package for that.

For information about packaging a WHL package, consult the documentation for the "Binary distribution format" on packaging.python.org.

Important notes

Automation dependencies do not affect apps (also known as connectors).

Modules pre-installed by Splunk are automatically updated to the latest Splunk-supported Python version.

Add a new automation dependency

To add a new automation dependency, follow these steps:

  1. Open the Automation Dependencies page. From the Home menu, select Administration, then Product Settings, then Automation Dependencies.

  2. Select + Package.

  3. In the Add Dependency window, specify the type of module and a name for the module. Next steps depend on the type of module you specify.

    • PyPI : Provide the name of the PyPI package, the version number, and specify the condition for the version. For example, specify whether the module type must be be greater than or equal to the version number you specify.

    • WHL: Upload the WHL file.

  4. Provide the version number, and specify the condition for the version. For example, specify whether the module type must be be greater than or equal to the version number you specify.

  5. Select Confirm. The module appears in the list of Automation Dependencies, under the appropriate Python version tab.

  6. Optionally repeat the sequence of adding a new package. You can install multiple packages at once in the following step.

  7. When you are ready to install all packages you added to the draft, select, select Validate and Install Splunk SOAR validates that the packages can be installed and are compatible with existing packages.

  8. The module appears in the Automation dependencies table.

  9. Optionally use the icons in the last column of the table to edit or delete the package you created.

You can now access these Python packages in your custom playbooks and custom functions.

For details on creating playbooks and custom functions, see the following articles: