External Alerts Fields and Templates

The following topics describe the fields in external alerts that are sent from Helix Control-M to external tools, such as an event management system, and how you can control these fields through the use of templates that you provide when you run the run alerts:stream:template::set command:

• External Alerts Default Fields: Describes the default combination of fields in external alerts.

• Setting Fields Using a Template: Describes how to use a template to customize fields in external alerts.

• Changing Field Names After Migrating from Control-M: Describes how to use a template to set pre-migration names for fields in external alerts.

• Restoring All Default Fields: Describes how to use a template to revert to the default combination of fields in external alerts.

External Alerts Default Fields

The following table lists the default alert fields provided by Helix Control-M. It also includes the names of the corresponding fields in Control-M, for a migration from Control-M to Helix Control-M.

* In the case of a migration from Control-M to Helix Control-M, backward compatibility for this field enables you to continue using the same scripts for external alert handling.

Setting Fields Using a Template

This procedure describes how to use a template to customize fields in external alerts and override the default combination of fields provided by Helix Control-M. In your template you control which fields to include in an alert (a subset of the default fields), the names of the fields, and the order of their appearance.

Begin

1. Create a template in JSON format with your combination of fields for external alerts.

   The following sample template sets a group of five fields of alert details. Of these five fields, three fields are renamed and two fields remain with their original names.

   Copy

   {
       "alertFields":
       [
           {"id":"alertId"},
           {"application":"businessUnit"},
           {"message":"message"},
           {"time":"date_and_time"},
           {"jobName":"jobName"}
       ]
   }

2. Run the run alerts:stream:template::set command to submit your template.

The following alert includes the fields defined in the submitted sample template, in the same order of appearance:

{
    "fields":
    [
        {"alertId":"650"},
        {"businessUnit":"ACCT"},
        {"message":"SHOUT TO Alertscript FAILED Shout to Destination Alertscript failed."},
        {"date_and_time":"20220120070014"},
        {"jobName":"J1"}
    ]
}

Changing Field Names After Migrating from Control-M

This procedure describes how to use a template to change the names of all fields in external alerts to their pre-migration names in Control-M. Use this template if you have migrated from Control-M to Helix Control-M and want to continue using your existing scripts to handle external alerts.

Begin

1. Create a template in JSON format to rename all fields to their previous names in Control-M:

   Copy

   {
     "fields":
     [
       {"eventType":"call_type"},
       {"id":"alert_id"},
       {"server":"data_center"},
       {"fileName":"memname"},
       {"runId":"order_id"},
       {"severity":"severity"},
       {"status":"status"},
       {"time":"send_time"},
       {"user":"last_user"},
       {"updateTime":"last_time"},
       {"message":"message"},
       {"runAs":"run_as"},
       {"subApplication":"sub_application"},
       {"application":"application"},
       {"jobName":"job_name"},
       {"host":"host_id"},
       {"type":"alert_type"},
       {"closedByControlM":"closed_from_em"},
       {"ticketNumber":"ticket_number"},
       {"runNo":"run_counter"},
       {"notes":"notes"}
     ]
   }

2. Run the run alerts:stream:template::set command to submit your template.

Restoring All Default Fields

This procedure describes how to use a template to revert to the default combination of fields in external alerts after you have customized the fields (as described in Setting Fields Using a Template).

Begin

1. Create a template in JSON format to reset the default fields:

   {    
       "fields": [
           {"eventType": "eventType"},
           {"id": "id"},
           {"server": "server"},
           {"fileName": "fileName"},
           {"runId": "runId"},
           {"severity": "severity"},
           {"status": "status"},
           {"time": "time"},
           {"user": "user"},
           {"updateTime": "updateTime"},
           {"message": "message"},
           {"runAs": "runAs"},
           {"subApplication": "subApplication"},
           {"application": "application"},
           {"jobName": "jobName"},
           {"host": "host"},
           {"type": "type"},
           {"closedByControlM": "closedByControlM"},
           {"ticketNumber": "ticketNumber"},
           {"runNo": "runNo"},
           {"notes": "notes"}    
       ] 
   }

2. Run the run alerts:stream:template::set command to submit your template.

   External alerts fields are restored to the default combination, as described in External Alerts Default Fields.