Batch completion notifications - Microsoft Teams integration

The Eyes Batch completion notifications feature gives you the option of automatically receiving Teams messages that inform you when batches you are running have successfully finished or failed. You can receive these notifications whether your tests are executed manually or by a build executed through a CI tool. The notifications contain a summary of the test completion status and quality, and include a link to the Test manager where you can review the test results in detail.

The Applitools Eyes App for Microsoft Teams links your Applitools Eyes test results to your Microsoft Teams chat. When you install the Applitools Eyes App in Microsoft Teams, you can configure and manage test results notifications for all your teams' preferred channels.

Configuring the Microsoft Teams Integration

note

You need to be a team admin or account admin to configure notifications.

Install Applitools Eyes App in Microsoft Teams

1. As an administrator of Microsoft Teams, open Teams and upload the Applitools EyesTeamsAppManifest.zip file.

   For about uploading a custom app, details see the Microsoft Teams documentation.

2. Once the upload is complete, Applitools Eyes is available under Built for your org.

   Click on the Applitools Eyes app and click Add to a dd it to a team.

   

3. In the Team's chat, search for the Applitools Eyes app, and click Update Eyes URL.

   

4. Enter the Applitools Eyes server URL, the default is https://eyes.applitools.com, and click Submit.

   

5. After providing your URL or selecting the default URL, click the Sign In button.

   In order to sign in, you need to provide your Applitools Eyes credentials. After signing in, Eyes notifications can be sent to the team or channel.

   As an Eyes administrator, you can manage notifications and change the default configurations.

Configuring the Applitools Eyes App

Here is the list of Applitools Eyes bot commands:

• Sign in: You can sign in to Applitools Eyes via the Sign In command. You need to sign in to receive and manage notifications. Once you sign in, default notifications are sent for all applications when tests complete.

• Manage notifications: After signing in to Applitools Eyes, you can manage notifications via the Applitools Eyes bot by selecting the Manage Notifications command or click on Manage Notifications button. A screen with all your notification configurations is displayed.

  • Add new notifications: You can add a new notification. New notifications are added and saved automatically, the same as in the Eyes admin page.

  • Update notifications: You can update existing notifications by editing each notification. All changes are updated automatically, the same as in Eyes admin page

  • Remove notifications: You can remove notifications from the Applitools Eyes bot using the Manage Notifications command. When you select the command, the Manage Notifications card pops up and you can delete notifications. When notifications are removed, you no longer receive test results notifications to your chat.

  • Disable all notifications: You can disable all notifications by selecting disable toggle. This will disable all notifications configured for your chat/channel.

  The following figure shows an example of Eyes test notifications:

  

• Sign Out: You can sign out from Applitools Eyes at any point by using the Sign Out command. When you select the command, a Sign out button is displayed. Click the Sign Out button and wait for the sign out message.

  

tip

You must close the sign-out window in order to see the sign out message.

• Help: Displays the Applitools help site for teams integration. If at any point you need help with Microsoft Teams-Applitools Eyes integration, select the Help command.

Managing Microsoft Teams notifications via the Eyes Admin page

Once the Applitools Eyes App is installed in Microsoft Teams, you can view and update your Microsoft Teams notification configurations via the Applitools Eyes Admin page:

1. As an administrator, go to the Admin page

2. Update Microsoft Teams notification configurations. Updates are saved and updated in Microsoft Teams accordingly.

   

Users and permissions

• Managing the Applitools Eyes App:

  • Only a Microsoft Teams Administrator can upload the Applitools Eyes App.

  • Teams users can add the app to their channels.

• Managing notifications:

  • Only an Eyes Admin can manage notifications.

  • Users must have an Applitools account to sign in to.

  • The Applitools Eyes account/team administrator can manage Microsoft Teams notifications via either the Microsoft Teams Manage Notifications command or via the Integration section of the Applitools Eyes Admin page.

  note

  Adding notifications can be done only via Teams Manage notifications card and only by an Eyes admin.

• All Teams users in a channel or using chat can receive test results notifications.

Configuring the SDK

Notifications are triggered once the BatchInfo object is marked as closed. Depending on the SDK in use, you may need to close the batch via an API in the code or it will be handled for you. See below for instructions on how to configure your selected SDK:

Configuring Notifications in CI/CD or Distributed Environments

When running tests through CI/CD, it is common to run parallel jobs and test executions to speed up test suites. As mentioned above, Batch Notifications are only sent once the BatchInfo object for your test suite has been closed. If you're running parallel jobs, you must ensure that the Batch is closed only after every job completes otherwise you'll get incorrect notifications.

See this article under the Batching section for instructions on how to handle batch close logic in distributed test runs.