Skip to main content

GUI: Frame Locator

Description

GUI: Frame Locator step allows you to search the frame by available options that is Name, ID, Title and Element, and returns the frame Indices, frame Xpath and current frame ID of selected frame.

Configurations

No.Field NameDescription
1Step NameName of the step. The name must be unique in a single workflow.
The data type is string, and the field is mandatory.
2Web Browser NameYou can select any one Web Browser from the given list.
Note: You must select the same Web Browser Name which was selected in Start Browser Step.
The field is mandatory.
3Search Frame BySelect the locator from the list to search the frame/iframe by.

Available options are:
Name – Specify the name of frame/iframe to locate.
ID – Specify the id of frame/iframe to locate.
Title – Specify the title of frame/iframe to locate.
Element – Specify a unique element (such as an ID, label, or other selector) that exists inside the frame you want to locate. The plugin searches all frames to find the one containing this element and returns its details, including the iframe indices and XPath.

Note: Element is the most reliable method for locating a frame because it directly identifies content inside the frame, rather than relying on attributes like name or title, which may be missing or duplicated.
The field is mandatory.
4ValueSpecify the locator value of the selected criteria.
Note: The field is available only when Search Frame By is set to Name, ID, or Title.
The field is mandatory.
5CriteriaSelect the criteria from the list to locate an element on Web GUI.
Criteria is the criterion to locate elements on Web GUI.
GUI Spy can capture the element in the Generate Step dialog. Upon Step Generation, it is populated in the step configuration.
You may change criteria by choosing from the list in the Step Generation window or step configuration.
Notes:
- For list and description of criteria values, See Criteria Table.
- The field is available only when Search Frame By is set to Element.
The field is mandatory.
6Criteria ValueSpecify relevant criteria value for the criteria provided above.
Note: The field is available only when Search Frame By is set to Element.
The field is mandatory.
7Element Index (Starts with 0)For multiple elements with the same criteria, specify the index of the element you want to locate.
Provide index 0 if you want the first element from the located elements. Increment the index by 1 for the next elements.
Note: The field is available only when Search Frame By is set to Element.
The field is mandatory.
8Frame IndicesField returns frame indices value on successful execution.
Default Value: frameIndices
9Frame XpathField returns frame xpath value on successful execution.
Default Value: frameXpath
10Frame IDField returns the current Frame ID in integer value of selected frame on successful execution.
Default Value: frameID