Welcome
Orchestrating
Orchestrate anything with HCL Universal Orchestrator.
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.
Human task
A Human task is a plug-in task included in the HCL Universal Orchestrator installation, that is helpful in situations where user input is required to complete a procedure.
Output properties
Reference for the human task output properties that capture user form input and completion button values, enabling output conditions and data passing to downstream tasks.

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.
Getting started with 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.
- 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.
  - Executable tasks
  - File monitor tasks
    You can use the file monitor tasks to create tasks that track changes in files. File monitor tasks can track changes in a single file or multiple files in HCL UnO agent installed in your local machine or mounted virtual machine.
  - Subflow task
    The task type that sets or references a valid workflow within a task. It is a workflow that is nested within a task. You can extend the functionality by adding multiple subflow tasks in a workflow, with each task containing a single workflow. The subflow task facilitates simultaneous submission of multiple workflows.
  - Shadow task definition
    A shadow task is a specific task type used to map a task to a task running on a different engine.
  - Human task queues
    A queue acts as a container for Human tasks.
  - Human task
    A Human task is a plug-in task included in the HCL Universal Orchestrator installation, that is helpful in situations where user input is required to complete a procedure.
    - Managing a Human task from the UI
      You can create a Human task using the UI to manage the acquisition of raw materials based on current market prices and user approval.
    - Output properties
      Reference for the human task output properties that capture user form input and completion button values, enabling output conditions and data passing to downstream tasks.
  - Managing a task definition from the Orchestration CLI
    In this topic you can find the syntax to manage a task definition.
  - Creating and referencing a task template from the UI
    The purpose of the following scenario is to show how to create a task template in the context of an example.
  - Creating file monitor tasks from the Orchestration CLI
    You can create a file monitor task by adding the specific attributes related to file monitor with the mandatory task definition attributes.
  - Using variables in tasks
    This section explains how to add variables to your tasks.
  - Selecting tasks in Orchestration CLI
    In Orchestration CLI you can perform actions either on a single task or on multiple tasks in the same instance. When you want to run commands on multiple tasks, instead of the task name, select the set of tasks by means of attributes and task qualifiers.
- Cross dependencies definition
  Cross dependencies enable you to define dependencies between workflows running on different orchestration engines.
- Event source definition
  An event source is an item that allows HCL Universal Orchestrator to receive events from specific event plug-ins.
- Endpoint definition
  An endpoint is a reusable item that defines the connection parameters required to communicate with an external system.
- 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.
- Run cycle group definition
  You can schedule workflows based on common run cycle groups.
- 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

Human task output properties

Reference for the human task output properties that capture user form input and completion button values, enabling output conditions and data passing to downstream tasks.

When a Human task completes, the engine generates a set of output properties. These properties are available to successor tasks in the workflow and can be referenced in output conditions and task parameters using the $this() function.

Output properties

A Human task produces the following output properties:


Property	Type	Value	Notes
`completionResult`	System	The value configured on the completion button that the user pressed to submit the form.	Always present after task completion. Defaults to `accept` if no value is configured on the button.
`field-name`	User-defined	The value entered by the user in the form field.	One property per form field. The key is the Name attribute of the field as configured in the Form editor.
`jsonInput`	System	A JSON object containing all form field values as key-value pairs.	Always present after task completion. Mirrors the individual user-defined field properties in a single structured object.

Note: The completionResult property defaults to accept when the completion button has no configured value. To drive branching logic based on which button was pressed, configure a distinct value on each button in the Form editor.

Example output properties in a task log

The following example shows the output properties of a Human task after the user filled out a form with two fields (action_type and item_name) and pressed a button configured with the value confirm:

= Output Properties:
=   action_type     : buy
=   item_name       : Gold
=   completionResult: confirm
=   jsonInput       :
{
  "action_type" : "buy",
  "item_name"   : "Gold"
}

Referencing output properties

Use the $this() function to reference output properties of a Human task in output conditions and in the parameters of successor tasks. The following examples use the output properties from the task log example above:


Use case	Expression
Output condition based on which button was pressed	`$this().completionResult = 'confirm'`
Output condition based on a form field value	`$this().action_type = 'buy'`
Passing a form field value to a successor task parameter	`${jobs.TASK_NAME.item_name}`