When an incident is reported to the Notifications system, the incident status is reported as being active and it will trigger a selected notification plan. Its current status will be displayed on the Notifications panel, located at Monitoring > Notifications in the WinGate Management console.
During the execution of notification events in the plan, WinGate gives you the ability to change the status of the incident by acknowledging or closing it. Changing the status of the incident will determine how the remaining notification events scheduled in the notification plan will continue to be executed (if at all).
When an incident is first reported to the Notifications system, its status is set as Active and any targeted notification plan will be initiated.
An incident can be set to Acknowledged by the administrator or authorized user using the WinGate Management console (See the Acknowledging and closing incidents section below).
When an incident status is set to Acknowledged, the notification plan will continue to execute the remaining notification events in the plan unless there has been a suspension period configured in the properties of the notification plan.
This Suspend (delay) pending notification events option allows you to set the time delay from the moment that someone acknowledges the incident, to when the rest of the notification events in the plan (that haven't been triggered yet) will resume being executed. This allows a safety period after the incident has been acknowledged, for someone to actually fix the issue and close the incident. Closing an incident will actually stop the execution of the rest of the notification events in the notification plan. During the suspension time the incident status will be set to Suspended.
When using a WinGate scripting system it is possible to suspend an incident using the Notifications object published by the Notifications system. The Notifications object provides the Notifications.Suspend(TextIncident,TextReason) method which can be used to suspend a notification plan when the script processing determines that it necessary from inside the script logic (See the WinGate objects section below).
When an incident status is set to Closed, any further pending notification events in the target notification plan will be canceled.
In the properties of the notification plan, there is an option to retrigger all of the notification events that have been already executed in the plan up till the point the incident was closed.
This is done so people who may have received notification as part of the plans schedule can see it has been closed and is no longer an issue, or no longer requires their attention.
You can change the status of an incident to acknowledged or closed from several places in WinGate:
The Notifications panel, located at Monitoring > Notifications in the WinGate Management console, displays the current incidents that have been reported to the Notifications system and allows you to manage their status accordingly.
Using the Notifications policy item
When you are configuring a policy you can set a Notification policy item to simply acknowledge or close a specified incident. This is useful when you want to have policy evaluate when conditions are suited to acknowledge or close an incident that has triggered off a notification plan.
Closing an incident when threshold checking on monitored data
When you are configuring threshold checking on piece of monitored data in WinGate, there is an option to trigger an incident if the value of the data breaches the upper or lower values of the threshold. This configuration also provides the ability to automatically close the incident if the value of the monitored data falls back below or above the threshold value.
When using a WinGate script system (such as the Lua script or Javascript event processors) or configuration that has access to a Symbol Browser, the Notifications system publishes the Notifications object which provides several methods for the management of notification escalation.
This allows you to report (create), acknowledge, suspend, and close incidents inside the processing of the script.
Member |
Description |
|---|---|
Cancel(Text Incident,Text Reason) |
This method allows you to cancel an existing incident that has been reported to the Notifications system. This will change the incident status in the Notifications system to Closed. e.g. A script could contain: Notifications.Cancel("Testincident","Fault found and fixed by administrator") This would close the incident called Testincident that had been reported to the Notifications system. The reason for closing ("Fault found and fixed by administrator") will appear next to incident in the Log pane of the Notifications panel. |
Report(Text Incident,Text Reason, Text Plan) |
This method will automatically check for the existence of the incident given in the Text Incident parameter. If it is not found, the an incident with that name will be created automatically, and trigger the notification plan specified in the Text Plan parameter. |
Suspend(Text Incident,Text Reason) |
This method allows you to acknowledge/suspend an incident given by the Text Incident parameter. Suspension status is if course dependent on the Suspend option set in the Notification plan being used (as mentioned in the Incident state section above). |
You can use basic Full-Text Searches against the page title and body to find matching articles. Use the following search modifiers to refine your query:
