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.1 Fix Pack 3.
User's Guide and Reference
Orchestration CLI
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.

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.1 Fix Pack 3.
- Fix pack readmes
- 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
  - Orchestration CLI
    - 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 Orchestration CLI, you can run one or combination of commands to accomplish specific results.
    - 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.
      - adddep job
        You can use the adddep command to add dependencies to a job.
      - adddep sched
        You can use the adddep command to add dependencies to a job stream.
      - altjob
        You can use the command option to modify a job in plan before it starts running.
      - cancel job
        You can use the cancel command to cancel a job.
      - cancel sched
        You can use the cancel command to cancel a job stream.
      - confirm
        You can use the confirm command to validate the status of a job after completion.
      - deldep job
        You can use the deldep jobcommand to delete the dependencies from a job.
      - deldep sched
        You can use the deldep schedcommand to delete the dependencies from a job stream.
      - kill
        You can use the kill command to stop a job in progress.
      - limit sched
        You can use the limit sched command to update the limit set in the definition of a job stream.
      - listfolder
        You can use the listfolder command to view the folders in a directory.
      - release job
        You can use the release job command to release normal and time dependencies from a job.
      - release sched
        You can use the release command to release the normal and time dependencies from a job stream.
      - rerun
        You can use the rerun command to rerun a job.
      - showcpu
        You can use the showcpu command to display the informations related to workstations or cpus.
      - showjobs
        You can use the showjobs command to view the informations related to jobs.
      - showschedules
        You can use the showschedulescommand to display the informations related to job streams.
      - submit docommand
        You can use the submit docommand command to schedule the start of a command as a job.
      - submit job
        You can use the submit job command to launch a job.
      - submit sched
        You can use the submit sched command to start a job stream.
  - 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

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.

In HCL Workload Automation, you can use the command line to run only the plan commands. The commands that you can use in Orchestration CLI have abbreviated forms. You can either use the abbreviation or the spelled-out form to complete the task. You can use the following list of commands in Orchestration CLI: