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
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.
AD – Application definition record
The AD record is a multi segment record with the following structure.
ADUSF – User Field (ADUSRF segment)
Use the ADUSF statement to define a user field for an operation.

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).
  - 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.
    - Modes of operation
      The batch loader processing supports several modes of operation, which you can specify by setting either OPTIONS DBMODE or the ACTION keyword of individual batch loader statements. Behaviors are different at the different levels.
    - Output masking
      Use output masking to update the content of existing fields using the percent sign (%) and asterisk (* ).
    - Batch loader syntax enhancements
      By default, Workload Automation Programming Language supports the same format of batch loader supported by EQQYLTOP. However, the following syntax enhancements make the batch loader function easier to use.
    - AD – Application definition record
      The AD record is a multi segment record with the following structure.
      - Automatic Operation numbering
        The Operation number is the unique identifier of an Operation within an Application. It is specified by the OPNO argument on the ADOP statement which defines each operation.
      - Automatic dependencies
        Batch loader can create automatic dependencies within an application by using the OPTIONS ADDEP keyword and the ADOP AUTOPRED and ADOP AUTOSUCC statements, when adding or replacing an entire application.
      - Submitting batch loader directly to the current plan
        Within Workload Automation Programming Language, you can use batch loader statements to create an occurrence directly in the current plan without creating the application in the database. To do that, set ACTION(SUBMIT) in the ADSTART statement.
      - ADAPD - Application Dependency
        Use the ADAPD statement to define a predecessor for an application.
      - ADCIV – External conditional dependency interval
        Use the ADCIV statement to define the absolute or relative interval specified with the A or R value in the ADCNS PRECSEL parameter.
      - ADCNC – Condition
        Use the ADCNC statement to define a condition for an operation that combines a set of following conditional dependencies (ADCNS).
      - ADCNS – Conditional dependency
        Use the ADCNS statement to define a conditional dependency for an operation. You must set at least one ADCNS statement for each ADCNC statement, matched by the CONDID keyword.
      - ADDEP - Dependency
        Use the ADDEP statement to define a predecessor for an operation.
      - ADEXT – Extended information (ADOPEXT segment)
        Use the ADOPEXT statement to define extended information for an operation.
      - ADLAT – User-defined late operation
        Use the ADLAT statement to specify your own settings by which an operation is to be considered late, and the alerts or actions to be taken.
      - ADOP - Operation
        Use the ADOP statement to define an operation.
      - ADRE – Remote job information
        Use the ADRE statement to define remote job information for an operation.
      - ADRULE - Rule
        The ADRULE statement defines a run cycle rule.
      - ADRUN – Run cycle
        Use the ADRUN statement to define a run cycle.
      - ADSAI – System Automation information (ADOPSAI segment)
        Use the ADOPSAI statement to define System Automation Information for an operation.
      - ADSR – Special Resource reference
        Use the ADSR statement to define a special resource requirement for an operation.
      - ADSTART – Application common details
        Use the ADSTART statement to define the common part of an Application Description.
      - ADUSF – User Field (ADUSRF segment)
        Use the ADUSF statement to define a user field for an operation.
      - ADVDD – Variable values for operation
        Use the ADVDD statement to define variable values applicable to the operation instances that are generated by the specified run cycles.
      - ADXIV – External dependency interval
        Use the ADXIV statement to define the absolute or relative interval specified with the A or R value in the ADDEP PRECSEL parameter.
    - AWSCL – All Workstations Closed record
      The AWSCL record is a single segment record with the following structure.
    - CL – Calendar record
      The CL record is a multi segment record, with the following structure.
    - ETT – Event Trigger Record
      The ETT record is a single segment structure.
    - JB – Ad-hoc in the current plan
      The JB Batch Loader statements do not map to a record within HCL Workload Automation for Z, instead this is pseudo batch loader generated as output from the LISTJOB command.
    - JCLV – JCL Variable Table record
      The JCLV record is a multi segment record, with the following structure.
    - JS – Current Plan JCL record
      The JS record is a multi segment record, with the following structure.
    - OI – Operator Instruction record
      The OI record is a multi segment record, with the following structure.
    - PR – Period record
      The PR record is a multi segment record, with the following structure.
    - RG – Run cycle group record
      The RG record is a multi segment record, with the following structure.
    - SR – Special Resource record
      The SR record is a multi segment record, with the following structure.
    - WS – Workstation record
      The WS record is a multi segment record with the following structure.
    - WSV – Virtual Workstation destination record
      The WSV record is a multi segment record, with the following structure.
  - 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

ADUSF – User Field (ADUSRF segment)

Use the ADUSF statement to define a user field for an operation.

Note: The ADUSF statement is available only starting from HCL Workload Automation for Z V8.5.1 SPE, or later.

Table 1. Keywords for ADUSF
Keyword	Description
`UFNAME`	User Field name, up to 16 characters long.
`UFVALUE`	User Field value, up to 54 characters long.

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.