Welcome
Orchestrating
Orchestrate anything with HCL Universal Orchestrator.
AI agent definition
An AI agent uses a large language model (LLM) as its cognitive engine to interpret natural-language requests, break down complex goals, and make autonomous decisions.
Communicating with the AI agent
Communication channels
Communication channels are external messaging platform integrations that enable an AI agent chatbot to receive and send messages through third-party services managed by the Event Manager.
GoogleChatBOT plug-in parameters (Preview)
Reference for the GoogleChatBOT plug-in definition properties that specify connection credentials for a Google Chat channel integration in an AI agent chatbot.

What's new
The What's new section tracks the capabilities delivered across each HCL Universal Orchestrator release, organized by version, so you can navigate directly to the features relevant to your deployment.
Getting started with HCL Universal Orchestrator
HCL Universal Orchestrator is a cloud-native workload orchestration and scheduling platform built on Kubernetes. Its microservices-based architecture enables the centralized orchestration of multi-cloud and hybrid environments from a single point of control.
Deploying and Administrating
Deploy, connect, and administer HCL Universal Orchestrator on your own infrastructure, or start immediately with a hosted SaaS environment where the service provider manages all platform operations.
Administering multitenancy
Configure and administer a HCL Universal Orchestrator multitenant environment.
Using the UI
The UI is the HCL Universal Orchestrator interface, from which you can 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.
- AI agent definition
  An AI agent uses a large language model (LLM) as its cognitive engine to interpret natural-language requests, break down complex goals, and make autonomous decisions.
  - Managing the AI agent
  - Communicating with the AI agent
    - Communicating with the AI agent using a chatbot interface
      If you enable the Published as Chatbot option in the AI agent definition, a chatbot interface for the AI agent is created at the AI Agents section in the UI. You can engage in conversation with the AI agent to access information and get assistance. This type of data flow is only possible with the AI agents that are configured with either basic agent type or Agentic AI builder.
    - Running the AI agent as a task from the UI
      You can run the AI agent that is configured either in your local environment or in an external environment as a task from the UI. The AI agents configured with either the basic agent type or Agentic AI builder can be run as a task. After the run is completed, you an view the results in the task log.
    - Running the AI agent as a task using Orchestration CLI
      You can run the AI agent that is configured either in your local environment or in an external environment as a task using Orchestration CLI. The AI agents configured with either the basic agent type or Agentic AI builder can be run as a task using Orchestration CLI. After the run is completed, you an view the results in the task log.
    - AI agent task context variables
      Reference for the originating task and parent workflow metadata that HCL Universal Orchestrator propagates to a workflow invoked by an AI agent, available through js.triggerInfo variables.
    - Communication channels
      Communication channels are external messaging platform integrations that enable an AI agent chatbot to receive and send messages through third-party services managed by the Event Manager.
      - Configuring a Telegram channel
        In the Graphical Designer, you can add a Telegram channel to an AI agent chatbot to route messages between the agent and a Telegram bot managed by the Event Manager.
      - TelegramBOT plug-in parameters
        Reference for the TelegramBOT plug-in definition properties that specify connection credentials and timeout settings for a Telegram channel integration in an AI agent chatbot.
      - Configuring a Microsoft Teams channel (Preview)
        In the Graphical Designer, you can add a Microsoft Teams channel to an AI agent chatbot to route messages between the agent and a Microsoft Teams bot through an Azure Service Bus queue managed by the Event Manager.
      - MSTeamsBOT plug-in parameters (Preview)
        Reference for the MSTeamsBOT plug-in definition properties that specify Service Bus connection attributes, application credentials, and timeout settings for a Microsoft Teams channel integration in an AI agent chatbot.
      - Configuring a Google Chat channel (Preview)
        In the Graphical Designer, you can add a Google Chat channel to an AI agent chatbot to route messages between the agent and a Google Chat space managed by the Event Manager.
      - GoogleChatBOT plug-in parameters (Preview)
        Reference for the GoogleChatBOT plug-in definition properties that specify connection credentials for a Google Chat channel integration in an AI agent chatbot.
      - Configuring a Slack channel
        In the Graphical Designer, you can add a Slack channel to an AI agent chatbot to route messages between the agent and a Slack workspace managed by the Event Manager.
      - SlackBOT plug-in parameters
        Reference for the SlackBOT plug-in definition properties that specify connection credentials for a Slack channel integration in an AI agent chatbot.
  - Exposing internal AI agents to external clients by using the Agent-to-Agent protocol
    You can expose selected internal HCL Universal Orchestrator AI agents as Agent-to-Agent (A2A) agents. The A2A protocol provides a standard framework for discovering and invoking agent clients.
- Cross dependencies definition
  Cross dependencies enable you to define dependencies between workflows running on different orchestration engines.
- Event source definition
  An event source is an item that allows HCL Universal Orchestrator to receive events from specific event plug-ins.
- Endpoint definition
  An endpoint is a reusable item that defines the connection parameters required to communicate with an external system.
- 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.
- Run cycle group definition
  You can schedule workflows based on common run cycle groups.
- Workstation definition
  A workstation is a scheduling item that runs tasks.
- Resource definition
  A resource is an item that represents a quantifiable asset, measured in terms of units. You can add resources as dependencies in tasks or workflows.
- 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.
- Changing the default editor for Orchestration CLI
  To customize the editing experience in HCL Universal Orchestrator, you can modify the default editor by setting the visual or editor environment variables.
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.
UnO Agentic AI Builder
Troubleshooting
Recover your environment if any issue occurs.
Notices

v2.1.7+GoogleChatBOT plug-in configuration parameters (Preview)

Reference for the GoogleChatBOT plug-in definition properties that specify connection credentials for a Google Chat channel integration in an AI agent chatbot.

The GoogleChatBOT plug-in type connects an AI agent chatbot to a Google Chat space. The plug-in definition properties below are supplied in the channel configuration modal in the Graphical Designer, or in the properties block of a channel entry when using Orchestration CLI.

Important: The GoogleChatBOT plug-in is a preview feature. Its properties may change in a future release, and it is not supported for production chatbot deployments.

Plugin definition properties


Property key	Type	Required	Description
`projectId`	String	Yes	The unique identifier of the Google Cloud project that hosts the Pub/Sub resources used to exchange messages with Google Chat. Minimum length: 1 character. Maximum length: 1000 characters.
`subscriptionId`	String	Yes	The name of the Google Cloud Pub/Sub subscription that receives event notifications and messages from Google Chat. Minimum length: 1 character. Maximum length: 1000 characters.