|
This context is a system context that provides access to different data and operations related to event management. It is not shown in the visible context tree.
Unique Actions
REMOVE EXPIRED EVENTS
Removes expired events from event history.
Action Type:
|
Call Function
|
Action Name:
|
removeExpired
|
Permissions:
|
Accessible at Engineer permission level
|
Context Information
Context Type: events
Context Name: events
Context Description: Events
Context Path: events
Context Mask: events
Context Permissions: Observer
Public Variables (Properties)
This context has no public variables (properties).
Public Functions
ACKNOWLEDGE EVENT
Adds new acknowledgement to the event.
Function Name:
|
acknowledge
|
Permissions:
|
Accessible at Operator permission level
|
Input Records:
|
1
|
Input Format:
|
Name
|
Type
|
Description
|
id
|
Long
|
ID of event to acknowledge.
|
ack
|
String
|
Acknowledgement text.
|
author
|
String
|
Acknowledgement author (optional field, username of the active user is used if author was not specified). This is just a plain text field; it is not actually linked to a system user, and thus should not be considered auditable (always accurate).
|
|
Output Records:
|
0
|
Output Format:
|
None
|
DELETE EVENT
Permanently deletes event from event history.
Function Name:
|
delete
|
Permissions:
|
Accessible at Manager permission level
|
Input Records:
|
1
|
Input Format:
|
Name
|
Type
|
Description
|
id
|
Long
|
Event ID.
|
|
Output Records:
|
0
|
Output Format:
|
None
|
REMOVE EXPIRED EVENTS
Removes all expired events from event history. Note, that normally all expired events are removed automatically by AggreGate Server by periodic execution of this function.
Function Name:
|
removeExpired
|
Permissions:
|
Accessible at Engineer permission level
|
Input Records:
|
0
|
Input Format:
|
None
|
Output Records:
|
0
|
Output Format:
|
None
|
GET EVENT HISTORY
Returns history of a specified event. See View Event History action for more information.
Function Name:
|
get
|
Permissions:
|
Accessible at Observer permission level
|
Input Records:
|
0
|
Input Format:
|
Name
|
Type
|
Description
|
mask
|
String
|
Context mask defining a number of context to select events from.
|
event
|
String
|
Event name.
|
filter
|
String
|
Filter expression text.
|
fromDate
|
Date
|
Timestamp used to select only events which occurred after a certain date. If it is NULL, all events will be selected.
|
|
Output Records:
|
0...unlimited
|
Output Format:
|
Dynamic
|
Delete Events
Deletes events from event history.
Function Name:
|
massDelete
|
Permissions:
|
Accessible at Engineer permission level
|
Input Records:
|
1
|
Input Format:
|
Name
|
Type
|
Description
|
mask
|
String
|
Context mask defining a number of context to delete events from.
|
event
|
String
|
Event name.
|
startDate
|
Date
|
Nullable. If specified, only events occurred after startDate are deleted.
|
endDate
|
Date
|
Nullable. If specified, only events occurred before endDate are deleted.
|
|
Output Records:
|
0
|
Output Format:
|
None
|
Public Events
Common Events: info (Information)
|