Skip to content
CA Workload Automation AE & Workload Control Center
Documentation powered by DocOps

Send Email Notifications

Last update August 1, 2018

You can configure CA Workload Automation AE to send email notifications to operators or administrators who resolve problems or attend to emergencies. When you define a job to send an email notification, the scheduler sends the email notification during terminal status processing. Messages are written to the scheduler log indicating whether the email notification was sent successfully.

To send an email notification using CA Workload Automation AE, follow these steps:

  1. Configure CA Workload Automation AE on UNIX or Windows.
  2. Specify the notification attributes in your job definition.

(UNIX) Configure CA Workload Automation AE to Send Email Notifications

You can configure CA Workload Automation AE to send email notifications to operators or administrators who resolve problems or attend to emergencies.

Follow these steps:

  1. Log in to CA Workload Automation AE as a user authorized to stop the scheduler and run the shell that is sourced to use CA Workload Automation AE.
  2. Enter the following command at the operating system prompt:

    unisrvcntr status waae_sched.$AUTOSERV

    The scheduler process ID is displayed as follows:

                   CA Services Status Report
               Component Name               Pid        Status    
    ------------------------------------  -------  --------------
    WAAE Scheduler (ACE)                    32220  runnin
  3. Edit the following parameters in the configuration file, and save the file:

    NotifyMethod=0|1

    • 0
      Specifies that CA Workload Automation AE does not send notifications to operators or administrators even if you specify the notification attributes in the job definition. This is the default.
    • 1
      Specifies that CA Workload Automation AE sends email notifications to operators or administrators.
    Note: If you set this parameter to 1, specify the Simple Mail Transfer Protocol (SMTP) server host name and port number in the NotifySMTPHost parameter.

    NotifySMTPHost=hostname:port

    • hostname
      Defines the host name of the SMTP server.
    • port
      Defines the port number the SMTP server uses to send email notifications. Do not specify this value if the SMTP server is using the default port.
      Default: 25

    Example: SMTPserver:333

    UseSMTPAuthentication=0|1

    NotifySMTPUser=user@email_domain.com/password

    NotifySMTPFromAddress=email_address

    • 0
      Specifies that the SMTP server does not require authentication to send an email. This is the default.
    • 1
      Specifies that the SMTP server requires authentication to send an email.

      Note: Check with your administrator and set this parameter to 1 only if the SMTP server requires authentication to send an email.
    • user@email_domain.com/password
      Defines the user name and the associated password that is used to connect to the SMTP server.

      Notes:

      • Specify the user name in the form of an email address. For example, specify user@example.com.
      • Use the autosys_secure interactive utility to get the encrypted password and then add this encrypted password in the configuration file. Follow these steps to get the encrypted password:

        1. Open the UNIX operating system and run the shell that is sourced to use CA Workload Automation AE.
          The operating system command prompt appears.

        2. Enter the following command:
          autosys_secure
          The interactive menu appears.

        3. Type 6 and press the Enter key.
          The Get encrypted password submenu appears.

        4. Type 1 and press the Enter key.
          The utility prompts you to specify your password.

        5. Type your password in plain text and press the Enter key. Confirm your password and press the Enter key.
          The utility displays the encrypted password.

    • email_address
      Defines a valid SMTP from email address. 
      Default: CA WAAE.XXX.DO_NOT_REPLY; XXX specifies the name of the CA Workload Automation AE instance.

      Note: You can use $$XXX$$ to specify the name of the CA Workload Automation AE instance. For example, if you set the value to Mail.From. $$XXX$$@xyz.com, the SMTP from email address is displayed as Mail.From.ACE@xyz.com, where ACE is the name of the CA Workload Automation AE instance.
  4. Enter the following command at the operating system prompt:

    kill -HUP scheduler_pid

    • scheduler_pid
      Defines the process ID of the scheduler to pause and resume.
    The scheduler resumes. CA Workload Automation AE is configured to send email notifications.

Notes:

  • If you specify an invalid email address, CA Workload Automation AE does not send the email notification. A login denied error message is displayed in the scheduler log after the terminal status events are processed. CA Workload Automation AE does not send the email notification even if one of the multiple email addresses you specified is invalid.
  • For better readability, view the email notification as plain text. This may require a change to the font used by your email editor.

(Windows) Configure CA Workload Automation AE to Send Email Notifications

You can configure CA Workload Automation AE to send email notifications to operators or administrators who resolve problems or attend to emergencies.

Follow these steps:

  1. Click Start, Programs, CA, Workload Automation AE, Administrator.
  2. Select an instance from the Instance drop-down list in the Settings pane.
  3. Click the Integration icon on the toolbar.
    The Integration - CA Workload Automation AE Administrator window appears. The Notification tab is selected by default.
  4. Select Standard Email from the Method drop-down list in the Settings pane. 
    The SMTP Host, SMTP Server Requires Authentication, SMTP User, SMTP Password, and SMTP From Address fields appear.

    Notes:
    • If you select None from the Method drop-down list, CA Workload Automation AE does not send notifications even if you specify the notification attributes in the job definition.
    • The equivalent configuration parameter is NotifyMethod.
  5. Complete the following fields as appropriate, and click Apply.
    • SMTP Host 
      Specifies the Simple Mail Transfer Protocol (SMTP) server host name and port number the scheduler sends the email to.
      Example: SMTPserver:333

      Notes:
      • The default port number is 25. If the SMTP server is using the default port, you do not need to enter the port number in the SMTP Host field. However, if the SMTP server is using a port other than the default, enter the port number in the SMTP Host field. Use a colon to separate the SMTP server host name and port number values.
      • The equivalent configuration parameter is NotifySMTPHost.
    • SMTP Server Requires Authentication
      Specifies whether the SMTP server requires authentication to send an email.

      Notes:
      • The SMTP Server Requires Authentication check box is not selected by default. Verify with your administrator and select this check box only if the SMTP server requires authentication to send an email.
      • The equivalent configuration parameter is UseSMTPAuthentication.
    • SMTP User
      Defines the user name that is used to connect to the SMTP server. 
      Example:user@example.com

      Notes:
      • Enter the user name in the form of an email address.
      • The SMTP User field is enabled only if you select the SMTP Server Requires Authentication check box.
      • The equivalent configuration parameter is NotifySMTPUser.
    • SMTP Password
      Defines the password that is associated with the SMTP User.

      Notes:
      • The SMTP Password field is enabled only if you select the SMTP Server Requires Authentication check box.
      • The equivalent configuration parameter is NotifySMTPUser.
    • SMTP From Address
      Defines a valid SMTP from email address. 
      Default: CA WAAE.XXX.DO_NOT_REPLY; XXX specifies the name of the CA Workload Automation AE instance.

      Note: You can use $$XXX$$ to specify the name of the CA Workload Automation AE instance. For example, if you enter Mail.From.$$XXX$$@xyz.com, the SMTP from email address is displayed as Mail.From.ACE@xyz.com, where ACE is the name of the CA Workload Automation AE instance.

  6. Click the Services icon on the toolbar.
  7. Right-click the scheduler service, and click Pause.
  8. Right-click the scheduler service, and click Resume. 
    The scheduler resumes. CA Workload Automation AE is configured to send email notifications

Notes:

  • If you specify an invalid email address, CA Workload Automation AE does not send the email notification. A login denied error message is displayed in the scheduler log after the terminal status events are processed. CA Workload Automation AE does not send the email notification even if one of the multiple email addresses you specified is invalid.
  • For better readability, view the email notification as plain text. This may require a change to the font used by your email editor.

Specify the Notification Attributes

To send an email notification, specify the following notification attributes in your job definition:

Note: To send an email notification using an email notification template, set the send_notification attribute value to y or and specify the notification_template and the notification_emailaddress, notification_emailaddress_on_success, notification_emailaddress_on_failure, notification_emailaddress_on_terminate, or notification_emailaddress_on_alarm attributes in your job definition based on the job status or alarm you want to send the email notification for.

Example: Send an Email Notification When the Job Completes

This example specifies that an email notification must be sent to admin@example.com when job email_job_1 completes.

insert_job: email_job_1

machine: localhost

job_type: c

command: as_test -t 2

send_notification:1

notification_emailaddress:admin@example.com

notification_msg:"email_job_1 has completed"

Example: Send an Email Notification When the Job Fails

This example specifies that an email notification must be sent to admin@example.com when job email_job_fails fails.

insert_job: email_job_fails

machine: localhost

job_type: c

command: as_test -t 2 -e 2

send_notification:F

notification_emailaddress:admin@example.com

notification_msg:"email_job_fails has failed"

Example:  Send an Email Notification Using the Template When the Job Terminates

This example specifies that an email notification is sent to admin@example.com and terminate@example.com using the emailtemplate email notification template when email_job_2 terminates.

insert_job: email_job_2

machine: localhost

job_type: c

command: as_test -t 2 

send_notification: y

notification_template: emailtemplate

notification_emailaddress: terminate@example.com

notifcation_emailaddress_on_terminate: admin@example.com

Was this helpful?

Please log in to post comments.

  1. Bismarck Fuentes
    2017-11-08 04:45

    FYI: send_notification Accepted values are "0, 1, F, f, n, y".

    1. Sumitha Vatsavai
      2017-12-01 12:17

      Thank you. This information is documented in theĀ send_notification Attribute -- Specify Whether to Send a Notification page.