Web GUI

Web GUI


Plugin Reference



Web GUI 

WebGUI plugins are used for automation of web applications. 

Any type of UI Automation with Web GUI plugin steps is supported on Windows and Linux based OS. The following browser versions are supported for WebGUI Automation/Web Spy in Release 2.1.

Browser Support

OS

Chrome

Firefox

IE

 Release 2.1

Windows

75 to 88

38 to 47

8 to11

Linux

80 to 88

-

-


Prerequisites: 

  1. Upload the latest browser drivers for WebGUI plugin as follows,
  1. Upload the latest browser drivers (e.g. <CHROME<VERSION>.zip>) for WebGUI Plugin - using Plugin Management on AutomationEdge UI. (Refer section - File Management in AutomationEdge_System_Administrator_Guide_R6.0.0).
  2. Once uploaded the driver is available for both Process Studio and Agent. For Process Studio, additionally, perform Plugin Sync operation so that the drivers are available for automation.


  1. Web Spy may be used to build workflows with WebGUI plugin steps. For a description on how to use Web Spy refer the following,
  1. 33 Appendix 7: Web Spy Tutorial

The Web Spy tutorial also has a Sample Workflow with Web Spy 



Close Web Window

Description

The Close Web Window step closes the current browser window in Web GUI automation.


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.


Exit Browser

Description

The Exit Browser step explicitly closes the entire browser session for the driver specified in Web GUI automation.

Note: When a WebGUI workflow is run on an agent the entire browser session implicitly closes after the end of the workflow even if Exit browser is not put at the end of the workflow. 

However, When a WebGUI workflow is run from Process Studio the entire browser session does not close implicitly. 

Browser terminates abnormally then you need to clear browser driver instance before you can start a new browser. Navigate to Tools Clear All Browser Instances as shown below.



  |



Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.


Get Current Window Title

Description

The Get Current Window Title Web GUI plugin step gets the title of the current browser window.


Configurations

No.

Field Name

Description

1

Step Name

Name of the step.  This name has to be unique in a single workflow.

2

Web Browser Name

You can select any one Web Browser Name from the given list (BROWSER1, BROWSER1). You must select the same Web Browser Name which was selected in Start Browser Step.  

3

Window title field

Specify a fieldname to hold the retrieved Window Title. The default value is windowTitle.


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.


Inject Java Script

Description


Inject java Script is used to inject java script in a Web GUI automation workflow. Sometimes web control with web locators doesn’t react well as is unable to perform the action. At such times this step can be very useful to perform web actions. 

Inject Java Script automatically gets the web handle for the Web Browser chosen in Web Browser Name selection which is not available automatically in other scripting steps.   

Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

Inject Java Script automatically gets web handle from the selection.


Left Pane:


2

Get Input Fields

By clicking on this it will give a list of all input fields that can be used as a part of Inject Java Script.


Code Snippets:


3

Sample Code

Double click Sample Code to populate sample code in the Inject Java Script right hand pane. Here you will find an example to make fields available to next step.


Partial pseudo code for making multiple fields available to next step,

  var FieldName = "FieldName";

  var FieldValue = "FieldValue";

  

  var FieldName2 = "FieldName2";

  var FieldValue2 = "FieldValue2";

  

  return "<<>>"+FieldName+"::"+FieldValue+"<<>>;<<>>"+FieldName2+"::"+FieldValue2+"<<>>"; 


Right Pane:


4

Inject Java Script

Write the Java Script in the space provided.


Following, is a sample Java Script showing how to set value and click a button.

In this case the code sets values of username and password and clicks a login button.

var chkPrint = document.getElementsByName('uid')[0].value = "mngr169997";

document.getElementsByName('password')[0].value = "YvynEtA";

document.getElementsByName('btnLogin')[0].click();


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.





Start Browser

Description

The Start Browser step initiates the web browser and navigates to the URL specified in Web GUI automation.


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list.

2

Browser

Web browser to initialize. Choose from a drop down list containing,

  1. Mozilla
  2. Chrome
  3. Internet Explorer -with Ignore IE Protected mode checkbox (Refer Note 3 below)

3

Web URL

URL to navigate after web browser is initialized.

4

Default download directory

Any browser has a default directory path where all files are downloaded.  This feature allows users to overwrite the default download directory. Once a new Default download directory is specified, any file downloaded will be stored in the specified directory.

This setting is only affective for the current browser instance. This option is not available for Internet Explorer.

5

Maximize Browser

Checkbox to specify if browser window is to be maximized. By default, the browser is not maximized. 

6

Start Node

Checkbox to specify if this step is a start node (no other input steps are connected to this step)

7

Clear all browser instances

Clear All Browser Instances option is available in Start Browser in addition to the process studio -> tools menu. 

When a WebGUI workflow is run from Process Studio the entire browser session does not close implicitly, 

  1. Leaving the browser open even when there is an error during development and browser is manually or abnormally terminated. 
  2. In case you manually terminate a browser the browser driver is still initialized and when you run the workflow the start step will give an error as the browser is already initialized. 
  3. Similarly in case Browser terminates abnormally then you need to clear browser driver instance before you can start a new browser session.

Enable Clear All Browser Instances checkbox to Clear All Browser Instances before starting the browser.

8

Delay (in milliseconds)

Maximum global delay set for the entire session.

9

Notify on browser version change

Enable this checkbox to notify Workflow Administrator and Tenant Administrator if valid emails and SMTP is configured.

10

Page load timeout(in  milliseconds)

The page load timeout in milliseconds for any web page across the workflow. Else the workflow errors out. The page load timeout can be overwritten by the Web URL Navigation step.

11

Delay (in  milliseconds)

The total delay in milliseconds for the entire workflow to execute. Delay to locate and perform any action on any web element step, else the workflow errors out

12

Retry count

User can set retry count number and that will be globally used in all steps of WEBGUI for retrying on error. Whenever the execution of WEBGUI step ends up with an error it will retry execution number of time specified in start browser. 

If one doesn’t want to retry for some specific steps, retry count can be set to 0 by using ‘Set Retry Count’ Step.  Use of ‘Web Set Retry Count’ is to modify the count specified in Start Browser. Steps after Web Set Retry Count will get newly set Retry Count.

Following steps are excluded from the functionality of Retry Count:

  1. Begin
  2. End
  3. CloseWindow
  4. Robot Handling
  5. SetDelay
  6. SetRetryCount
  7. URL navigation


Notes: 

  1. In case of multiple Initialize Web Driver steps in single process/workflow, make sure different drivers are selected.
  2. If delay is specified as 0, default considered is 30 seconds.
  3. In case of IE, starting version 7, notion of 4 Security zones; namely Intranet, Internet, Trusted Sites and Restricted Sites was introduced. The following two scenarios are to be noted in Web GUI automation using IE.
  1. The default behavior in Web GUI automation using IE is to check “Enable Protected Mode” settings for all the zones and throw an error when this setting is different for any two zones. 
  2. In Web GUI automation with IE When “Enable Protected Mode” settings are different for different security zones and you navigate from one URL in one zone to another URL in different zone having a different setting for “Enable Protected Mode”, IE internally launches a new process and from that point on, automation fails as it loses the process handle.

In case of Web GUI automation ‘Ignore IE Protected Mode Settings’ checkbox has been introduced inWeb-GUI “Start Browser” step and Web-Spy to handle the two scenarios above.

  1. When “Ignore Protected Mode Settings” is CHECKED in Web-GUI “Start Browser” step and Web-Spy.  “Enable Protected Mode” setting check for different zones is ignored and it starts without error no matter what “Enable Protected Mode” settings for different zones are.
  2. We already have the feature to start WebGUI automation with an initial Browser URL. If during entire automation, browser doesn’t navigate to some other URL but URL specified as initial Browser URL, zone switching never happens and automation works fine.


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.


Web Actions

Description

The Web Actions step gives the option to perform several actions on a specific element on the web page in Web GUI automation. When ‘drag and drop’ action is selected the configurations for destination element is enabled. 


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Action*

Click action to be performed on the web page element.


Source Element:


1

Criteria*

Locate element on web page

2

Criteria Value

Relevant criteria value has to be specified.  

3

Multiple elements with same criteria

Check this option if there are multiple web elements in the web page having same criteria value you have specified. By default it will be unchecked.

4

Element index

If you have checked Multiple elements with same criteria specify index of the element you want to locate.

Select option FIRST if you want first element from the located element and select LAST if you want last element.

5

Use Coordinates

Enable checkbox to use coordinate options. This option is disabled for drag and drop Action.

6

X-Coordinate Value

Specify the value of X-Coordinate to move the cursor to specified x-coordinate of the located element.

7

Y-Coordinate Value

Specify the value of Y-Coordinate to move the cursor to specified y-coordinate of the located element.


Destination Element:

When ‘drag and drop’ action is selected the configurations for destination element is enabled. The configurations available are same as 1-4 of source element as above. 


*Action

The table below contains the description of each Action.

No.

Field Name

Description

1

Click

Perform single click on the web element.

2

Right Click

Perform right click on the web element.

3

Double Click

Perform double click on the web element.

4

Drag and Drop

Will perform drag and drop operation. 

5

Move to element

Will move focus to the specified web element.

6

Click and Hold

Clicks (without releasing) in the middle of the element.


*Criteria

The table below contains the description of criteria.

No.

Field Name

Description

1

Xpath

Xpath defines the hierarchy of the tags through which you can reach to a particular element. For example /html/body/div[1]/div/div[3]/div[2]/div/div[2]/div/div/div[2]/div[2]/div[1]/div[1]/div[1]/span/span

2

Id

Id attribute of a web element can be best way to identify an element if it is present and is going to constant and unique. There are cases however when it is either absent or its value changes every time you access the application in the browser

3

Name

Name is another attribute of a web element which can be used to identify an element.                                      

4

Link Text

If a HTML page contains a hyperlink element <a href=www.google.com>Search On Google</a>, you can identify this href element by providing complete text ‘Search On Google’ as the Link value.

5

Partial Link text

This criteria is same as Link, just that, in this case, you can give partial string for finding a match 

6

Tag Name

Every HTML element has a tag associated with it. The element can be located using that tag name. For example, textbox has a tag <input>.

7

Class Name

Class name is the css class associated with an HTML element. If there is a div element

<div class=’someclass’>MyDiv</div>, you can locate it by giving class name ‘someclass’.

8

Css Selector

This criteria is useful when an HTML element has multiple associated css classes. Consider an HTML element <div class="btn primary-btn submit"></div>. To identify this div element you can use Css selector as “.btn.primary-btn.submit”


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.




Web Alert

Description

The Web Alert step gives the functionality of handling java script generated alerts in Web GUI automation.


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Alert Operations*

Specify the alert operation to perform

3

Value

By default this field will be disabled and will be enabled if SetValue alert operation is chosen. Through this field you can specify the value you want to set in the alert.

4

Output field name

By default this field will be disabled this will be enabled only when you select GetValue alert operation. This allows you to define field name in which alert’s text will be stored.


*Alert Operations

The table below contains the description of each Alert Operation.

No.

Field Name

Description

1

Accept

Select this option when you want to click “OK/Yes” button of the alert.

2

Dismiss

This option will dismiss the alert which is appeared on the web page.

3

SetValue

If any alert is asking you to enter some value in it you can select this option and specify the value in Value field which is entered in the alert.

4

GetValue

If you want to retrieve alert text choose this option and it will store the retrieved value in the field you have specified in the Output field name.


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.




Web Click

Description

The Web Click step is used to click web element like button, hyper link, image and div. It is basically a single click on the specified web element.


Configurations

No.

Field

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Criteria*

Locate element on web page

3

Criteria Value

Relevant criteria value has to be specified.  

4

Multiple elements with same criteria

Check this option if there are multiple web elements in the web page having same criteria value you have specified. By default it will be unchecked.

5

Element index

If you have checked Multiple elements with same criteria specify index of the element you want to locate.

Select option FIRST if you want first element from the located element and select LAST if you want last element.

6

Number of clicks

Put the number of times web click occurs. It should be greater than zero. Default is 1.


*Criteria

The table below contains the description of criteria.

No.

Field

Description

1

Xpath

Xpath defines the hierarchy of the tags through which you can reach to a particular element. For example /html/body/div[1]/div/div[3]/div[2]/div/div[2]/div/div/div[2]/div[2]/div[1]/div[1]/div[1]/span/span

2

Id

Id attribute of a web element can be best way to identify an element if it is present and is going to constant and unique. There are cases however when it is either absent or its value changes every time you access the application in the browser

3

Name

Name is another attribute of a web element which can be used to identify an element.                                    

4

Link Text

If a HTML page contains a hyperlink element <a href=www.google.com>Search On Google</a>, you can identify this href element by providing complete text ‘Search On Google’ as the Link value.

5

Partial Link text

This criteria is same as Link, just that, in this case, you can give partial string for finding a match.

6

Tag Name

Every HTML element has a tag associated with it. The element can be located using that tag name. For example, textbox has a tag <input>.

7

Class Name

Class name is the css class associated with an HTML element. If there is a div element

<div class=’someclass’>MyDiv</div>, you can locate it by giving class name ‘someclass’.

8

Css Selector

This criteria is useful when an HTML element has multiple associated css classes. Consider an HTML element <div class="btn primary-btn submit"></div>. To identify this div element you can use Css selector as “.btn.primary-btn.submit”


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.



Web Composite

Description

The Web Composite step is a singular step that can be used to perform several Web GUI actions. 

Note: The step will perform only the basic actions. For the advanced requirements the original steps need to be used.

Configurations

No.

Field

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  


Actions Tab Table:


2

Actions

Choose the Action to be performed from the drop down list.


The following, actions can be performed using the Web Composite step.


  1. Get Value
  2. Set Value
  3. Click
  4. Right Click
  5. Double Click
  6. Click and Hold
  7. Move to Element
  8. Alert SetValue
  9. Alert Getvalue
  10. Alert Accept
  11. Alert Dismiss
  12. Element Displayed
  13. Element Enabled
  14. Element Selected
  15. Page Scroll
  16. Wait Until Alert Present
  17. Wait Until Element Visible
  18. Wait Until Element Present



The following steps are not supported in 

  1. Start Browser
  2. Exit Brower
  3. Close Web Window
  4. Robot Handling
  5. Web Drop Down Selection
  6. Web File Upload
  7. Web Loop Table
  8. Web URL Navigation
  9. Web Set Delay
  10. Web Actions  Drag and Drop

3

Criteria*

Choose the element locator to locate element on web page.

4

Criteria Value

Specify the relevant criteria value of the element locator to search with.

5

Multiple elements with same criteria

If there are multiple elements on the same page/frame with same criteria select Yes. 

6

Element index(Starts with 0)

Element index(Starts with 0) is enabled if Multiple elements with same criteria is marked as Yes. Need to specify the index of element to access.Select option FIRST if you want first element from the located element and select LAST if you want last element.

7

Value

Provide an optional value depending on the action chosen. (Such as if Web Click is chosen as action put the number of times web click occurs. It should be greater than zero. Default is 1; Provide value for Web Set Value).

8

Output field name

Specify an optional new output fieldname to hold value given out by the action depending on the action chosen, example Web Get Value.

9

Delay(in milliseconds)

Specify delay for the particular action. If empty, it is defaulted to the value set by Start Browser or latest Web Set Delay step. This is an implicit delay.

10

Description

Provide an optional description depending on the action chosen.


*Criteria

The table below contains the description of criteria.

No.

Field

Description

1

Xpath

Xpath defines the hierarchy of the tags through which you can reach to a particular element. For example /html/body/div[1]/div/div[3]/div[2]/div/div[2]/div/div/div[2]/div[2]/div[1]/div[1]/div[1]/span/span

2

Id

Id attribute of a web element can be best way to identify an element if it is present and is going to constant and unique. There are cases however when it is either absent or its value changes every time you access the application in the browser

3

Name

Name is another attribute of a web element which can be used to identify an element.                                    

4

Link Text

If a HTML page contains a hyperlink element <a href=www.google.com>Search On Google</a>, you can identify this href element by providing complete text ‘Search On Google’ as the Link value.

5

Partial Link text

This criteria is same as Link, just that, in this case, you can give partial string for finding a match.

6

Tag Name

Every HTML element has a tag associated with it. The element can be located using that tag name. For example, textbox has a tag <input>.

7

Class Name

Class name is the css class associated with an HTML element. If there is a div element

<div class=’someclass’>MyDiv</div>, you can locate it by giving class name ‘someclass’.

8

Css Selector

This criteria is useful when an HTML element has multiple associated css classes. Consider an HTML element <div class="btn primary-btn submit"></div>. To identify this div element you can use Css selector as “.btn.primary-btn.submit”


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.


Web Download Image

Description

The Web Composite step is a singular step that can be used to perform several Web GUI actions. 

Note: The step will perform only the basic actions. For the advanced requirements the original steps need to be used.

Configurations

No.

Field

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Criteria

Locate element on web page

3

Criteria value

Relevant criteria value has to be specified.  

4

Multiple elements with same criteria

Check this option if there are multiple web elements in the web   having same criteria value you have specified. By default it will be unchecked.

5

Element index(Starts with 0)

If you have checked Multiple elements with same criteria specify index of the element you want to locate.

Select option FIRST if you want first element from the located element and select LAST if you want last element.

6

Download Directory

The directory where the image file will be downloaded. The default directory is ${Internal.Entry.Current.Directory} i.e. that is the same location where the workflow is saved.

8

Output file path

Specify a field to hold the Output file path including the file path along with name of the image file downloaded.


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.



Web Dropdown Selection

Description

The Web Dropdown Selection step is used to select value of dropdown list on the web page for Web GUI automation.


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Criteria*

Locate element on web page

3

Criteria Value

Relevant criteria value has to be specified.  

4

Multiple elements with same criteria

Check this option if there are multiple web elements in the web page having same criteria value you have specified. By default it will be unchecked.

5

Element index

If you have checked Multiple elements with same criteria specify index of the element you want to locate.

Select option FIRST if you want first element from the located element and select LAST if you want last element.

6

Select by*

Method to select the dropdown value

7

Selection value

Relevant value need to be specified for the method selected in Select by 


*Criteria

The table below contains the description of criteria.

No.

Field Name

Description

1

Xpath

Xpath defines the hierarchy of the tags through which you can reach to a particular element. For example /html/body/div[1]/div/div[3]/div[2]/div/div[2]/div/div/div[2]/div[2]/div[1]/div[1]/div[1]/span/span

2

Id

Id attribute of a web element can be best way to identify an element if it is present and is going to constant and unique. There are cases however when it is either absent or its value changes every time you access the application in the browser

3

Name

Name is another attribute of a web element which can be used to identify an element.                                       

4

Link Text

If a HTML page contains a hyperlink element <a href=www.google.com>Search On Google</a>, you can identify this href element by providing complete text ‘Search On Google’ as the Link value.

5

Partial Link text

This criteria is same as Link, just that, in this case, you can give partial string for finding a match 

6

Tag Name

Every HTML element has a tag associated with it. The element can be located using that tag name. For example, textbox has a tag <input>.

7

Class Name

Class name is the css class associated with an HTML element. If there is a div element

<div class=’someclass’>MyDiv</div>, you can locate it by giving class name ‘someclass’.

8

Css Selector

This criteria is useful when an HTML element has multiple associated css classes. Consider an HTML element <div class="btn primary-btn submit"></div>. To identify this div element you can use Css selector as “.btn.primary-btn.submit”


*Select by

The table below contains the description of each Select by methods.

No.

Field Name

Description

1

Index

Suppose located dropdown has 3 options “A,B,C”, now if you want to select “A” give the index value as “0” and so on.


2

Value

Every item in html dropdown has a value attribute associated with it. If the Value attribute of desired option is known select this option.

3

Visible Text

Visible Text is the value of the option which user can see on the web page.


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.




Web Element Condition

Description

The Web Element Condition step checks specified condition of web page element and returns a Boolean value in Web GUI automation.


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Condition*

Condition to check on web page element.

3

Criteria*

Locate element on web page

4

Criteria Value

Relevant criteria value has to be specified.  

5

Output field name

Name of the output field, which contains the evaluated Boolean value.


*Condition

The table below contains the description of each Condition.

No.

Field Name

Description

1

Is displayed

Check if web page element is displayed.

2

Is enabled

Check if web page element is enabled.

3

Is selected

Check if web page element is selected.


*Criteria

The table below contains the description of criteria.

No.

Field Name

Description

1

Xpath

Xpath defines the hierarchy of the tags through which you can reach to a particular element. For example /html/body/div[1]/div/div[3]/div[2]/div/div[2]/div/div/div[2]/div[2]/div[1]/div[1]/div[1]/span/span

2

Id

Id attribute of a web element can be best way to identify an element if it is present and is going to constant and unique. There are cases however when it is either absent or its value changes every time you access the application in the browser

3

Name

Name is another attribute of a web element which can be used to identify an element.                                      

4

Link Text

If a HTML page contains a hyperlink element <a href=www.google.com>Search On Google</a>, you can identify this href element by providing complete text ‘Search On Google’ as the Link value.

5

Partial Link text

This criteria is same as Link, just that, in this case, you can give partial string for finding a match 

6

Tag Name

Every HTML element has a tag associated with it. The element can be located using that tag name. For example, textbox has a tag <input>.

7

Class Name

Class name is the css class associated with an HTML element. If there is a div element

<div class=’someclass’>MyDiv</div>, you can locate it by giving class name ‘someclass’.

8

Css Selector

This criteria is useful when an HTML element has multiple associated css classes. Consider an HTML element <div class="btn primary-btn submit"></div>. To identify this div element you can use Css selector as “.btn.primary-btn.submit”


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.



Web File Upload

Description

The Web File Upload step is used for uploading a file with absolute path (browse dialog) on a web page in Web GUI automation.


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

File path

Absolute file path for upload


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.



Web Get Value

Description

The Web Get Value step allows you to retrieve text of any web element (including dropdown). The retrieved value will be stored in a field value. The step also allows multiple criteria to retrieve text of multiple web elements in Web GUI automation. 

Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Criteria*

Locate element on web page (including radio button and checkbox)

3

Criteria value

Relevant criteria value has to be specified.  

4

Element is dropdown

Select Yes/No based on element is dropdown or not.

5

Multiple elements with same criteria

Select Yes if there are multiple web elements in the web page having same criteria value you have specified, else select No

6

Element index

If you have selected Yes for Multiple elements with same criteria, specify index of the element you want to locate.

Select option FIRST if you want first element from the located element and select LAST if you want last element.

7

Output field name

Here you can define process studio output field in which retrieved value will be stored.


*Criteria

The table below contains the description of criteria.

No.

Field Name

Description

1

Xpath

Xpath defines the hierarchy of the tags through which you can reach to a particular element. For example /html/body/div[1]/div/div[3]/div[2]/div/div[2]/div/div/div[2]/div[2]/div[1]/div[1]/div[1]/span/span

2

Id

Id attribute of a web element can be best way to identify an element if it is present and is going to constant and unique. There are cases however when it is either absent or its value changes every time you access the application in the browser

3

Name

Name is another attribute of a web element which can be used to identify an element.                                       

4

Link Text

If a HTML page contains a hyperlink element <a href=www.google.com>Search On Google</a>, you can identify this href element by providing complete text ‘Search On Google’ as the Link value.

5

Partial Link text

This criteria is same as Link, just that, in this case, you can give partial string for finding a match 

6

Tag Name

Every HTML element has a tag associated with it. The element can be located using that tag name. For example, textbox has a tag <input>.

7

Class Name

Class name is the css class associated with an HTML element. If there is a div element

<div class=’someclass’>MyDiv</div>, you can locate it by giving class name ‘someclass’.

8

Css Selector

This criteria is useful when an HTML element has multiple associated css classes. Consider an HTML element <div class="btn primary-btn submit"></div>. To identify this div element you can use Css selector as “.btn.primary-btn.submit”


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.



Web Loop Table

Description

The step is used to traverse through an HTML table in Web GUI automation. Either entire table or specific columns can be the output. 

The Web Loop Table step is designed to be used within a loop. On drag n drop of this new step, Continue step is also added on the canvas and the validations are same as the Start Loop-Continue Loop steps.

Each row of the table is processed for a single iteration (The rows to be processed are specified in the Loop Tab as All or specific rows or based on a condition). Processing of all the rows specified for a single iteration completes a loop. 

The input row and additional fields are passed in the false path after all the rows (as specified in the Loop Tab) are processed.

Validations:

  1. If the workflow is using switch case for path decisions inside loop or error handling, all of them must end with Loop Continue Step.
  2. Both the steps must be present and connected properly in the workflow.
  3. Infinite loop will not be verified.
  4. Cannot have Blocking Steps in the loop
  5. Steps like Merge Join, Join Rows which wait for all rows before execution start will not be allowed in the loop. 
  6. Row generating steps like Microsoft Excel Input are not allowed in a loop. 


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  


Web Table Tab:

No.

Field Name

Description

2

Selection Options

This is an implicit field with only one option, Entire Table with Specific Columns.

3

Criteria*

Choose the element locator from the drop down list.

4

Criteria value

Provide the value of the element locator to search with.

5

Multiple elements with same criteria

Check this option if there are multiple web elements in the web page having same criteria value you have specified. By default it will be unchecked.

6

Element index

If you have checked Multiple elements with same criteria specify index of the element you want to locate.

You may also select option FIRST if you want first element from the located element and select LAST if you want last element.


Get Values Table:


7

Table Column Index

Specify column index to be retrieved. For multiple columns, mention column index on different rows.

8

Output Field Name

New field to store the retrieved value of the respective column for each row.


Loop Tab:

No.

Field Name

Description

1

Conditional Loop?

Checkbox to activate the Conditions block, else Number of rows will is active.

2

Number of rows

Specify the number of rows to pass through the loop. Values are in a dropdown,

  1. All Rows
  2. First 
  3. Last 

Also a text box is provided to enter a numeric value N, in case First or Last is selected. 


Table: Additional Fields 

This table is used to create user defined additional fields. Additional fields are added as columns to the row. They are permanent and visible even after the loop is over.


Note: Any fields created within a loop are not permanently available after loop execution. Only Additional fields specified in Loop Start are available even after loop execution.

3

Name

Provide names of all additional fields you want to define.

4

Type

Select a data type for the additional field.

5

Format

Select a format for the data Type selected above.

6

Default value

Provide a default value for the additional field.

7

Set empty string?

Select Y or N.

If default value is not provided set ‘Set empty string?’ to Y. This sets a null value as an empty string.

8

Block: Conditions


For more detailed description with screen shots refer Start Loop step.

Conditions Block is a set of five fields. These fields can be populated with Previous field, Addition fields or Static values.  Click the field to populate a value as a toggle or from a popup that comes up. 

The first field specifies a toggle for a condition. Leave it default to blank or click once to toggle it to NOT.

The second is the field to compare.

The third field is an operator

The fourth field is the field to be compared against or alternately specify a static value in the sixth field to be compared against.


Click on the small rectangular icon on the right hand side of the block to add a condition. You can Add a condition with the following operators: OR, AND, OR NOT, AND NOT, XOR.

Multiple condition list by icon on right side 


Right click on a condition to get a pop-up menu with the following options: Edit condition, Delete condition, Add sub-condition, Move condition to sub-condition (-->), Move condition to parent (<--) and more copy options. These options can be used to create Nested conditions.

9

Button: Get Fields

In the Conditions Block above only previous fields are available. Click Get Fields to make Additional fields also available in the conditions block.



*Criteria

The table below contains the description of criteria.

No.

Field Name

Description

1

Xpath

Xpath defines the hierarchy of the tags through which you can reach to a particular element. For example /html/body/div[1]/div/div[3]/div[2]/div/div[2]/div/div/div[2]/div[2]/div[1]/div[1]/div[1]/span/span

2

Id

Id attribute of a web element can be best way to identify an element if it is present and is going to constant and unique. There are cases however when it is either absent or its value changes every time you access the application in the browser

3

Name

Name is another attribute of a web element which can be used to identify an element.                                       

4

Link Text

If a HTML page contains a hyperlink element <a href=www.google.com>Search On Google</a>, you can identify this href element by providing complete text ‘Search On Google’ as the Link value.

5

Partial Link text

This criteria is same as Link, just that, in this case, you can give partial string for finding a match 

6

Tag Name

Every HTML element has a tag associated with it. The element can be located using that tag name. For example, textbox has a tag <input>.

7

Class Name

Class name is the css class associated with an HTML element. If there is a div element

<div class=’someclass’>MyDiv</div>, you can locate it by giving class name ‘someclass’.

8

Css Selector

This criteria is useful when an HTML element has multiple associated css classes. Consider an HTML element <div class="btn primary-btn submit"></div>. To identify this div element you can use Css selector as “.btn.primary-btn.submit”


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.



Web Table

Description

The Web Table step is used to traverse through HTML table in Web GUI automation. Either entire table or specific columns can be the output.


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Selection Options*

There are three options to iterate through entire table or specific row with specific columns.

3

Criteria**

Locate element on web page. 

4

Criteria value

Relevant criteria value to be specified.  

5

Multiple elements with same criteria

Check this option if there are multiple web elements in the web page having same criteria value you have specified. By default it will be unchecked.

6

Element index

If you have checked Multiple elements with same criteria specify index of the element you want to locate.

Select option FIRST if you want first element from the located element and select LAST if you want last element.

7

Table Column Index

Specify column index to be retrieved. For multiple columns, mention column index on different rows.

8

Output Field Name

Field to store the retrieved value of the respective column.


*Selection Option

The table below contains the description of each Selection Option.

No.

Field Name

Description

1

Entire Table With Specific Columns

Traverse entire table and retrieve values from specific column(s).

2

One Row With Specific Columns

Retrieve one row with specific column(s).

3

One Cell

Retrieve value of one column of any specific row.


**Criteria

The table below contains the description of criteria.

No.

Field Name

Description

1

Xpath

Xpath defines the hierarchy of the tags through which you can reach to a particular element. For example /html/body/div[1]/div/div[3]/div[2]/div/div[2]/div/div/div[2]/div[2]/div[1]/div[1]/div[1]/span/span

2

Id

Id attribute of a web element can be best way to identify an element if it is present and is going to constant and unique. There are cases however when it is either absent or its value changes every time you access the application in the browser

3

Name

Name is another attribute of a web element which can be used to identify an element.                                       

4

Link Text

If a HTML page contains a hyperlink element <a href=www.google.com>Search On Google</a>, you can identify this href element by providing complete text ‘Search On Google’ as the Link value.

5

Partial Link text

This criteria is same as Link, just that, in this case, you can give partial string for finding a match 

6

Tag Name

Every HTML element has a tag associated with it. The element can be located using that tag name. For example, textbox has a tag <input>.

7

Class Name

Class name is the css class associated with an HTML element. If there is a div element

<div class=’someclass’>MyDiv</div>, you can locate it by giving class name ‘someclass’.

8

Css Selector

This criteria is useful when an HTML element has multiple associated css classes. Consider an HTML element <div class="btn primary-btn submit"></div>. To identify this div element you can use Css selector as “.btn.primary-btn.submit”


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.



Web Page Scroll

Description

The Web Page Scroll step is used to scroll a web page in Web GUI automation. It can be used to locate or access an element on the web page which requires page scrolling. Criteria and value are specified to locate the element to scroll to and the step will automatically scroll where ever needed.


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Criteria*

Locate element on web page.

3

Criteria value

Relevant criteria value has to be specified.  

4

Multiple elements with same criteria

Check this option if there are multiple web elements in the web page having same criteria value you have specified. By default it will be unchecked.

5

Element index

If you have checked Multiple elements with same criteria specify index of the element you want to locate.

Select option FIRST if you want first element from the located element and select LAST if you want last element.


*Criteria

The table below contains the description of criteria.

No.

Field Name

Description

1

Xpath

Xpath defines the hierarchy of the tags through which you can reach to a particular element. For example /html/body/div[1]/div/div[3]/div[2]/div/div[2]/div/div/div[2]/div[2]/div[1]/div[1]/div[1]/span/span

2

Id

Id attribute of a web element can be best way to identify an element if it is present and is going to constant and unique. There are cases however when it is either absent or its value changes every time you access the application in the browser

3

Name

Name is another attribute of a web element which can be used to identify an element.                                       

4

Link Text

If a HTML page contains a hyperlink element <a href=www.google.com>Search On Google</a>, you can identify this href element by providing complete text ‘Search On Google’ as the Link value.

5

Partial Link text

This criteria is same as Link, just that, in this case, you can give partial string for finding a match 

6

Tag Name

Every HTML element has a tag associated with it. The element can be located using that tag name. For example, textbox has a tag <input>.

7

Class Name

Class name is the css class associated with an HTML element. If there is a div element

<div class=’someclass’>MyDiv</div>, you can locate it by giving class name ‘someclass’.

8

Css Selector

This criteria is useful when an HTML element has multiple associated css classes. Consider an HTML element <div class="btn primary-btn submit"></div>. To identify this div element you can use Css selector as “.btn.primary-btn.submit”


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.



Web Set Delay

Description

The Web Set Delay step sets the global delay value for further steps in Web GUI automation.


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Delay (in milliseconds)

Global delay value to be set for the specified driver.


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.



Web Set Retry Count

Description

Web Set Retry Count step is used to modify the Retry Count specified in Start Browser of Web GUI automation. Steps after Web Set Retry Count will get newly set Retry Count. 


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Retry Count

A retry count number can be set that is globally used in all steps of WEBGUI for retrying on error. Initially a retry count number can be set in Start Browser step. Whenever the execution of web gui step ends up with an error it will retry execution the number of time specified in start browser. 

If one does’nt want to retry for some specific steps, retry count can be set to 0 by using ‘Set Retry Count’ Step.  Use of ‘Web Set Retry Count’ is to modify the count specified in Start Browser. Steps after Web Set Retry Count will get newly set Retry Count.

Following steps are excluded from the functionality of Retry Count:

  1. Begin
  2. End
  3. CloseWindow
  4. Robot Handling
  5. SetDelay
  6. SetRetryCount
  7. URL navigation


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.



Web Set Value

Description

The Web Set Value step is used to set the text in the web element, example, text box, column in a table in Web GUI automation.

Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Criteria*

Locate element on web page. 

3

Criteria value

Relevant criteria value has to be specified.  

4

Text

Here you can specify the text you want to enter in to the element you have located.

5

Clear text before set?

Select Yes if you want to remove previously set value in the element you have located and No if you want to append the text in the element.


 *Criteria

The table below contains the description of criteria.

No.

Field Name

Description

1

Xpath

Xpath defines the hierarchy of the tags through which you can reach to a particular element. For example /html/body/div[1]/div/div[3]/div[2]/div/div[2]/div/div/div[2]/div[2]/div[1]/div[1]/div[1]/span/span

2

Id

Id attribute of a web element can be best way to identify an element if it is present and is going to constant and unique. There are cases however when it is either absent or its value changes every time you access the application in the browser

3

Name

Name is another attribute of a web element which can be used to identify an element.                                       

4

Link Text

If a HTML page contains a hyperlink element <a href=www.google.com>Search On Google</a>, you can identify this href element by providing complete text ‘Search On Google’ as the Link value.

5

Partial Link text

This criteria is same as Link, just that, in this case, you can give partial string for finding a match 

6

Tag Name

Every HTML element has a tag associated with it. The element can be located using that tag name. For example, textbox has a tag <input>.

7

Class Name

Class name is the css class associated with an HTML element. If there is a div element

<div class=’someclass’>MyDiv</div>, you can locate it by giving class name ‘someclass’.

8

Css Selector

This criteria is useful when an HTML element has multiple associated css classes. Consider an HTML element <div class="btn primary-btn submit"></div>. To identify this div element you can use Css selector as “.btn.primary-btn.submit”


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.


Web Switch Frame

Description

The Web Switch Frame step switches between HTML frames in the web page in Web GUI automation.


Configurations

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Locate By*

Switching frame options 

3

Criteria*

Locate element on web page

4

Criteria Value

Relevant criteria value has to be specified.  

5

Multiple elements with same criteria

Check this option if there are multiple web elements in the web page having same criteria value you have specified. By default it will be unchecked.

6

Element index

If you have checked Multiple elements with same criteria specify index of the element you want to locate.

Select option FIRST if you want first element from the located element and select LAST if you want last element.


*Locate By

The table below contains the description of each Locate By option.

No.

Field Name

Description

1

Default

Navigate to default context of the page i.e. outer most region of web page

2

Parent

Navigate to parent frame

3

Name

Specify name of the frame to switch to

4

Id

Specify id of the frame to switch to

5

Element

Switch to frame where element of specific criteria is present

6

Index

Index of the frame you want to switch to


*Criteria

The table below contains the description of criteria.

No.

Field Name

Description

1

Xpath

Xpath defines the hierarchy of the tags through which you can reach to a particular element. For example /html/body/div[1]/div/div[3]/div[2]/div/div[2]/div/div/div[2]/div[2]/div[1]/div[1]/div[1]/span/span

2

Id

Id attribute of a web element can be best way to identify an element if it is present and is going to constant and unique. There are cases however when it is either absent or its value changes every time you access the application in the browser

3

Name

Name is another attribute of a web element which can be used to identify an element.                                       

4

Link Text

If a HTML page contains a hyperlink element <a href=www.google.com>Search On Google</a>, you can identify this href element by providing complete text ‘Search On Google’ as the Link value.

5

Partial Link text

This criteria is same as Link, just that, in this case, you can give partial string for finding a match 

6

Tag Name

Every HTML element has a tag associated with it. The element can be located using that tag name. For example, textbox has a tag <input>.

7

Class Name

Class name is the css class associated with an HTML element. If there is a div element

<div class=’someclass’>MyDiv</div>, you can locate it by giving class name ‘someclass’.

8

Css Selector

This criteria is useful when an HTML element has multiple associated css classes. Consider an HTML element <div class="btn primary-btn submit"></div>. To identify this div element you can use Css selector as “.btn.primary-btn.submit”


No.

Common Buttons


1

Help

Click to see the Plugin description and configuration details.

2

OK

Click OK button to accept configurations.

3

Cancel

Click CANCEL button to discard configurations.


Web Switch Window

Description

The Web Switch Window step is useful when you want to switch between multiple browser windows in Web GUI automation. This basically gives the handle of desired window to perform further activity on that window.


Configuration

No.

Field Name

Description

1

Web Browser Name

You can select any one Web Browser Name from the given list, 

Basically you must select the same Web Browser Name which was selected in Start Browser Step.  

2

Switching options*

Options to switch window 

3

Criteria*

Locate element on web page. By default this field will be disabled and will be enabled only when Element is selected as a switching option.

4

Value

Relevant value for the specified Switching option. 


*Switching Options

The table below contains the description of each Switching option.

No.

Field Name

Description

1

Window Title

Option can be used when window title is known. 

2

Element

Tries to find the specified element in all open browser windows and stops on the window where this element is found.

Criteria to locate element can be specified using criteria and value field.

3

URL

If there are multiple windows or tabs open in the browser with different URLs and you need to navigate to the window having specific URL. Specify URL in the value field. 

4

Index

Every window open in the browser has the index starting from zero you can switch to any window using this index.


*Criteria