Subscription API
The xMatters Subscriptions component consists of the following parts:
- Event Domain: defines the predicates available in the xMatters system. Any event that enters the system has specific pieces of information included that are always required. These pieces of information are called predicates.
- Subscription Domain: defines a specific subset of the predicates in the Event Domain. These predicates can then be examined to determine the values associated with them, and generate notifications based on the results. The Subscription Domain also specifies the location of the custom panel, defines the Roles that specify which users can see and manage subscriptions within the Domain, and identifies whether the Subscriptions are one- or two-way.
Event Domains and Subscription Domains must be defined prior to creating custom panels.
Default Subscription Panel
You can view an example of the Subscription API results in the default generic subscription panel written in JSP, in the xMatters installation directory, under webserver/webapps/cocoon/alarmpoint/jsp/subscription. The file name is DefaultSubscriptionForm.jsp.
- To view this example in the xMatters web user interface, you will need to create a Subscription Domain, and assign a Subscription. If no custom panel is specified in the details for the Subscription Domain, xMatters uses the default Subscription panel.
For complete instructions on creating and managing Subscriptions and Subscription Domains, refer to the xMatters installation and administration guide.
The JSP content of the default subscription panel is simple, and illustrates how to use some of the custom XML markup specific to Subscriptions. There is also a set of custom panels that illustrate various ways to achieve the same functionality. These samples are located in webserver/webapps/cocoon/alarmpoint/jsp/subscription/samples.
Related topics
Using the Subscription Java Bean
Custom Subscription and Messaging Panels
Custom Subscription XML Tags