Welcome
Orchestrating
Orchestrate anything with HCL Universal Orchestrator.
Data exchange and transformation
This topic explains how you can streamline your workflows using data exchange and transformation.
Task context structure example
Task context example

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.
- 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.
  - Task context structure
    Provides a list and explanation of all fields in the task context structure.
  - Task context structure example
    Task context example
  - Proprietary functions for JSONata
    Full list and description of proprietary HCL Universal Orchestrator functions available for using with JSONata.
  - Passing variables between tasks
    This topic shows how to pass variables between tasks.
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

Task context structure example

Task context example

Consider the following example to understand the structure of the task context. In this case, the structure is populated after several tasks have completed. For more information about the task context structure, see Task context structure.

The WORKFLOWVAR workflow contains two tasks named TASKVAR and TASKVAR1.

{
    RC  
    var: {
        key:val... },
      "js" : {
       "defId" : "04885fa7-c3ee-45ab-a1db-264f814fb86d",
       "wksId" : "a842d20c-97d8-40c0-afee-7e617fbd911d",
       "name" : "/WFVAR",
       "schedTime" : "2023-02-09T14:44:32.250Z",
       "id" : "a5ffa516-d6a0-4516-86ba-4490e586b9c8",
       "wks" : "/WS_AGT_0"
      },
  "jobs" : {
   "TASKVAR" : {
    "wa" : {
     "jobDef" : "/TASKVAR",
     "wksId" : "a842d20c-97d8-40c0-afee-7e617fbd911d",
     "logon" : "[wauser]",
     "name" : "JOBVAR",
     "rerunNum" : 0,
     "id" : "c462119a-c65d-4963-a18f-584088ead26d",
     "jobDefId" : "39e3369d-0380-4976-9f69-e7fb8eb005e4",
     "wks" : "/WS_AGT_0"
    },
   }, 
   "TASKVAR2" : { 
     "wa" : { 
        "jobDef" : "/TASKVAR2", 
        "wksId" : "f0e04e03-aa27-4b20-9f5e-40eb5bf66b82", 
        "logon" : "[wauser]", 
        "name" : "TASKVAR2", 
        "rerunNum" : 0, 
        "id" : "44439148-be6e-41cd-bc84-f0093e47e481", 
        "jobDefId" : "3daae93c-6279-4af9-91cd-ae2a1807f306", 
        "wks" : "/WS_AGT_1" 
      } 
    } 
  } 
}

To add feedback about this topic, select the following checkbox:

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners Four, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site. Personal data should not be shared in this comment box. See our Privacy Statement to understand how personal data is used.