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

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

Creating file monitor tasks using Orchestration CLI

You can create a file monitor task by adding the specific attributes related to file monitor with the mandatory task definition attributes.

Syntax and attributes

Before creating the job definition, you must ensure that the HCL UnO agent is installed in your computer. For more information, see Installing HCL UnO agent.

The mandatory and optional attributes to create a file monitor task are as follows:

---
kind: JobDefinition
def:
  workstation: 
  folder:
  name: 
  type: filemonitor
  task:
    filemonitor:
      Action:
        queryInfo:
          event: [create | modify | delete]
          filePath: 
          minFileSize: 
          timeOut: 
          modificationCompletedTime: 
          outputFile: 
          pollingType:
            [periodic | eventdriven]:
              username: 
              polling: 
              password: 
          batch:
  recovery:
    action: STOP
    repeatInterval: PT0S
    repeatAffinity: false

You can configure the definition to create specific tasks. For more information about mandatory and optional file monitor attributes, see Creating file monitor tasks using Orchestration CLI.

Examples

To monitor the abc.txt file available in multiple folders every 20 seconds for 3 minutes, define the task definition as follows:

---
kind: JobDefinition
def:
  workstation: /MY_AGENT1
  folder: /
  name: JOB23
  type: filemonitor
  task:
    filemonitor:
      Action:
        queryInfo:
          event: modify
          filePath: C:\CodeRepo\fol*\abc.txt
          timeOut: 180
          pollingType:
            periodic:
              polling: 20
  recovery:
    action: STOP
    repeatInterval: PT0S
    repeatAffinity: false

To monitor the alram.txt file until a change occurs within 4 minutes, define the definition as follows:

---
kind: JobDefinition
def:
  workstation: /MY_AGENT1
  folder: /
  name: 
  type: filemonitor
  task:
    filemonitor:
      Action:
        queryInfo:
          event: modify
          filePath: C:\CodeRepo\folder1\alarm.txt
          minFileSize: 
          timeOut: "240"
          pollingType:
            eventdriven:""
  recovery:
    action: STOP
    repeatInterval: PT0S
    repeatAffinity: false