About ALM Objects and Properties

Workflow scripts can obtain information, make decisions based on that information, and change values in the project based on those decisions.

You can obtain information such as the user group to which the current user belongs, and the value of a field, by accessing objects such as the User object or the Field object.

You can also obtain information about the active module and active dialog box using workflow properties. For details on these properties, see ALM Properties.

Your script can change the value of a field or field list. To do so, the script modifies the Value property or the List property of the appropriate Field object.

For information on the event procedures in which you place VBScript code to create workflow scripts, see Workflow Event Reference.

The following table lists the ALM objects that are available when you write a script.




The list of actions that are available. See Actions Object.


The Action object is handled by the Actions object. See Action Object.


Includes the objects that provide access to specific fields. See Fields Objects.


The Field object is handled by the Fields objects. See Field Object.


Includes the lists that are available in an ALM project. See Lists Object.


Provides access to open test architecture (OTA) objects. See TDConnection Object.


Includes the properties of the current user. This object is available in all modules. See User Object.

ActiveTreeSelection Accesses the list of currently selected entities in active modules that are open test architecture (OTA) objects. See ActiveTreeSelection Object.

Note: In some cases, a function returns the object itself instead of the ID property of the object. For example, after the following statement has been executed, testsetf is a reference to a TestSetFolder object:
Set testsetf = TestSet_Fields("CY_FOLDER_ID").Value.

For each ALM object, this section lists the properties of the object. The list includes the property name, a description, and the data type of the property. It indicates whether the property is read-only (R) or whether your script can modify it (R/W).

Version Control: After enabling version control for a project, you should review all its workflow scripts and make adjustments for each checked in entity. This includes the following entities: Req, Test, Resource, and Component. For each checked in entity that includes a Post function in its script, you must modify the script. To modify, add a Checkout function before every Post function. Making this modification prevents the Check Out dialog box from opening each time a call to a Post function is made. For details about the Post and Checkout functions, see the ALM Open Test Architecture Reference.