TDConnection object

The TDConnection object is a global object that can be used in any event from any module to access almost all Web Client functionality. You can use it to expand the capabilities of your project scripts.

For example, if you want to have a defect converted to a requirement when the defect is rejected with a specific reason, you can write code in the Bug_FieldChange event of the Defects module using the TDConnection.ReqFactory property. The code implements the interaction between the Defects module and Requirements module. See TDConnection examples.

Public methods

TDConnection supports the following methods.

Method Description
GetCommonFavoriteFolderFactory

Returns a FavoriteFolderFactory object factory that manages favorite folders.

Syntax: TDConnection.GetCommonFavoriteFolderFactory()

For details about the FavortieFolderFactory object, see FavoriteFolderFactory object.

Public properties

TDConnection supports the following properties.

Property R/W Type Description

BugFactory

 R Object

The BugFactory object for this connection.

For details, see BugFactory object.

Connected

 R Boolean

Checks if the REST API server connection is initialized.

CoverageFactory

 R Object

The CoverageFactory for the connection.

For details, see CoverageFactory object.

DomainName

 R String

The current domain.
FetchAll R/W Boolean

Whether to get all entities in each NewList query request of TDConnection.

  • false. The number of entities returned depends on the PageSize. If PageSize is not specified, it returns up to 100 entities. This is controlled by the REST_API_DEFAULT_PAGE_SIZE parameter).

  • true. The default value. Gets all entities.
PageSize R/W Number The number of queried entities in each page.

ProjectName

 R String

The name of the connected project.
ReleaseFolderFactory R Object

The ReleaseFactory object for this connection.

For details, see ReleaseFolderFactory object.

ReqFactory

 R Object

The ReqFactory object for this connection.

For details, see ReqFactory object.
RunFactory R Object

The RunFactory object for this connection.

For details, see RunFactory object.

ServerTime

 R Date

The time and date of the application server.

ServerURL

 R String

The URL of the connected server.
TestConfigFactory R Object

The TestConfigFactory object for this connection.

For details, see TestConfigFactory object.

TestFactory

 R Object

The TestFactory object for this connection.

For details, see TestFactory object.

TestFolderFactory

 R Object

The TestFolderFactory object for this connection.

For details, see TestFolderFactory object.

TestLabFolderFactory

 R Object

The TestLabFolderFactory object for this connection.

For details, see TestLabFolderFactory object.

TestSetFactory

 R Object

The TestSetFactory object for this connection.

For details, see TestSetFactory object.

TSTestFactory

 R Object

The factory that manages test instances in test sets.

For details, see

Example

TDConnection examples

Back to top