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

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.
    - add
      You can use the add command to add scheduling items to the database.
    - delete
      You can use the delete command to remove the scheduling or security items from the database.
    - display
      You can use the command option to view the entire information about the item definitions of the same type.
    - extract
      You can use the command option to create a text file by copying the item definitions from the database.
    - list
      You can use the list command to view the list of items of the same type.
    - listfolder
      You can use the command option to view the list of folders available in the database.
    - lock
      You can use the command option to lock access to a scheduling item definition.
    - mkfolder
      You can use the command option to create new folders.
    - modify
      You can use the command option to update the existing scheduling or security items in the database.
    - new
      You can use the new command to create a new scheduling or security item definition.
    - rename
      You can use the rename command to rename a scheduling or security item in the database.
    - renamefolder
      You can use the rename command to rename folder definitions.
    - replace
      You can use the replace command to replace the existing scheduling or security item definitions in the database.
    - rmfolder
      You can use the rmfolder command to delete folders in the database.
    - unlock
      You can use the command option to unlock a scheduling or security item that are locked.
  - 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.
  - 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

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.

You can use the following list of model commands in Orchestration CLI:


Command	Description
add	To add scheduling items to the database. For more information, see add.
delete	To remove the scheduling or security items from the database. For more information, see delete.
display	To view the entire information about the item definitions of the same type. For more information, see display.
extract	To create a text file by copying the item definitions from the database. For more information, see extract.
list	To view the list of items of the same type. For more information, see list.
listfolder	To view the list of folders available in the database. For more information, see listfolder.
lock	To lock access to a scheduling item definition. For more information, see lock.
mkfolder	To create new folders. For more information, see mkfolder.
modify	To update the existing scheduling or security items in the database. For more information, see modify.
new	To create a new scheduling or security item definition. For more information, see new.
rename	To rename a scheduling or security item in the database. For more information, see rename.
renamefolder	To rename folder definitions. For more information, see renamefolder.
replace	To replace the existing scheduling or security item definitions in the database. For more information, see replace.
rmfolder	To delete folders in the database. For more information, seermfolder.
unlock	To unlock a scheduling or security item that is locked. For more information, see unlock.

Important: To manage the context parameters more efficiently when you have multiple config.yaml files available in your computer, see Managing multiple config.yaml files.