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
Managing the production cycle
Planman command line
Deploying rules

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
  - 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

Deploying rules

The planman deploy command is used in event management. You can use it to manually deploy all rules that are not in draft state (the isDraft property is set to NO in their definition). The command operates as follows:

Selects all event rule definitions not in draft state from the HCL Workload Automation database.
Builds event rule configuration files.
Deploys the configuration files to the monitoring engines running on the HCL Workload Automation agents.

The new configuration files update the event rules running on each monitoring engine in terms of:

New rules
Changed rules
Rules deleted or set back to draft state

You can use this command in addition to, or in replacement of, the deploymentFrequency (df) optman configuration option, which periodically checks event rule definitions for changes to deploy (see Administration Guide for details on this option).

The changes applied to the event rule definitions in the database become effective only after deployment has taken place.

The command syntax is:

planman [connection_parameters] deploy [-scratch]

where:

connection_parameters

Defines the settings to use when establishing the connection using HTTP or HTTPS through WebSphere Application Server Liberty to the master domain manager. For more information refer to Planman command line.

-scratch

Without this option, the command affects only the rules that have been added, changed, deleted, or set back to draft state .

With this option, the command deploys all the non-draft rules existing in the database, including the ones that are already in deployment and have not changed.

Note that the deployment time increases proportionally with the number of active rules to deploy. If you need to deploy a large number of new or changed rules, run planman deploy with this option to reduce the deployment time.

Use of this option results in a complete reset of the event processor and should be used with caution. The command may cause the loss of any rule instances in progress at the time you issue it. The typical case is a sequential rule that has been triggered and is waiting for additional events to take place: if you use the option at this time, the event rule environment is reset and the tracked events are lost.

To run this command, you need build access on the prodsked file.