Subscription Form Data

The purpose of the subscription form is to provide a means to specify the details of a particular subscription. The contents of the form are posted to a URL that is processed on the server side and saved as a single subscription. For existing subscriptions, all form data will be accessed through the JavaBean.

The subscription details consist of the following information:

Form Area Detail Description
Details Name

Should be a text input field. The form element's id attribute must be called “name”. This value can be found under the request attribute "name", which is only available when displaying an existing subscription.

Group Escalation

A text input field that specifies the subscription escalation override; should be identified as "escalation".

Predicates

The list of predicates the user can apply a value against for this subscription. The name of the predicate should be used as a label to indicate to the user for what predicate they are providing information.

Note that there are two types of predicates: text and list.

Predicate Operators

A selection list of available operators that can be applied to a predicate and a predicate value. This input element should be identified by combining the “PREDICATE_OPERATORS_” prefix with the predicate name.

There are four available predicate operator types:

  • contains: the predicate value contains the specified value as a substring
  • ends with: the predicate value ends with the specified value
  • starts with: the predicate value starts with the specified value
  • matches: the predicate value matches the specified value exactly
Predicate Values

There are two types of predicates:

  • text: a text input field that specifies a single value.
  • list: a selection list of available values from which the user can select.

Despite the type of predicate, this input field should be identified by combining the “PREDICATE_VALUE_” prefix with the predicate name. All predicate values are case insensitive when resolved against incoming events. Note that at least one predicate value must be specified.

Timeframe Start Time

A text field that specifies the starting time of the recurring shift. This input field is identified by “startTime”.

Hours A text field that specifies the duration of the recurring shift in hours. This input field is identified by “durationHours”.
Minutes

A text field that specifies the duration of the recurring shift in minutes. This input field is identified by “durationMinutes”.

Days of the Week

A list of checkboxes that indicate which days of the week there will be coverage. This input field is identified by one of the following: “sunday”, “monday”, “tuesday”, “wednesday”, “thursday”, “friday”, or “saturday”.

Time Zone

A selection list of available timezones that can be applied to the subscription timeframe. This input element should be identified by “timezone”.

Overrides Device Type Overrides

This should be selection list of the available Device types. The form element's id attribute must be called “deviceType”. The selected value can be found under the request attribute “deviceType”, which is available only when displaying an existing subscription.

Override User Device Timeframes

A checkbox that indicates if this subscription should override the Device timeframe with the subscription timeframe. This input field is identified by “overrideTimeframes”.

Ignore Device Delays

A checkbox that indicates if the subscription should ignore any configured Device delays. This input field is identified by “ignoreDeviceDelays”.

Override Device Severities

A checkbox that indicates if the subscription should ignore any configured Device severities and use all. This input field is identified by “overrideSeverities”.

Notification Delay

A text field that specifies a delay between notifications. This input field is identified by “notificationDelay”.

Custom Subscription and Messaging Panels

Adding Custom Panels