Apps

An app, formerly called extension or integration, is a collection of playbook components, code executables or both that represent an end-to-end function and is deployed to the Orchestration & Automation application.

Playbook components can include functions, rules, workflows, Python scripts, custom fields, data tables and message destinations. An code executable can access and return external data, interact or integrate with other security systems, or be a utility that performs a specific action.

App are available in two formats, one format supports the App Host Kubernetes-based container environments, the other supports the previously available extension format which requires an integration server.

There are various types of apps. The following describes the general types:
  • Function. An object that sends data to a remote function processor through a message destination, after being invoked by a workflow. The function processor performs an activity and returns the results to the workflow. This is the most common type of app.
  • Custom Action. Similar to a function but does not require the function component. A custom action can populate a custom field or data table within Orchestration & Automation, where a function returns the results to the workflow that invoked the function.
  • Threat Services. Provides artifact scanning. You can also provide your own custom threat services that allow you to provide artifact scanning from your threat sources.
  • Plug-ins. Allows you to integrate Orchestration & Automation with a security app using the API and your system’s RESTful API for bidirectional communication. IBM provides apps that allow you to integrate with security apps such as QRadar, Splunk, and BigFix. And you can develop your own.

You can download existing app packages from the IBM X-Force Community App Exchange. You must have an account to download packages.

You can download apps that support the container environment directly to the Orchestration & Automation application, as described Apps.

App developers can also create their own apps. For function based apps in either format, see the App Developers Guide.

For other types of apps, see the Developer web site. The Reference page on the web site provides pointers to various developer documents, such as the Custom Action Developer's Guide.