Defining E-Mail Settings

Edit online

About this task

You can configure the Analytic Engine to send an e-mail when a rule is violated that contains an alert to a specified recipient. E-mail alerts are formatted according to alert templates. When a certain rule is violated, you can specify that the e-mail alert that is sent is formatted according to the specified alert template. You can specify multiple template property tags to create multiple rule and alert template-file combinations.

When an e-mail alert is formatted, the Analytic Engine attempts to retrieve the template from the location specified in the Mail Settings panel, according to the following two options:

  • If no template is specified or if the template cannot be found, the e-mail alert is formatted with the default formatting. The default formatting cannot be changed. For more information about creating custom alert templates, see the PDF publication Administering IBM webMethods Optimize.
  • If a template is specified, the e-mail alert is formatted using that specified template.

To define e-mail settings

Procedure

  1. In My webMethods: Navigate > Applications > Administration > System-Wide > Environments > Define Environments.
  2. On the Define Environments page, click the name of the environment you want to work with.
  3. On the Edit Environment page, click the Configure Servers tab.
  4. Under the appropriate Analytic Engine logical server node in the configuration tree, click Mail Settings.

    A new area appears beside the configuration tree, labeled Mail Settings for Analytic Engine.

  5. Configure the Mail Settings forAnalytic Engine.
    The following table provides information about the Mail Settings for Analytic Engine.
    Field Description
    Mail Server Name of the host system on which the SMTP server resides that sends e-mail containing alerts. For example, this server might be smtp.client.com.
    Authentication Required Click this check box if the server requires user authentication.
    Server User User ID that is required if the server uses authentication.
    Server Password Password that is required if the server requires authentication.
    Sender Domain E-mail domain for the e-mail address specified in the Default Sender field (such as webmethods.com).
    Default Sender Sender to specify in the From field of the alert e-mails. Make sure the e-mail address provided in this field is within the e-mail domain specified in the Sender Domain field.
    Admin Address E-mail address of the recipient that you want to receive copies of e-mail alerts. The e-mail address in this field is also used as the default address for sending test e-mail messages.
    Socket Timeout The amount of time in seconds before the Analytic Engine terminates an idle connection with the SMTP server.
    Default Mail Encoding Default encoding to use for e-mail that is sent to users. You can specify any MIME registered encoding name. The default value is UTF-8.
    Templates Used to specify e-mail alert templates and to assign those templates to specific rules. When a rule is violated, the e-mail alert that gets sent will be formatted based on the associated alert template. If no rule or alert template is specified, the Analytic Engine uses the default format for the e-mail alert. For more information about creating custom alert templates, see the PDF publication Administering IBM webMethods Optimize.
  6. Click Test if you want to test the SMTP server connection. This button tests the connection and sends a message to the admin e-mail address.
  7. Click Save to save changes or click Cancel to discard any changes you have made in this settings area.

    If you click Finish without first clicking Save, any changes made to these settings will be lost.

  8. To configure another logical server subcomponent, click the name of that subcomponent in the configuration tree.
  9. Click Finish to close this page and return to the Define Environments page.