Fields Objects

You can use the following objects in workflow scripts to access the fields of ALM modules:

Object

Description

AnalysisItem_Fields

Provides access to the fields of the reports and graphs in the Dashboard module.

AnalysisItemFolder_Fields

Provides access to the fields of the report and graph folders in the Dashboard module.

Baseline_Fields

Provides access to the fields of the baselines in the Libraries module.

Bug_Fields

Provides access to the fields of the defects in the Defects module and the Manual Runner dialog box.

Component_Fields

Provides access to the fields of components in the Business Components module.

ComponentStep_Fields

Provides access to the fields of component steps in the Business Components module.

Cycle_Field

Provides access to the fields of cycles in the Releases module.

DashboardFolder_Fields

Provides access to the fields of dashboard page folders in the Dashboard module.

DashboardPage_Fields

Provides access to the fields of dashboard pages in the Dashboard module.

DesignStep_Fields

Provides access to the fields of the design steps in the Test Plan module.

Library_Fields

Provides access to the fields of the libraries in the Libraries module.

LibraryFolder_Fields

Provides access to the fields of the library folders in the Libraries module.

Release_Fields

Provides access to the fields of the releases in the Releases module.

ReleaseFolder_Fields

Provides access to the fields of the release folders in the Releases module.

Req_Fields

Provides access to the fields of the Requirements module.

Resource_Fields

Provides access to the fields of the resources in the Test Resources module.

ResourceFolder_Fields

Provides access to the fields of the resource folders in the Test Resources module.

Run_Fields

Provides access to the fields of the test runs in the Manual Runner dialog box.

Step_Fields

Provides access to the fields of the steps in the Manual Runner dialog box.

Test_Fields

Provides access to the fields of tests in the Test Plan module.

TestSet_Fields

Provides access to the fields of the test sets in the Test Lab module.

TestSetTest_Fields

Provides access to the fields of the test instances in the Test Lab module.

For example, to set a certain property for all fields in the Req_Fields object, you can refer to each field by its ID number (Req_Fields.FieldById). To set all fields to be visible (IsVisible)in a dialog box, you can use the following code:

For i = 1 to Req_Fields.Count
        Req_Fields.FieldById(i).IsVisible = True
Next

These objects have the following properties:

Property

R/W

Type

Description

Count

R

Long

Returns the number of fields in the current object.

Field
(FieldName)

R

Object

Accesses the fields by field name or field label.

FieldById
(FieldID)

R

Object

Accesses the fields by the field ID number.

Tip: To avoid errors if your script attempts to access a non-active or a non-existing field, include On Error Resume Next in the script.