Image-based automation settings specify Ranorex's behavior in detecting and identifying UI elements based on images. The settings can be made generally (employing the settings dialog) or action-based (using the action properties).

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.

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 to be considered a match

3. Downsize quality

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

5. Timeout (ms)
   

6. 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.

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

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

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

Further Reading: The similarity threshold and the preprocessing steps are part of the image-based properties which are introduced and explained in detail in 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.

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.

1. See the preprocessing settings

2. See the similarity factor setting

Reference: Image-based automation is an advanced concept that is introduced and explained in detail beginning in Image-based automation >  Introduction.