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
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.
Workload Automation Programming Language commands syntax
The general syntax for all Workload Automation Programming Language commands is COMMAND [RESOURCE] KEYWORD(value) KEYWORD(value)
Special resource and user field names
With HCL Workload Automation for Z, the names of special resources and user fields can contain characters different from alphanumeric and national characters, but this would cause problems when parsing in 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.
    - Running Workload Automation Programming Language in batch
      With APAR PI79321, the JCL EQQYXJPX procedure is provided to run the complete EXEC version of Workload Automation Programming Language in batch, by applying the new method of loading EQQREF, EQQLANG, and EQQFILE internally, and making EQQOPTS optional. Use EQQYXJPX instead of the EQQYXJCL procedure for all new Workload Automation Programming Language jobs; this will reduce startup I/O processing.
    - Running Workload Automation Programming Language as a load module
      In addition to running Workload Automation Programming Language as a compiled REXX EXEC, you can also use the load module EQQWAPL.
    - Running Workload Automation Programming Language within an online TSO session
      Workload Automation Programming Language is primarily designed for use in batch, but you can use it from within an online TSO session, either inside or outside of the HCL Workload Automation for Z dialogs.
    - Running Workload Automation Programming Language on a started task workstation
      You can run Workload Automation Programming Language on an HCL Workload Automation for Z started task workstation. In this way, you can code Workload Automation Programming Language commands within user fields, enabling commands to be issued without creating individual jobs.
    - Running Workload Automation Programming Language as a console command
      You can create custom versions of the EQQYXJPX procedure, for each controller you have, that enable simple Workload Automation Programming Language commands to be run from the console or automation products.
    - Specifying the subsystem
      To run Workload Automation Programming Language both batch and online, you must set the SUBSYS parameter to specify the subsystem used when the communication with HCL Workload Automation for Z was initialized.
    - Using OUTPUT statements
      Use the OUTPUT statements to define what information you want to extract from HCL Workload Automation for Z, where to send it, and in what format. Workload Automation Programming Language writes the output from LIST or SELECT requests only if you have run OUTPUT statements for the segments encountered in these commands.
    - Workload Automation Programming Language commands syntax
      The general syntax for all Workload Automation Programming Language commands is COMMAND [RESOURCE] KEYWORD(value) KEYWORD(value)
      - Using comparators
        When you need to specify comparators for a command (for example LIST) specify them in the form KEYWORD-COMPARATOR(value). For example, VALFROM-GE(060124)
      - Setting dates and times
        Some keywords allow you to enter dates, times, or date and times. To use the current date, time, or datetime, you can enter the equal sign (=) as the only content of the keyword.
      - Termination, line numbers, and continuation
        There is no termination character for a command statement. A command is terminated when a new command word is identified as the first word on an input line, or the end of an input stream is encountered. Continuation is automatic; no continuation character is needed.
      - Inserting comments in a statement
        You can specify comments by inserting lines that start with /* and terminate with */
      - Special resource and user field names
        With HCL Workload Automation for Z, the names of special resources and user fields can contain characters different from alphanumeric and national characters, but this would cause problems when parsing in Workload Automation Programming Language.
      - Special characters @, !, and #
        The characters at sign (@), exclamation mark (!), and number sign (#) have special usage in the Workload Automation Programming Language syntax.
      - The impact of code pages on special characters
        When code pages are used the core characters A to Z and 0 to 9 are displayed as they are, while special characters, for example the at sign (@), are mapped to characters that depend on the code page applied. This means that a program compiled and documented in a native code page will have some characters represented in a different way when it is used with another code page.
      - Knowing resource names
        You must know what resources you need, because the resource names are not always obvious from the modern name of the object. For example the resource needed to retrieve a job stream is AD, which is derived from the old name of Application Description.
      - 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).
      - Using wildcards
        Workload Automation Programming Language supports the use of wildcards in many commands, either partially or completely.
    - Controlling the processing within Workload Automation Programming Language
      Workload Automation Programming Language runs each command in sequence, running them from each of the input streams in the order that they are.
    - Protecting against PIF failure
      Because Workload Automation Programming Language uses the HCL Workload Automation for Z programming interface (PIF), it is vulnerable to a few of types of problem against which you can protect.
    - Overriding Workload Automation Programming Language defaults
      You can change the Workload Automation Programming Language defaults for many elements by setting the OPTIONS statement.
    - Message log
      Workload Automation Programming Language produces a message log, with different levels of detail, according to the OPTIONS MSGLEVEL setting.
  - 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.
  - 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

Special resource and user field names

With HCL Workload Automation for Z, the names of special resources and user fields can contain characters different from alphanumeric and national characters, but this would cause problems when parsing in Workload Automation Programming Language.

Consider that:

Quotes, blanks, and parentheses ( and ) can cause problems to read the syntax of a command correctly.
When using Workload Automation Programming Language with instream SYSIN, characters &, %, and ? could be resolved by JCL tailoring unintentionally.
The exclamation point (!) could be resolved by Workload Automation Programming Language variable substitution unintentionally.
The percent sign (%) and asterisk (*) could cause problems to commands that need to use wildcards to search.
/* and */ could be interpreted as a comment by Workload Automation Programming Language.

These characters can cause problems especially in object names that form searchable and key fields. You should avoid them when naming objects to be used with Workload Automation Programming Language.