Get Pop Up

Gets a pop-up from the open terminal command prompt.

Important:starting from IBM RPA 23.0.10, this command is deprecated. For more information, see Deprecated.

Command availability: IBM RPA SaaS and IBM RPA on premises a

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.

terminalgetpopup --bordertype(TerminalBorderTypes) --topleftcorner(String) --toprightcorner(String) --bottomleftcorner(String) --bottomrightcorner(String) [--interval(TimeSpan)] [--timeout(TimeSpan)] (String)=value

Dependencies

Use one of the following commands to connect to a Terminal:

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
Left Corner (Obsolete) leftcorner Optional Text Custom coordinate that defines the left corner of the terminal command prompt, checking if the pop-up exists.

Note:This parameter is obsolete, use the Bottom Left Corner or Top Left Corner parameters instead.
Right Corner (Obsolete) rightcorner Optional Text Custom coordinate that defines the right corner of the terminal command prompt, checking if the pop-up exists.

Note:This parameter is obsolete, use the Bottom Right Corner or Top Right Corner parameters instead.
Border Type bordertype Required TerminalBorderTypes Border type on the terminal used to detect the pop-up.
Top Left Corner topleftcorner Required when the Border Type parameter is enabled Text Custom coordinate that defines the upper left corner at the terminal prompt, where it checks for a pop-up.
Top Right Corner toprightcorner Required when the Border Type parameter is enabled Text Custom coordinate that defines the upper right corner at the terminal prompt, where it checks for a pop-up.
Bottom Left Corner bottomleftcorner Required when the Border Type parameter is enabled Text Custom coordinate that defines the lower left corner at the terminal prompt, where it checks for a pop-up.
Bottom Right Corner bottomrightcorner Required when the Border Type parameter is enabled Text Custom coordinate that defines the bottom right corner at the terminal prompt, where it checks for a pop-up.
Interval interval Optional Time Span Time interval between each pop-up scan within the time limit defined in Timeout.
Timeout timeout Optional Time Span, Number, Text Maximum wait time for pop-up to be found at the terminal command prompt.

Note:If no value is defined for the Timeout parameter, the bot uses the context timeout defined by the Set Timeout (setTimeout) command. If that command is not used on the script, the default timeout is 5 seconds.

bordertype parameter options

The following table displays the options available for the bordertype input parameter. The table shows the options available when working in Script mode and the equivalent label in the Designer mode.

Designer mode label Script mode name Description
Ascii Dots Ascii Dots Detects borders composed of dots on terminal pop-ups.
Ascii Girder Ascii Girder Detects borders composed
Ascii Rounded Ascii Rounded Detects rounded borders on terminal pop-ups.
Custom Custom Enables the topleftcorner, toprightcorner, bottomleftcorner, bottomrightcorner parameters to define custom border types for terminal pop-ups.
Double Double Detects double borders on terminal pop-ups.
Double Single Double Single Detects double with single borders on terminal pop-ups.
Single Single Detects single borders on terminal pop-ups.
Single Double Single Double Detects single and double borders on terminal pop-ups.

Output parameters

Designer mode label Script mode name Accepted variable types Description
Result value Text Pop-up returned from the terminal screen.

Example

The example gets a pop-up from the terminal and waits for 10 seconds. The Result parameter returns the text inside the pop-up.

defVar --name terminalName --type String --value Terminal
defVar --name terminalServer --type String --value "www.example.com"
defVar --name terminalPort --type Numeric --value 60
defVar --name popUpExists --type String
terminalConnect --name "${terminalName}" --hostname "${terminalServer}" --port ${terminalPort}
terminalgetpopup --bordertype "Single" --timeout 00:00:10 popUpExists=value
terminalDisconnect --name "${terminalName}"
Remember:Use a valid connection to connect to the server.