For information on converting to InterSystems IRIS,
see the InterSystems IRIS Adoption Guide
and the InterSystems IRIS In-Place Conversion Guide,
both available on the WRC Distributions page (login required).
Parameter to control whether the pAction parameter passed to the Update()()
is explicitly validated against the Ens.DataType.ManagedAlertAction datatype.
Users should override this setting if they extend this class and need to add their own actions.
Note that Ensemble reserves all action values up to and including 512 (i.e. 2^9), so any user-defined actions
should start with bit 10 (i.e. 1024).
Ensure that the current user has permission to edit managed alerts.
Also ensure that UpdateNextMonitorTime()() is called when saving a new
ManagedAlert, or when the alert management framework is performing an update,
or when NextActionTime has been modified.
classmethod AlertGroupsBuildValueArray(pAlertGroups As %String = "", Output pValueArray As %String) as %Status
Helper method to allow the individual values in AlertGroups to be indexed.
API to make it easier to mark some large set of managed alerts as closed.
The arguments that control which specific alerts are closed are as follows:
pErrors - flag to control whether the IDs that aren't removed are
reported in subscripts of the pErrors variable on output. By default only
the count is reported in pErrors.
pDaysToKeep - flag to control the time window that should be closed
using the same logic as purges. All managed alerts that occurred more than pDaysToKeep
days in the past will be closed. The flag supports a value of -1 to ensure that ALL matching
managed alerts are closed, including any that were created in the past day.
pReason - A required string to indicate why the managed alerts are being closed.
pConfigName - An optional string to specify that managed alerts from
a specific SourceConfigName should be closed.
pCurrentOwner - An optional string to specify that managed alerts assigned to
the specified user should be closed. The default of -1 indicates no filter should be applied,
as the empty string ("") is used to indicate that the managed alert is unassigned.
pText - An optional string to filter the results by specific text. By default,
the filter checks whether the AlertText property contains pText ignoring case.
To use an equality filter, the first character of pText should be specified as "=",
and the remainder of pText will be matched against the AlertText property.
NOTE: searches matching on AlertText may be very slow if no other filters are supplied.
Helper method to return a valid NextMonitorTime value.
If pNextActionTime is in the future, then pNextActionTime is returned.
Otherwise, the production's Alert Action Window setting is used to calculate the next time.
Calculate the next action time for the Managed Alert.
classmethod GetProperties(Output pProperties As %List, Output pCollectionProperties As %List) as %Status
Helper method to populate which values are available for display in the UI.
The tree structure for pProperties should be as follows: pProperties = $listbuild([names of properties]) pProperties([propName]) = $listbuild([Property Title],[Editable],[Action Value],[Datatype],[Empty Value],[Use Display Value])
The tree structure for pCollectionProperties is as follows: pCollectionProperties = $listbuild([names of collection properties]) pCollectionProperties([collectionName]) = $listbuild([Collection Title],[Editable],[Action Value],[Instance Title],$listbuild([list of sub-properties to display])) pCollectionProperties([collectionName],[propName]) = $listbuild([Property Title],[Editable],[Action Value],[Datatype],[Empty Value],[Use Display Value])