Welcome to the new Ranorex Support Portal

Image-based automation settings

Image-based automation settings are to specify the behavior of Ranorex in detecting and identifying UI-elements in an image-based way. The settings can either be made generally (by means of the settings dialog) or on an action-based way (by means of the action properties).

In this chapter

Image-based settings


To set up the default values for image-based recording, open up the ‘Settings‘ dialog and continue with activating the ‘Imaging‘ tab.

Image-based settings dialog
  1. Return the best match (and not the first one): If ‘Best Match’ is set to true, the result position with the highest similarity is used for validation. If is set to false, the first available result position will be used for the validation. The first is more accurate and the second is faster.

  2. Similarity threshold (0.0-1.0): Specifies the minimum similarity (0.0-1.0), that the image region to search for needs to have in common with the image in order to be considered a match

  3. Downsize quality

  4. Preprocessing steps: Defines preprocessing steps that can be performed on an image before search. Available options are ‘Downsize’, ‘Edges’, ‘EdgesSobel’, ‘Grayscale’ and ‘Threshold’

Download

Further reading


The similarity threshold and the preprocessing steps are part of the image-based properties which are introduced and explained in detail in > Ranorex Studio advanced > Image-based automation > ⇢ Image-based properties.

  1. Timeout (ms)

Default validation options

These options control the default reporting values for image-based validations (ContainsImage and CompareImage).

You can set them for individual validations in the respective validation action’s properties.

Image-based report settings
  1. Report difference image: If and when an image showing the differences between the expected and the actual image will be included in the report. Default setting = Never.

  2. Report screenshot: If and when a screenshot of the validated UI element will be included in the report. Default setting = Never.

  3. Report similarity: If and when the similarity of the expected and the actual image will be included in the report. Default setting = Never.

  4. Report expected and actual images: If and when the expected and the actual image will be included in the report. Default setting = On Fail.

Image-based properties


Image-based properties are available on an action-based access by selecting an action and pressing the F4 key. Remember that image-based properties only affect the corresponding action and not the image-based behavior of Ranorex generally.

Accessing image-based properties
  1. Select an action and press F4 to open the action properties

  2. See the image-based properties in the action properties pane

You find the same settings and configurations as in the image-based settings dialog.

Image-based action properties
  1. See the preprocessing settings

  2. See the similarity factor setting

Download

Reference


Image-based automation is an advanced concept which is introduced and explained in detail beginning in > Ranorex Studio advanced > Image-based automation > ⇢ Introduction.

USERS LOVE US

SUBSCRIBE TO OUR NEWSLETTER

Get the latest test automation information right in your mailbox.

FOLLOW US

© 2024 Ranorex GmbH. All Rights Reserved