TestResults.io
  • What is TestResults.io
  • System Architecture
  • Regulated Markets
    • Health Care Industry
    • Financial Services Industry
  • What's new?
    • Update Instruction
      • Update of the Designer extension in Visual Studio
      • Update the Execution Engine
      • Update the Base- and Environment Models
    • Migration to new project file
  • Designer
    • Overview
    • First Steps
    • Installation
    • TestResults.io solution
    • The development environment
      • Tool Window Overview
        • Test Environments
          • Steps to configure a SUT VM
          • How to access files on the system under test
        • Remote Viewer
          • Control Mode
          • Capture Mode
          • Screen Editor
          • Capture Single Image
        • Screen Explorer
        • Test Case Designer
        • Image Explorer
        • API Testing
        • TestResults.io options
          • Engines
          • Servers
    • Test Cases
      • Adding Test Cases
      • Test Case structure
      • Simple Test Case (Example)
      • Executing your Test Case
      • Generating Test Containers
      • Publishing Test Cases
      • Execution Variables
    • Software Models
      • Adding SW Models
      • Referencing the Model in the Test Case
      • Generating Test Containers
      • Publishing SW Models
      • Screens and Screen Elements
        • Tables
        • Visual Sense
        • Custom Screen Elements
    • Installers
      • Adding Installers
      • Generating Test Containers
      • Publishing Installers
    • Automation Framework Reference
      • Attributes
      • Enumerations
      • Filters
        • IImageFilter Interface
        • Select
        • Resize
      • GlobalEngineParameters
      • ImageDetectionParameters
      • ImageReference
      • Interfaces
        • ITester Interface
          • ITester Methods
          • ITester Properties
        • ITestee Interface
          • ITestee Methods
        • IConnections Interface
          • IConnections Methods
          • IConnections Properties
        • IDebug Interface
        • IEngineResult
        • IHelpers Interface
        • IImageHelper Interface
          • IImageHelper Methods
        • IKeyboard Interface
          • IKeyboard Methods
        • IMouse Interface
          • IMouse Methods
          • IMouse Properties
        • IReport Interface
          • IReport Methods
        • ISUTConnection Interface
      • OcrEngineParameters
        • Best practise
        • IronOcrEngineParameters
        • LEADOcrEngineParameters
        • OcrEngineRelatedCharacters
        • OcrPreprocessingParameters
      • ResultRectangle
      • SutNotReadyException
      • TestStepAbortedException
    • FAQ
      • Two-factor authentication (2FA) and One Time Passwords (OTP)
      • Receive and verify Emails
      • Using Excel as test data source
      • Verify PDF Content
  • Portal
    • Overview
    • First Steps
    • User's Guide
      • Login
      • Projects
      • Dashboard
      • Test Cases
      • Software & Environments
      • Test Sets
      • Job Queue
      • Management
      • Notifications Summary
    • Automation Engineer's Guide
      • Test Automation Workflow
      • Automating a test case
      • Enabling Software & Environments
    • REST API Reference
      • Authentication
      • Projects
      • Test Sets
      • Test Cases
      • Test Plans
      • Test Reports
      • Files
      • Software
      • Environments
      • Untitled
      • Executions
      • Favorites
      • Statistics
      • User Management
      • Customer Management
      • Notifications
      • Configurations
      • Invoicing
  • Models
    • Overview
    • Base Model
      • BaseScreen
        • BaseScreen Properties
        • BaseScreen Methods
      • OnScreenElement
        • OnScreenElement Methods
        • OnScreenElement Properties
      • Primitives
        • Button
          • Button Methods
          • Button Properties
        • Checkbox
          • Checkbox Methods
        • ContextMenu
          • ContextMenu Methods
          • ContextMenu Properties
        • Dropdown
          • Dropdown Methods
          • Dropdown Properties
        • DropdownMenu
          • DropdownMenu Methods
          • DropdownMenu Properties
        • GenericScroller
          • GenericScroller Methods
          • GenericScroller Properties
        • HorizontalScroller
        • IconButton
          • IconButton Properties
        • Label
        • LabelWithButton
          • LabelWithButton Properties
        • LabelWithCheckbox
          • LabelWithCheckbox Properties
        • LabelWithValue
          • LabelWithValue Methods
          • LabelWithValue Properties
        • PwTextBox
          • PwTextBox Methods
        • TextBox
          • TextBox Methods
          • TextBox Properties
        • Tables and lists
          • Column
            • Column Methods
            • Column Properties
          • ItemList
            • ItemList Methods
            • ItemList Properties
          • Row
            • Row Methods
            • Row Properties
          • TableBase
            • TableBase Methods
            • TableBase Properties
        • LabelWithElementBase
          • LabelWithElementBase Properties
      • Enumerations
      • Extensions
        • EngineResultExtensions Methods
        • EnumExtensions Methods
        • ReportExtensions Methods
        • StringExtensions Methods
        • TesterConnectionExtensions Methods
        • TesterDebugExtensions Methods
        • TesterHelperExtensions Methods
        • TesterMouseExtensions Methods
        • TesterOnScreenElementExtensions
        • TesterSelectExtensions Methods
      • Helper Classes
        • BaseModelHelpers
          • BaseModelHelpers Methods
          • BaseModelHelpers Properties
        • Attributes for Designer
        • ListHelpers
      • Exceptions
        • ElementNotFoundException
        • InteractionFailedException
        • ScreenNotFoundException
      • Interfaces
        • IAppBasics Interface
          • IAppBasics Methods
          • IAppBasics Properties
        • IBrowser
        • ICommandLineWindow
        • IScroller Interface
          • IScroller Methods
          • IScroller Properties
        • ISutLocale Interface
          • ISutLocale Methods
          • ISutLocale Properties
        • ISystemHelpers
        • ISystemInteractions
        • IWindow
    • Environment Model
      • Windows
        • Screens
          • CmdWindow
            • CmdWindow Methods
            • CmdWindow Properties
          • FileDialog
            • FileDialog Methods
            • FileDialog Properties
          • FileExplorer
            • FileExplorer Properties
          • RunWindow
            • RunWindow Methods
            • RunWindow Properties
          • Window
            • Window Methods
            • Window Properties
        • SutLocale
          • SutLocale Methods
          • SutLocale Properties
        • SystemHelpers
          • SystemHelpers Methods
          • SystemHelpers Properties
        • SystemInteractions
        • WebBrowser
          • Browser
            • Browser Methods
            • Browser Properties
          • BrowserScroller
            • BrowserScroller Methods
            • BrowserScroller Properties
          • AuthenticationDialog
            • AuthenticationDialog Methods
            • AuthenticationDialog Properties
          • DownloadDialog
            • DownloadDialog Methods
            • DownloadDialog Properties
        • EnvironmentModel Enumerations
        • Interfaces
          • IWebAppBasics
            • IWebAppBasics Property
Powered by GitBook
On this page
  • How to change the engine version on a test case?
  • How to upload multiple containers at the same time?
  • I am unsure what to record as the image of an element, what is the best practise?
  • I want to verify if a teststep was successful, by searching for an Image not recorded in the model
  • How do I access files on the system under test?
  • How do I invite my coworkers to my project?
  • My test execution just stopped in the middle of a testrun, what happend?
  • An element is not found during the test execution, how do I fix it?
  • An element is found in the wrong location, how do I fix it?
  • I have multiple Elements which look exactly the same, how can I make sure the correct one is used?
  • None of the existing Screen Elements work for my case, what can I do?
  • How do I change the settings for an Element?
  • OCR is reading the text on the screen wrong, what can I do to fix it?
  • I wrote some functions on my Screens, why are they not accessible in the Test Case Designer?
  • Still require help?

Was this helpful?

  1. Designer

FAQ

How to change the engine version on a test case?

  • Right click on the Test Case Project in the Solution Explorer

  • Select the TestResults.io context menu

  • Select the Change Engine version option

  • Select the desired engine version and press OK

How to upload multiple containers at the same time?

  • Right click on the Solution in the Solution Explorer

  • Select the TestResults.io context menu

  • Select the Publish all test containers option

I am unsure what to record as the image of an element, what is the best practise?

  • Make sure to only record the static part of an element. For example only the label of a textbox and not the box itself, because the content of the box itself can change.

  • Also test what happens if you change the size of your application window, for example a button could get smaller and smaller, so only capture the static text inside the button and not the border.

  • If there are multiple variants of an element make sure to record an image for all variants (like a button gets bigger on mouseover, or a link is blue first and purple if you already clicked it)

I want to verify if a teststep was successful, by searching for an Image not recorded in the model

  • For example if you want to verify the content of the confirmation PDF you get at the end of your teststep. You do not want to add images of the PDF to the model, as they are very specific to the teststep.

How do I access files on the system under test?

How do I invite my coworkers to my project?

My test execution just stopped in the middle of a testrun, what happend?

  • If an execution just stops it usually means an expected element or a screen was not found in which case the test engine aborts. Our debug log will tell you precisely at which point during the execution which element was not found.

  • To access the Debug Log in a Visual Studio test run, make sure to open the Output window (in View --> Output) and switch the "Show output from" dropdown to "TestResults.io Public" or "TestResults.io Debug" for even more details.

  • Use the following FAQ chapters to help you how to fix if an element was not found or found in the wrong location.

An element is not found during the test execution, how do I fix it?

  • First make sure the element is visible on the test environment and for example your navigation to the screen was correctly executed.

  • Compare your captured image with what is actually displayed on the test environment. Depending on your applications elements may look different if they were already clicked once, or on mouseover, or if the focus is somewhere else.

An element is found in the wrong location, how do I fix it?

  • Our image search engine allows some deviation while comparing your captured image to the test environment. Usually this is very helpful as the visual rendering on the test environment is not always the same if you compare each pixel by pixel.

  • In case some elements look very similar (e.g. some icons look almost the same) this allowed deviation can lead to mismatches.

I have multiple Elements which look exactly the same, how can I make sure the correct one is used?

Example for setting a Select depending on another ReferenceElement

        ReferenceElement.WaitFor();
        Select buttonSelect = Select.FromXY(
                ReferenceElement.Position.Boundary.Right,
                ReferenceElement.Position.Boundary.Top - 30, 
                600, 
                85);
        EnabledButton.SetSelectFilter(buttonSelect);

Example for using a Select with a ColorFill on an Image:

        Select rightSideSelect = t.SelectFromColorAtPoint(Images.Common.RightSideOrigin);
        rightList.SetSelectFilter(rightSideSelect);

None of the existing Screen Elements work for my case, what can I do?

How do I change the settings for an Element?

public partial class HomeScreen
{
    partial void ConfigureElementProperties()
    {
        SearchTextbox.TextBoxType = TextBoxType.OCR;
    }
}
  • Some settings use the keyword "static", these are applied to all elements of e.g. Type Textbox. We recommend to configure these inside the constructor of your App Class (you can find it inside your Model Project in the File App.cs, the constructor is the Method with the same name as your class)

TextBox.DefaultType = TextBoxType.OCR;

OCR is reading the text on the screen wrong, what can I do to fix it?

I wrote some functions on my Screens, why are they not accessible in the Test Case Designer?

  • To have some kind of filter the Test Case Designer only has access to functions which are marked as "Model Capabilities".

    [ModelCapability("Open Menu")]
    public void OpenMenu()
    {
        if (MenuButton.IsActive())                        //the "active"   image of the Button is where it is closed
            MenuButton.Click(MenuButton.WaitForInactive); //the "inactive" image of the Button is where it is open
    }
    [ModelCapability("Select Value With different Search")]
    public void SelectValueWithSearch(
        [DisplayName("Textbox search Value")] string textboxValue, 
        [DisplayName("Select Value in Dropdown")] string dropdownValue
    )
    {
        ...
    }

The Test Case Designer needs to load new functions before you can select them. Click the Link to refresh. If the notification is not showing you can always reload the functionalities and screens with the green marked Icon.

Still require help?

PreviousTestStepAbortedExceptionNextTwo-factor authentication (2FA) and One Time Passwords (OTP)

Last updated 9 months ago

Was this helpful?

Follow the guide on how to for testcases

If your system under test already includes the required files, you can just access it like a user would by e.g. using the Windows File Explorer or File Dialog which are already automated by us in the .

If your system under test does not include the required file, or you require more flexibility read our .

First invite your coworkers by creating a new User in the

To share your test automation progress we recommend using the which supports the git provider of your choice, such as GitHub, Azure DevOps, Bitbucket etc.

If you executed the test case in the portal platform use the to see where the execution stopped and download the linked Debug Log.

In case you require multiple different images of an element you can capture these by editing your Screen (double click in theon it), editing the Element and click the camera icon again. In the displayed folder structure you can right click on the folder or image to add, modify and delete images.

But you can edit the affected Image by using the to adjust the precision of the image search. In most cases of a mismatch we recommend switching the Engine from "Default" to "Precise", and below in "Precison" enter a value of "0.9". A value of 1.0 would require a pixel perfect match, 0.9 still allows a slight deviation.

First make sure you use the correct element type. For example if you have multiple Yes / No questions use the "" instead of "Button" Element. With this element type you can record the question as the Label, the answers as the Buttons and define the relative position of the buttons to the label including a grid width and height if required. The same options exist for Checkbox and

If this does not work in your scenario you can limit the screenspace where the element is searched on. For this create a and apply it to the Element with the method. You can apply a Select filter on a single Element or on the containing Screen itself.

First check out all the we have for each screen Element (for example ) and how to configure them (see the next FAQ).

It is also possible to create all custom Screen Elements, find an example of a Dropdown with a Searchbox in our .

In our documentation you can find all the settings (called Properties) we support for the different kind of elements (for example )

To change these Properties right click the Screen in the Screen Explorer and select "Open Screen Class". If it does not exist yet add the Method "ConfigureElementProperties" as displayed below inside the class of your screen (or check out our complete )

In this example we change the of the Textbox called "SearchTextbox" on the Screen "HomeScreen". With this change the clipboard is no longer used to verify the content of the textbox, but instead it is read using OCR.

We try to give you the best out of the box OCR experience possible, but depending on the used font, text size, text and background color furter configuration may be required. We support multiple OCR engines and give access to a lot of

Overwhelmed with all the possibilities? Check out our collection of .

Add the [ModelCapability] Attribute to your Function like this (complete example ):

You can also change the DisplayName of each Parameter (complete example ):

Join our and feel free to ask questions in #community-support

capture single images
Windows Environment Model
guide on how to use supporting files during a test exection
Visual Studio Version Control
Image Explorer
LabelWithButton
LabelWithCheckbox
possible settings
Buttons
Demo Project on Github
example on Github
configuration possiblities
best practise OCR configurations
on Github
on Github
Slack Channel
Select
User Management
Screen Explorer
Detailed Report Tab
Textbox Properties
TextBoxType
SetSelectFilter