Share this page

# Using the TDHelper Object

The TDHelper object supplies the following functions that you can use to perform ALM-related tasks.

RunTestSet

Executes the selected test set and returns the accumulated test set execution status.

RunTestSet([Name = `"`default`"`], [Filter = `""`], [Locally = FALSE], [Host = `""`], [HostGroup = `""`])

Name. Test set name. Optional. Default = `"default"`

Filter. Test filter. Defines tests to run. If empty, instructs ALM to run all the tests in a specified test set. Optional. Default = `""`

Locally. If set to `TRUE`, instructs ALM to run test set locally. Optional. Default = `FALSE`

Host. Host on which test set will be run. Optional. Default = `""`

HostGroup. Host group in which test set will be run. Optional. Default = `""`

RunTest

Executes the selected test and returns the test execution status.

RunTest(Name, Instance, TestSet, [Locally = FALSE], [Host = `""`], [HostGroup = `""`])

Name. Test name.

Instance. Test instance.

TestSet. Test set name.

Locally. If set to `TRUE`, instructs ALM to run test set locally. Optional. Default = `FALSE`

Host. Host on which test set will be run. Optional. Default = `""`

HostGroup. Host group in which test set will be run. Optional. Default = `""`

AddDefect

Adds a new defect to the current test, if the test is being run in debug mode. If the test is being run in test mode, a new defect is added to the current run of the test instance in the current test set. Returns a created defect object.

AddDefect([Fields], [stepKey])

Fields. Two-dimensional array—the first dimension is for the field name, and the second for the field value. Optional.

stepKey. step ID for step related to new defect. Optional.

AddDefectUI

Adds a new defect to the current test (in debug mode) or the current run (in test mode), using the ALM New Defect dialog box.

AddDefectUI([stepKey])

stepKey. step ID for step related to new defect. Optional.

AddStepToRun

Adds a new step to the current run. Returns a created step object.

AddStepToRun(Name, [Desc], [Expected], [Actual], [Status])

Name. Step name.

Desc. Step description. Optional.

Expected. Expected step result. Optional.

Actual. Actual step result. Optional.

Status. Step status. Optional.

DownLoadAttachment

Downloads the attachment associated with a test object. Returns the local path to which the download was performed.

DownLoadAttachment(Name, item)

Name. The attachment name.

item. Reference to the object with the attachment.

UpLoadAttachment

Uploads an attachment and associates it with a test object.

UpLoadAttachment(path, item)

path. The local path (fully specified file name) of the item to upload.

item. Reference to the object to which to associate the attachment.

https://admhelp.microfocus.com ALM 8942
Tips to improve your search results... ALM Help Center ALM Help Center ALM Help 15.5-15.5.1 All View Local Help Center View Online Help Center back Go back in browser history forward Go forward in browser history Remove search highlights next topic Go to next topic previous topic Go to previous topic Print the current topic Version: