Skip to main content

Set up email notifications

Configure Test Services to email a summary of test results to one or more recipients. This page is for Test Services administrators who want to keep their lab informed of test outcomes without checking the application. Notifications cover every test run on a machine, both manual and scheduled.

Prerequisites

  • You must have the Test Services Administrator role. (The notification settings are read-only for the Test Services User role.)
  • The email server must be configured in OpenLab Control Panel. (Test Services sends mail through OpenLab Shared Services and cannot enable notifications until the email server is set.)
  • You need the email addresses of everyone who should receive the reports.

Notifications are disabled by default. The settings you save are shared with every Test Services instance connected to the same server.

Enable notifications​

You turn notifications on, add recipients, and choose which reports to send from the Settings page.

  1. Click the Settings icon in the navigator.

  2. Under Notification Settings, click Enable.

    The notification fields become active.

    Notification Settings panel with the Send Emails To field and report type check boxes

    Figure 9. The Notification Settings panel on the Settings page.

  3. In Send Emails To, enter one or more recipient addresses, separated by semicolons.

  4. Select the reports to send (see Choose which reports to send).

  5. Scroll to the bottom of the Settings page and click Save.

note

If the email server is not configured in OpenLab Control Panel, an error appears and the notification fields cannot be saved. Set the email server in OpenLab Control Panel first, then return to this page.

Choose which reports to send​

Test Services sends two kinds of report: periodic summaries on a fixed cadence, and immediate alerts when a test reports an error or a warning. Select any combination that suits your lab.

  • Send Daily Test Execution Report covers all tests run in the previous day.
  • Send Weekly Test Execution Report covers all tests run in the previous week, ending on Sunday.
  • Notify immediately on errors emails recipients when a test reports an error.
  • Notify immediately on warnings emails recipients when a test reports a warning.

For the daily and weekly reports, you also set when they are sent. Enter the send time next to each report in 24-hour hh:mm format (for example, enter 6:30 PM as 18:30), and choose the day of the week for the weekly report. These fields are shown in the figure above.

Under Notification Options, you can refine the content and volume:

  • Exclude details for passed tests keeps passed tests in the subject line and the summary count table but leaves their detail rows out of the email.
  • Send no more than limits the number of immediate notifications sent within a set number of minutes.

Each report email lists the tests run during the period, grouped by result status, with a link to open each Summary report. A report opens on the machine that ran the test, so a link may first take you to that machine's Test Services login page, where you log in to view the report. For a test that has no individual report, such as an aborted or not-available result, the link opens the login page instead.

Daily notification email listing executed tests grouped by result status

Figure 10. An example daily report email listing the tests run, grouped by result.

Send a test email​

Send a test email to confirm that Test Services can reach the email server before you rely on scheduled reports. Test Services has no test-email button; instead, you open a health-check URL in a browser. This sends an email using the saved notification settings and the SMTP configuration from OpenLab Control Panel.

  1. Make sure email notifications are enabled and saved (see Enable notifications).

  2. In a browser, go to https://<server:port>/openlab/testservicesserver/v1/health/email, replacing <server:port> with your Test Services address.

    For client/server systems, the server is the address of OpenLab Server (or the OLSS server for an ECM 3.x backend). For a Workstation or Workstation Plus, it is the machine itself — for example, https://localhost:52088/openlab/testservicesserver/v1/health/email.

    Test Services sends a message with the subject Test Services Test email to the configured recipients.

note

You can send a test email only from a server, Workstation, or Workstation Plus machine — not from a client or AIC.

If the test email does not arrive, see Email notifications are not working.

Disable notifications​

Disabling notifications stops all report emails while keeping your recipients and report choices for later.

  1. Click the Settings icon in the navigator.

  2. Under Notification Settings, click Disable.

  3. Scroll to the bottom of the Settings page and click Save.

    To resume, click Enable and then Save. Your previous settings are restored.

See also​