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.

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.
  - 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.
  - 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.
- 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
- 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

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.

You can use task definitions to perform many actions, such as call a REST API, run a Kubernetes task, or extract data from the database.

In HCL Universal Orchestrator, you can use different task types to perform your operations. Some tasks are deployed at runtime, so you can use this kind of tasks soon after the deployment. For more information, see:

You can find other plug-ins on Automation Hub, as well as related information and instructions about importing them in your environment.

Tasks can either be an embedded task, or they can reference a task template.

An embedded task is defined within the workflow, and that definition can only be used within that workflow.Task templates are preset definitions that can be referenced multiple times by different tasks. You can reference a task template many times inside the same workflow or in different workflows.

Task definitions can be modified either before or after their run. When you update a task in the plan, the change affects all the following runs of that specific task in the plan. If you want to save a change to a task in the database, you must modify the task template definition in the database.

If you submit a single task, a workflow with the same name is created and submitted. The workflow contains only the task you submitted.

A task definition can be managed from the Orchestration CLI and from the UI. For information about how to define tasks, see:

For more information about available task types, see Automation Hub.

For information about how to define variables in task definitions, see Using variables in tasks.

You can also manipulate and transform the data resulting from the task execution. For more information, see Data exchange and transformation

To add feedback about this topic, select the following checkbox:

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners Four, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site. Personal data should not be shared in this comment box. See our Privacy Statement to understand how personal data is used.