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

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.
- 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
    - 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.
  - 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

The command line interface to run jobs or job streams in plan and to interact with HCL Workload Automation V10.2.

You can configure Orchestration CLI on different operating systems, such as Windows, Linux and Mac.

Orchestration CLI is embedded in the dynamic agent of HCL Workload Automation, but you can also download the command line as a stand-alone package from Flexnet.

You need to run the executable file to configure Orchestration CLI. The path to the executable depends on how the package was downloaded. You can find more information as follows:

Orchestration CLI embedded in the dynamic agent

Both the master domain manager and the dynamic agent must be updated to V 0.1 Fix Pack 1. You can find the executable file in the following path:

On Windows operating systems, <TWA_home>\bin.
On Unix operating systems, <TWA_DATA_DIR>/TWS/bin.

Note: If you set the tws_env script, the Orchestration CLI executable file can be run starting from any other path. For more information, see Setting the environment variables

Orchestration CLI as stand-alone package: You can download the Orchestration CLI stand-alone package from Flexnet. When the download process is complete, you can extract the executable file and save it on any path that you want.