Page tree
Skip to end of metadata
Go to start of metadata

Issues a notification

Syntax

Parameters

strIncident
Type: LPCWSTR
The name of the notification incident you are reporting. e.g. "Failed to open database"
strDescription
Type: LPCWSTR
The message describing the event that will be displayed to the user
strPlan
Type: LPCWSTR

The name of the Notification Plan that you wish to invoke for this incident. Specify an empty string to use the "Default Plan"

Return Value

Type: void
None

Remarks

strIncident is both the name of the incident and an identifier for that instance of the notification. You must use this same identifier when closing the incident. By using a free form text field for an id, you can create and close incidents with ids and text based on contextual information. e.g. In policy a user could issue a notification event by specifying an incident name of:

"User {{User.AccountName}} is visiting a dubious website {{Request.URL}}"

And then close it with the same text without having to have remembered a new ID (UUID for instance) for each notified incident.

Examples

None

See Also

NotificationAcknowledge

NotificationClose