Notification Destinations

The Notification Destinations tool enables you to change the destinations defined in Notifications before Job Completion, Notifications after Job Completion, or Notify If-Actions without the need to manually update the job properties of every job. In the tool, you can create multiple lists of destinations and activate the lists that you want jobs to send notifications to, depending upon the unique schedule of your organization.

A local municipal Department of Transportation (MDT) has three shifts of workers that it must send updates to at the beginning of every shift. To accomplish this, MDT does the following:

  • Three notification destination lists are created, one for each shift: Morning, Evening, and Night.

  • Each list contains the same destination name: MDT-Shift-Mail.

  • Each list contains a different value for destination MDT-Shift-Mail: the email addresses for this shift of workers.

  • A notification after job completion action is added to cyclic job Rail_Line_Maintenance, which sends a notification to destination MDT-Shift-Mail, when the job ends OK.

  • At the beginning of each shift, the following occurs:

    • The notification destination list for the current shift is activated.

    • Cyclic job Rail_Line_Maintenance executes and sends an email to each worker on the current shift when it ends OK.

You can define and save many notification destination lists, but you can only activate one list at a time.

For more information about notifications, see Actions.

You can also use the ctmshout utility to define and manage notification destination lists.

Creating a Notification Destinations List

This procedure describes how to create a list of destinations where your notifications are sent. You can type this list name in the Destination field in Notifications before Job Completion, Notify If-Actions, or Notifications before Job Completion actions in the job definitions.

Before You Begin

  • Verify that your user role has Full Configuration permissions in the Admin Management section in Configuration in Access Control, as described in User and Role Authorizations.

Begin

  1. From the icon, select Configuration.

    The Configuration domain appears.

  2. From the list of Quick Actions in the Home tab, select Manage Notification Destinations.

    The Notification Destinations dialog box appears.

  3. From the Server drop-down list, select a Server.

  4. Click .

    The Add Notification Destinations List dialog box appears.

  5. In the List Name field, define a unique list name and click Next.

    The Add First Destination dialog box appears.

  6. Do the following:

    1. In the Destination Name, define a logical name for your destination.

    2. From the Address drop-down list, which determines the source of the notification, select one of the following options:

      • Agent: Sends a notification to a destination from the Agent.

      • Server: Sends a notification to a destination from the Server.

    3. From the Destination drop-down list, select one of the following options:

      • Mail: Sends an email to one or more email addresses that you define in the Value field. By default, you must separate email addresses with a ;.

      • Log: Sends a notification to the job log.

      • Program: Executes a script or program that sends one or more notifications. You must type the full pathname in the Value field.

      • Control-M/EM: Sends a notification to the Alerts window, as described in Alerts.

      • Terminal: Sends a notification to the terminal or operating system that you define in the Value field.

  7. Click Save.
    The new list appears in the Notification Destinations List.

  8. (Optional) Click to add another destination.

  9. Click Done.

    The new notification destination list appears in the Notification Destination Lists section of the Notification Destinations dialog box.

  10. (Optional) To activate this list, click Activate next to a notification destination List Name, and click Activate in the confirmation dialog box that appears.

    The active notification destination list moves to the top of the Notification Destination Lists area and the Status appears as Active.