Welcome
Orchestrating
Orchestrate anything with HCL Universal Orchestrator.
Event plug-in structure
Orchestration events
Orchestration event monitors the different statuses of tasks, workflows and workstations to initiate the submission of a workflow. You can create multiple scenarios of event conditions by configuring different statuses of these scheduling items.

What's new
HCL Universal Orchestrator is constantly evolving to offer you the most comprehensive orchestration capabilities. For known limitations, workarounds, and contact information of HCL Customer Support, see Release notes.
What is HCL Universal Orchestrator
An introductory overview of HCL Universal Orchestrator.
Deploying and Administrating
All the information you need to deploy and administrate HCL Universal Orchestrator.
Using the UI
The UI is the HCL Universal Orchestrator interface, from which you can smoothly design your scheduling environment and monitor every process.
Orchestrating
Orchestrate anything with HCL Universal Orchestrator.
- Orchestration CLI commands
  You can use the various command options in Orchestration CLI to achieve specific results. The command options are not case sensitive and you can use either uppercase or lowercase letters.
- Workflow definition
  A workflow is a set of tasks to be run, together with times, priorities, and other dependencies that define the processing order.
- Task definition
  A task definition is a unit of work that specifies an action to be performed on specific workstations in the HCL Universal Orchestrator network.
- Event source definition
  An event source is an item that allows HCL Universal Orchestrator to receive events from specific event plug-ins.
- Calendar definition
  Calendars define the days in which workflows do or do not run.
- Folder definition
  You can use folders to organize your items accordingly to your business needs.
- Credentials definition
  Credential definitions are used to store user IDs and passwords, or tokens.
- Variable table definition
  Variables are values that can change according to the purpose of workflows and task templates.
- Workstation definition
  A workstation is a scheduling item that runs tasks.
- Event plug-in structure
  - Webhook plug-in structure
    In this topic you can find information about configuring Webhook event sources and Webhook event conditions.
  - AWS SQS plug-in structure
    In this topic you can find information about configuring AWS SQS event sources and AWS SQS event conditions.
  - Kafka plug-in structure
    In this topic you can find information about configuring Kafka event sources and Kafka event conditions.
  - GCP events plug-in structure
    In this topic you can find information about configuring GCP event sources and GCP event conditions.
  - Azure plug-in structure
    In this topic you can find information about configuring AzureEvents event sources and AzureEvents event conditions.
  - File events
    You can customize the orchestration event conditions with file events to create a trigger in the workflow. When the event conditions met, it triggers the workflow and submits the associated tasks. You can customize the event conditions to create multiple triggers and extend the functionality.
  - Orchestration events
    Orchestration event monitors the different statuses of tasks, workflows and workstations to initiate the submission of a workflow. You can create multiple scenarios of event conditions by configuring different statuses of these scheduling items.
    - Configuring orchestration events
      You can configure orchestration event conditions to create a trigger that monitors the different phases of a job or job stream or workstation to initiate the submission of a job stream. If required, you can create multiple triggers to extend the scenario.
  - Event driven orchestration configuration attributes
- Managing matching criteria
  In this topic you can find a description of matching criteria.
- Parsing OCLI files in streaming
  HCL Universal Orchestrator enables you to add or replace files containing multiple item types through OCLI in a single command.
- Data exchange and transformation
  This topic explains how you can streamline your workflows using data exchange and transformation.
Orchestrating from Mobile
You can use your mobile devices to manage quickly and easily your whole HCL Universal Orchestrator environment.
Monitoring
Take your environment under control.
Using REST API
Use REST APIs to easily integrate workload scheduling capabilities with external products and solutions.
Uno AI Pilot
Welcome to the HCL Universal Orchestrator AI Pilot documentation. This resource is designed to guide you through everything you need to know about using UnO AI Pilot effectively. You will find detailed instructions, feature overviews, and helpful tips to ensure you get the best experience with UnO AI Pilot.
Troubleshooting
Recover your environment if any issue occurs.
Notices

Orchestration events

Orchestration event monitors the different statuses of tasks, workflows and workstations to initiate the submission of a workflow. You can create multiple scenarios of event conditions by configuring different statuses of these scheduling items.

The orchestration events are associated with the different items in HCL Universal Orchestrator and this eliminates the need to create a separate event source. In an orchestration event you can create triggers by adding single or multiple event conditions. An event condition is configured by using the different outcomes or change in status related to items that circulate within the HCL Universal Orchestrator flow. These outcomes or change in status act as building blocks to precisely define the conditions under which an orchestration event is considered satisfied. After the event conditions are configured within a trigger, their fulfilment serves as a catalyst, that initiates the submission of a workflow. This process ensures that relevant actions or processes are automatically set in motion when the specified criteria is met.

The flexibility of this method extends further, as you have the capability to introduce multiple triggers, each configured with different event conditions. This integrated and customizable approach provides a powerful tool-set to efficiently manage and automate processes based on the dynamic orchestration events that occur within the flow of HCL Universal Orchestrator. There are seven orchestration event types, each tied to the diverse statuses of tasks, workflow, and workstations. You can configure an event condition by adjusting the status associated with each event type. This flexibility ensures a dynamic and responsive system, that accommodates a range of conditions and effective management of orchestration events based on the evolving statuses of tasks, workflows, and workstations. The different types of orchestration events that you can configure are:

For configuring the different attributes associated with each event types to set up an event condition, see Configuring orchestration events.