Legacy | Webpage.Element.Find

Command: webpage.element
Subcommand: find
Supported Platforms: Native (legacy), UFT (legacy), Selenium, Appium

All commands must be executed using the same framework. Sharing the execution ID between different frameworks is not possible. This means that if you work with a Selenium/Appium driver, you need to call the commands using the Selenium/Appium driver (or, in the case of Reporting commands, through the Reporting SDK that works with the driver) and not as part of a UFT test or another framework.
Supported OS: Android, iOS

Finds an element or elements on the webpage Can be used to validate whether an element exists on the webpage.

Description

Uses an element identifier (HTML attribute value or XPath) to search for the element in the display of the active window. Assumes that the display is using DOM elements. Can be used to validate whether an element exists on the webpage.

The returnValue of the response provides the element tree traversal to the element if found.

Parameters

Name	Value	Default	Description
deviceId^*			The device for this command.
value^*			The object identifier. By default, an Xpath is generated by the object spy. Use the By parameter to specify another identification method.
by	xpath (XPath) cssSelector (CSS Selector) id (HTML id) name (HTML name) className (HTML class) tagName (HTML tag) linkText (Text) partialLinkText (Partial text) cacheId ()	XPath	Specifies the identification method.
timeout		0	The time, in seconds, to wait for the element to appear on the screen or the web page.
datatable			The results of the find will be added to a data table, which can be used with other functions. The data table should have a single column of type STRING.
webView		1	The index number of the web view in a hybrid application.
framework	appium-1.3.4 (Appium) perfectoMobile (PerfectoMobile)	PerfectoMobile	The automation framework.
scope			A list of XPath expressions representing the iFrames/Frames leading to the element.
pageTimeout		30	The time, in seconds, to wait for the application screen or the web page to be loaded.
report	screenshot (Screenshot) screenshot-on-error (Screenshot on error) none (None)	Screenshot	The value to display in the report. Screenshot - display screenshot Screenshot on error - display screenshots only for actions in error None - display nothing It is recommended to reduce the resolution in very long scripts that result in large report files.
report.resolution	high (High) medium (Medium) low (Low)	High	The image resolution. It is recommended to reduce the resolution in very long scripts that result in large report files.

^* Mandatory parameter

Request & Response

Copy

Request

https://mycloud.perfectomobile.com/services/executions/john@perfectomobile.com_controller_16-12-07_08_30_54_151?operation=command&securityToken=<your_token>&command=webpage.element&subcommand=find&param.deviceId=570E7512&param.by=id&param.value=okBtn

Copy

JSON response

{
    "reason":"Success",
    "timer.elapsed":"578",
    "returnValue":"[/html[1]/body[1]/div[5]/div[2]]",
    "testGridReportUrl":"https://mycloud.reporting-stg.perfectomobile.com?externalId[0]=john@perfectomobile.com_controller_16-12-07_08_30_54_151",
    "description":"Success",
    "timer.system":"15",
    "completed":"true",
    "flowEndCode":"SUCCEEDED",
    "executionId":"john@perfectomobile.com_controller_16-12-07_08_30_54_151",
    "timer.ux":"563",
    "singleTestReportUrl":"https://mycloud.perfectomobile.com/nexperience/singletest/report/?reportRepositoryKey=PRIVATE:controller/161207/controller_16-12-07_08_30_54_151.xml&ownerId=john@perfectomobile.com&sharingCode=a8d8ba68-ee11-4594-a83a-2eca62034d2c",
    "reportKey":"PRIVATE:controller/161207/controller_16-12-07_08_30_54_151.xml",
    "timer.device":"563"}