UIActions Objects

You can use the UIActions objects in workflow scripts to perform actions in the ALM user interface. The following objects are available:

Object

Description
UIActions.SwitchTab

Switches to the specified tab when the event is triggered.

Syntax: UIActions.SwitchTab "<Tab Label>"

Example: In the Test Plan module, after the Status field value changes, the Attachments tab is displayed.

Sub Test_FieldChange(FieldName)
 On Error Resume Next
 If FieldName="TS_STATUS" Then
  UIActions.SwitchTab "Attachments"
 End If
 On Error GoTo 0
End Sub
UIActions.FocusEntity

Changes focused entity in the current module according to the specified entity ID.

Syntax: UIActions.FocusEntity "<id of the entity>", [true/false]

Optional boolean parameter indicates if the specified ID belongs to a folder in the tree (default value is false).

Example: In the Test Plan module, after the event is triggered, the focus is placed on a test with the Test ID value of 1.

Function ActionCanExecute(ActionName)
 On Error Resume Next
 If ActionName = "UserDefinedActions.TestPlan_Action1" Then
  UIActions.FocusEntity "1"
 End IF
ActionCanExecute = DefaultRes
 On Error GoTo 0
End Function
UIActions.FocusField

Goes to the specified field when the event is triggered. This object only works on the fields in the Details dialog box and does not work on the grid view.

Syntax: UIActions.FocusField "<Field Name>"

Example: In the Defects module, after the Closing Date value is set, the focus is placed on the Comments field.

Sub Bug_FieldChange(FieldName)
 On Error Resume Next
 If FieldName = "BG_CLOSING_DATE" Then
  UIActions.FocusField "BG_DEV_COMMENTS"
 End IF
 On Error GoTo 0
End Sub