Last updated: Apr 08, 2021 14:36
Step-by-Step instructions
Expand the procedure you want to perform to view its steps.
Available parameters
The following table describes the parameters available in the UI and their values. These parameters address the most common use cases. For more information about these parameters and about additional parameters that apply to more advanced use cases, see General Visual Analysis Parameters.
Parameter | Description | Values |
---|---|---|
Haystack | Use to limit the area of the screenshot (haystack) examined by providing the coordinates of the top-left corner of the haystack rectangle and the rectangle's dimensions. This is especially useful if the image or text that you are looking for is known to appear in a particular area of the screen, such as the header or footer. To define the haystack, you can:
For example, in the following image, the search area is defined as offset by 25% from the left and 0% from the top, with a width of 50% and a height of 10%. | The offset from top and left as well as width and height, in percent or pixels |
Relative position | Only available with the Button command selected. Use to specify the position of text relative to the button and the text distance from the button, in percent. | Above, Below, Left, or Right Distance in percent |
Timeout (secs) | Use to define the time, in seconds, to wait for a needle to appear on the device screen. This is useful with a dynamic screen where the page loading time should be considered when searching for the needle. | Time, in seconds |
Accurate timer | Add to specify the accuracy level of the timer. Turn on for a measurement in sub-seconds (0.1 seconds, which is accurate). Turn off for normal accuracy, in seconds (considered rough). | On/off |
Threshold (%) | Use to specify the acceptable match level percentage, between 20 and 100. Values that are too low can lead to a false positive result, while values that are too high can lead to a false negative result. | 20-100 |
OCR Profile | (Text analysis only) Use to set optimal values for a large number of OCR parameters to match a particular scenario. We highly recommend setting a profile due to profile complexity and the large number of parameters involved. For details, see What are OCR profiles?. |
|
Languages | (Text analysis only) Use to specify the OCR language to use. You can select multiple values. | English, Spanish, Japanese, German, French, Dutch, Italian, Chinese, Russian, Portuguese |
Scroll and Search | Turn on to specify whether to scroll until the label is found. Scrolling results in a longer execution time. | On/off |
Ignore Case | (Text analysis only) Use to specify case sensitivity of the search pattern. When turned on, the search is not case sensitive. | On/off |
Whole Word | (Text analysis only) Turn on to match only whole words in the haystack. Otherwise, also part of other words are found. | On/off |
Ignore White Space | (Text analysis only) Turn on to ignore spaces within search pattern words. | On/off |
Match | (Image analysis only) Use to specify the needle comparison method, where:
| Identical, Similar, or Bounded |
Available commands
The following table describes the commands available in the UI. For more information on these commands, see Visual analysis functions.
Command | Description | Code Snippet (Java) |
---|---|---|
Find | Finds the text or image (needle) on the device screen (haystack) and stores the coordinates for future commands. See also Find text (FR) and Find image (FR). | mobile:text:find |
Button | Identifies a button, based on a text or image label, and clicks it. This command includes an integrated platform-specific OCR customization. See also Text button click (FR) and Image Button Click (FR). | mobile:button-text:click |
Edit-get | Identifies an edit field, based on a text or image label, and retrieves its text value. The value is returned as a string. See also Edit-text get (FR) and Edit-image get (FR). | mobile:edit-text:get |
Edit-set | Identifies an edit field, based on a text or image label, and inserts the specified text or image in the value parameter into the field. The field is in relation to the found label. It is defined by the label position and offset parameters. See also Edit-text set (FR) and Edit-image set (FR). | mobile:edit-text:set |
Screen | (Text analysis only) Returns the text that appears on the screen of the device. It does not select the text. See also Screen text (FR). | mobile:screen:text |