Send email notifications from Analytics

Concept Information

NOTIFY command

You can send email notification messages from Analytics to one or more recipients. Messages can include attached data files and Analytics projects.

A common use of email notifications is to alert the appropriate personnel when a script fails unexpectedly.

How email notification works

The Analytics notification feature submits an outgoing email message to an SMTP mail server (Simple Mail Transfer Protocol server). The mail server, in turn, relays the message to recipients. The connection between Analytics and the mail server can be authenticated or unauthenticated. An unauthenticated connection is no longer the norm for modern email systems.

Compatible SMTP servers

The Analytics email notification feature works with a wide range of SMTP servers requiring authenticated connections. However, notification does not work with all SMTP servers or services. For example, the notification feature does not work with Gmail. For third-party apps to connect to a Google account requires a security configuration beyond the user name and password supported by Analytics.

In general, be aware that successfully using Analytics to submit outgoing emails to an SMTP server requires a compatible configuration on the Analytics side, and also on the SMTP server side. If Analytics is failing to connect and successfully send emails, work with your IT department to make sure a compatible connection configuration exists between Analytics and the server.

Send email messages using an authenticated SMTP connection

Note

You must be using Analytics version 16.1 or later to set up an authenticated SMTP connection through the user interface. If you are using version 16.0, setting up an authenticated connection is supported only in scripts. For more information, see NOTIFY command.

Versions of Analytics earlier than 16.0 do not support authenticated connections with an SMTP mail server.

Use the Analytics user interface to set up email notification using an authenticated connection with an SMTP mail server. Most modern email systems require authenticated connections.

The benefit of setting up the connection through the user interface is that Analytics creates the ACLScript syntax for you. Once you have configured a connection that works, you can copy the syntax from the command log to a script.

  1. From the Analytics main menu, select Tools > Notify by Email.

    The Notify dialog box opens.

  2. Select SMTP and complete the following information:
    • SMTP User (optional) Enter the name of the user account to authenticate against and access the SMTP server.

      You can leave this field blank and the email address specified by Sender is used to authenticate against and access the SMTP server.

    • Port Enter the port number to use to access the SMTP server.

      You may need to contact your IT department to find out which port you should use. Common port numbers for SMTP servers are:

      • 587
      • 2525
      • 465
    • SSL Optional. Select SSL if the SMTP server requires a secure SMTP/SSL connection.

      You may need to contact your IT department to find out if the SMTP server requires an SSL connection. Or send test emails with and without SSL selected.

  3. Complete the following information:
    • Sender – Enter a sender email address for the email messages sent via the SMTP server.
    • Password – Enter the password for the sender email account.

      The password is automatically encrypted by Analytics and the encrypted version appears in the log. For more information, see Generating an encrypted password.

    • Mailbox Path – Enter the domain name of the SMTP server to use to send the email message.

      For example: smtp.example.com

    • To – Enter the email address of one or more recipients. Separate multiple email addresses with a comma.

      Note

      Enter a maximum of 1020 characters.

    • Cc – Optional. Enter the email address of one or more carbon copy recipients. Separate multiple email addresses with a comma.

      Note

      Enter a maximum of 1000 characters.

    • Bcc – Optional. Enter the email address of one or more blind carbon copy recipients. Separate multiple email addresses with a comma.
    • Subject – Enter the subject line of the email message.
    • Text – Enter the body text of the email message.

      The message is plain text and does not support HTML. If you want to insert a line break in the message, use two carat characters: ^^

    • Attachment – Optional. Specify the path and file name of one or more attachments, or click Browse to open the Select File dialog box.

      You do not have to specify a path if the file is located in the same folder as the Analytics project.

      Specify multiple attachments by entering a comma-separated list of files. For example: result1.csv,result2.csv

      Note

      In a comma-separated list, make sure there are no spaces after the commas.

  4. Click OK.

    Analytics submits the email to the SMTP mail server to be relayed to the recipients.

    If the connection attempt between Analytics and the mail server fails, Analytics automatically retries the connection for a specified number of times. For more information, see How Analytics responds to failed connection attempts.

Send email messages using an unauthenticated connection

Use the Analytics user interface to set up email notification using an unauthenticated connection with an SMTP mail server, or with a local mail system. An unauthenticated connection is no longer the norm for modern email systems.

An unauthenticated connection from Analytics to an open SMTP server uses port 25, which must be open on the server for the connection to be successful.

The benefit of setting up the connection through the user interface is that Analytics creates the ACLScript syntax for you. Once you have configured a connection that works, you can copy the syntax from the command log to a script.

  1. From the Analytics main menu, select Tools > Notify by Email.

    The Notify dialog box opens.

  2. Make sure SMTP is not selected.
  3. Complete the following information:
    • Sender – Enter a sender email address for the email messages sent via the SMTP server or the local mail system.
    • Password – If a password is required for the sender email account, enter the password.

      The password is automatically encrypted by Analytics and the encrypted version appears in the log. For more information, see Generating an encrypted password.

    • Mailbox Path – Enter the domain name of the SMTP server to use to send the email message.

      For example: smtp.example.com

      If you are using a local mail system, enter the path to a local mailbox or click Browse to open the Browse for Folder dialog box.

    • To – Enter the email address of one or more recipients. Separate multiple email addresses with a comma.

      Note

      Enter a maximum of 1020 characters.

    • Cc – Optional. Enter the email address of one or more carbon copy recipients. Separate multiple email addresses with a comma.

      Note

      Enter a maximum of 1000 characters.

    • Bcc – Optional. Enter the email address of one or more blind carbon copy recipients. Separate multiple email addresses with a comma.
    • Subject – Enter the subject line of the email message.
    • Text – Enter the body text of the email message.

      The message is plain text and does not support HTML. If you want to insert a line break in the message, use two carat characters: ^^

    • Attachment – Optional. Specify the path and file name of one or more attachments, or click Browse to open the Select File dialog box.

      You do not have to specify a path if the file is located in the same folder as the Analytics project.

      Specify multiple attachments by entering a comma-separated list of files. For example: result1.csv,result2.csv

      Note

      In a comma-separated list, make sure there are no spaces after the commas.

  4. Click OK.

    Analytics submits the email to the SMTP mail server or the local mail system to be relayed to the recipients.

    If the connection attempt between Analytics and the mail server or the mail system fails, Analytics automatically retries the connection for a specified number of times. For more information, see How Analytics responds to failed connection attempts.