SentryOne Test Web Portal Notification Engi

EOL: SentryOne Test reached its end of life date on June 15, 2022. See the Solarwinds End of Life Policy for more information.

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

SentryOne Test Notification Subscriptions The 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 Function

Description

Subscription Name

The name of the test that you are subscribed to.

Event Name

The event outcome that your subscription is monitoring.

The following Event types are available:

Event Type	Description
LegiTest.TestObjectFailed	An object(s) in the test assembly failed during execution.
LegiTest.TestExecutionFailed	The test assembly failed during execution.
LegiTest.TestObjectPassed	An object(s) in the test assembly passed during execution.

Created

The date and time when the test assembly subscription was created.

No. of Executions

The number of tests executed within the test assembly.

Last Execution

The date and time of the most recent test execution.

Last Status

The status result of the most recent test execution.

Button	Description	Image
/	Displays 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.
	Opens the Edit Subscription page for the desired subscription.
	Deletes 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.
	Displays the Notification Log page for the desired subscription.

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. Selecton the desired test to open the 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 Schema

SentryOne Test Assembly execution failed Sample Event Schema

SentryOne 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 action to take place 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.

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.

Test Now

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

SentryOne Test Notification Actions page

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

Function	Description
Action Name	The name of the action.
Created	The date and time when the action was created.
No. of Executions	The number of times the action has executed.
Last Execution	The date and time of the most recent action execution.
Last Status	The result of the most recent action execution.

Button	Description	Image
	Opens the Edit Action page for the desired action.
	Deletes 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.

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 select to trigger the action.

Select Action

Trigger action for selected row

Success: Your action has successfully triggered.

SentryOne Test Successful Action example

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.

Function	Description
Name	The name of the message template.
Content Type	The format type of the message. The following message formats are available for the SentryOne Test Web Portal: HTML Plain Text

Button	Description	Image
	Opens 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.
	Opens the Edit Message template window for the selected custom template.
	Deletes the selected message template.

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

HTML	Plain 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 selecting.

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.

Function	Description
Name	The name of the message template you are viewing.
Content Type	The format of the message template.
Template Content	A code view of the message template.

Event Type Schema Reference

SentryOne Test Edit Message Template Event Type Schema Reference

Function	Description
View sample schema for event type	Displays 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

Function	Description	Image
Preview message using sample schema for event type:	Select a sample message schema for a selected event type.
Show Preview	Displays the sample message schema.

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

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.

Function	Description
Name	The name of the target or target form.
Type	The type of target (Base or Custom).

Button	Description	Image
	Opens the selected Create Custom Notification target configuration form.
	Opens the Edit Custom Notification Target window.
	Deletes the selected custom target.

Create Visual Studio Team Services Work Item form

SentryOne Test Create Visual Studio Team Services Work Item Target form

Function	Description
Name	The name of your target.
Username	The username that's needed to authenticate with Visual Studio. Note: Alternate credentials must be enabled by the desired username.
Password	The password that's needed to authenticate with Visual Studio.
Host Name	The name of the Visual Studio Team Services host that contains the target project.
Collection Name	The name of the team project collection that contains the project.
Project Name	The name of the target project.
Work Item Type	The type of work item you want to create.

Create Email (SMTP) form

SentryOne Test Create Email (SMTP) Target form

Function	Description
Name	The name of your target.
Host	The host address for your SMTP server.
Port	The 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 SSL	Turn on SSL for your target.
Use Default Credentials	Uses the default credentials for your target authentication.
Timeout in Seconds	The time to wait before the email server sends your message(s) in seconds. Note: The default timeout is 100 seconds.
Service Provider Name	The Service Provider Name (SPN) to use for authentication when using extended protection.
Username	The username to authenticate with the email server.
Password	The password to authenticate with the email server.
Subject	The subject of the email message.
Reply To Email Addresses	An alternate email to reply to rather than the From Address.
Priority	The priority of the email alert being sent. The following priority levels are available: Low Normal High
Is Message HTML	Determines whether the message renders as HTML or Plain text.
CC Email Addresses	Email addresses you want to carbon copy.
BCC Email Addresses	Email addresses you want to blind carbon copy.
To Email Addresses	The email address(es) where the message is sent.
From Email Address	The email address that displays as the sender of the message.
From Display Name	The name that displays as the sender of the message.

Create REST Call (Basic authentication) form

SentryOne Test Create REST Call (Basic Authentication) Target form

Function	Description
Name	The name of your target.
Username	The username needed to authenticate with the host.
Password	The password needed to authenticate with the host.
Use base64 authentication header	Enables the base64 authentication header.
Endpoint URL	The URL where the notification is posted.
Content Type	The content type used to send data to the server.
HTTP request method	The HTTP request method to use for the REST call. The following request methods are selectable: Get Post Put Delete Patch
Headers	Any custom headers required. Note: Enter one header per line in the following format: header=value
Security protocol	Identifies 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 name	The host name of the proxy to use. Note: Proxy settings are optional.
Proxy port	The port of the proxy to use.
Proxy username	The username needed to authenticate with the proxy.
Proxy password	The password need to authenticate with the proxy.
Proxy domain	The domain needed to authenticate with the proxy.

Create REST Call (OAuth1 authentication) form

SentryOne Test Create REST Call (OAuth1 authentication) Target form

Function	Description
Name	The name of your target.
Api key	The authentication key that's provided at the application's developer site.
Api secret	The authentication secret that's provided at the application's developer site.
Token	The token that's required by the web Api. This information is provided at the application's developer site.
Token secret	The token's secret password that's provided at the application's developer site.
Signature type	The signature type to use. The following signature types are available: HMACSHA1 HMACSHA256 Plain text
Endpoint URL	The URL where the notification is posted.
Content type	The content type used to send data to the server.
HTTP request method	The HTTP request method to use for the REST call. The following request methods are available: Get Post Put Delete Patch
Headers	Any custom headers required. Note: Enter one header per line in the following format: header=value
Security protocol	Identifies the transport layer security, or secure sockets layer used by the endpoint. The following security protocols are available: Default SsI3 TIs TIs11 TIs12
Proxy host name	The host name of the proxy to use. Note: Proxy settings are optional.
Proxy port	The port of the proxy to use.
Proxy username	The username needed to authenticate with the proxy.
Proxy password	The password need to authenticate with the proxy.
Proxy domain	The domain needed to authenticate with the proxy.

Create REST Call (OAuth2 authentication) form

SentryOne Test Create REST (OAuth2 authentication) Target form

Function	Description
Name	The name of your target.
Api key	The authentication key that's provided at the application's developer site.
Api secret	The authentication secret that's provided at the application's developer site.
Access token	The 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 token	An authorization header that's required by some APIs. Note: Check this box if the API issues a bearer token.
Refresh token	The token given to you by the application or service. Note: Refresh tokens allow you to request new Access Tokens.
Refresh token request URL	The URL where refresh tokens are sent.
Refresh token request parameters	The query parameters that are used when the refresh token is requested.
Refresh token access JSON path	If 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 URL	The URL where the notification is posted.
Content type	The content type used to send data to the server.
HTTP request method	The HTTP request method to use for the REST call. The following request methods are available: Get Post Put Delete Patch
Headers	Any custom headers required. Note: Enter one header per line in the following format: header=value
Security protocol	Identifies the transport layer security, or secure sockets layer used by the endpoint. The following security protocols are available : Default SsI3 TIs TIs11 TIs12
Proxy host name	The host name of the proxy to use. Note: Proxy settings are optional.
Proxy port	The port of the proxy to use.
Proxy username	The username needed to authenticate with the proxy.
Proxy password	The password need to authenticate with the proxy.
Proxy domain	The domain needed to authenticate with the proxy.

Create SMS Text Message form

SentryOne Test Create SMS Text Message Target form

Function	Description
Name	The name of your target.
Host	The host address for your SMTP server.
Port	The 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 SSL	Turn on SSL for your target.
Use Default Credentials	Uses the default credentials for your target authentication.
Timeout in Seconds	The time to wait before the email server sends your message(s) in seconds. Note: The default timeout is 100 seconds.
Username	The username needed to authenticate your SMTP server.
Password	The password needed to authenticate your SMTP server.
Subject	The subject of the message.
Priority	The priority of the alert being sent. The following priority levels are available: Low Normal High
SMS Provider	The provider of the SMS or MMS services.
Phone Numbers	The phone numbers where the message is sent. Note: Separate phone numbers by a semicolon ( ; ) or comma ( , ).
From Email Address	The email address that displays as the sender of the message.
From Display Name	The 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. Selectto open the desired target configuration form.

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

Complete form

Select Save

Success: Your new notification target is now available!
SentryOne Test Notification Targets New target created

SentryOne Test Web Portal Notification Engine