DLConnection Object

Supported in UFT One version 23.4 and later.

Description

Determines property values for UFT One to connect to Digital Lab (ValueEdge Digital Lab or UFT Digital Lab) or Digital Lab Lite.

For more details, see Connect to Digital Lab or local mobile devices.

The properties of this object depend on one another. Therefore, make sure that you define all the relevant properties, and that you define them in the correct order.

Example:  

To use an access key for authentication, first set the AuthType property, then the AccessKey.

To connect to UFT Digital Lab using a proxy, and provide a user name and password for both the UFT Digital Lab server and the proxy, set the following properties, in the following order: Type, Server, Username, Password, UseProxySettings, ProxyAddress, SpecifyAuthentication, ProxyUsername, ProxyPassword.

To connect to ValueEdge Digital Lab, set the Type property before setting ValueEdgeHostAddress, AuthType, and ValueEdgeAccessKey.

Properties that you set are saved for future use. Therefore, if a property was already set and you do not need to change its value, you do not need to specify it.

Public properties

Public Property AccessKeyThe access key used for authentication when connecting to UFT Digital Lab.
Public Property AuthTypeIndicates whether to use access keys or user name and password for authentication when connecting to Digital Lab.
Public Property LocalPortThe port used to connect to Digital Lab Lite.
Public Property PasswordThe password used for authentication when connecting to UFT Digital Lab.
Public Property PortThe port for the UFT Digital Lab server you want to connect to.
Public Property ProxyAddress

The proxy server address used to connect to Digital Lab.

Public Property ProxyPort

The proxy server port used to connect to Digital Lab.

Public Property ProxyType

The proxy type to use when connecting to Digital Lab.

Public Property ProxyUserName

The proxy user name used to connect to Digital Lab.

Public Property ProxyPassword

The proxy password used to connect to Digital Lab.

Public Property Server

The IP address of the UFT Digital Lab server you want to connect to.

Public Property SharedSpaceThe Digital Lab shared space that you want to connect to.
Public Property ShowRemoteWndOnRunIndicates whether to display the remote access window during the test run.
Public Property SpecifyAuthentication

Indicates whether to provide credentials for the proxy used when connecting to Digital Lab.

Public Property TypeIndicates whether to connect to ValueEdge Digital Lab, UFT Digital Lab, or Digital Lab Lite.
Public Property UseProxySettings

Indicates whether to use a proxy when connecting Digital Lab.

Public Property UsernameThe user name used for authentication when connecting to UFT Digital Lab.
Public Property UseSSLIndicates whether to use SSL when connecting to UFT Digital Lab.
Public Property ValueEdgeAccessKey

The access key used for connecting to ValueEdge Digital Lab.

Public Property ValueEdgeHostAddressThe server address of ValueEdge Digital Lab you want to connect to.
Public Property WorkSpace

The ValueEdge Digital Lab workspace or UFT Digital Lab workspace that you want to connect to.

Back to top

AccessKey property

Description

The access key used for authentication when connecting to UFT Digital Lab.

Generate your access key in UFT Digital Lab, as described in the Digital Lab Help Center.

Property type

Read-write property.

IMPORTANT

Make sure the AuthType property is set before setting this property.

Use the Password Encoder utility installed with UFT One to encode the access key.

Syntax

Public Property AccessKey As String

Back to top

AuthType property

Indicates whether to use access keys or username and password for authentication when connecting to Digital Lab.

Property type

Read-write property.

Possible string values: 

  • "Username Password" (default)

  • "Access Key"

IMPORTANT

If your Digital Lab server requires an access key, make sure this property is set before setting the access key property.

Always make sure this property is set to "Access Key" if you are connecting to ValueEdge Digital Lab.

Syntax

Public Property AuthType As String

Back to top

LocalPort property

Description

The port used to connect to Digital Lab Lite.

Property type

Read-write property.

Default value

8080

Syntax

Public Property LocalPort As String

Back to top

Password property

Description

The password used for authentication when connecting to UFT Digital Lab.

Property type

Read-write property.

IMPORTANT

This property value is used after the Username property.

Syntax

Public Property Password As String

Back to top

Port property

Description

The port for the UFT Digital Lab server you want to connect to.

Property type

Read-write property.

Default value

8080

Syntax

Public Property Port As String

Back to top

ProxyAddress property

Description

The proxy server address used to connect to Digital Lab.

Property type

Read-write property.

IMPORTANT

Set this property after the ProxyType property is set to HTTP Proxy.

Syntax

Public Property ProxyAddress As String

Back to top

ProxyPort property

Description

The proxy server port used to connect to Digital Lab.

Property type

Read-write property.

Default value

8080

Syntax

Public Property ProxyPort As String

Back to top

ProxyType property

Description

The proxy type to use when connecting to Digital Lab.

Property type

Read-write property.

Possible string values: 

HTTP Proxy, System Proxy (default value)

IMPORTANT

Make sure the UseProxySettings property is set before setting this property.

If you set this property to HTTP Proxy, the ProxyAddress property value is used as well.

Syntax

Public Property ProxyType As String

Back to top

ProxyUserName property

Description

The proxy user name used to connect to Digital Lab.

Property type

Read-write property.

IMPORTANT

Set this property after the SpecifyAuthentication property is set to True.

Syntax

Public Property ProxyUserName As String

Back to top

ProxyPassword property

Description

The proxy password used to connect to Digital Lab.

Property type

Read-write property.

IMPORTANT

Set this property after the ProxyUsername property is set.

Syntax

Public Property ProxyPassword As String

Back to top

Server property

Description

The IP address of the UFT Digital Lab server you want to connect to.

Property type

Read-write property.

IMPORTANT

If the value of this property is set in the https://<IP address>:port or http://<IP address>:port format, leave the UseSSL and Port properties empty. Otherwise, make sure you set those properties to match this one.

For example, if you set this property to http://192.157.1.38:80, then you must set the UseSSL property to False and the Port property to 80. Otherwise, the connection may fail.

Syntax

Public Property Server As String

Back to top

SharedSpace Property

Description

The Digital Lab shared space that you want to connect to.

This option is not relevant when using an access key to authenticate the connection to Digital Lab.

Property type

Read-write property.

IMPORTANT

UFT One 23.4: If the shared space is already set in the UFT One Options dialog box, setting the same shared space using this property is results in a run-time error.

Syntax

Public Property SharedSpace As String

Back to top

ShowRemoteWndOnRun Property

Description

Indicates whether to display the remote access window during mobile test runs.

Property type

Read-write property.

Syntax

Public Property ShowRemoteWndOnRun As Bool

Back to top

SpecifyAuthentication property

Description

Indicates whether to provide credentials for the proxy used when connecting to Digital Lab.

Property type

Read-write property.

IMPORTANT

If you set this property to True, the ProxyUsername and ProxyPassword property values are used as well.

Syntax

Public Property SpecifyAuthentication As Bool

Back to top

Type property

Description

Indicates whether to connect to ValueEdge Digital Lab, UFT Digital Lab, or Digital Lab Lite.

Property type

Read-write property.

Possible string values: 

"0" - Connect to UFT Digital Lab (Default).

"1" - Connect to Digital Lab Lite.

"2" - Connect to ValueEdge Digital Lab.

Syntax

Public Property Type As String

Back to top

UseProxySettings property

Description

Indicates whether to use a proxy when connecting to Digital Lab.

Property type

Read-write property.

IMPORTANT

If you set this property to True, the ProxyType property value is used as well.

Syntax

Public Property UseProxySettings As Bool

Back to top

Username property

Description

The username used for authentication when connecting to UFT Digital Lab.

Property type

Read-write property.

IMPORTANT

Set this property if the Server property is set and you are not using an access key to connect to UFT Digital Lab.

Syntax

Public Property Username As String

Back to top

UseSSL property

Description

Indicates whether to use SSL when connecting to UFT Digital Lab.

Property type

Read-write property.

Syntax

Public Property WorkSpace As Bool

Back to top

ValueEdgeAccessKey property

Description

The access key used for connecting to ValueEdge Digital Lab.

Property type

Read-write property.

IMPORTANT

Make sure the AuthType property is set before setting this property.

Use the Password Encoder utility installed with UFT One to encode the access key.

Syntax

Public Property ValueEdgeAccessKey As String

Back to top

ValueEdgeHostAddress property

Description

The server address of ValueEdge Digital Lab you want to connect to.

Property type

Read-write property.

Important

Use this property if the Type property is set to "2".

Syntax

Public Property ValueEdgeHostAddress As String

Back to top

WorkSpace Property

Description

The Digital Lab workspace that you want to connect to.

Property type

Read-write property.

IMPORTANT

  • When using an access key to connect to Digital Lab, you cannot select a shared workspace as the access key string includes a specific tenant ID.

  • If the workspace is already set in the UFT One Options dialog box, setting the same workspace using this property is unnecessary and results in a run-time error.

Syntax

Public Property WorkSpace As String

Back to top

DLConnection object examples

Back to top