Configuring Subscription Domains

Users can subscribe to a Subscription Domain, and whenever an Event occurs that matches the criteria, all Users who have subscribed to that domain are notified.

To view and manage Subscription Domains:
  1. Do one of the following:
    1. To modify an existing Subscription Domain, click its name in the Subscription Domains list to view its details. For more information, see the Subscription Domain details table, below.
    2. To delete a Subscription Domain, select the check box next to the domains you want to delete, and then click Remove Selected.
    3. To add a new Subscription Domain, click the Add New link, and then specify its details on the Subscription Domain details page as explained in the following section.

Defining Subscription Domain details

You can create new Subscription Domains or modify the details for existing Domains from the Subscription Domains page.

To set Subscription Domain details:
  1. On the Subscription Domains page, do one of the following:
    1. To modify an existing Subscription Domain, in the Subscription Domains for Company table, click the name of the Subscription Domain you want to edit.
    2. To create a new Subscription Domain, click the Add New link. On the Add Subscription Domain page, in the Event Domain drop-down list, select the Event Domain on which you want to create the Subscription Domain, and then click Continue.
  2. On the Subscription Domain Details page, enter the following information into the form:
Subscription Domain details

Detail

Description

Name

Name of this Subscription Domain. This name should be descriptive enough so that the nature of the issues caught by the domain is clear. For example, assume that you want to create a Subscription Domain based on Event Domain named Help Desk with predicates of Software, Hardware, and Network. Your new Subscription Domain will be limited to the Software predicate and its values (e.g., OS, Upgrades, Applications, etc.). As a result, you name the new Subscription Domain Help Desk Software Tickets.

Description

Brief description of this Domain. Although this field is optional, it is recommended that you specify a Description that will help Users understand the nature of the alerts they will receive when subscribed. Following from the example above for the Name field, you might specify a Description of "Subscription Domain for Help Desk Tickets related to software issues such as operating systems, upgrades, applications, and so on".

One Way

When selected, indicates that Alerts generated by this Subscription Domain are informational only, and will not accept or require a response from Users. If not selected, you must specify Response choices (covered below).

Type of Management

Select one of the following options to specify who can manage Subscriptions to this domain:

  • Self-Managed: Subscriptions in this Domain can be modified by the subscriber, or by Users with “Manage Subscriptions” permissions for the subscriber.
  • Managed: Subscriptions to this Domain can be modified only by Users that have “Manage Subscriptions” permissions for the subscriber.
  • Both: This domain supports both kinds of Subscriptions.

These settings are based on Administrative Roles permissions, as explained below.

Custom Page URL

(Note: required only if you are not using the default Subscription panel.)

If you are not using the default Subscription panel, use this setting to specify the location and file name of the custom Subscription interface for this domain. This path must be relative to the <xMHOME>/webserver/webapps/cocoon/ alarmpoint directory.

For example, if you created a new CustomSubscription.jsp file and stored it in the <xMHOME>/webserver/webapps/cocoon/alarmpoint/jsp/ subscription/custom/ folder, the Custom Page URL would be:

jsp/subscription/custom/CustomSubscription.jsp

For more information about creating custom Subscription panels, see the xMatters Online Developer's Guide.

Suppressed Subscription Fields

Specifies the elements that you do not want to appear as overrides on Subscription pages for this domain. Items that are not excluded here appear on the default Subscription panel in the "Overrides" section, and allow Subscription creators to modify Subscription notification handling. For example, if you want to ensure that Subscription creators cannot change escalations between Groups or specify that Device delays should be ignored, you would select Group Escalation and Ignore Device Delay here (and as a result these settings would not appear as options in the Overrides section of the default Subscription panel).

Select the check box next to any of the following Subscription options to suppress them:

  • Timeframe (uses a default 24x7 timeframe)
  • Group Escalation
  • Notification Delay
  • Override Device Timeframe
  • Ignore Device Delay
  • Override Device Severity

You can specify default values for the Override Device Timeframe, Ignore Device Delay, and Override Device Severity Settings in the Subscription Defaults area, as explained below.

Suppressed Devices Specifies the names of Devices that will not be available to select as targets on the Subscription details page.

Subscription Defaults

Specifies the default settings for Subscriptions created on this domain. Select the check box next to any of the following Subscription options to set a default value:

  • Override Device Timeframe: when selected, Subscriptions created on this domain will override Device Timeframes specified by the notification recipient.
  • Ignore Device Delay: when selected, Subscriptions created on this domain will ignore any Device delay settings specified by notification recipients.
  • Override Device Severity: when selected, Subscriptions created on this domain will override the Device severity settings specified by notification recipients.

Note that unless these settings are suppressed using the Suppressed Subscription Fields as explained above, Subscription creators can override the defaults on the Subscription Details page. For more information, see Defining Subscription Details.

  1. Click Continue.
    1. If you selected to create a one-way Subscription Domain, continue to Step 6 to add Predicates. If you are creating a two-way Domain, xMatters displays the Response Choices page.
  1. Do any of the following:
    1. To add a response choice, type it in the Enter Response field, and then click Add Response.
    2. To delete a response choice, select it in the Responses field, and then click Remove Selected Response.
Note: If you add new Subscription responses, you must modify the corresponding handler script. For more information, see Updating Subscription Response Handler Scripts.
  1. Click Continue.
    1. xMatters displays the Select Predicates page, where you can specify (or exclude) predicates that are relevant to the Subscription you are creating. For example, if you are creating a Subscription Domain that focuses on software problems and predicates such as Windows, Oracle, and SAP are available, you will likely want to include these in your Subscription Domain. Conversely, for the same domain you may want to exclude potentially irrelevant predicates such as Hardware and Medical from the Applied Predicates list.
  1. Do any of the following:
    1. To add Predicates to the Subscription Domain, select them in the Available Predicates list, and then click Add.
    2. To remove Predicates from the Subscription Domain, select them in the Applied Predicates list, and then click Remove.
  2. Click Continue to apply your changes and assign.
Note: If you are creating a new Subscription Domain, be sure to assign Administrative Roles, as explained below.