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.
Plug-in commands
You can use the plug-in commands to install, delete, or update plug-ins supported by HCL Universal Orchestrator.
install
You can use the install command to install a single plug-in or multiple plug-ins simultaneously.

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.
  - 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.
    - delete
      You can use the delete command to remove any plug-in from the database.
    - install
      You can use the install command to install a single plug-in or multiple plug-ins simultaneously.
    - List
      You can use the list command to view information about all the installed task and event plug-ins. The command shows details such as, name, ID, type, and version of each plug-in.
    - update
      You can use the update command to install higher versions of existing plug-ins or revert to an earlier version.
  - 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.
  - Orchestration CLI keywords
    You can use Orchestration CLI keywords when defining a workflows and tasks.
  - 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.
- 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

install

You can use the install command to install a single plug-in or multiple plug-ins simultaneously.

Overview

After you download the required files, you can run the install command to install one or more plug-ins. If the requested plug-in is already installed, an error message is displayed. If you want, you can keep multiple versions of the same plug-in at the same time. You must have INSTALL_PLUGIN access to run this command. For more information, see Access required to run Orchestration CLI commands.

Important:

The process of installing a plug-in takes up to a maximum of 5 minutes.
If the size of the plug-in that needs to be installed exceeds 10 MB, you must specify a value higher than the plug-in size for maxSize parameter in the values.yaml file. In the values.yaml file, navigate to config > plugins > maxSize to add this value.

Syntax and command line options

You can enter the command as follows:

ocli plugin [install | i ] filepath or folderpath

The filepath or folderpath parameter is mandatory.

The details required with each parameter are as follows:

filepath or folderpath: You must specify the path to the executable file. To install multiple plug-ins simultaneously, keep all the executable files in the same folder, and specify the folder path. Orchestration CLI installs all the plug-ins in the folder. During the process, HCL Universal Orchestrator disregards any files that are not related to the plug-ins and installs only the relevant files. If you want to install a single plug-in, specify the plug-in name along with the folder path. For more details see the following examples.

Examples

Run the following command to install the plug-ins in C:\ProgramFiles\plugins folder.
```
ocli plugin install C:\ProgramFiles\plugins
```
Run the following command to install the com.hcl.wa.plugin.gcpcloudfunction_10.1.0.01.jar plug-in in C:\ProgramFiles\single folder.
```
ocli plugin install C:\ProgramFiles\single\com.hcl.wa.plugin.gcpcloudfunction_10.1.0.01.jar
```
Run the following command to install the plug-ins in home/john/plugins folder.
```
ocli plugin install home/john/plugins
```
Run the following command to install the com.hcl.wa.plugin.gcpcloudfunction_10.1.0.01.jar plug-in in home/john/single/ folder.
```
ocli plugin install home/john/single/com.hcl.wa.plugin.gcpcloudfunction_10.1.0.01.jar
```