Home
HCL Workload Automation for Z
Welcome to the HCL Workload Automation for Z documentation, where you can find information about how to install, maintain, and use the product.
Workload Automation Programming Language for z/OS User's Guide and Reference
Using TSO commands within Workload Automation Programming Language
Some TSO commands are specific to HCL Workload Automation for Z; you can run them natively in TSO, through program EQQEVPGM, and through Workload Automation Programming Language.

HCL Workload Automation for Z
Welcome to the HCL Workload Automation for Z documentation, where you can find information about how to install, maintain, and use the product.
- Program Directory
- Dynamic Workload Console Readmes
  For the latest information about a Dynamic Workload Console fix pack, see the appropriate Readme File.
- Planning and Installation
- Customization and Tuning
- Managing the Workload
  You can plan when and how your workload runs and manage it as part of a plan.
- Scheduling End-to-end with z-centric Capabilities
- Quick Reference
- Diagnosis Guide and Reference
- Workload Automation Programming Language for z/OS User's Guide and Reference
  - About this publication
  - Overview
    The Workload Automation Programming Language is a programming language that provides you with easy access to the features of the HCL Workload Automation for Z Program Interface (PIF).
  - Running Workload Automation Programming Language
    You can run Workload Automation Programming Language as a batch job by using the compiled REXX exec, as a load module, online within a TSO session, as a started task workstation, or as a console command. A user program must run as an authorized program.
  - Core programming commands
    The following sections describe the Workload Automation Programming Language commands that control the behavior and logic of the program. Use the commands to set options, return codes, determine an output, modify the flow, change variables, or make decisions.
  - Workload Automation Programming Language functions
    Some commands in Workload Automation Programming Language operate in REXX mode. These commands are CONSOLE, DISPLAY, DO, IF, LOG, SETVAR when the equal sign (=) is used, and WRITE.
  - Data Access commands based on PIF
    The Data Access commands supported by Workload Automation Programming Language are low level commands based on the HCL Workload Automation for Z programming interface (PIF).
  - Current Plan Operation commands
    Use the Current Plan Operation commands to perform specific functions against operations in the current plan, using a common set of keywords to identify the operation you want.
  - Current Plan Occurrence commands
    Use the Current Plan Occurrence commands to perform specific functions against all operations within a single occurrence in the current plan, using a common set of keywords to identify the occurrence.
  - Function Based commands
    The Function Based commands combine various low level PIF commands. Use the Function Based commands to perform specific scheduling or operational functions.
  - Using TSO commands within Workload Automation Programming Language
    Some TSO commands are specific to HCL Workload Automation for Z; you can run them natively in TSO, through program EQQEVPGM, and through Workload Automation Programming Language.
    - BACKUP – Initiate JCL or CP backup
      Use BACKUP to initiate a backup of either the current plan or JCL repository.
    - BULKDISC – Initiate Bulk Discovery
      Use BULKDISC to initiate a bulk discovery request.
    - JSUACT – Activate/Inactivate Job Submission
      Use JSUACT to activate or inactivate job submission.
    - OPINFO – Update Operation User field
      Use OPINFO to update the User Field of an operation in the current plan.
    - OPSTAT – Set operation status
      Use OPSTAT to set the status of an operation in the current plan.
    - SRSTAT – Set special resource status
      Use SRSTAT to set the status of a special resource in the current plan.
    - WSSTAT – Set workstation status
      Use WSSTAT to set the status of a workstation in the current plan.
    - Other TSO commands
      You can also run a small subset of TSO commands, including IDCAMS commands, directly from the Workload Automation Programming Language command stream.
  - Batch loader commands
    The batch loader function of Workload Automation Programming Language uses a set of statements to define or modify objects within the HCL Workload Automation for Z database.
  - Variable substitution
    Workload Automation Programming Language supports variable substitution within its control statements. In this way, the actual values required for each command run are provided (for example, the occurrence name or Input Arrival date).
  - Performance considerations
    With Workload Automation Programming Language you can use different methods to perform the same action. Each method has different implications for ease of use and performance, the balance of which might change depending on the volume of records to which it is being directed.
  - Resource reference
  - OPTIONS keywords
    Use the following keywords with the OPTIONS statement.
  - Workload Automation Programming Language variables
    In addition to the HCL Workload Automation for Z variables and user variables, Workload Automation Programming Language has access to some additional information relating to the job running Workload Automation Programming Language and when scheduled the operation and occurrence within which it is running.
  - WAPLEXEC programs
    The Workload Automation Programming Language for z/OS is a REXX based tool provided to give you easy access to the features of the HCL Workload Automation for Z Program Interface (PIF). Workload Automation Programming Language can be extended by WAPLEXEC programs, which are REXX programs using Workload Automation Programming Language functions to tackle specific tasks or functions.
  - Messages and Return Codes
    Messages and return codes provide information for problems occurred.
- Driving HCL Workload Automation for Z

Using TSO commands within Workload Automation Programming Language

Some TSO commands are specific to HCL Workload Automation for Z; you can run them natively in TSO, through program EQQEVPGM, and through Workload Automation Programming Language.

Within Workload Automation Programming Language, you specify HCL Workload Automation for Z TSO commands almost in the same way as the normal HCL Workload Automation for Z TSO command with the same name. The only difference is that you are not required to specify SUBSYS.

If you omit SUBSYS from the command, Workload Automation Programming Language adds it by using the information that you set in OPTIONS TRACKERS, to set the correct tracker subsystem name for the controller with which you are communicating. If you did not specify any OPTIONS TRACKERS, the SUBSYS value that was passed to Workload Automation Programming Language at startup is used.

The SUBSYS keyword cannot be abbreviated within Workload Automation Programming Language.

Note:

HCL Workload Automation for Z TSO commands are asynchronous: they generate an event to perform the action. Successful completion of the command indicates only that the event was generated, it does not mean that the event reached the target or that the keywords identified an object with the correct state for update.
With the EQQWAPL load module, you cannot use the TSO commands BULKDISC, DEFINE, DELETE, JSUACT, and REPRO.

For detailed documentation and syntax about TSO commands, see HCL Workload Automation for Z: Managing the Workload.