Home
Orchestrating
Orchestrate anything with HCL Universal Orchestrator.
Event plug-in structure
Internal events
Internal event monitors the different statuses of jobs, job streams and workstations to initiate the submission of a job stream. You can create multiple scenarios of event conditions by configuring different statuses of these scheduling items.
Configuring internal events
You can configure internal 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.
Workstation status change event
The change in status for a workstation triggers an event. You can configure the event conditions to trigger an event whenever the monitored workstation changes its status or only when it changes to a specific state.

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.
- Job stream definition
  This topic introduces the job stream definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Job definition
  This topic introduces the job definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Calendar definition
  This topic introduces the calendar definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Folder definition
  This topic introduces the folder definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Credentials definition
  This topic introduces credentials definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Variable table definition
  This topic introduces the variable table definition, that can be managed from the Orchestration CLI and from the Dynamic Workload Console.
- Workstation definition
  This topic introduces the workstation definition, that can be done from the Orchestration CLI and from the Dynamic Workload Console.
- Managing an event source definition from the Orchestration CLI
  In this topic you can find the syntax to manage an event source definition.
- Event plug-in structure
  - Webhook plug-in structure
  - AWSEvents plug-in structure
  - Kafka plug-in structure
  - GCPEvents plug-in structure
  - AzureEvents plug-in structure
  - Internal events
    Internal event monitors the different statuses of jobs, job streams and workstations to initiate the submission of a job stream. You can create multiple scenarios of event conditions by configuring different statuses of these scheduling items.
    - Configuring internal events
      You can configure internal 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.
      - Job status change event
        The change in status for a job in plan creates an event. Whenever the monitored job changes its status, an event is created, and you can configure the event conditions to match such an event. When all the event conditions are satisfied, it triggers the job stream. You can configure the event conditions to trigger an event whenever the monitored job changes its status or only when it changes to a specific status.
      - Job Late Event
        When the deadline time instructions of the monitored job is exceeded, and if the job is not yet started or still in progress, it triggers an event.
      - Job Stream Status Change event
        The change in status for a job stream in plan triggers an event. You can configure the event conditions to trigger an event whenever the monitored job stream changes its status or only when it changes to a specific status.
      - Job stream late event
        When the deadline time instructions of the monitored job stream is exceeded, and if the job stream is not yet started or still in progress, it triggers an event.
      - Job stream completed event
        When the job stream is completed it triggers an event. You can configure the event conditions to trigger an event whenever the monitored job stream changes its status or only when it changes to a specific status.
      - Workstation status change event
        The change in status for a workstation triggers an event. You can configure the event conditions to trigger an event whenever the monitored workstation changes its status or only when it changes to a specific state.
  - Event driven orchestration configuration attributes
- Static pools
  A static pool in HCL Universal Orchestrator groups multiple workstations together and manages the workload by assigning jobs to available workstations within the pool. This helps to optimize resource utilization.
- Managing matching criteria
  In this topic you can find a description of matching criteria.
- Managing HCL UnO agent in Unix operating systems
  You can manage the agent by using scripts that are generated while configuring the agent or by Daemon process. It is recommended to use any method for ideal cohesion and efficient administration.
- Managing HCL UnO agent in Windows operating systems
  You can manage the agent by using scripts that are generated while configuring the agent or by Daemon process. It is recommended to use any method for ideal cohesion and efficient administration.
- Managing time zones
  In this topic you can find information about managing time zones.
- Policy-driven plan
  The new HCL Universal Orchestrator policy-driven adaptive plan makes your workload more autonomous, dynamic and scalable.
- 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.

Workstation status change event

The change in status for a workstation triggers an event. You can configure the event conditions to trigger an event whenever the monitored workstation changes its status or only when it changes to a specific state.

Overview

You can configure the event conditions with different statuses of a workstation. You can customize both mandatory and optional attribute filters to define specific conditions to trigger an event.

Workstation

Specify the name of the workstation to monitor. This detail must be preceded by the workstation folder details. The supported value type is string and for available operators see Event driven orchestration configuration attributes. Wildcard characters are permitted.

The multipleFilters property is disabled and if required, you can provide multiple filters or values separated by a semicolon (;) for a single instance of the workstation attribute.
The singlePredicate property is disabled, so you can also add multiple instances of the workstation attribute.
Note: To add a workstation that is not saved in the folder specified by the current_folder property in the config.yaml file, provide the complete path to the workstation folder.
Example: If the RS_AGT_1 workstation is saved under FOLDER1 under the root folder and the folder specified by the current_folder property in config.yaml is the root folder, then specify the workstation as follows in event definition:
/FOLDER1/RS_AGT_1

You can also use the following optional attribute to further configure the event conditions:

Status

Specify the expected status of the workstation to trigger the event. The supported value type is string and for available operators see Event driven orchestration configuration attributes. Wildcard characters are not permitted.

You can provide ONLINE or OFFLINE or both as values. If you do not provide any value, whenever there is a change in workstation status, the filter is considered satisfied.
Connection

Specify the connection to the engine. The supported value type is string and for available operators see Event driven orchestration configuration attributes. Wildcard characters are not permitted.

You can provide LINKED or UNLINKED or both as values. If you do not provide any value, whenever there is a change in workstation status, the filter is considered satisfied.