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).
MODIFY – Modify objects in the plans
Use the MODIFY request to modify one or more fields in an LTP or CP record.
MODIFY CPWS – Current Plan 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.
    - MODIFY – Modify objects in the plans
      Use the MODIFY request to modify one or more fields in an LTP or CP record.
      - MODIFY CPCOND – CP Condition
        When you are modifying an existing current plan condition, the CONDID argument is required to identify the condition to be modified. All remaining arguments are optional and provide the information used to modify the condition.
      - MODIFY CPEXT – CP Extended Operation Info
      - MODIFY CPOC – Current Plan Occurrence
        When you are modifying an existing current plan occurrence, the ADID and IA arguments identify the occurrence to be modified. All the remaining arguments provide the information used to modify the occurrence. The valid values for the STATUS argument are W (Waiting) and C (Complete).
      - MODIFY CPOP – Current Plan Operation
      - MODIFY CPREND – Distributed remote job info
      - MODIFY CPRENZ – z/OS remote job info
      - MODIFY CPSAI – Current Plan System Automation Info
      - MODIFY CPUSRF – User Field
      - MODIFY CPWS – Current Plan Workstation
      - MODIFY CPWSV – CP Virtual Workstation Destination
        When you are modifying a current plan virtual workstation, the WSNAME and WSDEST arguments are required. The remaining arguments contain the modified information.
      - MODIFY CSR – Current Plan Special Resource
      - MODIFY IVL – Current Plan Workstation Interval
      - MODIFY LTOC – Long Term Plan Occurrence
      - MODIFY VIVL – CP Virtual workstation interval
    - 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

MODIFY CPWS – Current Plan Workstation

When you are modifying a current plan workstation, the WSNAME argument is required. The remaining arguments contain the modified information.

Table 1. MODIFY CPWS – Current Plan Workstation
Argument Name	Description
ALTWS	When the workstation is set to failed or offline then another workstation can be specified for rerouting. Specify ALTWS if operations should be rerouted; if ALTWS is not supplied, no rerouting takes place. Note: For Virtual Workstations this arguments is ignored.
PSC	Control on parallel server. Note: For Virtual Workstations this arguments is ignored.
R1C	Control on resource 1. Note: For Virtual Workstations this arguments is ignored.
R2C	Control on resource 2. Note: For Virtual Workstations this arguments is ignored.
STARTACT	Action to be taken on current plan operations that have a status of started when the workstation status is set to failed or offline. Values are restart (R), set to error (E), or leave operation as is (L). Note: If the STARTACT argument is omitted when a workstation is set to failed or offline then no action is performed on the operations, as though STARTACT L was specified.
STATUS	New status of active (A), failed (F), or offline (O).
WSNAME	Workstation name.
WSREP	Workstation reporting attribute. Note: For Virtual Workstations this arguments is ignored.

Have feedback?
Google Analytics is used to store comments and ratings. To provide a comment or rating for a topic, click Accept All Cookies or Allow All in Cookie Preferences in the footer of this page.