Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Setup Alerts page shows details about existing system alerts associated to the current product view, and lets you edit them and create new alerts.

Click on "Add Alert" to create a new alert.
Click on the alert name to enter the "alert details" page and edit the alert. 

ColumnDescription
Enabled
Shows whether or not the alert execution will be scheduled to run (this is a read only field, you can change it by editing the alert)
NameThe alert's name, click on the name to go to the Alert details Page - you can edit the alert from there.
DescriptionA description of the alert - displays the "Query Value" field of the alert
EnabledShows whether or not the alert execution will be scheduled to run (this is a read only field, you can change it by editing the alert)
System Health MetricShows whether or not the alert is a metric
Schedule

When an alert execution will be scheduled -

Info
The alert will not be scheduled if it is not enabled, even if this field contains a value


Recipients"Syslog" and/or the email addresses of the recipients for the alert publishing

Alert Details page

The top part displays the following fields:

...

FieldDescription
EnabledWhether or not the alert will be scheduled for execution
System Health MetricWhether or not the alert is a metric
NameThe Alert's name
ProductGateway or / API-C / Supported Products(when alert is relevant to all product views)
ScheduleWhen the alert will be scheduled, the format is identical to the one used to schedule reports
Destination

Specify the alert publishing destinations:
Syslog - a syslog record will be written, you'll need to configure the Syslog target server's host name, port and the syslog severity field value (Error, Info, etc) in the System Parameters page.

Email - send an email (make sure that "Enable Queries Emails SMTP" is set to true inthe System Parameters page)

Email WS - send an email via webservice (make sure that "Enable Queries Emails SMTP WS" is set to true inthe System Parameters page)

Recipientsif the destination is Email or Email WS - this field will contain the list of recipients

...

FieldDescriptionApplicable Product Type
DeviceWhich DataPower devices the alert's query should checkGateway/API-C
DomainWhich DataPower domains the alert's query should checkGateway/API-C
ServiceWhich DataPower services the alert's query should checkGateway
CatalogWhich API-C catalog names the alert's query should checkAPI-C
SpaceWhich API-C space names the alert's query should checkAPI-C
ProductWhich API-C product names the alert's query should checkAPI-C
PlanWhich API-C plan names the alert's query should checkAPI-C
API NameWhich API-C names the alert's query should checkAPI-C
API VersionWhich API-C versions the alert's query should checkAPI-C
App NameWhich API-C names the alert's query should checkAPI-C

...