Using the Eggplant Functional Connection List

The Connection List shows you the names and other relevant information about system under test (SUT) connections defined in your Eggplant Functional application. You can add, edit, delete and establish connections to SUTs in this window.

Connection List Contents

The columns in the Connection List can be customized. Go to Connection > Customize Columns to select which columns to display.

The Eggplant Functional Connection Window

The Eggplant Functional Connection List

Default Columns

The following columns display by default in the Connection List:

Status: This column indicates the availability of the SUT, denoted by a color-coded dot. Go to Connection > Check Availability for status updates. The Connection List status colors are shown below. The "Cloud" category refers to Eggplant Automation Cloud SUTs.

Cloud Device WebDriver Color Status
Eggplant Automation Cloud connected icon in the Eggplant Functional Connection List Device connected status icon in the Eggplant Functional Connection List WebDriver connected icon in the Eggplant Functional Connection List Green Connected
Eggplant Automation Cloud connection available icon in the Eggplant Functional Connection List Device available icon in the Eggplant Functional Connection List WebDriver available icon in the Eggplant Functional Connection List Blue Available
Eggplant Automation Cloud connection unavailable icon in the Eggplant Functional Connection List Unavailable status icon in Eggplant Functional Connection List WebDriver unavailable icon in the Eggplant Functional Connection List Gray Unavailable
Eggplant Automation Cloud status unknown icon in the Eggplant Functional Connection List Device status unknown icon in the Eggplant Functional Connection List WebDriver status unknown icon in the Eggplant Functional Connection List Yellow Unknown
Eggplant Automation Cloud status connecting icon in the Eggplant Functional Connection List Device connecting icon in the Eggplant Functional Connection List WebDriver connecting icon in the Eggplant Functional Connection List Partial Yellow Connecting
Eggplant Automation Cloud status connecting icon in the Eggplant Functional Connection List Device connecting icon in the Eggplant Functional Connection List Eggplant FunctionalWebDriver connecting icon in the Eggplant Functional Connection List Partial Green Connecting
Eggplant Automation Cloud error status icon in the Eggplant Functional Connection List Error status icon in the Eggplant Functional Connection List WebDriver error status icon in the Eggplant Functional Connection List Red Error
Eggplant Automation Cloud active status icon in the Eggplant Functional Connection List Device active icon in the Eggplant Functional Connection List WebDriver active icon in the Eggplant Functional Connection List Green check Active
Eggplant Automation Cloud reserved status icon in the Eggplant Functional Connection List Eggplant Automation Cloud connections only Reserved

Name: This column refers to the display name a SUT sends to Eggplant Functional. Before Eggplant Functional connects to a SUT, the Name column displays the same information as the Host column.

Tip: To insert the name of a SUT into a script quickly, drag it from the Connection List to the Script Editor. To insert a connection property list into the script, Alt-drag (Option-drag on Mac) the SUT to the Script Editor.

Host: This column displays the SUT’s host name or IP address.

Note: If the name in the Host field contains the word "tutorial," it means the SUT is a "fake" SUT you can use when you are following an Eggplant Functional tutorial. For information about Eggplant Functional tutorials, see Tutorials.

Port: This column displays the number of the port on which the SUT listens for connections.

Activity: This column displays a running description of your VNC connection.

Optional Columns

The following columns can be added to the Connection List window:

Color: This column displays the setting you choose in the Color Depth menu.

SSH Host: This column displays the host name or IP address of the computer that hosts an SSH tunnel for the SUT’s secure connections.

SSH User: This column displays the account name with which the SUT user logs into an SSH host.

Type: This column displays the type of connection.

Adding or Editing a SUT in the Connection List

For SUTs that you use frequently in Eggplant Functional, you can save the connection details in the Connection List so that you can easily make connections either from the Connection List or from within scripts.

If you are new to Eggplant Functional, you might want to visit Getting Started with Eggplant Functional for information about setting up your SUT environments, and Creating Your First SUT Connection for details on saving your first connection details in the Connection List.

After you've saved SUTs, the Connection List displays SUT details in a table:

The Connection List in Eggplant Functional with saved SUTs

To add a new connection, click the Add button at the bottom of the Connection List. To edit an existing connection, select it in the list, then click the Edit button. Both the New Connection and Edit Connection dialog boxes include the same fields for entering SUT information.

Note: Eggplant Functional provides the option for you to create a SUT that you can use for testing when you are following an Eggplant Functional tutorial. See Creating a Tutorial SUT below for more information. For information about Eggplant Functional tutorials, see Tutorials.

The New Connection dialog box from the Eggplant Functional Connection List

The New Connection window in Eggplant Functional

Server (IP Address, Hostname, or Android Device): Enter the SUT's IP address or hostname.

Port: The port number used to connect to the SUT.

Password: See below for requirements for VNC or RDP connections.

Username: See below for requirements for VNC or RDP connections.

Display Name: Enter a name for this connection as you want it to appear in the Connection List. You can then use this name to reference the specific connection or device from your scripts when using the connect command.

Note: The Server information is used as the default Display Name.

Connection Type: The type of connection you are making. Options include:

  • VNC Automatic: Detects and assigns the appropriate VNC connection type.
  • VNC Mobile: This option is included with Eggplant +Mobile licenses.
  • VNC Standard and VNC Legacy: Different versions of the RFB protocol that the VNC server is using, for use when connecting to certain servers.
  • RDP: Select for connections via RDP.
  • WebDriver: Select for connections using Selenium WebDriver.

Color Depth: The depth of color with which the Viewer window draws a SUT. To read about changing this setting, see Changing Color Depth below.

Skip Availability Check: Select this checkbox if you don't want Eggplant Functional to poll the listed server to see if it's available. This setting isn't available for RDP connections.

Connect Securely (SSH): Selecting this checkbox allows you to create a secure connection via SSH. This setting isn't available for RDP connections. To read more about creating a secure connection, see Opening Secure Connections below, as well as VNC Security.

Scale Remote Screen: Select this checkbox to scale mobile VNC servers by 50 percent in each dimension. This option provides better performance when you are using mobile devices with large screens or high resolution.

Note: This option works only with iOS Gateway and Eggplant Functional's built-in VNC server for Android devices.

Blend Scaled Screen: Select this option to blend pixel colors when you are using Scale Remote Screen. This option should be used only for backward compatibility with older scripts or images.

Connect: This button instructs Eggplant Functional to attempt to make a connection with the current settings.

Save: This button saves the current SUT settings. Saved SUTs appear in the main Connection List window.

Remember This Connection: This option is enabled by default. With this option enabled, Eggplant Functional saves this connection in the Connection List for use in the current and future Eggplant Functional sessions. If you disable this option, Eggplant Functional creates the connection as a temporary connection for the current session only; it will not be available in future sessions. Temporary connections display with their names in italics in the Connection List.

Step by Step: Entering VNC Connection Details

  1. Open the add/edit panel of the Connection List.
  2. Enter the display name you want to use and the IP address or hostname of the SUT you want to connect to.
  3. VNC connections default to port 5900, but you can change this if necessary.
  4. For VNC connections, the Password and Username fields refer to the VNC server on the SUT. If this information is required to connect to the VNC server, enter it here.
  5. Select the appropriate VNC Connection Type from the drop-down list. VNC Automatic is the default.
  6. Make any other changes or selections for this connection, then click Save to save the connection details to the Connection List.

Step by Step: Entering RDP Connection Details

  1. Open the add/edit panel of the Connection List.
  2. Enter the display name you want to use and the IP address or hostname of the SUT you want to connect to.
  3. Select RDP from the Connection Type drop-down list. RDP connections default to port 3389, but you can change this if necessary.
  4. For RDP connections, the Password and Username fields refer to the Windows user account you are connecting to. This information is always required for RDP connections.
  5. When you select RDP as the connection type, the RDP Options section appears, which lets you specify the Width and Height at which the RDP session window opens.
  6. RDP options available when adding a new connection in Eggplant Functional

    RDP options available when adding a new connection

  7. Make any other changes or selections for this connection, then click Save to save the connection details to the Connection List.

Remember that for RDP, the SUT also has to be configured to accept the connection.

Step by Step: Entering WebDriver Connection Details

  1. Open the add/edit panel of the Connection List.
  2. Enter the display name you want to use and the IP address or hostname of the SUT you want to connect to.
  3. Select WebDriver from the Connection Type drop-down list. WebDriver connections default to port 4444.
  4. The WebDriver Options section appears. You can further configure the connection here.
    • Browser: The browser you want WebDriver to connect to.
    • Capabilities: Define arbitrary browser capabilities here, in key=value pairs, i.e., Mode=Incognito for browsers that allow it. Different browsers have different capability keys.

      WebDriver connection options in Eggplant Functional

      WebDriver connection options in Eggplant Functional

  5. Click Save to save the connection details to the Connection List.

Changing Color Depth

To increase the speed of your connection, you can decrease the color depth with which the Viewer window draws a SUT.

To increase or decrease color depth, choose a value in the Color Depth pop-up menu. Choose Default to draw the SUT with the same color depth you see on its native display.

Note: If you change the color depth of a SUT, images you captured at the former color depth might not match the SUT in the current Viewer window.

Creating a Tutorial SUT

Eggplant Functional provides the option for you to create a SUT that you can use for testing when you are following Eggplant Functional tutorials. For information about Eggplant Functional tutorials, see Tutorials.

The tutorial SUT looks like a mobile device. When you connect to a tutorial SUT, it opens in the Eggplant Functional viewer window:

Tutorial SUT open in theEggplant Functional Viewer window

To create a tutorial SUT, create a connection for it and specify tutorialSUT as the hostname in the Server field. That is the only requirement. You can optionally specify a display name for it and create it as any connection type.

Creating a tutorial SUT in Eggplant Functional

Opening Secure Connections

Secure Shell (SSH) is a network protocol that uses data encryption to transfer information securely. For Eggplant Functional to connect to a SUT securely, the SUT must be able to host an SSH tunnel or have a secure connection with another computer that can host an SSH tunnel. Also, you must have a user account on the SSH host computer.

Visit the VNC Security page for general information on VNC security in Eggplant Functional.

Step by Step: Setting up an SSH Login

  1. In the Connection List, select the SUT.
  2. Click Edit.
  3. Select the Connect Securely (SSH) checkbox, which opens the SSH login pane.
  4. Fill in the Username and Password fields. Username and Password refer to your user account on the SSH host computer. On Windows, enter your SSH key in the Password field.
  5. In the SSH Host field, enter the IP address or hostname of the SSH host computer.
  6. Select the Remember SSH Password checkbox to save the password of the user account on the SSH host; otherwise, you must enter the password whenever you open a connection with the SSH host.

SSH configuration options in Eggplant Functional

SSH login panel

Setting up SSH in the SUT's VNC Server Application

When you use SSH to connect to a SUT, the SUT's firewall must allow connections on port 22, the standard port for SSH connections.

For more information about secure VNC connections, see VNC Security, or see the SUT's VNC server documentation.

Opening a Connection with a SUT

There are several ways to open a connection with a SUT:

  • In the Connection List, double-click the name of the SUT.
  • Select the SUT and click Connect.
  • Select the SUT and choose Connect from the Connection menu.
Note: You can open a VNC connection from within a script by inserting a Connect command. If you use the Connect command to connect to a SUT that isn't saved in the Connection List, the connection is treated as an ad-hoc connection. The connection shows up in the Connection List while it is active (during the script run), and is removed from the list when it is no longer being used; the connection isn't saved. For more information, see The Connect Command.
Note: RDP connections allow only one user connection at a time. If you attempt an RDP connection to a Windows system that already has a connected user, you're given the choice to ask the other user to log off or to cancel your logon attempt. If another user attempts to access a SUT while you are logged on via RDP, you'll receive a Windows system message in the SUT asking if you want to log off to allow the other user access; if you don't respond within 30 seconds, Windows logs you off—which can have unintended results if you are in the middle of running a test.
Tip: If you are running a script that switches between SUTs, you can save execution time by keeping both (or all) connections open rather than disconnecting and reconnecting with each switch.

Closing a Connection with a SUT

There are two ways to close a connection manually:

  • In the Connection List, select the SUT and click the Disconnect button.
  • Choose Connection > Disconnect.
Note: Closing a Viewer window does not close your connection with the corresponding SUT.
Note: You can close a connection from within a script by inserting a disconnect command.

Connecting to a Device through Eggplant Automation Cloud

If you are working with Eggplant Automation Cloud, you can set up Eggplant Functional so that your cloud SUTs are accessible through the Connection List. See Cloud Preferences for details of establishing a connection to your Eggplant Automation Cloud environment.

After you connect to your cloud SUTs, you can use the Connection List to establish connections to those SUTs just as you do for other SUTs. For instructions on making reservations and other features of Eggplant Automation Cloud, see the Eggplant Automation Cloud documentation.

Screenshot Connections

Screenshot connections are useful for troubleshooting. If a test fails, you can capture an image of the screen where the test failed, then use that screenshot to perform image and text searches to help find the source of the failure. You can also use a screenshot connection to create a character collection.

Take a screenshot of your SUT, and take note of where it's saved. To open the screenshot, go to Connection > Open Screenshot Connection. You can also open a screenshot connection using the Connect Command.

Mobile Connections

Depending on the type of mobile connection, the steps for adding a connection can vary from the above instructions. See iOS and tvOS SUTs for an explanation of the methods for connecting to iOS devices. For connections to devices running Android OS, see our documentation on Android Connections.

Troubleshooting SUT Connections

If you are having problems connecting to a SUT, see Troubleshooting Connection Issues.

 

This topic was last updated on July 12, 2018, at 02:48:33 PM.

Eggplant icon Eggplant.io | Documentation Home | User Forums | Support | Copyright © 2018 Eggplant