Notifications report
The Notifications report provides an overview of all notifications within the system, and can be used to monitor system activity during periods of load. The report contains data when the system is busy creating and delivering notifications.
Notifications Report
Generate a Notifications report
- Click the Reports tab, and then click Notifications.
- On the Notifications Report, specify the time period for which you want to view notifications; i.e., do one of the following:
- Click one of the buttons indicating a time in minutes or hours.
- Click the Date Range button to specify a start and end date and time, and then click Search.
Notification delivery details
The Notification Delivery area displays five boxes, indicating the number of notifications in each of the possible delivery states. The numbers in each of the boxes may not add up to the expected total. This is because the "Responded" category is a count of the responses received, and does not necessarily reflect the number of notifications sent.
| Status Box | Description |
|---|---|
| Total |
Number of notifications created and submitted for delivery during the specified time period. |
| Pending | Number of notifications for which a Provider Delivered response has not yet been received from a device engine. For more information about the conditions required for a notification to appear in this state, see Pending Notifications report. |
| Delivered |
Number of notifications for which a Provider Delivered response has been received from one or more device engines. |
| Responded |
Number of responses received for this event. This number may be different than the number in the "Delivered" total, as the total number of "Responded" includes call-in responses, web browser responses, and responses via mobile apps. |
| Failed | Number of notifications that could not be delivered. |
To view more information about the notifications in each status, click one of the boxes; xMatters displays a new report listing all of the notifications in that category. For example, if you click on the Delivered box, xMatters displays the Delivered Notifications report:
Example of a Delivered Notifications report
Notifications reports details
The Notifications reports list the notification details in separate columns; note that not all of the reports have the same columns, as explained in the following table.
| Column | Description |
|---|---|
| Company |
Name of the company for which the notification was generated. Note that this column only appears for Super Administrators. |
| User | The name and target name of the user targeted by the notification. |
| Event | The event ID of the event that generated the notification. Click the link in this column to view the event properties (for more information, see Properties report). |
| Domain | The event domain associated with the notification. |
| Device | The device targeted by the notification. Each device type is represented by a different icon, and that you can mouse over the icon to view the device name. |
| Delivery |
Date and time at which a "Provider Delivered" response was received for this notification. . This column does not appear on the Pending or Failed Notifications reports. |
| Elapsed Time | Available only on the Pending Notifications report; indicates the length of time since the notification was created. For more information about notifications on this report, see Pending Notifications report. |
| Failed |
The time and date at which the notification passed the maximum number of allowable retries configured for the device engine. This column appears only on the Failed Notifications report. |
| Response Time |
The time and date at which a response was received for this notification. This column does not appear on the Pending or Failed Notifications reports. |
| Response |
The response returned by the User. The value in this column depends on the possible responses configured in the event domain. This column does not appear on the Pending or Failed Notifications reports. |
Reorder column entries
You can reorder report results by clicking on column headings. An arrow next to the column heading indicates whether the results are sorted in ascending or descending order.
Filter results
You can filter the notification results in any of the following ways:
- To view only the notifications for a specific event domain, click the Domain list, and then select one of the available event domains. Click Search to regenerate the Report.
- To view only those notifications that were targeted to a specific device type, click the Device drop-down list, and then select one of the available device types. Click Search to regenerate the report.
- To change the time span for the results, modify the start and end date and time fields, and then click Search.
Export results
To export the report results to a Microsoft Excel Spreadsheet, click Export. xMatters will copy the information to a .xls file and save it to your computer.
Pending Notifications report
A notification will be included and displayed on the report when it meets the following conditions:
- The event to which the notification relates must be active in the system.
- The notification must have been created; i.e., the system components, including the device engine and protocol provider, must be properly configured, and the notification must have been identified as a non-duplicate.
A notification is removed from the report under the following conditions:
- The notification is delivered by the device engine to the protocol provider. Note that this is usually signified by a "Provider Delivered " status returned by the device engine. In the rare event that no response is received from the protocol provider, the notification is removed when the User responds.
- The notification has passed the maximum number of allowable retries configured for the device engine.
- The notification is archived. xMatters archives data after seven days, and purges archived data 21 days after archiving it.