Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Usually, notifications are configured to be delivered to the "current assignee" (e.g. the Test Run assignee or the Test Execution assignee, depending on the context). Nevertheless, it's possible to configure other stakeholders, such as the watchers, to be notified on the changes related with Test Runs. 

Table of Contents

How it works

Xray reuses the notifications mechanism provided by Jira; this simplifies a lot the management of Test Run notifications.

...

However, by default, no notifications will configured for those events upon installation; you'll need to add, and therefore enable, them explicitly.

Global settings

There are some global settings related with Test Run notifications. For more information on these settings, please see Global Preferences.


Project Setup

Quick setup

Enable notifications

There is a quick setup, that will create a notification for each Test Run related event and will configure it for the "current assignee".

...

  1. go to project settings => Summary
  2. from the Actions menu, choose "Enable Test Run notifications". Note that this will impact the Notification Scheme being used by this project and all other projects that also use it.
  3. For each Test Run related event, a notification will be created and assigned to the "current assignee"; please have a look at the Events section below, for clarification on the meaning of this specific recipient.

Disable notifications

There is a quick way to "disable" (i.e. remove) notifications for each Test Run related event.

...

  1. go to project settings => Summary
  2. from the Actions menu, choose "Disable Test Run notifications". Note that this will impact the Notification Scheme being used by this project and all other projects that also use it.


Detailed setup

In order to enable notifications in some project, you need to:

  1. go to project settings => Notifications
  2. from the Actions menu, choose "Edit notifications". Note that this will impact the Notification Scheme being used by this project and all other projects that also use it.
  3. in each Test Run related event, click on "Add" in order to add a notification to the related Notification Scheme
  4. in the notification configuration page, besides the Event that will be pre-selected, define who shall receive the email notifications related with that event

     

Events

Test Run Assigned

The aim of this event is to notify a user (or users) that a Test Run has been assigned, so the tester can proceed with testing.

...

  • Whenever a specific Test Run is individually assigned to some user (e.g. in the Test Execution screen), the "Test Run Assigned" event is triggered;
  • Whenever a Test Execution is created, all Test Runs are assigned by default to the Test Execution assignee. In this case, the "Test Run Assigned" event is not triggered (possibly, the user will be already notified because of issue created event);
  • Whenever several Test Runs are assigned to some user using the bulk operation, in the Test Execution screen, the user is asked if email should be sent (i.e. if the event should be triggered).


    Info
    titlePlease note

    The "Send mail" option is only available if there is a notification assigned to the "Test Runs Assigned" event.

Test Run Status set to Final

The aim of this event is to notify users that a Test Run has been complete/finished (i.e. its current status is a final one).

...

  • Whenever a specific Test Run is changed to a final status (e.g. in the execution screen or as an inline change), the "Test Run Status set to Final" event is triggered;
  • Whenever several Test Runs are changed to a final status using the bulk operation, in the Test Execution screen, the "Test Run Status set to Final" event is triggered for each "Test Run".

Precedent Test Run Status set to Final

The aim of this event is to notify a user (or users) whenever a different user has finished running the previous Test, in the context of some Test Execution involving multiple testers.

...