Skip to main content

GUI: Get Values

Description

GUI: Get Values step allow the user to read the value from element.

Prerequisites:

  1. If you want to use Java technology in this step, ensure you have Java 1.8 32-bit installed on your system. For details on installing Java 1.8 and setting up access bridge, see Appendix: Java Access Bridge Installation.
  2. If you want to use Web technology in this step, ensure valid extensions are added to corresponding web Browser.

Limitations:

The step will not work for Java and Windows technologies on Linux. For Java technology:

  • The scaling factor of the machine must be 100% only.
  • Resolution and scaling of workflow recorder machine and workflow runner step must be same.
  • This release does not support minimizing frames or maximizing internal frames. Designer can use GUI: Universal Actions step for robot handling
  • Max Timeout in step configuration is only applicable for Java and Windows technology.
  • Recorder is not supported for java/applet.

Known issues:

  • For Java technology: When the Access Bridge is configured to run the GUI Java automation steps, then SAHI automation will not work.
  • For Windows Technology: On detecting the element using Edit Element button if the detected element is other than text box then it shows the Mouse Actions on Step from Dialog.

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.
2TechnologySelect the technology used by the target application: Java, Web, or Windows.The data type is String and the field is mandatory.
3Action InformationClick to open the action information dialog.

Select the field details, as required. Click OK, and the selected Action Information details appear in the tabular format.

Note: The fields will change depending on the selected technology.
4Fail If Error OccursSpecify Yes, if you want the step to fail when an error occurs.
Specify No, if you do not want the step to fail when an error occurs.

Allow values: Yes, No
Default value: Yes
4.1Default Value If FailedSpecify the default value or null value to be returned when no value is retrieved or an error occurs.
This field ensures uninterrupted process execution.

Note: This field is available only if Fail If Error Occurs is set to No.
For Windows/Java Technology:Provide the following field details in the Action Information dialog.
IWindow PathWindow Path is the relative path of the Windows application in which element exists. It is captured by GUI Spy in the Generate Step dialog. It is then populated in the step configuration upon Step Generation. You may also enter or modify Windows path manually on the Step Generation window or step configuration.

Windows path may be provided as a String or regex.

Sample of Windows Path as string:
w[Desktop]/w[Application Name]
w[Desktop]/w[/Application N/]
w[Desktop]/w[/Application .*/]

If you are putting partial application name, then put it as a regex between / and /. Also, if the application name changes dynamically, it is a good idea to provide it as a regex.

Java: Provide the Window Name on which automation actions should be performed.
For example, Windows Name: AutomationEdge Applet App

Users can also utilize a regex pattern to match the window name, instead of specifying the exact window name of the Java Application.

For example:
Suppose the Java application window title is “Oracle Apps 2024-11-26“, a user can provide:
• Oracle Apps \d4-\d2-\d2
• ^Oracle
• Any other valid regex
IIElement Index(Starts with 0)For Multiple elements with same criteria, specify index of the element you want to locate.Provide index 0 if you want first element from the located elements, increment index by 1 for the next elements.

Default Value: 0

IIICriteriaSelect the criteria from the list to locate an element.
‘Criteria’ is the criterion to locate element on Windows or Java application. It is captured by Windows Spy 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 ‘Step Generation’ window or step configuration.
For list and description see Criteria Table.
The data type is string and the field is mandatory.
IVCriteria ValueSpecify relevant criteria value for the criteria provided above.
VAction TypeChoose any of the following options:
- Value: Get the actual value inside that control.
- Name: Get the control name value.
- Text: (Visible only for Window technology)
VIOutput FieldSpecify an output field name to hold the output of step execution.

Default Name: Result.

For Web TechnologyProvide the following field details in the Action Information dialog
IWeb Browser NameSelect any one Web Browser Name from the given list.

Note: Select the same Web Browser Name, which was selected in Start Browser Step.

IIElement Index(Starts with 0)Specify the index of the element you want to locate.

Note: One can also specify First or Last. First, if you want the first element from the located element or specify Last if you want the last element.

Default Value: 0

IIICriteriaSelect the criteria from the list to locate an element.
‘Criteria’ is the criterion to locate elements on Web GUI. GUI Spy can capture it 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.
Note: For list and description of criteria, See Criteria Table.
The data type is String and the field is mandatory.
IVCriteria ValueSpecify relevant criteria value for the criteria provided above.It is a mandatory field.
VIframe indicesSpecify Iframe Indices value. Specifying iframe indices ensures that the target element is identified correctly within the nested frame structure.You can provide comma-separated values.
For example. 0,1,2,…
VIIframe XpathIframe Xpath is a uniquely generated path that represents the location of an <iframe> or <frame> relative to the top-level window.

Iframe Xpath identifies each frame using a unique attribute such as id, name, or title if available, for example, iframe[@id='mainFrame'].

If no such attributes exist, the frame is identified by its position among sibling frames, like iframe[2] for the second iframe.

For nested structures, each frame is joined in sequence to form a full path. For example, if an element is inside an iframe[@id='outer'], which contains a frameset with a frame[@name='middle'], and that frame contains iframe[@title='inner'], the generated path would be:
iframe[@id='outer'];frame[@name='middle'];iframe[@title='inner'].

Note: If an iframe or frame has no id, name, or title, its origin (i.e., the src URL) will be used as a fallback in the path for unique identification. For example: iframe[@origin='https://example.com'].
VIIFrame IDProvide the current Iframe Id to target a specific iframe to perform the action.
Default Value: frameID
VIIOutput FieldProvide name which hold the result on successful execution. Default Name: Result.
4Max Timeout (In Second)Specify a Timeout value for the action to be performed.
5Step DescriptionDescribe the intended action for better step-row clarity.
Action Buttons:
No.Field NameDescription
1Button: Edit ElementClick to start spying.

Opening spy from step is restricted to the step, that is, only relevant elements are detected from active spy. Use Hotkeys (‘Shift’ or ’~’) to detect the element. We may call it as a ‘Step Restricted Spy’ for understanding purposes.

For example, suppose spy is started from ‘Get Table Data’ step. Now spy is restricted to elements of type ‘Table’ only. All element of type ‘Table’ will be highlighted in blue color. If we try to detect element other than of type ‘Table’ it will be highlighted in ‘Red’ color upon hover. Step dropdown is disabled and value selected is ‘Get Table Data’.

Note: Edit Element is visible for Java Technology or Windows Technology.