Welcome
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.
Orchestration CLI keywords
You can use Orchestration CLI keywords when defining a workflows and tasks.
Validity keywords
The keywords available for the creation of workflow definitions are listed below. See the following sections for syntax and examples.

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
HCL Universal Orchestrator is a cloud-native workload orchestration and scheduling platform built on Kubernetes. Its microservices-based architecture enables the centralized orchestration of multi-cloud and hybrid environments from a single point of control.
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 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.
  - Access required to run Orchestration CLI commands
    You must have specific permissions to run each command in Orchestration CLI. The level of access to run the command is customizable and you can use Dynamic Workload Console (DWC) or Orchestration CLI to manage the roles.
  - Context commands
    The term context refers to the set of parameters in the config.yaml file that is used to establish an environment to run HCL Universal Orchestrator. You can create multiple contexts in the config.yaml file to manage the workload. This helps you to utilize the resources in a more efficient manner.
  - Model commands
    You can use the model commands to create or modify the item definitions for folders, tasks, workflows, and other scheduling or security items.
  - Plan commands
    You can use the plan commands to submit and run the task or workflows.
  - Plug-in commands
    You can use the plug-in commands to install, delete, or update plug-ins supported by HCL Universal Orchestrator.
  - help
    You can use the help command to view the online help or details about the commands that Orchestration CLI supports.
  - version
    You can use the version command to view the version of Orchestration CLI that is installed in your system.
  - Recovery options
    You can use recovery options to move forward in the event of abnormal job completions and to resolve any issues efficiently, minimizing downtime. This feature ensures smooth and efficient job runs, even in the event of unexpected interruptions.
  - Orchestration CLI keywords
    You can use Orchestration CLI keywords when defining a workflows and tasks.
    - Affinity attribute
      Use the Affinity attribute in a task or workflow definition to ensure that multiple tasks run on the same workstation.
    - asap
      The asap attribute forces the launch in the plan of a workflow instance, disregarding the scheduled start time (at) specified in its workflow definition. It can be applied to run cycles, workflows, and tasks.
    - Dependency keywords
      In this topic you can find the list of dependency keywords.
    - nop
    - Run cycle keywords
      In this topic you can find the list of run cycle keywords.
    - Time restriction keywords
      In this topic you can find the list of time restriction keywords.
    - Validity keywords
      The keywords available for the creation of workflow definitions are listed below. See the following sections for syntax and examples.
  - Managing multiple config.yaml files
    You can create multiple config.yaml files in the database to run commands on different contexts without changing the default context. The feature permits you to use multiple config.yaml files at the same time.
  - Managing multiple formats
    You can set the format by configuring the config.yaml file or by adding the parameter in model commands.
  - Modifying context parameter temporarily
    You can temporarily modify the parameters in the default config.yaml file when you run a plan, model or plug-in command. This feature permits you to customize the behavior of a specific command without modifying the entire config.yaml file.
  - Special characters as wildcards and delimiters
    When you want to use filters to select scheduling items in the database, you can use a list of selected special characters as wildcards and delimiters.
  - Orchestration CLI return codes
    Orchestration CLI return codes
- 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.
- Resource definition
  A resource is an item that represents a quantifiable asset, measured in terms of units. You can add resources as dependencies in tasks or workflows.
- Event plug-in structure
- Communicating with the AI agent
- 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.
- Changing the default editor for Orchestration CLI
  To customize the editing experience in HCL Universal Orchestrator, you can modify the default editor by setting the visual or editor environment variables.
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.
Administering multitenancy for service providers
Configure and administer a HCL Universal Orchestrator multitenant environment.
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.
UnO Agentic AI Builder
Troubleshooting
Recover your environment if any issue occurs.
Notices

Validity keywords

The keywords available for the creation of workflow definitions are listed below. See the following sections for syntax and examples.

validfrom / validto
draft

validfrom / validto

These keywords specify a time frame in which a workflow definition is valid.

Syntax

validfrom date

Arguments

validfrom date: The validfrom date defines the earliest moment in time from which workflow instances can be generated.; If a validfrom date is not defined within the run cycle, the default value is set to 2020/01/01.

validto: The validto date for a workflow is a read-only field. It is generated when a subsequent workflow version is created (with same folder, name, and workstation values but a later validfrom date). In this scenario, the validto date of the original workflow is set to the instant immediately preceding the validfrom date of the subsequent workflow version. The validto date specified in the run cycle is not included in the run cycle, so the workflow does not run on that date.
The validto date is shown when issuing list and display commands when MAESTROCOLUMNS is set to 120.

Comments

You can define different versions of the same workflow by creating other workflows with the same name and workstation, but with different validity intervals. The workflow identified as the dependency is the one that has a validity interval coincident with the period in which the dependency is active. When you define a workflow version, you must enter the validfrom date only.

Example

In the following example, the WORKFLOW1 workflow, which contains the TASK_1 task, is active from December 1, 2024.
```
SCHEDULE WS_AGT_1#WORKFLOW1 VALIDFROM 12/01/2024 
:
WS_AGT_0#TASK_1

END
```

draft

You can use this keyword to save the workflow as a draft so that it is not included in the plan generation process. If the workflow is referenced by dependencies, such workflow is not considered.

Syntax

draft

Comments

If you save as draft an existing task which has already been referenced, all the instances of that task do not run and the dependencies are realeased.

Example

In the following example, the WORKFLOW1 workflow is active from December 1, 2024, though it is marked as draft and thus it is not included in the plan. WORKFLOW1 contains the TASK_2 task.

SCHEDULE WS_AGT_1#WORKFLOW1 VALIDFROM 12/01/2024 
DRAFT
:
WS_AGT_0#TASK_2

END