Ui.Vision RPA

https://ui.vision/rpa/docs
Admin
Ui.Vision RPA is an open-source automation tool that combines Selenium IDE with advanced features...
Tokens:155,215
Snippets:373
Trust Score:9.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### XClick Example

Source: https://ui.vision/rpa/docs/xclick

A basic example demonstrating the XClick command for interacting with web elements. It shows how to specify a target image and an optional pattern for double-clicking.

```Ui.Vision RPA
Command | Target | Pattern/Text
XClick | button.png | #doubleclick
echo | done
```

--------------------------------

### WaitForPageToLoad Example Usage

Source: https://ui.vision/rpa/docs/selenium-ide/waitforpagetoload

An example demonstrating the use of the WaitForPageToLoad command within a Selenium IDE script, alongside an assertText command.

```Selenium IDE
Command | Target | Pattern/Text ||
| assertText | link=Free Web Automation | Free Web Automation |
| WaitForPageToLoad | 3000 |  |
```

--------------------------------

### WaitForPageToLoad Example Usage

Source: https://ui.vision/rpa/docs/selenium-ide/waitForPageToLoad

An example demonstrating the use of the WaitForPageToLoad command within a Selenium IDE script, alongside an assertText command.

```Selenium IDE
Command | Target | Pattern/Text ||
| assertText | link=Free Web Automation | Free Web Automation |
| WaitForPageToLoad | 3000 |  |
```

--------------------------------

### Example Macro for select Command

Source: https://ui.vision/rpa/docs/selenium-ide/select

This example demonstrates how to use the 'select' command with different option locators (label=, label=*.., value=, index=) to automate selecting OCR languages on the ocr.space form.

```Selenium IDE
Command | Target | Pattern/Text ||
| open | https://ocr.space/ |  |
| select | id=ocrLanguage | label=ChineseSimplified |
| select | id=ocrLanguage | label=*man* |
| select | id=ocrLanguage | value=ita |
| select | id=ocrLanguage | index=10 |
| click | id=SearchableAndLayer |  |
```

--------------------------------

### storeAttribute Example

Source: https://ui.vision/rpa/docs/selenium-ide/storeattribute

Example demonstrating how to extract the link (src attribute) and ALT text from an image using the storeAttribute command.

```Selenium IDE
Command | Target | Pattern/Text ||
open | https://ui.vision/rpa/docs/selenium-ide/executescript |  |
storeAttribute | css=img.responsive-img@src | myimagelink |
storeAttribute | css=img.responsive-img@alt | myimagetext |
storeAttribute | linkText=flow control commands@href | mytextlink |
echo | The image links to ${myimagelink} and its ALT text is ${myimagetext} |  |
```

--------------------------------

### storeAttribute Example

Source: https://ui.vision/rpa/docs/selenium-ide/storeAttribute

Example demonstrating how to extract the link (src attribute) and ALT text from an image using the storeAttribute command.

```Selenium IDE
Command | Target | Pattern/Text ||
open | https://ui.vision/rpa/docs/selenium-ide/executescript |  |
storeAttribute | css=img.responsive-img@src | myimagelink |
storeAttribute | css=img.responsive-img@alt | myimagetext |
storeAttribute | linkText=flow control commands@href | mytextlink |
echo | The image links to ${myimagelink} and its ALT text is ${myimagetext} |  |
```

--------------------------------

### RPA XType Macro Example: Save Page

Source: https://ui.vision/rpa/docs/xtype

An example macro that simulates saving a web page. It uses XType to send the 'Ctrl+S' shortcut, followed by typing a new file name and pressing 'Enter'. The example also includes recommendations for breaking up long text entries and managing replay speed to avoid lost characters.

```RPA
Command | Target | Pattern/Text || open | https://ui.vision/ |  |
XType | ${KEY_CTRL+KEY_S} |  |
store | false | !stringescape |
XType | New-file-name |  |
Pause | 100 |  |
XType | ${KEY_ENTER} |  |
echo | Page saved |  |
```

--------------------------------

### storeValue Example Execution

Source: https://ui.vision/rpa/docs/selenium-ide/storevalue

An example demonstrating the storeValue command to extract hardware information from a textarea field and store it in a variable named 'mytext', then echo the extracted text.

```Selenium IDE
Command | Target | Pattern/Text || 
open | https://ui.vision/docs/selenium-ide/storevalue |  | 
storeValue | id=Readonlytask_Description | mytext | 
echo | Extracted Text = ${mytext} |  |
```

--------------------------------

### Ui.Vision RPA Performance Monitoring Example

Source: https://ui.vision/rpa/docs/index

An example demonstrating how to use the !RUNTIME variable for performance testing. It measures the time taken for an OCR operation by recording the time before and after the operation.

```APIDOC
Performance Monitoring Example:
  - Step 1: Click 'Start OCR button' and store current runtime in a variable (e.g., 'StartTime').
    - Command: `store`
    - Target: `!RUNTIME`
    - Value: `StartTime`
  - Step 2: Wait for the OCR result (web element) to appear.
    - Command: `waitForVisible` (or similar element waiting command)
    - Target: `[OCR Result Element Selector]`
  - Step 3: Measure the time again after the element is found.
    - Command: `store`
    - Target: `!RUNTIME`
    - Value: `EndTime`
  - Step 4: Calculate the duration.
    - Command: `store`
    - Target: `${EndTime}-${StartTime}`
    - Value: `TimeForThisStep`
  - Step 5: Optionally write the duration to a file.
    - Command: `csvSave`
    - Target: `TimeForThisStep`
    - Value: `performance_results.csv`
```

--------------------------------

### storeValue Example Execution

Source: https://ui.vision/rpa/docs/selenium-ide/storeValue

An example demonstrating the storeValue command to extract hardware information from a textarea field and store it in a variable named 'mytext', then echo the extracted text.

```Selenium IDE
Command | Target | Pattern/Text || 
open | https://ui.vision/docs/selenium-ide/storevalue |  | 
storeValue | id=Readonlytask_Description | mytext | 
echo | Extracted Text = ${mytext} |  |
```

--------------------------------

### storeXpathCount Example - Counting Links

Source: https://ui.vision/rpa/docs/selenium-ide/storexpathcount

An example demonstrating the use of the storeXpathCount command to count all anchor (link) elements on a web page and display the total count.

```Selenium IDE
Command | Target | Pattern/Text
open | https://ui.vision/docs/selenium-ide/storexpathcount |
storeXpathCount | xpath=//a | c
echo | Number of Links on Page = ${c} |
```

--------------------------------

### Ui.Vision RPA Example Macro

Source: https://ui.vision/rpa/docs/selenium-ide

Demonstrates a sequence of actions including opening a URL, inputting text, selecting an option from a dropdown, and clicking buttons. This macro is compatible with both the original Selenium IDE and Ui.Vision RPA.

```Ui.Vision RPA Macro
open | /
type | id=imageUrl | https://download.ui.vision/ocrbenchmark/chs.png
select | id=ocrLanguage | label=ChineseSimplified
click | link=Start OCR!
click | //*[@id="sucOrErrMessage"]/strong
click | id=btnShowOverlay
```

--------------------------------

### gotoLabel Command Example

Source: https://ui.vision/rpa/docs/selenium-ide/gotolabel

Demonstrates the usage of the gotoLabel command for flow control in Ui.Vision RPA's Selenium IDE. It shows how to jump to a defined label, skipping subsequent commands.

```Selenium IDE
Command | Target | Pattern/Text
| open | https://ui.vision/ |
| gotoLabel | MYLABEL |
| echo | This line is never reached |
| Label | MYLABEL |
```

--------------------------------

### gotoLabel Command Example

Source: https://ui.vision/rpa/docs/selenium-ide/gotoLabel

Demonstrates the usage of the gotoLabel command for flow control in Ui.Vision RPA's Selenium IDE. It shows how to jump to a defined label, skipping subsequent commands.

```Selenium IDE
Command | Target | Pattern/Text
| open | https://ui.vision/ |
| gotoLabel | MYLABEL |
| echo | This line is never reached |
| Label | MYLABEL |
```

--------------------------------

### Ui.Vision RPA Selenium IDE Commands

Source: https://ui.vision/rpa/docs/selenium-ide/open

Documentation for core Selenium IDE commands within Ui.Vision RPA, focusing on navigation and browser control.

```APIDOC
open | url
  - Opens the specified URL in the current selected browser tab.
  - Parameters:
    - url: The full URL to open (recommended) or a path relative to the base URL.
  - Behavior:
    - If the URL does not start with 'http://' or 'https://', it's treated as a relative path appended to the current URL.
  - Note:
    - The 'openWindow' command is not supported; use 'selectWindow | TAB=OPEN | url' for new tabs.

openBrowser | url (deprecated)
  - Opens the specified URL in a new browser window.
  - Status: Deprecated. Replaced by the command line interface.
  - Recommendation: Do not use in new macros. For new windows, use the CLI or 'selectWindow | TAB=OPEN | url'.

selectWindow | TAB=OPEN | url
  - Opens the specified URL in a new browser tab.
  - This is the recommended method for opening URLs in new tabs.

Example Usage:
Command | Target | Pattern/Text
|| open | https://ui.vision/docs/selenium-ide | 
| echo | This was all... | -
```

--------------------------------

### Browser Window Resize Example

Source: https://ui.vision/rpa/docs/selenium-ide/setwindowsize

Demonstrates using the setWindowSize command to change the browser window dimensions and visualAssert to check layout consistency across different resolutions.

```Selenium IDE
Command | Target | Pattern/Text
| open | https://ui.vision/ |
| setWindowSize | 1024x768 |
| visualAssert | layout_monitor1.png |
| setWindowSize | 375x667 |
| visualAssert | layout_iphone8.png |
```

--------------------------------

### Browser Window Resize Example

Source: https://ui.vision/rpa/docs/selenium-ide/setWindowSize

Demonstrates using the setWindowSize command to change the browser window dimensions and visualAssert to check layout consistency across different resolutions.

```Selenium IDE
Command | Target | Pattern/Text
| open | https://ui.vision/ |
| setWindowSize | 1024x768 |
| visualAssert | layout_monitor1.png |
| setWindowSize | 375x667 |
| visualAssert | layout_iphone8.png |
```

--------------------------------

### Get Date in N Days

Source: https://ui.vision/rpa/docs/selenium-ide/storeeval

Calculates and formats the date for a specified number of days in the future (e.g., 5 days). The number can be changed to get past or future dates.

```Javascript
var d= new Date(new Date().getTime() + 24 * 60 * 60 * 1000 * 5); var m=((d.getMonth()+1)<10)?'0'+(d.getMonth()+1):(d.getMonth()+1); d.getFullYear()+"-"+m+"-"+d.getDate();
```

--------------------------------

### Related Selenium IDE Commands and Resources

Source: https://ui.vision/rpa/docs/selenium-ide/assertText-verifytext

Lists related commands and resources for Selenium IDE users within Ui.Vision RPA, including sourceSearch, assertTitle, storeText, and links to the user manual and forums.

```APIDOC
Related Commands:
  - sourceSearch: Allows text checks directly on HTML source code, not just the rendered DOM.
  - assertTitle: Asserts that the current page title matches a given pattern.
  - storeText: Stores the text content of an element into a variable.

Resources:
  - Ui.Vision RPA User Manual: [Web Automation Extension](/rpa/docs/)
  - Selenium IDE Commands List: [/rpa/docs/selenium-ide/]
  - Classic Firefox Selenium IDE: [/rpa/docs/selenium-ide/oldfirefoxide]
  - Demo Macros: Available on GitHub [/rpa/tree/master/macros]
```

--------------------------------

### Custom Selenium Command Example (user-extensions.js)

Source: https://ui.vision/rpa/docs/selenium-ide/oldfirefoxide

Demonstrates how to add custom commands to Selenium IDE using JavaScript, historically done via a 'user-extensions.js' file. This example shows a 'doStoreRandom' command that types a random number into an element.

```javascript
Selenium.prototype.doStoreRandom = function(locator){
  random = Math.floor(Math.random()*11);
  this.doType(loacator, random);
}
```

--------------------------------

### Related Selenium IDE Commands and Resources

Source: https://ui.vision/rpa/docs/selenium-ide/assertText-verifyText

Lists related commands and resources for Selenium IDE users within Ui.Vision RPA, including sourceSearch, assertTitle, storeText, and links to the user manual and forums.

```APIDOC
Related Commands:
  - sourceSearch: Allows text checks directly on HTML source code, not just the rendered DOM.
  - assertTitle: Asserts that the current page title matches a given pattern.
  - storeText: Stores the text content of an element into a variable.

Resources:
  - Ui.Vision RPA User Manual: [Web Automation Extension](/rpa/docs/)
  - Selenium IDE Commands List: [/rpa/docs/selenium-ide/]
  - Classic Firefox Selenium IDE: [/rpa/docs/selenium-ide/oldfirefoxide]
  - Demo Macros: Available on GitHub [/rpa/tree/master/macros]
```

--------------------------------

### Related Selenium IDE Commands and Resources

Source: https://ui.vision/rpa/docs/selenium-ide/asserttext-verifytext

Lists related commands and resources for Selenium IDE users within Ui.Vision RPA, including sourceSearch, assertTitle, storeText, and links to the user manual and forums.

```APIDOC
Related Commands:
  - sourceSearch: Allows text checks directly on HTML source code, not just the rendered DOM.
  - assertTitle: Asserts that the current page title matches a given pattern.
  - storeText: Stores the text content of an element into a variable.

Resources:
  - Ui.Vision RPA User Manual: [Web Automation Extension](/rpa/docs/)
  - Selenium IDE Commands List: [/rpa/docs/selenium-ide/]
  - Classic Firefox Selenium IDE: [/rpa/docs/selenium-ide/oldfirefoxide]
  - Demo Macros: Available on GitHub [/rpa/tree/master/macros]
```

--------------------------------

### ExecuteScript Workflow Example

Source: https://ui.vision/rpa/docs/selenium-ide/executeScript

Demonstrates a sequence of commands to perform a calculation and update the page title. It uses store commands to set variables, executeScript_Sandbox for calculation, and executeScript to modify the document title.

```APIDOC
open | https://ui.vision/ |
| store | 100 | Var1 |
| store | 20 | Var2 |
| executeScript_Sandbox | return Number (${Var1}) - Number (${Var2}) | Var3 |
| executeScript | document.title = ${Var3}; |  |
| assertTitle | 80 |  |
```

--------------------------------

### gotoIf Example - Selenium IDE

Source: https://ui.vision/rpa/docs/selenium-ide/gotoif

A basic example demonstrating the usage of the gotoIf command. This snippet shows how a conditional jump to a label can alter the execution flow, preventing subsequent commands from running if the condition is met.

```Selenium IDE
Command | Target | Pattern/Text
| open | https://ui.vision/ |  |
| gotoIf | 8 > 5 | MYLABEL |
| echo | This line is never reached! |  |
| Label | MYLABEL |  |
```

--------------------------------

### ExecuteScript Workflow Example

Source: https://ui.vision/rpa/docs/selenium-ide/executescript

Demonstrates a sequence of commands to perform a calculation and update the page title. It uses store commands to set variables, executeScript_Sandbox for calculation, and executeScript to modify the document title.

```APIDOC
open | https://ui.vision/ |
| store | 100 | Var1 |
| store | 20 | Var2 |
| executeScript_Sandbox | return Number (${Var1}) - Number (${Var2}) | Var3 |
| executeScript | document.title = ${Var3}; |  |
| assertTitle | 80 |  |
```

--------------------------------

### gotoIf Example - Selenium IDE

Source: https://ui.vision/rpa/docs/selenium-ide/gotoIf

A basic example demonstrating the usage of the gotoIf command. This snippet shows how a conditional jump to a label can alter the execution flow, preventing subsequent commands from running if the condition is met.

```Selenium IDE
Command | Target | Pattern/Text
| open | https://ui.vision/ |  |
| gotoIf | 8 > 5 | MYLABEL |
| echo | This line is never reached! |  |
| Label | MYLABEL |  |
```

--------------------------------

### gotoIf Example - Selenium IDE

Source: https://ui.vision/rpa/docs/selenium-ide/GotoIf

A basic example demonstrating the usage of the gotoIf command. This snippet shows how a conditional jump to a label can alter the execution flow, preventing subsequent commands from running if the condition is met.

```Selenium IDE
Command | Target | Pattern/Text
| open | https://ui.vision/ |  |
| gotoIf | 8 > 5 | MYLABEL |
| echo | This line is never reached! |  |
| Label | MYLABEL |  |
```

--------------------------------

### Ui.Vision RPA storeText Example

Source: https://ui.vision/rpa/docs/selenium-ide/storetext

A practical example demonstrating the use of the storeText command to extract text from a specific HTML element identified by an XPath locator and store it into a variable named 'name'. It then uses the 'echo' command to display the captured variable's content.

```Ui.Vision RPA
Command | Target | Pattern/Text
| open | https://ui.vision/ |
| storeText | //*[@id="content"]/div[2]/div/h2[1] | name |
| echo | Name var = ${name} |
```

--------------------------------

### Ui.Vision RPA storeText Example

Source: https://ui.vision/rpa/docs/selenium-ide/storeText

A practical example demonstrating the use of the storeText command to extract text from a specific HTML element identified by an XPath locator and store it into a variable named 'name'. It then uses the 'echo' command to display the captured variable's content.

```Ui.Vision RPA
Command | Target | Pattern/Text
| open | https://ui.vision/ |
| storeText | //*[@id="content"]/div[2]/div/h2[1] | name |
| echo | Name var = ${name} |
```

--------------------------------

### Get Pixel Color

Source: https://ui.vision/rpa/docs/visual-ui-testing

Retrieves the color value of a specific pixel on the screen.

```APIDOC
visualGetPixelColor | x,y | var
  - Description: Returns the color value of a given screen position (x,y) and stores it in the specified variable 'var'. This is useful for checking status indicators, icon states, or waiting for color changes.
  - Parameters:
    - x,y: The coordinates of the pixel to check.
    - var: The variable name to store the color value in.
  - Returns:
    - The color value in hexadecimal red-green-blue (RGB) format (e.g., "#142467").
  - Usage:
    - Can be used to check if an icon is active or greyed out.
    - Useful in loops to wait until a button changes color.
    - Uses the same logic as the open-source color picker extension.
  - Example:
    visualGetPixelColor | 150,200 | !pixelColor
    # Now !pixelColor holds the hex color code of the pixel at (150,200)
```

--------------------------------

### Get Current Time

Source: https://ui.vision/rpa/docs/selenium-ide/storeeval

Retrieves the current time and formats it as HH : MM : SS.

```Javascript
(new Date().getHours()+" : " + new Date().getMinutes() + " : " + new Date().getSeconds())
```

--------------------------------

### Get Today's Date (DD-MM-YYYY)

Source: https://ui.vision/rpa/docs/selenium-ide/storeeval

Retrieves the current date and formats it as DD-MM-YYYY.

```Javascript
var d=new Date(); d.getDate()+'-'+((d.getMonth()+1))+'-'+d.getFullYear();
```

--------------------------------

### Ui.Vision RPA Concurrent Instance Command Line Arguments

Source: https://ui.vision/rpa/docs/index

Run multiple instances of Ui.Vision RPA simultaneously by starting each browser instance with its own profile. This is achieved using specific command-line switches for Chrome and Firefox.

```Shell
# For Chrome:
-profile-directory="Profile 2"

# For Firefox:
-p PROFILE_NAME
```

--------------------------------

### Basic Click and Wait Commands (Selenium IDE)

Source: https://ui.vision/rpa/docs/selenium-ide/click

Demonstrates the use of fundamental Selenium IDE commands for interacting with web pages. 'click' simulates a mouse click on an element, while 'clickAndWait' performs a click and then waits for a page load or navigation to complete.

```Selenium IDE
Command | Target | Pattern/Text
|
| open | https://ui.vision/ | 
|
| click | link=Free Web Automation | -
|
| clickAndWait | link=Go To Next Page | -
```

--------------------------------

### Get Current Time

Source: https://ui.vision/rpa/docs/selenium-ide/storeEval

Retrieves the current time and formats it as HH : MM : SS.

```javascript
(new Date().getHours()+" : " + new Date().getMinutes() + " : " + new Date().getSeconds())
```

--------------------------------

### Get Today's Date (DD-MM-YYYY)

Source: https://ui.vision/rpa/docs/selenium-ide/storeEval

Retrieves the current date and formats it as DD-MM-YYYY.

```javascript
var d=new Date(); d.getDate()+'-'+((d.getMonth()+1))+'-'+d.getFullYear();
```

--------------------------------

### Run RPA Macro on Windows (Chrome)

Source: https://ui.vision/rpa/docs/index

Example of launching Ui.Vision RPA from a Windows batch file using Google Chrome. It specifies the macro to run, a direct execution switch, and a log file path.

```batch
"C:\Program Files (x86)\Google\Chrome\Application\chrome.exe"
"file:///D:/test/ui.vision.html?direct=1&macro=MyLogin&savelog=c:/test/log1.txt"
```
Tokens:
Raw