Get Field Value

Gets the field text in the terminal according to the index entered.

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.

terminalGetField --index(Numeric) (String)=value


Connect to a terminal using the Connect to Terminal (terminalConnect) command.

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
Index index Required Number Index of the field in which the text should be obtained.

Output parameters

Designer mode label Script mode name Accepted variable types Description
Value value Text Text obtained according to the Index entered.


Gets the text contained in the index field "0" on a TN3720 terminal emulator.

defVar --name success --type Boolean
defVar --name obtainedValue --type String
defVar --name terminalConnection --type Boolean
// Connecting to fandhezi terminal
terminalConnect --name terminal --hostname "" --port 23 --timeout 00:01:00 terminalConnection=value
terminalSetField --index 0 --value "Hello World" success=value
// Get the value contained in index field "0".
terminalGetField --index 0 obtainedValue=value
logMessage --message "${obtainedValue}" --type "Info"
terminalDisconnect --name terminal