Get Field

UiPath.Terminal.Activities.TerminalGetField

Description

Gets the text from a specified form field and stores it into a String variable. The form field is designated by using selectors.

The activity is valid only inside a Terminal Session activity.

Note: This activity fails if the VT family of terminals is being used, either with the Direct Connection provider or with a provider using a 3rd party terminal emulator, like IBM EHLLAPI. This happens because the VT family of terminals does not support fields.

Project compatibility

Windows - Legacy | Windows

Configuration

Designer panel

• LabeledBy - The label that appears before the field to be searched for.
• Index - If there are multiple fields with the same labels, select an identifier greater than 0 that describes the order of the label to be searched for.
• FollowedBy - The label that appears after the field to be searched for.

Properties panel

Common

• DisplayName - The display name of the activity.

Field

• FollowedBy - The label that appears after the field to be searched for.
• Index - If there are multiple fields with the same labels, select an identifier greater than 0 that describes the order of the label to be searched for.
• LabeledBy - The label that appears before the field to be searched for.

Misc

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Options

• DelayMS - Delay time (in milliseconds) after executing the activity. The default amount of time is 300 milliseconds (0.3 seconds).
• TimeoutMS - Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 5000 milliseconds (5 seconds).
• WaitType - Before performing the actions, wait for the target to become ready. The following options are available:
  • NONE - Does not wait for the terminal keyboard to be enabled.
  • READY / COMPLETE - Waits for the terminal keyboard to be enabled. The default value is READY.
  Note: The READY and COMPLETE options have the same function, since the wait type is related to the status of the terminal keyboard, which has only two states: enabled or inhibited.

Output

• Text - The information found in the indicated field, as a string variable. This field supports only String variables.