Home
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.2.
User's Guide and Reference
Defining objects in the database
Defining scheduling objects
Job stream definition keyword details
servicevariables

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.2.
- Planning and Installation
- User's Guide and Reference
  - HCL Workload Automation
  - Understanding basic processes and commands
  - Configuring the job environment
  - Managing the production cycle
  - Using workload service assurance
    Workload service assurance is an optional feature that provides the means to flag jobs as mission critical for your business and to ensure that they are processed in a timely manner. Using this function benefits your scheduling operations personnel by enhancing their ability to meet defined service levels.
  - Customizing your workload using variable tables
    This chapter introduces the concept of variable tables to group global parameters, from now on called variables, to customize your workload.
  - Condition-based workload automation
  - Running event-driven workload automation
  - Defining objects in the database
    - Defining scheduling objects
      - Workstation definition
      - Workstation class definition
      - Domain definition
      - Job definition
      - User definition
      - Calendar definition
      - Folder definition
      - Variable and parameter definition
        Variables and parameters are objects to which you assign different values.
      - Variable table definition
      - Prompt definition
      - Resource definition
      - Run cycle group definition
      - Job stream definition
      - Job stream definition keyword details
        at
        Carryforward
        Comment
        Confirmed
        Critical
        Deadline
        Description
        Draft
        End
        Every
        every (used for job streams)
        every (used for jobs)
        Except
        Folder
        Follows
        Freedays
        Job statement
        isservice
        Join
        Jsuntil
        Keyjob
        Keysched
        Limit
        Matching
        maxdur
        mindur
        Needs
        nop
        On
        Onlate
        onoverlap
        Opens
        Priority
        Prompt
        Schedtime
        Schedule
        statisticstype custom
        Startcond
        servicename
        servicedescription
        servicetags
        servicevariables
        Timezone
        Until
        Validfrom/validto
      - Variable table
      - Event rule definition
      - Workload application definition
        You can use workload applications to standardize a workload automation solution so that the solution can be reused in one or more HCL Workload Automation environments thereby automating business processes.
      - Security object definition
  - Managing objects in the database - composer
  - Managing workload applications
    Workload applications can be created and then exported so that they can be shared with other HCL Workload Automation environments. In the new environment, the workload application can be subsequently updated, replaced, or deleted.
  - Managing objects in the plan - conman
  - Using Orchestration Query Language from command line
    You can use the essential Orchestration Query Language keywords and syntax to effectively write queries from command line.
  - Orchestration CLI
    The command line interface to run jobs or job streams and to interact with HCL Workload Automation.
  - Modifying context parameter temporarily
    You can temporarily modify the parameters in the default config.yaml file when you run a plan, model or plug-in command. This feature permits you to customize the behavior of a specific command without modifying the entire config.yaml file.
  - Monitoring HCL Workload Automation
    Using internal and third-party tools to monitor HCL Workload Automation
  - Extending HCL Workload Automation capabilities
    You can extend HCL Workload Automation capabilities by integrating with third-party products. This integration allows you to easily start HCL Workload Automation jobs on external products, while using HCL Workload Automation scheduling capabilities. HCL Workload Automation also provides jobs that perform everyday operations, such as file transfer and web services, and utility jobs that automate and simplify operations, such as the job stream submission.
  - Managing dynamic scheduling
    This section explains how you can manage dynamic scheduling capabilities in your environment to schedule both existing HCL Workload Automation jobs and job types with advanced options, both those supplied with the product and the additional types implemented through the custom plug-ins.
  - Using utility commands
  - Using utility commands in the dynamic environment
  - Getting reports and statistics
  - Managing time zones
  - Defining access methods for agents
  - Managing internetwork dependencies
  - Applying conditional branching logic
    With HCL Workload Automation you can define jobs to run when and as often as necessary. Sometimes some jobs might have to wait for other jobs to finish successfully before they start. Add even more flexibility to your job flows by choosing which job to run depending on the result of the job status or output of a previous job. Whenever you have conditions that specify whether or not a segment of your job flow should run, then that is a conditional dependency.
  - Defining and managing cross dependencies
  - Managing an IBM i dynamic environment
  - Event-driven workload automation event and action definitions
  - Quick reference for commands
  - Accessibility
- Administration Guide
- Scheduling with the Agent for z/OS
- Database Views
- High Availability Cluster Environment
- Driving HCL Workload Automation
- Extending HCL Workload Automation

servicevariables

Specifies the service variables for a job stream which is usable by Self-Service Catalog. You can use service variables to define variables in your job stream. When creating and editing SSC-ready job streams, it is recommended you use the Dynamic Workload Console.

Syntax

servicevariables

Comments

Variables are defined as CLOB in Json format. The maximum supported length is 16 characters.

SCHEDULE BW-XFR-LNX53#JS2
DESCRIPTION "Added by composer."
ISSERVICE
SERVICENAME TEST2
SERVICEDESCRIPTION “This is my Service”
SERVICETAGS "|tag2|tag3|"
SERVICEVARIABLES "{var: \"value2\"}"
ON RUNCYCLE RC1 "FREQ=DAILY;"
:

BW-XFR-LNX53#JS2

END