Welcome
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. The documentation has been updated for version 10.2 SPE (Revised April 2025).
Workload Automation Programming Language for z/OS User's Guide and Reference
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.
REMAIN – Return the remainder from division
This function performs division on two numbers, and returns the remainder.

Product requirements
This section contains links to the HCL Workload Automation Product Requirements.
Detailed System Requirements for HCL Workload Automation, Version 10.2.4
Detailed System Requirements for Dynamic Workload Console, Version 10.2.4
Overview
Mobile Applications Userʼs Guide
Dynamic Workload Console User's Guide
AI Data Advisor (AIDA) User's Guide
Scheduling Job Integrations with HCL Workload Automation
HCL Workload Automation
Welcome to the HCL Workload Automation documentation, where you can find information about how to install, maintain, and use HCL Workload Automation. The documentation has been updated for HCL Workload Automation Version 10.2.4.
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. The documentation has been updated for version 10.2 SPE (Revised April 2025).
- 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.
    - @ - Date logic function
      The @ function returns a boolean true or false (1 or 0), based on whether the input string is true for the day that is being evaluated.
    - @CMD and @JCL – Check RC of previous command or JCL step
      This function compares the return code of a previous Workload Automation Programming Language command, or a previous JCL step in the same job, with a specified value.
    - @LOG – Return the date and time in EQQYLOG format
      This function provides the current date and time in the same format used in the EQQYLOG. It is a function with no arguments, but the parentheses must be coded.
    - @V – Return the value of a named variable
      This function returns the value of a named variable.
    - ADDWORD – Add words to a list
      This function adds one or more words to a list, if they are not already existing in the list.
    - CONTAINS – Search for certain characters in a string
      This function returns the position of the first character, from those defined in a list, that is found in a string.
    - DATEADD – Add or subtract days to or from a date
      This function adds or subtracts a number of days to or from a date.
    - DATEDIFF – Calculate the difference between two dates
      This function returns the difference in days between two dates.
    - DATEFORM – Change the format of a date variable
      This function changes a date and/or a time to a new format.
    - DROPWORD – Delete a single word from a string
      This function deletes a word from a space delimited string, if it exists.
    - ENVATTR – Environment attributes
      This function returns environment attributes, for example return codes from previous steps or data set names attached to DD statements.
    - FLAG – Check if flag is set
      This function checks if binary flags are set within a byte, but performed in decimal number form, to avoid having to convert values to binary. The function returns 1 if the bits in <check> are also set in<source>. On the contrary, it returns 0.
    - GETHHMM – Convert minutes to hours and minutes
      This function converts a number of minutes into the HHMM format.
    - GETMINS – Convert minutes to hours and minutes
      This function converts hours and minutes expressed in the HHMM format into the number minutes.
    - IS – Validate input type
      This function confirms if the input data belongs to the specified data type. It returns 1 if the answer is affirmative. On the contrary, it returns 0.
    - ISDSN – Confirms whether a data set and/or member exists
      This function returns 1 if a data set exists, or 0 if it does not.
    - LOWER – Confirms whether a data set and/or member exists
      This function converts the non-accented uppercase characters found in a string to lowercase format.
    - NODE – Return a node from a string
      This function returns a node from a string, using a specified delimiter.
    - NODES – Return the number of nodes in a string
      This function returns the number of nodes within a string, using a specified delimiter.
    - OP – Format an operation number
      This function formats operation numbers with leading zeros, according to the maximum width allowed for the operation field.
    - REMAIN – Return the remainder from division
      This function performs division on two numbers, and returns the remainder.
    - REMOVE – Remove characters from a string
      This function deletes the specified characters from a string and returns the modified input string.
    - SEC100 – Convert hundredths of a second to HHMMSSXX
      This function converts hundredths of a second to hours, minutes, seconds and hundredths of seconds.
    - UPPER – Format an operation number
      This function converts the non-accented lowercase characters within a string into the uppercase format.
    - WORDSX – Extend the REXX WORDS function
      This function extends the REXX WORDS function to enable you delimit words with characters different from a blank. As with the WORDS function, the leading delimiters are ignored and consecutive delimiters treated as one, returning the number of delimited word. If the number is greater than the number of words, a null string is returned. The input string must not contain the “00”x character.
    - WORDX – Extend the REXX WORD function
      This function extends the REXX WORD function to enable you delimit words with characters different from a blank. As with the WORD function, the leading delimiters are ignored and consecutive delimiters treated as one, returning the number of delimited word. If the number is greater than the number of words, a null string is returned. The input string must not contain the “00”x character.
  - 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
Messages and Codes
Glossary
Notices

REMAIN – Return the remainder from division

This function performs division on two numbers, and returns the remainder.

REMAIN(<numerator>,<divider>)

Where:

<numerator>: The number on which to perform the division.
<divider>: The number by which to divide the <numerator>.

For example, the command REMAIN(15,6) returns 3, the command REMAIN(24,12) returns 0.