Class | Description |
---|---|
AbortAlertGroupRun |
Aborts the run of a scheduled alerting group.
Throws an exception if the group is not running, if the group does not exist, or if the group is a real-time alerting group. |
AddAlert |
Creates a new alert.
If the user is null in the AlertDesc, a global alert is edited. Returns the AlertDesc with the key filled. |
AlertDesc |
No documentation for this element.
|
AlertDescList |
No documentation for this element.
|
AlertGroup |
Defines the scheduling and publication rules that apply to a set of scheduled alerts
|
AlertingConfig |
No documentation for this element.
|
AlertingGroupStatus |
No documentation for this element.
|
AlertingStatus |
No documentation for this element.
|
AlertPublisher |
Publishes push-mode alerts
|
ApplicationAlertingConfig |
No documentation for this element.
|
ConsolePublisher |
Debug-only publisher that simply logs alerts
|
CustomPublisher |
Publishes push-mode alerts
|
CustomPublisher.Config | |
CustomPublisherDescriptorList |
No documentation for this element.
|
CustomPublisherDescriptorList.Descriptors | |
DeleteAlert |
Delete an alert based on its key.
Deleting an alert invalidates its history. |
DeleteAllAlerts |
Delete all alerts for all groups.
|
EditAlert |
Edits the alert based on its key.
If the user is null in the AlertDesc, a global alert is edited. Editing an alert invalidates its history. |
FixedTimeScheduling |
Sequentially executes all alerts at fixed times, according to cron rules.
Use this option when alerts need to be sent at fixed times, and when there are few alerts (in the low 1000s). Because of the sequential processing, this option generates a significant load when alerts are triggered. |
GetAlert |
Retrieves an existing alert description
|
GetAlertFromId |
Retrieves an existing alert description from the identifier
|
GetAlertingConfig |
No documentation for this element.
|
GetAlertingConfigByVersion |
Interface for every action specific to a given applied configuration version
|
GetAlertingStatus |
No documentation for this element.
|
GetCustomRTPublisherDescriptors |
No documentation for this element.
|
GetCustomScheduledPublisherDescriptors |
No documentation for this element.
|
GetGlobalAlerts |
Returns an AlertDescList
|
GetGroupAlerts |
Returns all group alerts as an AlertDescList
|
GetStoredAlertResult |
No documentation for this element.
|
GetUserAlerts |
Returns an AlertDescList
|
IncrementalModeConfig |
No documentation for this element.
|
InternalAllApplicationsAlertingConfig |
No documentation for this element.
|
ObjectFactory | |
RealTimeHTTPPublisher |
Pushes the alerts to a remote HTTP service.
Each alert occurence triggers an HTTP POST query. This publisher can only be used for real-time alert groups. |
RebuildAlertGroupMatchers |
Rebuilds and reloads the matchers for a real-time alerting group.
Throws an exception if the group does not exist, or if the group is not a real-time alerting group. |
RunAlertGroup |
Execute all alerts of a scheduled alerting group.
Returns once all alerts have been executed. Throws an exception if the group is already running, if the group does not exist, or if the group is a real-time alerting group. |
Scheduling |
Trigger rule for a scheduled-alerting group.
|
SetAlertGroupEnabled |
Enables or disables auto-run of a scheduled alerting group.
Throws an exception if the group does not exist, or if the group is a real-time alerting group. |
SetAlertGroupPaused |
Pauses or resumes the run of a scheduled alerting group.
Throws an exception if the group is not running, if the group does not exist, or if the group is a real-time alerting group. |
SetAlertingConfig |
No documentation for this element.
|
SimpleHTTPPublisher |
Pushes the alerts to a remote HTTP service.
Each alert occurence triggers an HTTP POST query. This publisher can only be used for scheduled alert groups. |
SimpleMailPublisher |
In the formats, the following entries are replaced:
${TOTAL_NB_RESULTS}, ${NB_ALERTS}, ${USER}, ${ALERT_NAME}, ${ALERT_DESCRIPTION}, ${ALERT_NB_RESULTS}, ${TITLE}, ${TEXT}, ${ID} |
SimpleMailPublisher.MetaToExpose | |
SMTPServer |
No documentation for this element.
|
StandardIncrementalModeConfig |
A simple implementation of incremental mode.
|
StoredAlertResult |
No documentation for this element.
|
Copyright © 2021 Dassault Systèmes, All Rights Reserved.