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
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.
Defining variables and passwords for local resolution on dynamic agents
Defining variables in dynamic workload broker jobs
This section explains how to add variables to jobs you plan to run with dynamic workload broker.

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.
    - Prerequisite steps to create job types with advanced options
      How to define a new job definitions using the Dynamic Workload Console.
    - Creating advanced job definitions
    - Job definition - z/OS jobs
    - Remote command jobs
    - IBM i jobs
    - Executable jobs
    - Access method jobs
    - Shadow jobs
    - Variable Table jobs
      A Variable Table job adds or modifies a variable in a specified variable table.
    - Job Management jobs
      A Job Management job runs actions on a job in a job stream.
    - Job Stream Submission jobs
      A Job Stream Submission job submits a job stream for processing.
    - Return Codes for job types with advanced options
      The following is a list of the return codes for job types with advanced options
    - Defining variables and passwords for local resolution on dynamic agents
      - Specifying local variables and passwords in the job definitions
      - Defining variables in dynamic workload broker jobs
        This section explains how to add variables to jobs you plan to run with dynamic workload broker.
    - Passing variables between jobs
    - Running a script when a job completes
  - 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

Defining variables in dynamic workload broker jobs

This section explains how to add variables to jobs you plan to run with dynamic workload broker.

You can include variables in your job definition. The variables are resolved at submission time.

The supported variables are as follows:

Table 1. Supported HCL Workload Automation variables in JSDL definitions.
Variables that can be inserted in the dynamic workload broker job definition	Description
tws.host.workstation	Name of the host workstation.
tws.job.date	Date of the submitted job.
tws.job.fqname	Fully qualified name of the job (UNISON_JOB).
tws.job.ia	Input arrival time of the job.
tws.job.interactive	Job is interactive. Values can be `true` or `false`. Applies only to jobs compatible with earlier versions.
tws.job.logon	Credentials of the user who runs the job (LOGIN). Applies only to jobs compatible with earlier versions.
tws.job.name	Name of the submitted job.
tws.job.num	UNISON_JOBNUM.
tws.job.priority	Priority of the submitted job.
tws.job.promoted	Job is promoted. Values can be `YES` or `No`. For more information about promotion for dynamic jobs, see Promoting jobs scheduled on dynamic pools .
tws.job.recnum	Record number of the job.
tws.job.resourcesForPromoted	Quantity of the required logical resources assigned on a dynamic pool to a promoted job. Values can be `1` if the job is promoted or `10` if the job is not promoted. For more information about promotion for dynamic jobs, see Promoting jobs scheduled on dynamic pools.
tws.job.taskstring	Task string of the submitted job. Applies only to jobs compatible with earlier versions.
tws.job.workstation	Name of the workstation on which the job is defined.
tws.jobstream.id	ID of the job stream that includes the job (UNISON_SCHED_ID).
tws.jobstream.name	Name of the job stream that includes the job (UNISON_SCHED).
tws.jobstream.workstation	Name of the workstation on which the job stream that includes the job is defined.
tws.master.workstation	Name of the master domain manager (UNISON_MASTER).
tws.plan.date	Start date of the production plan (UNISON_SCHED_DATE).
tws.plan.date.epoch	Start date of the production plan, in epoch format (UNISON_SCHED_EPOCH).
tws.plan.runnumber	Run number of the production plan (UNISON_RUN).