"DESKTOP_EXISTS" Command

Owned by Joseph Hamdan
Last updated: Jun 11, 2024
2 min read

Description: This command is used to check if a desktop element defined by a screenshot of the target (Desktop locator) or by OCR with the option Use Text exists on screen or not and returns a Boolean value accordingly.

Usage Scenario: Suppose we want to check if the folder named “Subject7 Test Folder” has been created by getting a value of "true" or “false”.

Procedure: Take a screenshot of the folder and upload it to be used in a Desktop locator for the command to interact with. Enter a variable name that will take a Boolean value upon execution. Your step will look like this:

image-20240611-152315.png

  • NOTE: The Similarity field is to adjust the matching approximation (minimum of 0.10 - maximum of 0.98 - default of 0.75) which improves the accuracy of matching the exact image in the case of multiple images with similar appearance.

Alternatively, you can use OCR Use Text option and enter the text Subject7 Test Folder

image-20240611-152351.png

Desktop commands are controlled by Locator Timeouts under User Execution Preferences. If the locator timeout is not sufficient enough for the command to find the element, you can increase Locator Timeout to give the step more time to work. It’s recommended to use 20 seconds for desktop commands.

Notes:

  1. If you do not see any highlight during execution, please enable the option Desktop Highlight under User Execution Preferences and save.

  2. Crop Region Offset can be used to designate an area for execution to look through to reduce execution duration and ensure additional accuracy. The values provided will crop the area. For example, if you provide 50 points in the Left field, only the 50% of the right side of your screen will be interacted with.

  3. Multiline can be used to interact with text which is visible on multiple lines.

The following video demonstrates how these steps get executed: