Defining custom events

In addition to the already defined event types and event classes (known as providers) listed in detail in Event providers and definitions, HCL Workload Automation supplies the template of a generic event provider named GenericEventPlugIn that programmers with specific application and XML programming skills can modify to define custom event types that might be of use to the organization.

The tools supplied to define custom event types are:
  • The GenericEventPlugIn event provider in XML
  • The evtdef utility command with which a programmer can download the GenericEventPlugIn event provider as a local file to define the custom events
  • The XML schema definition (XSD) files necessary to validate the modified generic event provider. They also contain online guidelines to aid in the programming task.
  • The sendevent utility command with which the custom events can be sent to the event processing server to trigger rules from any agent or any workstation running simply the HCL Workload Automation remote command line client.
This is the flow for defining and using custom events:
  1. With the evtdef command, the programmer:
    1. Downloads the generic event provider as a local file.
    2. Follows the schema definitions to add custom event types and to define their properties and attributes in the file with an XML editor.
    3. Uploads the local file as the modified generic event provider containing the new custom event type definitions. The modified generic event provider is saved in an XML file on the master domain manager.
  2. The rule builder, or the administrator, defines, with either composer or the Dynamic Workload Console, the event rules that are to be triggered by these custom events, specifying:
    • The generic event provider as the event provider
    • The custom event types as the event types
    • The custom event type properties (or attributes) defined for the custom events in the generic event provider with the particular values that will trigger the rules.
  3. Deploy the rules.
  4. When the occurrence of a custom event takes place, it can be sent to the event processing server by the sendevent command, run from a script or from the command line

    As soon as the event is received by the event processing server, it triggers the rule.

    Note: Custom events (in event rules) must be added manually after an upgrade.

    When you upgrade, the “custom events” are not migrated.

    You should add them manually as follows:

    1. 1: On MDM: $ evtdef dumpdef <file_name>

      where <file_name> is the name of a new XML file to where your custom events are saved.

    2. switchmgr to BKM

    3. Copy the file created in step 1 to BKM.

    4. On BKM: $ evtdef loaddef <file_name>

    5. Stop DWC Liberty

    6. Start DWC Liberty with "-directclean" option.

      <DWC_HOME>/appservertools/startAppServer.sh -directclean