Categories: USER GUIDE NOTIFICATIONS ENTERPRISE

Notifications

If you’ve purchased the Notification package or are running the Premium Enterprise version of step, you’ll be able to receive notification based on the status of a test plan execution.

Currently only E-mail notification are supported, follow below steps to first define a notification gateway and then setup notification trigger on your test plan.

Define your notification gateways

To create a notification gateway , navigate to Admin > Settings > Notification gateways and click on the New button on the top right :

Fill in below fields accordingly to the email account you want to use :

  • Name : the name of your gateway
  • Type : the gateway type, currently only E-Mail Gateway is supported.
  • From Address : the address that will be used to send the email notification
  • From Name : the name that will be displayed in the email notification
  • SMTP Server host : the SMTP server hostname
  • SMTP Server port : the SMTP server port
  • Username : the username to access the email account
  • Password : the password to access the email account

Example

Example below is using a Gmail account in order to setup a gateway :

Follow this link for more information about Google SMTP servers configuration.

Setup your notification triggers

Now that you have defined a notification gateway, you will have to create a trigger on the test plan you want to receive notification from.

Create your test plan,execute it, open the last execution then click on the Add notification link on the bottom right :

Fill in below fields accordingly to the kind of notification you want to receive :

  • Event : could be either Execution ended or Execution failed
  • Gateway : select the gateway your previously defined
  • Recipient : enter here the email address of the recipient. Note that this field is dynamic and supports Groovy evaluation to define the recipient.

Example

Keyword “Notification_Send”

A LocalFunction keyword, pre-populated by default in the enterprise edition of step, allows you to send personalized notifications using the gateways you have set up previously:

The expected inputs are:

  • gatewayId : the name of the gateway your previously defined
  • sendTo : the destination of the notification
  • subject: the subject of your message
  • message: the body of your message
  • sendExecutionLink (optional): test it to false to remove the execution link from the message body. By default this link is added at the end of the message

Notification subscription view

You can see all the notification subscriptions directly from the associated view, accessible via the top level as in the below screenshot :

You can also edit and delete any subscription from this view :

See Also