Connect to Terminal

Description

Connect to mainframe-based applications or terminal-based applications through the terminal emulator. You can connect to applications built for zSeries mainframes over the 3270 protocol, and for System i5®, eServer i5®, iSeries, or AS/400 systems over the 5250 protocol.

This command connects with different terminal emulator providers:

• IBM RPA internal provider

The default provider that is provisioned by the product, which you can use to connect to host sessions over 3270 protocol.

• IBM® Personal Communications

In IBM RPA, you can use IBM® Personal Communications provider to launch and connect to zSeries mainframe-based applications over the 3270 protocol, and for System i5®, eServer i5®, iSeries, or AS/400 systems over the 5250 protocol.

• High-level Language Application Program Interface (HLLAPI)

In IBM RPA, you can use terminal emulator providers that implement the HLLAPI standard to connect to zSeries mainframe-based applications over the 3270 protocol, and for System i5®, eServer i5®, iSeries, or AS/400 systems over the 5250 protocol.

Dependencies

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.

terminalConnect --name(Text) --provider(TerminalProviderTypes) [--profile(Text)] [--sessionid(Text)] [--dllpath(Text)] [--encoding()] [--hostname(Text)] [--port(Numeric)] [--lu(Text)] [--usessl(Boolean)] [--timeout(TimeSpan)] (Boolean)=value

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.

Output parameters

Example

The following examples demonstrates how to connect to a terminal emulator with the supported providers. You must update the connection data to connect to a terminal host session.

Example 1: Connects to a terminal emulator over 3270 protocol with IBM RPA internal provider.

defVar --name terminalName --type String --value Terminal
defVar --name terminalServer --type String --value "www.example.com"
defVar --name port --type Numeric --value 60
defVar --name connectionSuccess --type Boolean
// Connects to a terminal emulator over 3270 protocol with IBM RPA internal provider.
terminalConnect --name "${terminalName}" --provider "Internal" --hostname "${terminalServer}" --port ${port} --usessl
if --left "${connectionSuccess}" --operator "Is_True"
 | // Logs a message in IBM RPA Studio if the connection is established.
 | logMessage --message "Connection to the \"${terminalServer}\" host established." --type "Info"
 | // Assign a value to the field in focus on the terminal emulator screen.
 | terminalSetField --index 0 --value IBM
endIf
// Disconnects from the terminal.
terminalDisconnect --name "${terminalName}"

Example 2: Connects to a terminal emulator over 5250 protocol with IBM® Personal Communications provider.

defVar --name terminalName --type String --value Terminal
defVar --name connectionSuccess --type Boolean
defVar --name wp --type String --value "C:\\IBM\\Personal Communications\\hostname.ws"
// Connects to a terminal emulator over 5250 protocol with IBM Personal Communications provider.
terminalConnect --name "${terminalName}" --provider "PCOMM" --profile "${wp}" connectionSuccess=value
if --left "${connectionSuccess}" --operator "Is_True"
 | // Logs a message in IBM RPA Studio if the connection is established.
 | logMessage --message "Connection to the \"${wp}\" host established." --type "Info"
 | // Assign a value to the field in focus on the terminal emulator screen.
 | terminalSetField --index 0 --value IBM
endIf
// Disconnects from the terminal.
terminalDisconnect --name "${terminalName}"

Example 3: Connects to a terminal emulator over 5250 protocol with IBM® Personal Communications provider through the HLLAPI standard. The session defined must be started in IBM® Personal Communications before you run this example.

defVar --name terminalName --type String --value Terminal
defVar --name connectionSuccess --type Boolean
defVar --name sessionId --type String --value A
defVar --name hllapiDll --type String --value "C:\\Program Files\\IBM\\Personal Communications\\pcshll32.dll"
// Connects to a terminal emulator over 5250 protocol with IBM Personal Communications provider through the HLLAPI standard.
terminalConnect --name "${terminalName}" --provider "HLLAPI" --sessionid "${sessionId}" --dllpath "${hllapiDll}" connectionSuccess=value
if --left "${connectionSuccess}" --operator "Is_True"
 | // Logs a message in IBM RPA Studio if the connection is established.
 | logMessage --message "Connection to the \"${sessionId}\" host session established." --type "Info"
 | // Assign a value to the field in focus on the terminal emulator screen.
 | terminalSetField --index 0 --value IBM
endIf
// Disconnects from the terminal.
terminalDisconnect --name "${terminalName}"

Limitations

Enabling FIPS restricts this command to support only TLS connections.

Related links

• Connect to Terminal via SSH
• Connect to Terminal via Telnet
• Disconnect from Terminal