Home > Class Reference > ENSLIB namespace > Ens.Alerting.NotificationOperation

Ens.Alerting.NotificationOperation

abstract class Ens.Alerting.NotificationOperation extends Ens.BusinessOperation

Base class that implements some simple helper methods that actual Notification Operations can make use of.

Property Inventory

Method Inventory

Parameters

parameter SETTINGS = SystemName:Basic,IncludeUTCTimes:Basic;
Inherited description: List of properties can be set as settings in the configuration file format is a comma separated list of property names

Properties

property IncludeUTCTimes as %Boolean [ InitialExpression = 1 ];
Flag to control whether UTC times should be included in the text of notifications addition to the time of the local system.
Property methods: IncludeUTCTimesDisplayToLogical(), IncludeUTCTimesGet(), IncludeUTCTimesIsValid(), IncludeUTCTimesLogicalToDisplay(), IncludeUTCTimesNormalize(), IncludeUTCTimesSet()
property InstanceName as %String [ InitialExpression = ##class(%SYS.System).GetInstanceName() ];
The current instance name.
Property methods: InstanceNameDisplayToLogical(), InstanceNameGet(), InstanceNameIsValid(), InstanceNameLogicalToDisplay(), InstanceNameLogicalToOdbc(), InstanceNameNormalize(), InstanceNameSet()
property SystemName as %String;
Name of the system for inclusion in notifications sent from this system. If this value is empty, then the default value will be the value of InstanceName.
Property methods: SystemNameDisplayToLogical(), SystemNameGet(), SystemNameIsValid(), SystemNameLogicalToDisplay(), SystemNameLogicalToOdbc(), SystemNameNormalize(), SystemNameSet()

Methods

method GetSystemInfo(pManagedAlert As Ens.Alerting.ManagedAlert = "", Output pSystemName As %String, Output pInstanceName As %String, Output pNodeName As %String) as %Status [ Language = objectscript ]
Helper method to get information about the system where the alert originated.
method GetUpdateText(pNotificationRequest As Ens.Alerting.NotificationRequest, Output pUpdateText As %String) as %Status [ Language = objectscript ]
Helper method to get a text message describing the update that has been requested.

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new window