KPIs for HCL Workload Automation
Find out the HCL Workload Automation KPIs managed by AIDA.
KPIs definitions and data retrieval frequency are defined into a json file inside HCL Workload Automation. This file is retrieved by AIDA Exported component once a day.
KPIs definitions and KPIs metrics cannot be modified by AIDA users.
For details about HCL Workload Automation exposed metrics, see Exposing metrics to monitor your workload in the HCL Workload Automation User's Guide and Reference.
For details about HCL Workload Automation for Z exposed metrics, see Exposing metrics to monitor your workload in the HCL Workload Automation for Z Managing the Workload.
AIDA also collects a special KPI named Job history, containing the start time, the end time, and the duration for each job that has been defined in HCL Workload Automation with the advanced analytics option enabled and for all its predecessor jobs. This KPI generates one data point per day (frequency = 1 day).
On a daily basis, AIDA Orchestrator component checks the KPIs against their prediction to detect anomalies.
HCL Workload Automation KPIs are grouped in the following categories:
| Category | KPI name | Metric name | Description | Data frequency |
| Jobs | Job history | job_history | Start time, end time, and duration of each job with the advanced analytics option enabled and all its predecessor jobs. | 1 data point per each daily job executions (86400 seconds) |
| Total jobs in plan | application_wa_JobsInPlanCount_job_total | The total number of jobs in the current plan. | 1 data point every 4 minutes (240 seconds) | |
| Jobs in plan by status | application_wa_JobsInPlanCount_job | Jobs in the current plan with a specific status. The status can be: WAITING, READY, RUNNING, SUCCESSFUL, ERROR, CANCELED, HELD, UNDECIDED, BLOCKED, and SUPPRESS. | 1 data point every 4 minutes (240 seconds) | |
| Jobs in plan by workstation | application_wa_JobsByWorkstation_jobs | Jobs in the current plan, with a specific status, running on a specific workstation. | 1 data point every 4 minutes (240 seconds) | |
| Jobs in plan by folder | application_wa_JobsByFolder_jobs | Jobs in the current plan, with a specific status, in a specific folder. | 1 data point every 4 minutes (240 seconds) | |
| Queue | WA Message files fill percentile | application_wa_msgFileFill_percent | Internal message queue usage for Appserverbox.msg, Courier.msg, mirrorbox.msg, Mailbox.msg, Monbox.msgn, Moncmd.msg, auditbox.msg, clbox.msg, planbox.msg, Intercom.msg, pobox messages, and server.msg | 1 data point every 4 minutes (240 seconds) |
HCL Workload Automation KPIs json file
In the KPIs json file, each entry defines a KPI. The frequency parameter represents the frequency of the KPI data retrieval, expressed in seconds. This file cannot be modified by users.
See the KPI json file used by HCL Workload Automation.
[
{
"name": "Job history KPI",
"metric_name": "job_history",
"frequency": 86400,
"category": "Jobs",
"subcategory": "history",
"labels":[
"job"
],
"keyprop":"attributes",
"keyPropValues":["duration"],
"type":"records"
},
{
"name": "Total jobs in plan",
"metric_name": "application_wa_JobsInPlanCount_job",
"frequency": 240,
"category": "Jobs",
"subcategory": "Trend",
"type":"total"
},
{
"name": "Jobs in plan by status",
"metric_name": "application_wa_JobsInPlanCount_job",
"frequency": 240,
"category": "Jobs",
"subcategory": "Trend",
"keyprop": "jobstatus"
},
{
"name": "Jobs in plan by workstation",
"metric_name": "application_wa_JobsByWorkstation_jobs",
"frequency": 240,
"category": "Jobs",
"subcategory": "Trend_by_wks",
"keyprop": "jobstatus",
"labels": [
"workstation"
]
},
{
"name": "Jobs in plan by folder",
"metric_name": "application_wa_JobsByFolder_jobs",
"frequency": 240,
"category": "Jobs",
"subcategory": "Trend_by_folder",
"keyprop": "jobstatus",
"labels": [
"folder"
]
},
{
"name": "WA Message files fill percentile",
"metric_name": "application_wa_msgFileFill_percent",
"frequency": 240,
"category": "Queue",
"subcategory": "Msg file fill",
"keyprop": "msgfile"
}
]