Monitor and respond to unplanned event or interruption of HCL Workload Automation objects using Jira action plug-in

​A JIRA plug-in is a new EDWA action plugin to open tickets, that eliminates manual efforts and speed up resolution greatly. It is a work management tool which offers functionalities to help the users to manage their work efficiently. 

Use this plugin to Create Issue in Jira when a job that matches a defined policy ends in error (Abend/Failed). It helps you monitor the solution from a single point of control.
 
You can use the JIRA feature to launch a predefined action in response to events that occur on the nodes where  HCL Workload Automation runs. This action creates a ticket on Jira server.

The main elements are:
·        Events
·        Actions

Events

An event represents a set of circumstances that match selected criteria. Events are divided into the following major categories:

HCL Workload Automation object related events

All the events relating to scheduling objects such as jobs, job streams, and workstations.

Note: Any change performed on a workstation referenced in a rule is not reported in the rule. For example, if you modify, update, or delete a workstation that is referenced in a rule, the rule ignores the change and continues to consider the workstation as it was when it was included in the rule.

File monitoring events

Events relating to changes to files and logs. File monitoring events are not supported on HCL systems.
This type of event is described in more detail in File monitor.

Generic events

Events used to manage custom events sent by external applications. You can write an XML file to define a custom event. A schema is provided to validate your XML, as well as a basic event template that you can use as a starting point. For more information, see the schemas for generic events. Events of this category are:

·         Changes in a resource of the operating system, such as processes and memory
·         Email received

Actions

You can only create a single action that creates a ticket on Jira server.
 
Let us learn how to use the Jira action plug-in
 
This plug-in helps to trigger issue (create issue) based on the HCL Workload Automation object related events such as jobs, job streams, workstations.
 
To use this plug-in, do the following things in Workload Automation:
-         Create an event rule
-         Add HCL Workload Automation plan events
-         Add Jira action
-         Review and save the changes.
 
This activity takes a short interval to deploy the newly created event rule to master domain manager. The status of an event rules can be monitored in Manage Event Rules page
 
Creating event rule
Login to Dynamic Workload Console and open the Design -> Create Event Rules page and create a new event rule with necessary information about the event rules.

Figure 1: Create Event Rule Page

Adding HCL Workload Automation plan events
 
Every event comes with a set of predefined information from the plan. In the Add event page you can filter the required job-related information for your requirements.
For example, the Job Status Changed event captures all the job-related information in the scheduler plan. You can filter the events based on the job status like FAIL/ABEND/ERROR.

Figure 2: Add Event Page

Figure 3: Add Event Page>Status

Adding Jira action

In the Add Action page provide the mandatory connection related information of the Jira server like URL of the Jira server, username, password, the project name on which the Jira issue must be created and a short description of the action. Apart from the mandatory information, you can assign the newly created issue to the default assignee using Assignee field and other required fields using custom parameter.
Note: The custom parameter should be in the format key=value.

Figure 4: Add Action Page

Figure 5: Add Action Page>Properties

Figure 6: Add Action Page>Properties

The event specific information is available to actions in the form of variables as mentioned in the above picture. It will be useful to add more accurate information about the events.
 
Save the event rule after filling all the required information of the action.

Monitoring actions

This page will give the status of the event rule.

Figure 7: Monitor Page

Once the changes are deployed into master domain manager the status will change to active.

Figure 8: Monitor Page>Status

Managing event rules

The Monitoring Triggered Actions page displays the information about the triggered action like success or failure and other information.

Figure 9: Monitor Triggered Action Page

Figure 10: Create Issue Page>Properties

​Are you curious to try out the Jira plug-in? Download the integrations from the Automation Hub and get started or drop a line at [email protected].

Reference:
​
To know more about event management, refer to the product document https://www.ibm.com/docs/en/workload-scheduler/9.5.0?topic=concepts-event-management

Author's Bios

Rabic Meeran K, Senior Engineer at HCL Technologies 

Responsible for design and develop integration plug-ins for Workload Automation. Having two decades of experience in creating software products to enterprise customers.

---

Saket Saurav, Tester (Senior Engineer) at HCL Technologies
 
Responsible for performing Automation and Manual Testing for different plugins in Workload Automation using Java Unified Test Automation Framework. Hands-on experience on Java programming language, Web Services with databases like Oracle and SQL Server. 

---

Preethi K V – Senior Software Engineer at HCL Software 
 
Preethi is an ardent information developer for different plugins in HCL Workload Automation in India, Bangalore. She works with the ID team to improve the documentation for Workload Automation and create videos to promote new features. She likes to analyze new features and improve her knowledge about technical components.