Welcome
Orchestrating
Orchestrate anything with HCL Universal Orchestrator.
Endpoint definition
An endpoint is a reusable item that defines the connection parameters required to communicate with an external system.
Managing an endpoint definition from the UI
You can create and manage endpoint definitions using the Graphical Designer.

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.
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
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 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.
- 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.
  - Managing an endpoint definition from the Orchestration CLI
    In this topic you can find the syntax to manage an endpoint definition.
  - Managing an endpoint definition from the UI
    You can create and manage endpoint definitions using the Graphical Designer.
- 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
- Communicating with the AI agent
- 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.
Administering multitenancy for service providers
Configure and administer a HCL Universal Orchestrator multitenant environment.
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

Managing an endpoint definition from the UI

You can create and manage endpoint definitions using the Graphical Designer.

About this task

Defining an endpoint enables you to configure connection details for an external system once and reuse them across multiple tasks. This approach centralizes the management of credentials and URLs, enhancing security and maintainability.

Procedure

Click Design to access the My workspaces page.
Click New workspace or open an existing workspace to access the Graphical Designer.
From the palette, select the Assets tab.
Click Add new (+ icon) and select Endpoint from the drop-down menu.
In the General information section, specify the following details:
- Folder: Select the folder where you want to save the endpoint definition.
- Name: Enter a unique name for the endpoint.
- Description: Optionally, provide a description to identify the purpose of the connection.
In the Endpoint type field, search for and select the specific task plug-in associated with the external system (for example, RESTful, Database, or AmazonBedrock).

Note: The selection you make here determines which connection fields appear in the next step.
In the Connection section, enter the specific parameters required to establish the connection.

These fields vary based on the endpoint type selected. Common parameters include Service URL, Port, Database name, and Authentication details (such as User, Password, or API Key).

Important: If you are configuring an endpoint for cross dependencies (connecting to a remote HCL Universal Orchestrator or HCL Workload Automation for Z engine), the test connection action explicitly fails and returns a 403 Forbidden error if the provided API Key is valid but is not of the Cross dependencies type.
Optionally, configure the Monitoring settings to enable proactive availability checks:
- Monitored frequency: Specify the interval at which the system checks the endpoint status (range: 1 minute to 24 hours).
- Workstation: Select the workstation that runs the connectivity test. If left blank, the default CLOUD workstation is used.
Click Add to save the definition to the database.

Results

You have successfully created an endpoint. You can now reference this endpoint in compatible task definitions to handle external connections.