SentryOne Test Web Portal Notification Engine

The Notification Engine in the SentryOne Test Web Portal allows you to create notification subscriptions, as well as actions to take for those subscriptions across the events in your testing environment. You can apply message templates to events, or create custom message templates. The Notification Engine allows you to configure notification targets that can be used and reused across the subscriptions and events in your testing environment. 

Notification Subscriptions

Notification Subscriptions

SentryOne Test Notification SubscriptionsThe Notification Subscription page allows you to create and manage the notification subscriptions for test assemblies across your testing environment. Opening the page displays all of your current test subscriptions.

Page FunctionDescription
Subscription NameThe name of the test that you are subscribed to.
Event NameThe event outcome that your subscription is monitoring.

The following Event types are available:
Event TypeDescription
LegiTest.TestObjectFailedAn object(s) in the test assembly failed during execution.
LegiTest.TestExecutionFailedThe test assembly failed during execution.
LegiTest.TestObjectPassedAn object(s) in the test assembly passed during execution.
CreatedThe date and time when the test assembly subscription was created.
No. of ExecutionsThe number of tests executed within the test assembly.
Last ExecutionThe date and time of the most recent test execution. 
Last StatusThe status result of the most recent test execution.
ButtonDescriptionImage
SentryOne Test Enabled notification subscription button/SentryOne Test Disabled notification subscription buttonDisplays whether the subscription is enabled or disabled. Select the button to toggle the test subscription on or off .

Note:  Newly created Notification Subscriptions are set to Disabled by default. Select the Disabled button to enable the subscription.

To disable the subscription, select the Enabled button to open the Confirm Disable window, and then select OK.
SentryOne Test Confirm Disable for Notification Subscription
SentryOne Test Edit Subscription buttonOpens the Edit Subscription page for the desired subscription.  SentryOne Test Edit Subscription page
SentryOne Test Delete Subscription buttonDeletes the desired Test Notification Subscription from the SentryOne Test Web Portal.

Select the Delete Subscription button to open the Confirm Subscription Deletion window, and then select OK to delete the subscription. 
SentryOne Test Confirm Subscription Deletion window
SentryOne Test History Log buttonDisplays the Notification Log page for the desired subscription. SentryOne Test Notification Log

Creating a New Test Subscription

Create a new test Subscription by completing the following steps:

1. Select New on the Notification Subscription page to open the Create subscription page.

SentryOne Test Create New Subscription

Note:  You can also create a new subscription for a selected test on the Dashboard Summary page. SelectSentryOne Test Create Subscription buttonon the desired test to open the Create subscription page.

SentryOne Test Create a subscription from the Dashboard
SentryOne Test Create Subscription page

2. Enter a Name for the Test Subscription, and then select an Event type from the drop-down list that you want the subscription to monitor. 

SentryOne Test Create Subscription enter Subscription name

Note:  Selecting an Event type displays a Sample Event schema for the event type.

SentryOne Test Object failed Sample Event SchemaSentryOne Test Assembly execution failed Sample Event SchemaSentryOne Test Object passed Sample Event Schema

Minimize the Sample Event Schema by selecting View Sample Event Schema.

3. Enter a filter for your test, or select to Hide Filters

SentryOne Test Create Subscription Filters

Note:  Selecting to create a subscription for a test assembly or test object on the Data Testing Dashboard automatically filters the subscription to only include the selected test assembly or object.

SentryOne Test Predefined Subscription Filter

For more information about filtering within SentryOne Test, see the Notification Subscription Filtering topic.

4. Create a target actions to take when this subscription triggers. At least one target action needs to be added to the subscription. Select a pre-configured target action type, or select to configure a new target action from the Type drop-down list. 

SentryOne Test Create Subscription select Target Type

Note:  Selecting a pre-configured target displays that target's form. Selecting to configure a new target action displays the form for you to configure.

SentryOne Test Create Subscription Preconfigured Target example
SentryOne Test Create Subscription New Target Type example

5. Select a Message template to launch for your action from the Message Template drop-down list. 

SentryOne Test Create Subscription choose Message Template

Note:  For more information about the Message Templates available in the SentryOne Test Web Portal, see the Message Template section.

6. Select Add Target if you would like to add more targets to the subscription. After you're finished adding targets, select Test Subscription to open the Test Subscription window, and then select Test Now to test the subscription. 

SentryOne Test Subscription button
SentryOne Test Subscription window
Test Now
SentryOne Test Subscription Successful
Test Subscription Successful

7. Select Save Subscription to save your subscription to the Notification Subscriptions page. 

SentryOne Test Save Subscription

Success: Your subscription is now on the Notification Subscriptions page!

SentryOne Test Notification Subscription added

Note:  Selecting to create a subscription for a test assembly on the Data Testing Dashboard automatically filters the subscription to only include the selected test assembly.

Actions

Actions

SentryOne Test Notification Actions page

Create custom actions to trigger in the event of user-specified testing outcomes within your testing environment.

FunctionDescription
Action NameThe name of the action.
CreatedThe date and time when the action was created.
No. of ExecutionsThe number of times the action has executed.
Last ExecutionThe date and time of the most recent action execution.
Last StatusThe result of the most recent action execution.
ButtonDescriptionImage
SentryOne Test Edit Action buttonOpens the Edit Action page for the desired action. SentryOne Test Edit Action page
SentryOne Test Delete Action buttonDeletes the desired action from SentyOne Test.

Select the Delete Action button to open the Confirm Action Deletion window, and then select Ok to delete the action.
SentryOne Test Confirm Action Deletion window

Creating a New Action

Create a new action in the SentryOne Test Web Portal by completing the following steps :

1. Select New on the Actions page to open the Create Action window.
SentryOne Test Create New Action

2. Enter a name for the new action.
SentryOne Test Create Action enter action name

3. Select an existing, or create a new type of target for the action. For more information about targets, see the Notification Targets section of this article.
SentryOne Test Create Action select Type

4. Select a message template to trigger for the action, and then select Save Action to create the action.
SentryOne Test Create Action select Message Template

Note:  LegiTest Action is the recommended template to use for an action.

Success: Your action is created and available on the actions page.

SentryOne Test Actions Page New Action created

Triggering an Action

Actions can be triggered as a result of a user-specified test outcome. Launch actions directly from the Assertion Details page of a selected test assembly to draw attention to specific information.

SentryOne Test Assertion Details

Select the action you want to trigger from the drop-down menu, and then selectSentryOne Test Trigger Action button to trigger the action. 

SentryOne Test Assertion Details page Select Action
Select Action

SentryOne Test Assertion Details page Trigger Action for selected row
Trigger action for selected row

Success: Your action has successfully triggered. 

SentryOne Test Successful Action example

Message Templates

Message Templates

SentryOne Test Message Templates page

Message templates apply to events received by the Notification Engine. The templates are used to create formatted output that forms the content of a notification.  You can create message templates that generate the content for a notification email, and include specific data from the event that triggered it.

FunctionDescription
NameThe name of the message template.
Content TypeThe format type of the message. The following message formats are available for the SentryOne Test Web Portal:
  • HTML
  • Plain Text
ButtonDescriptionImage
SentryOne Test View Message Template buttonOpens the Edit Message window for the selected template in a view-only mode.

Note:  The default message templates in the SentryOne Test Web Portal cannot be edited or deleted.
SentryOne Test Edit Message Template view-only
SentryOne Test Edit Message Template buttonOpens the Edit Message template window for the selected custom template.SentryOne Test Edit Message Template window
SentryOne Test Delete Message Template buttonDeletes the selected message template.SentryOne Test Delete Message Template

The following Message Templates are available in the SentryOne Test Web Portal : 

HTMLPlain Text
  • LegiTest Dynamic Status With Annotations Html
  • LegiTest Failure Plaintext
  • LegiTest Dynamic Status Html
  • LegiTest Success Plaintext
  • LegiTest Failure HTML
  • LegiTest VSTS
  • LegiTest Success HTML
  • LegiTest Execution Failure Plaintext
  • LegiTest Execution Failure Html

  • LegiTest Action

Open a message template by selectingSentryOne Test View Message Template button.

SentryOne Test View Message Template

Edit Message Template Window

Message Template

SentryOne Test Edit Template window Message Template

Note:  The default message templates within the SentryOne Test Web Portal cannot be edited.

FunctionDescription
NameThe name of the message template you are viewing.
Content TypeThe format of the message template.
Template ContentA code view of the message template. 

Event Type Schema Reference

SentryOne Test Edit Message Template Event Type Schema Reference

FunctionDescription
View sample schema for event typeDisplays a sample schema of the message template for a selected event type. The following event types are available:
  • LegiTest.TestObjectFailed
  • LegiTest.TestExecutionFailed
  • LegiTest.TestObjectPassed

Preview

SentryOne Test Edit Message Template Preview tab

FunctionDescriptionImage
Preview message using sample schema for event type:Select a sample message schema for a selected event type.SentryOne Test Edit Message Template Preview Message drop down menu
Show PreviewDisplays the sample message schema.SentryOne Test Edit Message Template Preview tab

Creating a New Message Template

Create a new message template in the SentryOne Test Web Portal with the existing default templates by completing the following steps:

1. Copy the desired default message template.
SentryOne Test Copy Message template

2. Select New to open the Create New Message Template window.
SentryOne Test New Message Template

3. Enter a name for the test, select a content type, and then paste the desired schema into the Template Content text box.
SentryOne Test Create New Message Template enter data

4. Select Add to create the new message template.
SentryOne Test Create New Message Template select add

Success: Your custom Message Template is now available for selection!

SentryOne Test Message Template added

Notification Target

Notification Target

A notification target is an action or outcome destination that triggers in response to an event occurring. SentryOne Test has the following built-in base targets that you can configure on a per-subscription basis : 

  • Create Visual Studio Team Services Work Item
  • REST Call (Basic authentication)
  • REST Call (OAUTH2 authentication)
  • Email (SMTP)
  • REST Call (OAUTH1 authentication)
  • SMS Text Message

Use these base targets to create custom targets that are pre-configured for your testing environment. Custom targets can be reused across multiple subscriptions. Select to begin configuring a custom target.

FunctionDescription
NameThe name of the target or target form.
TypeThe type of target (Base, or Custom).
ButtonDescriptionImage
SentryOne Test Create Custom Notification Target buttonOpens the selected Create Custom Notification target configuration form.SentryOne Test Create Custom Notification Target
SentryOne Test Edit Custom Notification Target buttonOpens the Edit Custom Notification Target window.SentryOne Test Edit Custom Notification Target
SentryOne Test Delete custom target buttonDeletes the selected custom target.SentryOne Test Delete Target

Create Visual Studio Team Services Work Item form

SentryOne Test Create Visual Studio Team Services Work Item Target form

FunctionDescription
NameThe name of your target.
UsernameThe username that's needed to authenticate with Visual Studio. Note:  Alternate credentials must be enabled by the desired username. 
PasswordThe password that's needed to authenticate with Visual Studio.
Host NameThe name of the Visual Studio Team Services host that contains the target project. 
Collection NameThe name of the team project collection that contains the project.
Project NameThe name of the target project.
Work Item TypeThe type of work item you want to create.

Create Email (SMTP) form

SentryOne Test Create Email (SMTP) Target form

FunctionDescription
NameThe name of your target. 
HostThe host address for your SMTP server.
PortThe port number that your SMTP server requires. Note:  The most common port for non-secured email servers is 25, and is 443 for secured email servers.
Enable SSLTurn on SSL for your target.
Use Default CredentialsUses the default credentials for your target authentication. 
Timeout in SecondsThe time to wait before the email server sends your message(s) in seconds. Note:  The default timeout is 100 seconds.
Service Provider NameThe Service Provider Name (SPN) to use for authentication when using extended protection.
UsernameThe username to authenticate with the email server.
PasswordThe password to authenticate with the email server.
SubjectThe subject of the email message.
Reply To Email AddressesAn alternate email to reply to rather than the From Address.
PriorityThe priority of the email alert being sent. The following priority levels are available:
  • Low
  • Normal
  • High
Is Message HTMLDetermines whether the message renders as HTML or Plain text.
CC Email AddressesEmail addresses you want to carbon copy.
BCC Email AddressesEmail addresses you want to blind carbon copy.
To Email AddressesThe email address(es) where the message is sent.
From Email AddressThe email address that displays as the sender of the message.
From Display NameThe name that displays as the sender of the message.

Create REST Call (Basic authentication) form

SentryOne Test Create REST Call (Basic Authentication) Target form

FunctionDescription
NameThe name of your target.
UsernameThe username needed to authenticate with the host.
PasswordThe password needed to authenticate with the host.
Use base64 authentication headerEnables the base64 authentication header.
Endpoint URLThe URL where the notification is posted.
Content TypeThe content type used to send data to the server.
HTTP request methodThe HTTP request method to use for the REST call. The following request methods are selectable: 
  • Get
  • Post
  • Put
  • Delete
  • Patch
HeadersAny custom headers required. Note:  Enter one header per line in the following format:
header=value
Security protocolIdentifies the transport layer security, or secure sockets layer used by the endpoint. The following security protocols are selectable :
  • Default
  • SsI3
  • TIs
  • TIs11
  • TIs12
Proxy host nameThe host name of the proxy to use. Note:  Proxy settings are optional.
Proxy portThe port of the proxy to use.
Proxy usernameThe username needed to authenticate with the proxy.
Proxy passwordThe password need to authenticate with the proxy.
Proxy domainThe domain needed to authenticate with the proxy.

Create REST Call (OAuth1 authentication) form

SentryOne Test Create REST Call (OAuth1 authentication) Target form

FunctionDescription
NameThe name of your target.
Api keyThe authentication key that's provided at the application's developer site.
Api secretThe authentication secret that's provided at the application's developer site.
TokenThe token that's required by the web Api. This information is provided at the appication's developer site.
Token secretThe token's secret password that's provided at the application's developer site.
Signature typeThe signature type to use. The following signature types are selectable:
  • HMACSHA1
  • HMACSHA256
  • Plain text
Endpoint URLThe URL where the notification is posted.
Content typeThe content type used to send data to the server.
HTTP request methodThe HTTP request method to use for the REST call. The following request methods are selectable: 
  • Get
  • Post
  • Put
  • Delete
  • Patch
HeadersAny custom headers required. Note:  Enter one header per line in the following format:
header=value
Security protocolIdentifies the transport layer security, or secure sockets layer used by the endpoint. The following security protocols are selectable :
  • Default
  • SsI3
  • TIs
  • TIs11
  • TIs12
Proxy host nameThe host name of the proxy to use. Note:  Proxy settings are optional.
Proxy portThe port of the proxy to use.
Proxy usernameThe username needed to authenticate with the proxy.
Proxy passwordThe password need to authenticate with the proxy.
Proxy domainThe domain needed to authenticate with the proxy.

Create REST Call (OAuth2 authentication) form

SentryOne Test Create REST (OAuth2 authentication) Target form

FunctionDescription
NameThe name of your target.
Api keyThe authentication key that's provided at the application's developer site.
Api secretThe authentication secret that's provided at the application's developer site.
Access tokenThe Access Token that's provided at the application's developer site and carries the necessary information to determine if the client is authorized. 
Is bearer tokenAn authorization header that's required by some APIs. Note:  Check this box if the API issues a bearer token.
Refresh tokenThe token given to you by the application or service. Note:  Refresh tokens allow you to request new Access Tokens.
Refresh token request URLThe URL where Refresh Tokens are sent.
Refresh token request parametersThe query parameters that are used when the Refresh Token is requested. 
Refresh token access JSON pathIf you make a request for a new access token, the service returns the access token in JSON. This property is the path to the JSON access token.
Endpoint URLThe URL where the notification is posted.
Content typeThe content type used to send data to the server. 
HTTP request methodThe HTTP request method to use for the REST call. The following request methods are selectable: 
  • Get
  • Post
  • Put
  • Delete
  • Patch
HeadersAny custom headers required. Note:  Enter one header per line in the following format:
header=value
Security protocolIdentifies the transport layer security, or secure sockets layer used by the endpoint. The following security protocols are selectable :
  • Default
  • SsI3
  • TIs
  • TIs11
  • TIs12
Proxy host nameThe host name of the proxy to use. Note:  Proxy settings are optional.
Proxy portThe port of the proxy to use.
Proxy usernameThe username needed to authenticate with the proxy.
Proxy passwordThe password need to authenticate with the proxy.
Proxy domainThe domain needed to authenticate with the proxy.

Create SMS Text Message form

SentryOne Test Create SMS Text Message Target form

FunctionDescription
NameThe name of your target.
HostThe host address for your SMTP server.
PortThe port number that your SMTP server requires. Note:  The most common port for non-secured email servers is 25, and is 443 for secured email servers.
Enable SSLTurn on SSL for your target.
Use Default CredentialsUses the default credentials for your target authentication.
Timeout in SecondsThe time to wait before the email server sends your message(s) in seconds. Note:  The default timeout is 100 seconds.
UsernameThe username needed to authenticate your SMTP server. 
PasswordThe password needed to authenticate your SMTP server.
SubjectThe subject of the message. 
PriorityThe priority of the alert being sent. The following priority levels are available:
  • Low
  • Normal
  • High

SMS ProviderThe provider of the SMS or MMS services. Note:   
Phone NumbersThe phone numbers where the message is sent. mpNote:  Separate phone numbers by a semicolon ( ; ) or comma ( , ).
From Email AddressThe email address that displays as the sender of the message.
From Display NameThe name that displays as the sender of the message.

Creating a New Target

Create a new target in the SentryOne Test Web Portal by completing the following steps:

1. SelectSentryOne Test Preconfigured base target buttonto open the desired target configuration form. 

2. Enter the appropriate configuration information into the form, and then select Save to create your target. 

SentryOne Test Complete Target form
Complete form

SentryOne Test Save Target form
Select Save

Success: Your New Target is now selectable!
SentryOne Test Notification Targets New target created