Welcome
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.7.
User's Guide and Reference
Integrating with SAP and PeopleSoft
Integration with SAP
Access method for SAP
The SAP R/3 batch access method enables communication between an external SAP R/3 system and HCL Workload Automation and provides a single point of entry for automating the launching of jobs, monitoring the status of jobs and managing exceptions and recovery.
Roles and responsibilities

Product requirements
This section contains links to the HCL Workload Automation Product Requirements.
Product Library in PDF format
This section contains links to the PDF versions of all the publications provided in Product Documentation for HCL Workload Automation.
Overview
Best practices
Mobile Applications Userʼs Guide
Dynamic Workload Console User's Guide
AI Data Advisor (AIDA) User's Guide
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.7.
- 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
  - 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
    You can use the essential Orchestration Query Language (OQL) keywords and syntax to effectively write queries.
  - 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.
  - Using utility commands
  - Using utility commands in the dynamic environment
  - Getting reports and statistics
  - Managing time zones
  - Integrating with SAP and PeopleSoft
    - Access method interface
    - Running methods
    - Access methods
    - Integration with SAP
      - Introducing HCL Workload Automation for SAP
        Improve SAP operations and enable business growth with HCL Workload Automation.
      - Access method for SAP
        The SAP R/3 batch access method enables communication between an external SAP R/3 system and HCL Workload Automation and provides a single point of entry for automating the launching of jobs, monitoring the status of jobs and managing exceptions and recovery.
        Scheduling process for the agent workstation hosting the r3batch access method
        Roles and responsibilities
        Configuring user authorization (Security file)
        Configuring the SAP environment
        You must configure the SAP environment before using the SAP access method.
        Configuring the SAP access method
        This section provides detailed information about the SAP options file creation.
        Defining SAP jobs
        You must define some jobs to be able to run jobs on an SAP workstation from HCL Workload Automation.
        Managing SAP jobs
        This section describes how to manage SAP jobs.
        Defining SAP jobs dynamically
        This section describes how to create and submit SAP jobs dynamically without creating or referencing predefined job templates.
        Defining conditions and criteria
        HCL Workload Automation accesses the Computer Center Management System (CCMS) Background Processing components of SAP systems through the BC-XBP interface to provide additional capabilities from the Dynamic Workload Console, one of those being the Criteria Manager.
        Using the BDC Wait option
        By using the Batch Data Collector (BDC) Wait option, you can specify that a SAP job launched by HCL Workload Automation is not to be considered complete until all of its BDC sessions have completed.
        Job interception and parent-child features
        This section describes how the job interception and parent-child features of BC-XBP 2.0 and 3.0 are supported by HCL Workload Automation.
        Using Business Information Warehouse
        Business Information Warehouse (BIW) is a data warehouse solution tailored to SAP.
        Job throttling feature
        Learn how the job throttling feature helps you to improve the efficiency of your scheduling on SAP systems and reduce the batch window for your SAP jobs to a minimum.
        Exporting SAP factory calendars
        This section describes how to export SAP factory calendars into a file format that can be processed by the HCL Workload Automation composer command line, to add the exported calendar definitions to the HCL Workload Automation database.
        Defining internetwork dependencies and event rules based on SAP background events
        This section describes how to define internetwork dependencies and event rules for HCL Workload Automation based on SAP background events.
        Defining event rules based on IDoc records
        You can use HCL Workload Automation to monitor Intermediate Document (IDoc) records in SAP systems and forward events to the HCL Workload Automation event integration framework.
        Defining event rules based on CCMS Monitoring Architecture alerts
        Use CCMS functions to check the performance of the various SAP system components, diagnose potential problems, and be alerted about error and warning conditions.
        National Language support
        The National Language support feature allows you to install SAP on a localized HCL Workload Automation workstation and use localized characters for HCL Workload Automation job names, job streams, and SAP variants.
        Troubleshooting
        Learn what to do if you get any problems while installing or using HCL Workload Automation access methods or plug-ins.
      - Scheduling jobs on HCL Workload Automation from SAP Solution Manager
        HCL Workload Automation and SAP Solution Manager are integrated to allow the HCL Workload Automation engine to run the job scheduling tasks available from the Solution Manager user interface.
    - Troubleshooting
  - 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
- Troubleshooting
- Driving HCL Workload Automation
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 Fix Pack 4.
Messages and Codes
Glossary
Notices

Roles and responsibilities

In a typical enterprise, different users contribute to the implementation and operation of the product. Roles and responsibilities in HCL Workload Automation for SAP describes the roles and responsibilities of all users in the process model, showing the tasks they perform.

Table 1. Roles and responsibilities in HCL Workload Automation for SAP
User role	User task
HCL Workload Automation administrator	Creating the HCL Workload Automation RFC user Creating the authorization profile for the HCL Workload Automation user Copying the correction and transport files Importing ABAP/4 function modules into SAP
HCL Workload Automation configurator	Changing the HCL Workload Automation RFC user ID password Migrating from previous versions Print parameter and job class issues Defining the configuration options Connecting to the SAP system Creating SAP Standard R/3 jobs from the Dynamic Workload Console Using the BDC Wait option Implementing job interception Defining user authorizations to manage SAP Business Warehouse InfoPackages and process chains Setting and using job throttling Exporting SAP factory calendars Setting National Language support options
HCL Workload Automation developer	Editing a standard SAP job Task string to define SAP jobs Displaying details about a standard SAP job Verifying the status of a standard SAP job Deleting a standard SAP job from the SAP database Balancing SAP workload using server groups Defining SAP jobs dynamically Managing SAP R/3 Business Warehouse InfoPackages and process chains
HCL Workload Automation developer	Defining internetwork dependencies and event rules based on SAP background events Defining event rules based on IDoc records Defining event rules based on CCMS Monitoring Architecture alerts
HCL Workload Automation operator	Rerunning a standard SAP job Mapping between HCL Workload Automation and SAP job states Raising an SAP event Killing an SAP job instance Displaying details about a process chain job