This section contains an alphabetical reference of the ALM event functions and subroutines. It includes the event name, description, syntax, type (Function or Sub), the value returned by a function, and the entities for which the event procedure is available.
For information on the naming conventions for event procedures, see Naming Conventions for ALM Event Procedures.
The following event functions are available:
|
Function Name
|
When the Function is Triggered
|
|
ActionCanExecute
|
before performing a user action
|
|
Attachment_CanDelete
|
before deleting an attachment
|
|
Attachment_CanOpen
|
before opening an attachment
|
|
Attachment_CanPost
|
before updating an attachment
|
|
CanAddTests
|
before adding tests to a test set
|
|
CanCustomize
|
before opening Customization window
|
|
CanDelete
|
before deleting an object from the server
|
|
CanLogin
|
before a user logs in to the project
|
|
CanLogout
|
before a user logs out of the project
|
|
CanPost
|
before posting an object to the server
|
|
CanRemoveTests
|
before removing tests from a test set
|
|
CanAddComponentsToTest
|
before adding business components to a test of type Flow or Business-Process
|
|
CanAddFlowsToTest
|
before adding flows to a test of type Business-Process
|
|
CanRemoveComponentsFromTest
|
before removing business components from a test of type Flow or Business-Process
|
|
CanRemoveFlowsFromTest
|
before removing flows from a test of type Business-Process
|
|
CanDeleteGroupsFromTest
|
before deleting groups from a test of type Flow or Business-Process
|
|
CanReImportModels
|
before importing business models
|
|
DefaultRes
|
before resetting project defaults
|
|
FieldCanChange
|
before changing a field value
|
|
GetDetailsPageName
|
before displaying Defect Details dialog box
|
|
GetNewBugPageName
|
before displaying Add Defect dialog box (for backward compatibility)
|
|
GetNewReqPageName
|
before displaying New Requirement dialog box (for backward compatibility)
|
|
GetReqDetailsPageName
|
before displaying Requirement Details dialog box (for backward compatibility)
|
The following event subroutines are available:
|
Subroutine Name
|
When the Subroutine is Triggered
|
|
AddComponentToTest
|
a component has been added to a test of type Flow or Business-Process
|
|
AfterPost
|
an object has been posted to the server
|
|
Attachment_New
|
an attachment is added
|
|
DialogBox
|
a dialog box is opened or closed
|
|
EnterModule
|
user switches modules
|
|
ExitModule
|
user exits a module
|
|
FieldChange
|
a field value changes
|
|
MoveTo
|
user changes focus
|
|
MoveToComponentFolder
|
user moves to the specified component folder in the business component tree (for backward compatibility)
|
|
MoveToFolder
|
user clicks a folder in the test sets tree (for backward compatibility)
|
|
MoveToSubject
|
user clicks a subject in the test plan tree (for backward compatibility)
|
|
New
|
an object is added
|
|
RemoveComponentFromTest
|
user removes a component from a test of type Flow or Business-Process
|
|
RunTests
|
user clicks Run in the Test Lab module (provided that Sprinter is not installed and none of the tests is automated)
|
|
RunTests_Sprinter
|
user clicks Run in the Test Lab module (provided that Sprinter is installed and at least one test is automated)
|
|
RunTestSet
|
user clicks RunTest Set in the Test Lab module
|
|
RunTestsManually
|
user clicks Run > Run Manually in the Test Lab module
|