Connections

The Connection tab lets you set up a connection to different servers. Multiple connections can be created and saved which can be used for running the flow.

Leapwork supports three different ways to set up a connection:

  • Appium Server
  • HeadSpin Server
  • Lightweight Directory (LDAP)

Appium Server

Appium Server is an open-source automation framework that is used for testing mobile applications. It drives Android and iOS app using WebDriver.

Add Connection:

To add a connection, click the Add button and the following pop-up appears:

On the Add Connection pop-up window:

Enter the title in the Title field. It should be unique.

Enter the description in the Description field.

From the Type drop-down, select the Appium Server option:

Select Appium Server and the following new fields appear:

Enter Hostname in the Hostname field.

The Hostname is a ‘localhost’ if the same system is used to configure a mobile device on which Leapwork exists.

The Hostname is a ‘IP address’ (details provided below for iOS devices) if multiple systems and devices are being used.

Note:

How to obtain the Hostname for iPhone:

The Hostname for iPhone can be obtained from Settings >Wi-Fi.

Click on the information icon at the right of the connected network.

The value in the field IP Address is a host name for the device.

 

How to obtain the Hostname for mac:

The Hostname for mac can be obtained from System Preferences → Network.

Select the Wi-Fi or the ethernet with which the device is connected to the internet.

The IP address on the right pane will be the host name for the device. Screenshot below for reference.

 

Enter the port configured in Appium in the Port field.

Enter the path in the Path filed. (e.g., /wd/hub)

Select the Capturing type from the drop-down list:

Screenshot: The screenshots of individual blocks are captured as the flow executes on the mobile device ensuring effective debugging. This is the most viable option for optimal performance while executing multiple flows.

Streaming: The flow being executed on the mobile device is streamed in video mode. This option requires more space and high-speed internet to ensure optimal performance. You may notice a slight lag in capturing (using recorder) or executing multiple flows with streaming mode as it may reduce the run performance.

Click the Test connection button to test the connection.

Click the Save button to save the details. Once your connection is saved a success message appears to let you know the connection is successful.

To the right of the Add button, use the buttons Edit or Delete to change and remove the connection.

Note: This feature can be accessed by Leapwork Admin only.

HeadSpin Server

HeadSpin Server is a cloud-based automation framework that is used for testing mobile applications. It drives real Android and iOS app using WebDriver.

Add Connection:

To add a connection, click the Add button and the following pop-up appears:

On the Add Connection pop-up window:

Enter the title in the Title field. It should be unique.

Enter the description in the Description field.

From the Type drop-down, select the HeadSpin Server option:

Select HeadSpin Server and the following new fields appear:

Enter Hostname in the Hostname field.

Enter the port configured in HeadSpin in the Port field.

Enter the API token in the API token filed. (e.g., /wd/hub)

Select the Capturing type from the drop-down list:

Screenshot: The screenshots of individual blocks are captured as the flow executes on the mobile device ensuring effective debugging. This is the most viable option for optimal performance while executing multiple flows.

Streaming: The flow being executed on the mobile device is streamed in video mode. This option requires more space and high-speed internet to ensure optimal performance. You may notice a slight lag in capturing (using recorder) or executing multiple flows with streaming mode as it may reduce the run performance.

 

Click the Test connection button to test the connection.

Click the Save button to save the details. Once your connection is saved a success message appears to let you know the connection is successful.

To the right of the Add button, use the buttons Edit or Delete to change and remove the connection:

Note: This feature can be accessed by Leapwork Admin only.

Lightweight Directory

Lightweight Directory Access Protocol (LDAP) is a protocol for connecting to a directory service and it is used for accessing and maintaining user information. Organizations may have customized user directories which follow LDAP protocol. This feature will support such a customized user directory so that users/groups can be added to Leapwork.

The Connections tab lets you set up a connection to the LDAP server which can be used to identify users or groups in an LDAP directory.

Note:

  • Leapwork users can only use one directory at a time and cannot switch between Active Directory (AD) and LDAP.

  • Leapwork recommends deleting AD and LDAP users from Leapwork's User Management tool rather than deleting from AD and LDAP.

  • Leapwork does not support adding AD users or groups and then adding LDAP users or groups.

  • Existing AD users or groups will be deleted if a user switches from AD to LDAP and vice versa.

  • You can continue using AD as an option to log into Leapwork studio.

Add Connection:

To add a connection, click the Add button and the following pop-up appears:

On the Add Connection pop-up window:

Enter the title in the Title field. It should be unique.

Enter the description in the Description field.

From the Type drop-down, select the Lightweight Directory (LDAP) option:

Select LDAP and the following new fields appear:

Enter the mandatory attributes LDAP Server, Port, Bind DN or User, and Bind Password. These attributes are used to connect the LDAP server.

All other attributes are optional, and users can choose attributes based on their requirements.

The Domain is server address where directory is hosted.

The User filed is used to authorize the user in the LDAP directory.

The Full Name filed is used to display the names of users who are authorized in the LDAP directory.

The User Unique Identifier is used to uniquely identify the user based on ID assigned.

The MemberOf field is used to fetch groups of users logging into the platform and authorize them accordingly.

The Group field is used to authorize a group in the LDAP directory.

The Group Membership field is used to match a group’s distinguished name with the name of groups which user is member.

The Group Unique Identifier is used to uniquely identify the group based on ID assigned.

The Default User Directory check box is checked by default.

Click the Save button to save the details. Once your connection is saved a success message appears to let you know the connection was successful.

To the right of the Add button, use the buttons Edit or Delete to change and remove the connection.

Note: This feature can be accessed by Leapwork Admin only.