Validate Screen
Validates the current terminal screen by checking occurrences of the entered text.
Command availability: IBM RPA SaaS and IBM RPA on premises
Script syntax
IBM RPA's proprietary script language has a syntax similar to other programming languages. The script syntax defines the command's syntax in the script file. You can work with this syntax in IBM RPA Studio's Script mode.
terminalValidateScreen --keywords(String) [--label(String)] (Boolean)=value
Dependencies
Use one of the following commands to connect to a Terminal:
- Connect to Terminal (
terminalConnect) - Connect to Terminal via Telnet (
terminalTelnetConnect) - Connect to Terminal via SSH (
terminalSshConnect)
Input parameters
The following table displays the list of input parameters available in this command. In the table, you can see the parameter name when working in IBM RPA Studio's Script mode and its Designer mode equivalent label.
| Designer mode label | Script mode name | Required | Accepted variable types | Description |
|---|---|---|---|---|
| Keywords | keywords |
Required |
Text |
Text to use as a keyword that should be found on the terminal screen. |
| Screen Name | label |
Optional |
Text |
Terminal screen name instantiated that should be validated. Note:Name that appears in the terminal window.
|
Output parameters
| Designer mode label | Script mode name | Accepted variable types | Description |
|---|---|---|---|
| Result | value | Boolean |
Returns True if it found occurrences of a text, or False otherwise. |
Example
This examples searches your terminal screen for the keyword "example.com", expecting True or False as a result of validation.
defVar --name terminalConnection --type Boolean
defVar --name validateScreen --type Boolean
// Connecting to the terminal.
terminalConnect --name terminal --hostname "example.com" --port 23 --timeout 00:01:00 terminalConnection=value
// Finding on the current terminal screen the keyword "example.com".
terminalValidateScreen --keywords "example.com" --label example validateScreen=value
logMessage --message "${validateScreen}" --type "Info"
terminalDisconnect --name terminal