Integrate with Orchestrator

The primary function of the Orchestrator Service is to Orchestrate events and commands across different services. It actively monitors the incoming events and with the help of developer-defined plugins, responds to the events. The following how-to sections will help you understand the functioning of the Orchestrator and provide the steps required to register a Plugin, register Plugin Workflow, and create execution rules.

The Orchestrator utilizes Plugin Management to handle events effectively. Plugins contain a specific logic and constructive response to be executed in response to events. It may also trigger another plugin if required. When an event is detected, Orchestrator, based on the rules defined in the Rule Engine of Plugin Manager, calls specific plugins in the order defined in Plugin Workflow. Rules also determine which Plugins should handle specific events aligned with the given reason code.

Refer to the block diagram below for an overview of the Orchestrator.

Define a plugin according to your business requirements. It can be triggered by different events as specified in the rules in Orchestrator.

Here is a sample payload to register a Plugin

The Plugin Workflow determines the sequence of the utilizing plugins and their interaction with other components of the platform. It ensures the Plugins are executed in a pre-defined sequence and respond to the events while performing the desired actions.

The Orchestrator is triggered by specific events. The execution rules govern how the Orchestrator manages the execution of Plugins with the Plugin Workflow (if relevant).

Here is a sample payload to create a Rule.