System Events

Modified on Mon, 19 Jan at 4:35 PM

TABLE OF CONTENTS

System Events

System Events

System events in ManagementStudio are specific actions within the platform that can be subscribed to and extended. These events can trigger actions such as sending email notifications (for example, when an application is archived), or they can be used more commonly to run PowerShell scripts. PowerShell scripts can interact with the ManagementStudio API to provide additional functionality beyond what is available out of the box. For example, when an application is superseded, a script could be triggered to check users' migration readiness.

Subscribing to System Events

System events must be subscribed to from appropriate platform sections. The main sections that support event subscriptions are:

PowerShell Scripts Panel
- Navigation: Administration → Project Admin → PowerShell Scripts
- For detailed guidance, see the PowerShell Scripts Panel article.
Email Templates Panel
- Navigation: Administration → [Module] → Email Templates
- For more information, see the Email Templates Panel article.
My Preferences Page
- Accessible via the My Preferences button at the top right of the main window.

Event Arguments

When an event is triggered, a list of relevant IDs (such as AppIds, MigrationIds, or DeviceIds) is passed to scripts in the Items variable. Some events also include additional data through the EventArg1 and EventArg2 variables.

Note: The Process Changed and Owner Changed events pass objects containing detailed data instead of just IDs. Refer to the Event List section for details.

Event List

The table below outlines system events, the arguments passed, and which modules support each event:

Event	Arg 1	Arg 2	Apps	Users	Devices	DeployUnit	Defect
Created	–	–	✔	✔	✔	✔	✔
Updated	–	–	✔	✔	✔	✔	✔
Locked	`True` / `False`	–	✔	✔	✔	✔	✔
Archived	`True` / `False`	–	✔	✔	✔	✔	✔
Deleted	`True` / `False`	–	✔	✔	✔	✔	✔
Process Changed	See Note 1 below	–	✔	✔	✔	✔	✔
Team Member Changed	See Note 2 below	–	✔	✔	✔	✔	✔
Blueprint Added	`BlueprintId`	–	✔	✔	✔	✔	✔
Blueprint Removed	`BlueprintId`	–	✔	✔	✔	✔	✔
Defect Added	`DefectId`	–	✔	✔	✔	✔	✔
Attachment Added	`AttachmentId`	–	✔	✔	✔	✔	✔
Attachment Removed	`AttachmentId`	–	✔	✔	✔	✔	✔
Contact Added	`ContactId`	–	✔	✔	✔	✔	✔
Contact Removed	`ContactId`	–	✔	✔	✔	✔	–
Excel Data Imported	–	–
Survey Signed Off	`SurveyId`	`True`/`False`	✔	✔	✔	–	–
Deploy Unit Added To	`DeployUnitId`	–	✔	✔	✔	–	–
DeployUnit Removed From	`DeployUnitId`	–	✔	✔	✔	–
Deploy Unit Slot Booked	`DeployUnitId`	–	✔	✔	✔	–	–
DeployUnit Slot Changed	`DeployUnitId`	–	✔	✔	✔	–	–
App Superseded By	–	–	✔	–	–	–	–
App Status Accepted	–	–	✔	–	–	–	–
App Status Pending	–	–	✔	–	–	–	–
App Status Rationalised	–	–	✔	–	–	–	–
App Status Rejected	–	–	✔	–	–	–	–

Notes

For Process Changed events, the Items variable contains a list of objects with the following structure:
{ Id, FromProcessId, FromSubProcessId, ToProcessId, ToSubProcessId }
For Team Member Changed events, the Items variable contains a list of objects with the following structure:
{ Id, UserId, Owner }

Further Support

For additional assistance, visit the ManagementStudio Service Desk to search the knowledge base or submit a support ticket.