Welcome to the HCL Workload Automation for Z documentation, where you can find information about how to install, maintain, and use the product.
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).
Use the SELECT request to retrieve a record by specifying field names and values that identify the record you want to retrieve.
SELECT
This request has no arguments.
For the latest information about a Dynamic Workload Console fix pack, see the appropriate Readme File.
You can plan when and how your workload runs and manage it as part of a plan.
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).
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.
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.
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.
CONSOLE
DISPLAY
DO
IF
LOG
SETVAR
Use the DELETE request to delete a record or record segment.
DELETE
Use the EXECUTE request to update the current plan after one or more modify, insert, or delete current plan requests are completed.
EXECUTE
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.
INIT
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.
INSERT
Use the LIST request to retrieve a list of records of a selected type.
LIST
Use the MODIFY request to modify one or more fields in an LTP or CP record.
MODIFY
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.
REPLACE
Use the RESET request to delete the current Modify Current Plan (MCP) block.
RESET
Use the OBJECT argument to create an object variable for the record retrieved by the SELECT command.
OBJECT
Use the TAG argument in a SELECT command to create an additional output field named TAG that will be available in any segment generated by the command. This allows for the output from multiple SELECT commands to be correlated back to the originating command.
TAG
Use the SELECT CPUSRF command to generate a record containing a CPUSRF segment for each user field belonging to the operation.
SELECT CPUSRF
CPUSRF
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.
SETSTAT
Use the TERM request to terminate the programming interface session and perform the cleanup processing.
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.
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.
The Function Based commands combine various low level PIF commands. Use the Function Based commands to perform specific scheduling or operational functions.
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.
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.
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).
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.
Use the following keywords with the OPTIONS statement.
OPTIONS
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.
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 provide information for problems occurred.