Using the involved interfaces and commands

About this task

Running and managing event-driven workload automation calls for the following tasks:
  • Edit configuration settings
  • Model event rules
  • Manually deploy or undeploy event rules
  • Manage monitoring and event processing devices
  • Monitor and manage event rule instances
You must be ready to use several HCL Workload Automation interfaces and commands to do them. Interfaces and commands for managing event-driven workload automation summarizes the ones you need:
Table 1. Interfaces and commands for managing event-driven workload automation
Interface or command Use to...
optman Change the default values of global options associated with event management. Global options are used to configure:
  • The frequency with which rule definitions are checked for updates (deploymentFrequency). Modified definitions are deployed in the HCL Workload Automation domain
  • The EIF port number where the event processing server receives events (eventProcessorEIFPort, or eventProcessorEIFSSLPort when SSL-protected).
  • Management of the cleanup policies of rule instance, action run, and message log data (logCleanupFrequency).
  • SMTP server properties if you deploy rules implementing actions that send emails via an SMTP server (smtpServerName, smtpServerPort, smtpUseAuthentication, smtpUserName, smtpUserPassword, smtpUseSSL, smtpUseTLS ).
  • The possibility to disable the event rule management mechanism (enEventDrivenWorkloadAutomation) which is installed by default with the product.

See the Administration Guide for a list of global options.
composer

Run modeling and management tasks of event rule definitions like add, create, delete, display, extract, list, lock, modify, new, print, unlock, validate. Event rules are defined in XML.

Query the HCL Workload Automation relational database for:
  • event rule definitions filtered by:
    • rule, event, and action properties
    • jobs and job streams involved with the rule action
  • event rule instances, actions run, and message log records

See Event rule definition to learn how to define event rules. See Managing objects in the database - composer for command reference.
Dynamic Workload Console Have a graphical user interface to:
  • Model and manage event rule definitions (browse, create, delete, modify, query, unlock)
  • Query the HCL Workload Automation relational database for:
    • event rule definitions filtered by:
      • rule, event, and action properties
      • jobs and job streams involved with the rule action
    • event rule instances, actions run, and message log records
  • Manage the event processing server and monitoring engines, as described in tables conman commands for managing monitoring engines and conman commands for managing the event processing server

See the Dynamic Workload Console documentation:

Creating an event rule.

Creating an event monitoring tasks.
conman

Manage the monitoring devices, namely the event processing server and monitoring engines, as described in tables conman commands for managing monitoring engines and conman commands for managing the event processing server.

See Managing objects in the plan - conman for command reference.
utility commands

Create custom event definitions and manually send custom events to the event processing server. See evtdef and sendevent for details on these commands.
planman Manually deploy new and changed rules.

See Deploying rules for details.
Security file Set security authorizations to manage event rules, events, actions, and their instances.

See the HCL Workload Automation Administration Guide for reference about configuring the HCL Workload Automation security file.
Important: If you use a security firewall, make sure that the ports defined in global option eventProcessorEIFPort and in the nm port local option on each agent are open for incoming and outgoing connections.