Home
HCL Workload Automation
Welcome to the HCL Workload Automation documentation, where you can find information about how to install, maintain, and use HCL Workload Automation. The documentation has been updated for HCL Workload Automation Version 10.2.2.
User's Guide and Reference
Orchestration CLI
The command line interface to run jobs or job streams and to interact with HCL Workload Automation.
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, jobs, job streams, and workstations.

HCL Workload Automation
Welcome to the HCL Workload Automation documentation, where you can find information about how to install, maintain, and use HCL Workload Automation. The documentation has been updated for HCL Workload Automation Version 10.2.2.
- Planning and Installation
- User's Guide and Reference
  - HCL Workload Automation
  - Understanding basic processes and commands
  - Configuring the job environment
  - Managing the production cycle
  - Using workload service assurance
    Workload service assurance is an optional feature that provides the means to flag jobs as mission critical for your business and to ensure that they are processed in a timely manner. Using this function benefits your scheduling operations personnel by enhancing their ability to meet defined service levels.
  - Customizing your workload using variable tables
    This chapter introduces the concept of variable tables to group global parameters, from now on called variables, to customize your workload.
  - Condition-based workload automation
  - Running event-driven workload automation
  - Defining objects in the database
  - Managing objects in the database - composer
  - Managing workload applications
    Workload applications can be created and then exported so that they can be shared with other HCL Workload Automation environments. In the new environment, the workload application can be subsequently updated, replaced, or deleted.
  - Managing objects in the plan - conman
  - Using Orchestration Query Language from command line
    You can use the essential Orchestration Query Language keywords and syntax to effectively write queries from command line.
  - Orchestration CLI
    The command line interface to run jobs or job streams and to interact with HCL Workload Automation.
    - Configuring Orchestration CLI
      The extension for Orchestration CLI is bundled with the product. If required, you can download it as a stand-alone feature also.
    - Running commands from Orchestration CLI
      After you installed and configured the Orchestration CLI, you can run one or a combination of commands to accomplish specific results.
    - Authenticating Orchestration CLI using API Keys
      When you connect to HCL Workload Automation using Orchestration CLI for the first time, you need to authenticate the connection using API Keys.
    - 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 the Dynamic Workload Console 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 Workload Automation. 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, jobs, job streams, and workstations.
        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 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 items in the database.
        new
        You can use the new command to create a new scheduling item definition.
        rename
        You can use the rename command to rename a scheduling item in the database.
        renamefolder
        You can use the renamecommand to rename folder definitions.
        replace
        You can use the replace command to replace the existing scheduling 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 item that are locked.
      - Plan 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.
    - 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.
    - 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
    - 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.
  - Monitoring HCL Workload Automation
    Using internal and third-party tools to monitor HCL Workload Automation
  - Extending HCL Workload Automation capabilities
    You can extend HCL Workload Automation capabilities by integrating with third-party products. This integration allows you to easily start HCL Workload Automation jobs on external products, while using HCL Workload Automation scheduling capabilities. HCL Workload Automation also provides jobs that perform everyday operations, such as file transfer and web services, and utility jobs that automate and simplify operations, such as the job stream submission.
  - Managing dynamic scheduling
    This section explains how you can manage dynamic scheduling capabilities in your environment to schedule both existing HCL Workload Automation jobs and job types with advanced options, both those supplied with the product and the additional types implemented through the custom plug-ins.
  - Using utility commands
  - Using utility commands in the dynamic environment
  - Getting reports and statistics
  - Managing time zones
  - Defining access methods for agents
  - Managing internetwork dependencies
  - Applying conditional branching logic
    With HCL Workload Automation you can define jobs to run when and as often as necessary. Sometimes some jobs might have to wait for other jobs to finish successfully before they start. Add even more flexibility to your job flows by choosing which job to run depending on the result of the job status or output of a previous job. Whenever you have conditions that specify whether or not a segment of your job flow should run, then that is a conditional dependency.
  - Defining and managing cross dependencies
  - Managing an IBM i dynamic environment
  - Event-driven workload automation event and action definitions
  - Quick reference for commands
  - Accessibility
- Administration Guide
- Scheduling with the Agent for z/OS
- Database Views
- High Availability Cluster Environment
- Driving HCL Workload Automation
- Extending HCL Workload Automation

Model commands

You can use the model commands to create or modify the item definitions for folders, jobs, job streams, and workstations.

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

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.