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 9.5 Fix Pack 6.
User's Guide and Reference
Using utility commands in the dynamic environment
Sendevent

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 9.5 Fix Pack 6.
- Fix Pack readmes
  For the latest information about a Fix Pack, see the appropriate Readme File.
- 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
  - Monitoring with Prometheus
    Access metrics that provide insight into the state, health, and performance of your workload environment and infrastructure.
  - Predicting job duration
  - Extending HCL Workload Automation capabilities
    You can extend HCL Workload Automation capabilities by integrating with IBM and third-party products, such as IBM Sterling Connect:Direct or MS SQL. 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 centralized agent update.
  - 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
    - Command-line configuration file
      The CLIConfig.properties file contains configuration information which is used when typing commands. By default, arguments required when typing commands are retrieved from this file, unless explicitly specified in the command syntax.
    - exportserverdata
      Use the exportserverdata command to download the list of dynamic workload broker instances from the HCL Workload Automation database and change a port number or a host name.
    - importserverdata
      Use the importserverdata command to upload the list of dynamic workload broker instances to the HCL Workload Automation database after editing the temporary file to change a port number or a host name.
    - jobprop
      Use the jobprop command on a job definition to set variables locally for a job on dynamic agents.
    - movehistorydata
      Use the movehistorydata when access to the database becomes too slow. This command moves the data present in the Job Repository to the archive tables
    - param
      Use the param command to define and manage user passwords and variables locally on dynamic agents and HCL Workload Automation Agents.
    - resource
      Use the resource command to create, modify, associate, query, or set resources online or offline.
    - Sendevent
    - twstrace
  - 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
  - Job Submission Description Language schema reference
    This reference section specifies the semantics and structure of the Job Submission Description Language (JSDL) that apply specifically for use with dynamic workload broker. The JSDL schema is used to describe the job requirements for submission to resources. dynamic workload broker analyzes the IT environment and assigns the best available resource to run the job, based on the requirements you specify.
  - Quick reference for commands
  - Accessibility
- Administration Guide
- Scheduling with the Agent for z/OS
- Database Views
- Integrating
- High Availability Cluster Environment
- Driving HCL Workload Automation
- Extending HCL Workload Automation

sendevent

The command sends from a dynamic agent or domain manager the custom events defined with the evtdef command to the event processor server currently active in the production plan. As the events are received by the event processor, they trigger the event rules in which they were specified.

Note: On Windows 2012, the command is not supported on Windows PowerShell.

Users can override the default destination server (defined by global options) by specifying the hostname and the port of a new server.

Syntax

sendevent -V | ? | -help | -u | -usage

sendevent [-hostname hostname]
          [-port port]
          eventType
          source
          [[attribute=value]...]

Arguments

-V: Displays the command version and exits.
? | -help | -u | -usage: Displays command usage information and exits.
-hostname hostname: Specifies the host name of an alternate event processor server other than the currently active one.
-port port: Specifies the port number of an alternate event processor server other than the currently active one.
eventType: One of the custom event types defined with the evtdef command in the generic event provider and specified as the triggering event in an event rule definition.
source: The name of the event provider that you customized with evtdef. This is also the name you must specify as the argument for the eventProvider keyword in the definition of the event rules triggered by these custom events.
The default name is GenericEventPlugIn.
attribute=value: One or more of the attributes qualifying the custom event type that are specified as the triggering event attributes for the event rule.

Comments

The command in this form applies to the dynamic environment only. To send events from non-dynamic agents, see sendevent.

Examples

In this example an application running on a dynamic agent sends the BusProcCompleted custom event type to the default event processor. The event is that file calcweek finished processing.

sendevent BusProcCompleted GenericEventPlugIn TransacName=calcweek 
Workstation=acagn002

The file name and the associated workstation are the two BusProcCompleted event attributes that were specified as triggering event attributes in an associated event rule.

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.