DLConnection Object
Supported in versions 23.4 and later.
Description
Determines property values for connecting to a lab for mobile devices and cloud browsers. This can be one of the following:
OpenText Functional Testing Lab
OpenText Core Software Delivery Platform
Functional Testing Lab Lite
In earlier versions, these were respectively named:
UFT Digital Lab
ValueEdge Digital Lab
Digital Lab Lite
Throughout this topic, we use the new names for simplicity.
For more details, see Connect to a lab or to 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:
Set the Type property
Set the server address (Server+Port, ValueEdgeHostAddress, or Local Port )
Set the authentication information
Set the proxy
Set the SharedSpace (The SharedSpace ID is retrieved from the connected lab)
Set the WorkSpace (The WorkSpace ID is retrieved from the connected lab)
Example:
To use an access key for authentication, first set the AuthType property, then the AccessKey.
To connect to OpenText Functional Testing Lab using a proxy, and provide a user name and password for both the 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 OpenText Core Software Delivery Platform, 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.
However, for the SharedSpace and WorkSpace properties to be properly set up and saved, the connection to the lab must complete successfully.
Public properties
AccessKey | The access key used for authentication when connecting to OpenText Functional Testing Lab. |
AuthType | Indicates whether to use access keys or user name and password for authentication when connecting to the lab. |
LocalPort | The port used to connect to Functional Testing Lab Lite. |
Password | The password used for authentication when connecting to OpenText Functional Testing Lab. |
Port | The port for the OpenText Functional Testing Lab server you want to connect to. |
ProxyAddress | The proxy server address used to connect to the lab. |
ProxyPort | The proxy server port used to connect to the lab. |
ProxyType | The proxy type to use when connecting to the lab. |
ProxyUserName | The proxy user name used to connect to the lab. |
ProxyPassword | The proxy password used to connect to the lab. |
Server | The IP address of the OpenText Functional Testing Lab server you want to connect to. |
SharedSpace | The lab shared space that you want to connect to. |
ShowRemoteWndOnRun | Indicates whether to display the remote access window during the test run. |
SpecifyAuthentication | Indicates whether to provide credentials for the proxy used when connecting to the lab. |
Type | Indicates which type of server to connect to:
|
UseProxySettings | Indicates whether to use a proxy when connecting the lab. |
Username | The user name used for authentication when connecting to OpenText Functional Testing Lab. |
UseSSL | Indicates whether to use SSL when connecting to OpenText Functional Testing Lab. |
ValueEdgeAccessKey | The access key used for connecting to OpenText Core Software Delivery Platform. |
ValueEdgeHostAddress | The server address of OpenText Core Software Delivery Platform you want to connect to. |
WorkSpace | The workspace that you want to connect to in OpenText Core Software Delivery Platform or OpenText Functional Testing Lab. |
AccessKey property
Description
The access key used for authentication when connecting to OpenText Functional Testing Lab.
Generate your access key in OpenText Functional Testing Lab, as described in the OpenText Functional Testing 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 OpenText Functional Testing to encode the access key.
Syntax
Public Property AccessKey As String
AuthType property
Indicates whether to use access keys or username and password for authentication when connecting to the lab.
Property type
Read-write property.
Possible string values:
"Username Password" (default)
"Access Key"
IMPORTANT
Set the authentication properties after the server address and before the proxy properties.
If your lab server requires an access key, make sure this property is set before setting the access key property.
UFT One version 23.4: Always make sure this property is set to "Access Key" if you are connecting to OpenText Core Software Delivery Platform.
Syntax
Public Property AuthType As String
LocalPort property
Description
The port used to connect to Functional Testing Lab Lite.
Property type
Read-write property.
Default value
8080
Syntax
Public Property LocalPort As String
Password property
Description
The password used for authentication when connecting to OpenText Functional Testing Lab.
Property type
Read-write property.
IMPORTANT
This property value is used after the Username property.
Syntax
Public Property Password As String
Port property
Description
The port for the OpenText Functional Testing Lab server you want to connect to.
Property type
Read-write property.
Default value
8080
Syntax
Public Property Port As String
ProxyAddress property
Description
The proxy server address used to connect to the 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
ProxyPort property
Description
The proxy server port used to connect to the lab.
Property type
Read-write property.
Default value
8080
Syntax
Public Property ProxyPort As String
ProxyType property
Description
The proxy type to use when connecting to the 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
ProxyUserName property
Description
The proxy user name used to connect to the lab.
Property type
Read-write property.
IMPORTANT
Set this property after the SpecifyAuthentication property is set to True.
Syntax
Public Property ProxyUserName As String
ProxyPassword property
Description
The proxy password used to connect to the lab.
Property type
Read-write property.
IMPORTANT
Set this property after the ProxyUserName property is set.
Syntax
Public Property ProxyPassword As String
Server property
Description
The IP address of the OpenText Functional Testing Lab server you want to connect to.
Property type
Read-write property.
IMPORTANT
Set this property after the Type property and before the proxy and authentication properties.
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
SharedSpace Property
Description
The lab shared space that you want to connect to. Provide a SharedSpace ID, or use an empty string ("") to clear any shared space that may have been set previously.
This option is not relevant when using an access key to authenticate the connection to the lab, as the access key string includes a specific tenant ID.
Property type
Read-write property.
IMPORTANT
Set this property after you set the properties required to set up the lab connection.
The SharedSpace property can only be set after the connection to the lab is set up successfully. The SharedSpace ID is retrieved from the connected lab.
If you use the DLConnectionObject just to update some properties, you do not need to specify a shared space. But if you are using it to set up the connection, you should set the SharedSpace property.
If the connection was previously set up with an access key, which specifies the shared space as well, you can replace or clear this value with an empty string when you connect with a username and password.
UFT One version 23.4: If the shared space is already set in the OpenText Functional Testing Options dialog box, setting the same shared space using this property is unnecessary and results in a run-time error.
Syntax
Public Property SharedSpace As String
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
SpecifyAuthentication property
Description
Indicates whether to provide credentials for the proxy used when connecting to the 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
Type property
Description
Indicates whether to connect to OpenText Core Software Delivery Platform , OpenText Functional Testing Lab, or Functional Testing Lab Lite.
Property type
Read-write property.
Possible string values:
"0" - Connect to OpenText Functional Testing Lab(Default).
"1" - Connect to Functional Testing Lab Lite.
"2" - Connect to OpenText Core Software Delivery Platform.
Syntax
Public Property Type As String
IMPORTANT
Unless you are using a previously set or default value, set this property first.
UseProxySettings property
Description
Indicates whether to use a proxy when connecting to the lab.
Property type
Read-write property.
IMPORTANT
Set the proxy properties after the server address and the authentication properties.
If you set this property to True, the ProxyType property value is used as well.
Syntax
Public Property UseProxySettings As Bool
Username property
Description
The username used for authentication when connecting to OpenText Functional Testing 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 OpenText Functional Testing Lab.
Syntax
Public Property Username As String
UseSSL property
Description
Indicates whether to use SSL when connecting to OpenText Functional Testing Lab.
Property type
Read-write property.
Syntax
Public Property WorkSpace As Bool
ValueEdgeAccessKey property
Description
The access key used for connecting to OpenText Core Software Delivery Platform.
Property type
Read-write property.
IMPORTANT
Make sure the AuthType property is set before setting this property.
Use the Password Encoder utility installed with OpenText Functional Testing to encode the access key.
Syntax
Public Property ValueEdgeAccessKey As String
ValueEdgeHostAddress property
Description
The server address of OpenText Core Software Delivery Platform 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
WorkSpace Property
Description
The lab workspace that you want to connect to.
Property type
Read-write property.
IMPORTANT
Set this property after you set the properties required to set up the lab connection.
The WorkSpace property can only be set after the connection to the lab is set up successfully. The WorkSpace ID is retrieved from the connected lab.
UFT One version 23.4: If the workspace is already set in the OpenText Functional Testing 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
DLConnection object examples
The following code shows an example of the DLConnection object, when connecting to OpenText Core Software Delivery Platform:
Dim App 'As Application
Set App = CreateObject("QuickTest.Application")
App.Launch
App.Visible = True
'set Type
App.Options.DLConnection.Type= "2"
'set server address (ValueEdge)
App.Options.DLConnection.ValueEdgeHostAddress = "https://qa102.uftmobile.com"
'set AuthType
App.Options.DLConnection.AuthType = "Access Key"
'set the access key
App.Options.DLConnection.ValueEdgeAccessKey = "64c8bacbe7802dd1527f3224d"
'set proxy
App.Options.DLConnection.UseProxySettings = True
App.Options.DLConnection.ProxyType = "HTTP Proxy"
App.Options.DLConnection.ProxyAddress = "xx"
App.Options.DLConnection.ProxyPort = 80
App.Options.DLConnection.SpecifyAuthentication = True
App.Options.DLConnection.ProxyUserName = "xx"
App.Options.DLConnection.ProxyPassword = "xx"
'set workspace
App.Options.DLConnection.WorkSpace = "3dede266-bae5-413a-93f3-413bd064b04f"
App.Options.DLConnection.ShowRemoteWndOnRun = False
The following code shows an example of the DLConnection object, when connecting to OpenText Functional Testing Lab using username/password authentication:
Dim App 'As Application
Set App = CreateObject("QuickTest.Application")
App.Launch
App.Visible = True
'set server address
App.Options.DLConnection.Server = "192.157.1.38"
App.Options.DLConnection.Port = "80"
'set AuthType
App.Options.DLConnection.AuthType = "Username Password"
'set credentials
App.Options.DLConnection.Username = "xx"
App.Options.DLConnection.Password = "xx"
App.Options.DLConnection.UseSSL = False
'set proxy
App.Options.DLConnection.UseProxySettings = False
'set sharedspace
App.Options.DLConnection.SharedSpace = "xx"
'set workspace
App.Options.DLConnection.WorkSpace = "3dede266-bae5-413a-93f3-413bd064b04f"
App.Options.DLConnection.ShowRemoteWndOnRun = False
The following code shows an example of the DLConnection object, when connecting to OpenText Functional Testing Lab using access key authentication:
Dim App 'As Application
Set App = CreateObject("QuickTest.Application")
App.Launch
App.Visible = True
'set server address
App.Options.DLConnection.Server = "192.157.1.38"
App.Options.DLConnection.Port = "80"
'set AuthType
App.Options.DLConnection.AuthType = "Access Key"
'set access key
App.Options.DLConnection.AccessKey = "64c8bacbe7802dd1527f3224dcc"
App.Options.DLConnection.UseSSL = False
'set proxy
App.Options.DLConnection.UseProxySettings = True
App.Options.DLConnection.ProxyType = "System Proxy"
'set workspace
App.Options.DLConnection.WorkSpace = "3dede266-bae5-413a-93f3-413bd064b04f"
App.Options.DLConnection.ShowRemoteWndOnRun = False
The following code shows an example of the DLConnection object, when connecting to Functional Testing Lab Lite:
Dim App 'As Application
Set App = CreateObject("QuickTest.Application")
App.Launch
App.Visible = True
'set the Type
App.Options.DLConnection.Type= "1"
'set server address (lite)
App.Options.DLConnection.LocalPort = "8080"