Read and Review Automation Anywhere Documentation

Automation 360

Close Contents

Contents

Open Contents

Terminal Emulator package

  • Updated: 10/04/2021
    • Automation 360 v.x
    • Build
    • RPA Workspace

Terminal Emulator package

The Terminal Emulator package contains actions that enable you to connect to and automate tasks on another machine. Use these actions to access and control operations on a remote machine. For example, you can run applications and access files on a different operating system.

The Terminal Emulator enables a machine to connect to and communicate with another machine using a command-line or graphical interface. The Terminal Emulator uses the Telnet or SSH protocol to communicate with other machines.

The Terminal Emulator supports ANSI, TN3270E, TN5250E, and VT100 terminal types.

Before you start

Important: Before you establish a connection to a different terminal type, ensure that you have Visual C++ 2019 Redistributable Package installed on your system. If you are on an Automation 360 version earlier than A2019.14 (Build 5322), you must install Visual C++ 2013 Redistributable Package or Visual C++ 2015 Redistributable Package on your system.

Perform the following actions within the Terminal Emulator package as part of using the set of available actions:

  1. Establish a connection with a host machine using the Connect action.

    You must first establish a connection with a host machine to automate any Terminal Emulator related task. When establishing the connection, specify the details of the host machine and associate it with a session name. Use the session name provided in this action in the other actions so that you do not have to provide details of the host machine in those actions again. See Using the Connect action.

    Important: If you use any other action from this package before establishing the connection, you will encounter an error.
  2. Use the Terminal Emulator actions to automate a task. For example, use the Get field action to retrieve the value from a particular field.
  3. After you have automated all the Terminal Emulator related tasks, terminate the connection to the host machine using the Disconnect action.

Actions in the Terminal Emulator package

The Terminal Emulator package includes the following actions:

Action Description
Clear terminal Clears the screen of the terminal. Specify the Terminal emulator session name that you used to establish a connection with the terminal using the Connect action.
Connect See Using the Connect action.
Disconnect Terminates the connection with the terminal. Specify the Terminal emulator session name that you used to establish a connection with the terminal using the Connect action.
Get all fields Retrieves the values of all fields and assigns them to a table variable.
  • Specify the Terminal emulator session name that you used to establish a connection with the terminal using the Connect action.
  • Select a table variable to store the retrieved data from the Assign the value to an existing table variable list. The table stores each field as a row, with the values of each field organized in the following columns:
    • Field index
    • Field name
    • Field value
    • Is Editable (yes/no)
    • Is Hidden (yes/no)
Note: You can use this action with the TN3270E and TN5250E terminal types.
Get field Retrieves the value of a field based on the index or name of the field and assigns it to a string variable.
  • Specify the Terminal emulator session name that you used to establish a connection with the terminal using the Connect action.
  • Select the By index option to retrieve the value of a field based on its index, or select the By name option to retrieve the value of a field based on its name.
  • Select a string variable to store the retrieved data from the Assign the value to an existing variable list.
Note: You can use this action with the TN3270E and TN5250E terminal types.
Get text See Using Get text action.
Hide terminal Hides the terminal screen. This action enables you to hide the terminal screen when the Show terminal window option from the Connect action is selected. It is useful when you do not want to display the terminal screen when a bot is performing certain tasks. Specify the Terminal emulator session name that you used to establish a connection with the terminal using the Connect action.
Search field Searches for the field based on the text it contains.
  • From the Terminal emulator session name field, choose one of the following options:
    • Local name to establish a connection with the terminal using the Connect action
    • Shared session to share the variable from Set session variable or from the parent bot
  • Specify the text based on which you want to search the field.
  • Select an option from Select field to specify whether to retrieve the index or name of the field.
  • Assign and save the output to a variable.
    Note: The search text you enter must be a complete match and is not case-sensitive.
Send key See Using Send key action.
Send text See Using Send text action.
Set cursor position Sets the position of the cursor on the screen of the terminal.
  • Specify the Terminal emulator session name that you used to establish a connection with the terminal using the Connect action.
  • Specify the row number in which to set the cursor in the Set row field.
  • Specify the column number in which to set the cursor in the Set column field.
Note: You can enter a value of 1 through 999 to specify the row and column number where the cursor is set.
Set field See Using Set field action.
Set session variable Assign the session name to a variable. Pass this session variable from the parent bot to a child bot by entering the variable as an input type variable in the child bot.
Show terminal Shows the terminal screen. This action enables you to show the terminal screen when the Show terminal window option from the Connect action is not selected. It is useful when you want to display the terminal screen when a bot is performing certain tasks. You must specify Specify the Terminal emulator session name that you used to establish a connection with the terminal using the Connect action.
Wait See Using Wait action.
Send Feedback