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
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).
LIST – Find objects in the Database and Plans
Use the LIST request to retrieve a list of records of a selected type.
LIST WSCOM – Workstation

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).
    - DELETE – Delete object from database or plan
      Use the DELETE request to delete a record or record segment.
    - EXECUTE – Commit updates to the Current Plan
      Use the EXECUTE request to update the current plan after one or more modify, insert, or delete current plan requests are completed.
    - INIT – Initialize communication with HCL Workload Automation for Z
      Use the INIT request to identify the required HCL Workload Automation for Z subsystem and initialize the communication session between the subsystem and Workload Automation Programming Language.
    - INSERT – Add objects into the plan
      In Workload Automation Programming Language, use the INSERT request to add occurrences to the Current Plan and Long-Term Plan. The PIF facility to update the database is handled by Batch Loader within Workload Automation Programming Language.
    - LIST – Find objects in the Database and Plans
      Use the LIST request to retrieve a list of records of a selected type.
      - OBJECT
        Use the OBJECT keyword to create an object variable for the LISSTAT process and the record identified.
      - MATCHTYP Argument
        Use the MATCHTYP argument for LIST requests with searchable fields that might contain wildcards or spaces.
      - SAVELIST Argument
        Use the SAVELIST argument to save the list of objects that were found for input to Batch Loader commands to identify the objects to update.
      - TAG Argument
        Use the TAG argument in a LIST command to create an additional output field called TAG, which will be available in any segment generated by the command. This allows for the output from multiple LIST commands to be correlated back to the originating command.
      - Automatic SELECT and DELETE
        Both the SELECT and DELETE commands require keywords that identify a specific record. In many cases, you will want to SELECT or DELETE a set of records based on various criteria, rather than individually create a statement for each record.
      - LIST ADCOM, LIST ADKEY – Application ID, Application Key
      - LIST AWSCL – All Workstations Closed
      - LIST CLCOM - Calendar
      - LIST CPCONDCO – Current Plan Condition (Common)
      - LIST CPOC – Current Plan Occurrence
      - LIST CPOPCOM – Current Plan Operation
      - LIST CPOPSRU – Current Plan Operation SR Usage
      - LIST CPWSCOM – Current Plan Workstation
      - LIST CPWSVCOM – CP Virtual workstation destination
      - LIST CRITSUCS – Critical Successors
      - LIST CSRCOM – Current Plan Special Resource
      - LIST ETT – Event Triggers
      - LIST GENDAYS – Generate dates from a rule
      - LIST JCLVCOM – JCL Variable tables
      - LIST JSCOM – Current Plan JCL
      - LIST LTOCCOM – Long Term Plan Occurrence
      - LIST OICOM – Operator Instructions
      - LIST PRCOM – Period
      - LIST RGCOM – Run Cycle Group
      - LIST SRCOM – Special Resource
      - LIST WSCOM – Workstation
      - LIST WSVCOM – Virtual workstation destination
    - MODIFY – Modify objects in the plans
      Use the MODIFY request to modify one or more fields in an LTP or CP record.
    - REPLACE
      The REPLACE request is performed by Workload Automation Programming Language internally using the Batch Loader functionality to build records before writing them to the database.
    - RESET – Resets pending changes to the plan
      Use the RESET request to delete the current Modify Current Plan (MCP) block.
    - SELECT – Retrieve a record or common segment
      Use the SELECT request to retrieve a record by specifying field names and values that identify the record you want to retrieve.
    - SETSTAT – Sets a Condition status
      The SETSTAT request changes the condition status from undecided to true or false, if the original status was undecided because of missing step-end information.
    - TERM – Terminate HCL Workload Automation for Z session
      Use the TERM request to terminate the programming interface session and perform the cleanup processing.
  - 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

LIST WSCOM – Workstation

Table 1. LIST WSCOM – Workstation
Argument Name	Description
WSAUTO	Automation workstation, Y or N
WSNAME	Workstation name
WSREP	Workstation reporting attribute
WSRETYPE	Remote engine type: D Distributed Z z/OS blank
WSTYPE	Workstation type
WSVIRT	Virtual workstation, Y or N
WSWAIT	WAIT Workstation, Y or N
WSZCENTR	z-Centric workstation, Y or N