Skip to main content

GUI: Set Values

Description

GUI: Set Values plugin step allow user to sets value to element of type – Text box, Text area, document or pane.

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.

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.
For Windows/Java Technology:Provide the following field details in the Action Information dialog.
I.Window PathWindow Path is the relative\absolute path of the Windows application on 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 providing 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 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’ to locate elements on Windows Desktop\Java application. It is captured by GUI 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.

The data type is string, and the field is mandatory.
IVCriteria ValueSpecify relevant criteria value for the criteria provided above.
VWrite TypeChoose options from list:

-Set new text: Replace existing text with new.

- Append: Adds text to the end of the existing text.

- Insert At Start: Adds text at the beginning of existing text.
VIInput TextProvide the text that you want to set.
VIIVerify Entered TextSelect the checkbox if you want to validate that the set input text is applied to the element.

Notes: For Windows and Java, if the Verify Entered checkbox is selected and Write Type is one of the following:

- Set new text then the already set text is cleared and will set the value provided in the Input Text field. The checkbox selection also checks if the set and provided values from the plugin step are the same. If the values are same, then the workflow execution is successful else an error is shown.

-Append then the provided Input Text is appended to the already existing text, and the entire value, that is, already existing text and text provided from the plugin step is checked to see if they match. If the values are same, then the workflow execution is successful, else an error is shown.

Insert At Start then the text is inserted at the start or beginning of the provided Input Text of already existing text. The complete value, that is, the already existing text and text provided from the plugin step is checked. If the text matches, then the workflow execution is successful else an error is shown.
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

IIICriteria‘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.
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 e.g. 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'].
VIII.Frame IDProvide the current Iframe Id to target a specific iframe to perform the action.
Default Value: frameID
VIIInput TextSpecify the text you want to enter into the element you have located.It is a mandatory field.
VIIIVerify Entered TextSelect the checkbox if you want to validate that the set input text is applied to the element.

Notes:- If Clear Text Before Set? is selected, then the already set text is cleared and will set the value provided in the Input Text field. The checkbox selection also checks if the set and provided values from the plugin step are the same. If the values are same, then the workflow execution is successful else an error is shown.

If Clear Text Before Set? is cleared the provided Input Text is appended to the already existing text, and the entire value, that is, already existing text and text provided from the plugin step is checked to see if they match. If the values are same, then the workflow execution is successful, else an error is shown.

IXCheckbox: Clear Text Before Set?Check the checkbox if you want to remove previously set value in the element you have located and uncheck if you want to append the text in the element.
4Max Timeout (In Second)Specify a Timeout value for the action to be performed.
5Step DescriptionDescribe the intended action for better step-row clarity.
Common Buttons:
1Edit Element

Click Edit Element to start spying.

Opening spy from step is restricted to the step, i.e. 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. E.g. Suppose spy is started from ‘Set Value’ step. Now spy is restricted to elements that support ‘Set Value’. All elements that are supported will be highlighted in blue color and others will be highlighted in ‘Red’ color upon hover. Step dropdown is disabled and value selected is ‘et Value’

Note: Option is visible for Java Technology or Windows Technology.