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
Defining access methods for agents
Access method interface
Method response messages

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.
  - 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
    - Access method interface
      - Method command line syntax
      - Method response messages
      - Method options file
        For extended, agents, and HCL Workload Automation Agent you can use a method options file to specify login information and other options.
    - Running methods
    - Troubleshooting
  - 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

Method response messages

Methods return information to HCL Workload Automation in messages written to stdout. Each line starting with a percent sign (%) and ending with a new line is interpreted as a message. The messages have the following format:

%CJ state [mjstring | jobid]

%JS [cputime]

%RC rc

%UT [errormessage]

where:

CJ

Changes the job state.

state

The state to which the job is changed. All HCL Workload Automation job states are valid except HOLD and READY. For the GS task, the following states are also valid:

ERROR: An error occurred.
EXTRN: Status is unknown.

mjstring

A string of up to 255 characters that HCL Workload Automation will include in any MJ task associated with the job.

jobid

A string of up to 64 characters that HCL Workload Automation will include in any GS task associated with the job.

JS [cputime]

Indicates successful completion of a job and provides its elapsed run time in seconds.

RC rc

rc is a number that is interpreted by HCL Workload Automation as the return code of the extended agent job. The return code is taken into account only if a return code condition was specified in the definition of the extended agent job. Otherwise, it is ignored and the successful completion of the extended agent job is indicated by the presence of message %JS [cputime]. Likewise, if the method does not send the %RC message, then the successful completion of the extended agent job is indicated by the presence of message %JS [cputime].

UT [errormessage]

Indicates that the requested task is not supported by the method. Displays a string of up to 255 characters that HCL Workload Automation will include in its error message.