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.
Using variables in tasks
This section explains how to add variables to your tasks.
Defining variables with the jobprop utility
You can use the jobprop utility in a task definition to set output properties that you can utilize in other tasks. The feature is useful when you need to use specific values or parameters across different tasks.
Passing variables set by jobprop between tasks
You can use the jobprop utility to set one or more variables and their value in a task and pass it to another task. This utility is supported only on executable tasks and is useful for scenarios where tasks need to share or exchange data dynamically after it completes the run.

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.
    - Defining variables with the jobprop utility
      You can use the jobprop utility in a task definition to set output properties that you can utilize in other tasks. The feature is useful when you need to use specific values or parameters across different tasks.
      - Passing variables set by jobprop between tasks
        You can use the jobprop utility to set one or more variables and their value in a task and pass it to another task. This utility is supported only on executable tasks and is useful for scenarios where tasks need to share or exchange data dynamically after it completes the run.
  - 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

Passing variables set by jobprop between tasks

You can use the jobprop utility to set one or more variables and their value in a task and pass it to another task. This utility is supported only on executable tasks and is useful for scenarios where tasks need to share or exchange data dynamically after it completes the run.

Overview

Variables can be passed to another task that provides seamless flow of information. To set variable and its value in the first task use the following syntax:

jobprop <VAR-NAME> <value>

For more information about jobprop utility, see Defining variables with the jobprop utility.

To define the variables in another task, use the following syntax:

${jobs.<job_name>.wa.<variable_name>}

job_name: The name or the alias of the task from which you are exporting the <variable_name> value.

variable_name: The name of the variable you want to export.

In this example, the TEST_JS workflow contains the UN123#TASKA and UN123#TASKB executable tasks. The UN123#JOB task references the following UN123#TASKA variable values set by using the jobprop utility:

VAR1 variable set to value1 value.
VAR2 variable set to value2 value.
VAR3 variable set to value3 value.
VAR4 variable set to value4 value.

---
kind: JobStream
def:
  folder: /
  name: TEST_JS
  jobs:
  - workstation: /UN123
    name: TASKA
    jobDefinitionRef: /UN123#/TASKA
    jobDefinition:
      workstation: /UN123
      type: executable
      task:
        executable:
          interactive: "false"
          script: "#!/bin/sh \n jobprop VAR1 value1 \n jobprop VAR2 value2 \n jobprop VAR3 value3 \n jobprop VAR4 value4"
      recovery:
        action: STOP
  - workstation: /UN123
    name: TASKB
    jobDefinitionRef: /UN123#/TASKB
    jobDefinition:
      workstation: /UN123
      type: executable
      task:
        executable:
          interactive: "false"
          script: |-
            echo VAR1=${jobs.TASKA.VAR1}
            echo VAR2=${jobs.TASKA.VAR2}
            echo VAR3=${jobs.TASKA.VAR3}
            echo VAR4=${jobs.TASKA.VAR4}
      recovery:
        action: STOP
    internalPredecessors:
    - jobName: TASKA