- Appendix 1: Details For Issues Fixed In This Release
- Appendix 2: Known Issues
- Appendix 3: DDL Changes in This Release
These release notes are for the xMatters 5.1 release:
Release version: PATCH-510-005
Release date: March 13, 2015
To download the latest version, see the xMatters 5.x Product Suite page.
NOTE: This document is subject to change after the initial release. If you would like to be alerted when the document is modified, click Follow above this article.
This release of xMatters offers the following deployment options:
- you can install this release as a new xMatters version 5.1 deployment (i.e., you do not need to install a previous version of xMatters);
- you can use this release to patch an existing xMatters 5.x deployment up to xMatters version 5.1 patch 005 (in this case, this release should be applied to all xMatters Application Nodes, Notification Nodes, Web Servers, and to the DataSync Server, if applicable);
- or, you can use the included Database Migration tool to upgrade from xMatters 4.1 patch 023 directly to xMatters version 5.1 patch 005 (for more information and complete migration tool instructions, refer to the xMatters 5.x Documentation).
The following table lists the issues addressed since the most recent patch release and included in this version of xMatters. To see details about an issue, click the related link in the Details column:
|ARCH-2765||After network maintenance, node is unable to deliver voice notifications via SIP||Details|
|ARCH-2848||Incorrect representation of message responder (number instead of a string)||Details|
|ARCH-2849||Message bus monitor checks deleted nodes||Details|
|ARCH-2918||MAPI device engine fails when htmlmessage is not set||Details|
|ARCH-2920||Escalation triggers still active after all recipients delinked from an event||Details|
|ARCH-2935||FindGroups web service performs case-sensitive search||Details|
|HOTH-3592||SMPP failed with null pointer exception||Details|
|KAM-815||User service provider missing from Device Details page||Details|
|KAM-888||Company administrator unable to view group details||Details|
|SCO-5748||Deleting a one-time coverage results in a stack trace||Details|
|SCO-5967||Node does not log stack trace when there is an exception||Details|
|SCO-5969||Notifications timing out while waiting for a device engine||Details|
|SCO-5990||Support user not able to logout after logging as another user||Details|
|SCO-6105||Duplicate (case-insensitive) recurring coverage names allowed on Oracle deployment||Details|
|XFO-5789||Users could modify or delete objects they do not have permission to access||Details|
|XFO-5877||QueryGroup web service method returns a NullPointerException for rotation teams||Details|
|XFO-5976||UpdateDevice web service does not update the descrion field||Details|
The following instructions describe how to use the installer to patch an existing xMatters 5.x deployment and upgrade it to version 5.1 patch 005. For information about installing a new xMatters 5.x deployment, see the xMatters 5.x Documentation.
Apply this patch to all xMatters Application Nodes, Notification Nodes and Web Servers (and any DataSync installations, if applicable).
Installer files included with this release:
For use on:
Note that this installer file also requires a 32-bit JRE.
|For use only on supported Microsoft Windows systems that are using a 64-bit JRE, and which will not require PSTN/Dialogic support.|
Warning: Existing Integrations
When applying an xMatters patch to an existing installation, the patch may overwrite some files that were already modified for an integration. This may cause the integration to stop working. If this occurs, using the integration documentation, re-apply the configuration changes and validate the integration. (See also Integration stops working after applying patch.)
Warning: Spring Configuration Changes
When applying an xMatters patch, any changes you have made to the parameters in spring configuration files may not be retained. The patch may overwrite modifications to some or all of the following files:
Warning: Database Changes
Be aware that while this release does not include database updates, if you are upgrading from an older version, previous patches include database changes that may impact your replication mechanism (consult with your database administrator for further details).
These patches may also include updates to the database audit tables that can take an extreme amount of time to adjust when applying the patch. It is highly recommended that you clear the audit data (i.e., archive all your runtime data by running the Clear Runtime/History job in the web user interface) before installing any xMatters patch to reduce the amount of time required for the patch to process the data.
Note that introducing new indexes to a database may cause an increase in the required storage space. This is a normal consequence of using indexes, and assists performance of the overall system.
Before installing this patch:
- Shut down or stop all node processes.
- Shut down or stop all web server processes.
- Back up the xMatters Database.
- If you have made changes to the Template Company scripts, back up your script packages (see note about database changes, above.)
Note: If you are installing on Windows, you must run the installer as an administrator.
To install this patch:
1. Back up the xMatters installation directory (referred to as <xMHOME>).
- On Linux, the default install directory is:
- On Windows, the default install directory is:
C:\Program Files (x86)\xMatters\
2. Save the xmatters-installer-<version>-5.1.5.jar file to .
3. Open a command prompt and navigate to <xMHOME>.
4. Do one of the following:
- To run the installer in GUI mode, run the following command (replace with i586 or x64, depending on your version of the installer):
java -jar xmatters-installer-<version>-5.1.5.jar
- To run the installer in console mode, run the following command:
java -jar xmatters-installer-<version>-5.1.5.jar -console
5. The installer displays a welcome message; press Enter (console installation) or click Next (GUI installation) to continue.
6. Specify the location on the machine where the xMatters components are installed, and then press Enter or click Next to continue.
- The installer will inspect the current installation and determine whether the patch needs to be applied.
7. Next, the installer offers the following options:
- Back up the installation folder: Selecting this option will create a backup copy of the existing xMatters installation directory (by default, saved to /opt/xmatters.bak.1/)
- Remove old application log files and temporary folder: Selecting this option will remove the temporary folders and log files from the existing installation's web server cache.
8. Select the options you want, and then press Enter or click Next to continue.
9. The installer then checks the disk to determine whether there is enough space to continue with the installation; press Enter or click Next to continue.
10. Next, the installer displays a summary of your selected options and the components included in the patch process; press Enter or click Next to continue.
- The installer will then patch your installation. When it is complete, it displays a summary page, and gives you an option to generate an automatic installation script so you can patch other components using the same options. (For more information about the automatic installation script, see the xMatters installation and administration guide.)
After installing this patch:
- Start the Node processes.
- Start the web server processes.
- Database upgrades may take place after this patch is applied (i.e., during startup of xMatters components). The first component to be started will cause the database upgrades to be applied. This means that the subsequent startup of web servers and nodes may be delayed while they wait for the database updates to be completed. To monitor the progress of the updates, see "Determining the status of database updates", below.
Determining the status of database updates
To determine the current status of database updates, open the log file(s) associated with the first xMatters component being restarted. The default locations are shown; only one log will include the MUTEX entries. Note also the log level indicated in the messages below; if your logging level is not detailed enough, you will not see the log messages.
During component restart, you will see log entries similar to the following:
2009-01-21 22:07:02,251 [AlarmPoint Node-main] WARN - - Acquiring patch update MUTEX.
2009-01-21 22:07:21,685 [AlarmPoint Node-main] WARN - - Acquired patch update MUTEX.
2009-01-21 22:07:22,356 [AlarmPoint Node-main] WARN - - Package 1 of 8 (apod/oracle/01.xml)
2009-01-21 22:07:22,356 [AlarmPoint Node-main] WARN - - Statement 1 of 2: Executing SQL Statement.
2009-01-21 22:07:22,506 [AlarmPoint Node-main] WARN - - Statement 2 of 2: Executing SQL Statement.
2009-01-21 22:07:22,516 [AlarmPoint Node-main] WARN - - Package 2 of 8 (apod/oracle/02.xml)
2009-01-21 22:07:22,847 [AlarmPoint Node-main] WARN - - Package 8 of 8 (apod/oracle/finalize.sql)
2009-01-21 22:07:22,936 [AlarmPoint Node-main] WARN - - The database update scripts have been successfully processed and deleted.
2009-01-21 22:07:22,936 [AlarmPoint Node-main] WARN - - Patch update MUTEX released.1
After the message "Patch update MUTEX released" appears in the log, the database update has completed.
Note: If the log shows that the process has not proceeded from "Acquiring patch update MUTEX" to "Acquired patch update MUTEX" in a timely manner, ensure that there are no locks on the ORGS database table.
After network maintenance, node is unable to deliver voice notifications via SIP
An issue was noticed with voice notifications on SIP not working after performing network maintenance. This was traced to an incorrect configuration on an Asterisk server that caused suboptimal traffic routing; the configuration has been updated to address this issue.
Incorrect representation of message responder (number instead of a string)
An issue was reported where a message responder was being represented in the event log as a number instead of a text string. This was traced to a problem in the code, which has been updated.
Message bus monitor checks deleted nodes
An issue was reported where the message bus monitor would continue to check deleted nodes for messages. The monitor has been updated to exclude deleted nodes.
MAPI device engine fails when htmlmessage is not set
An issue was reported where the MAPI device engine would fail and return a NullPointerException if the content.htmlmessage was not set. This was traced to an incorrect placement of the escapeHtml function. The code has been updated to address this issue.
Escalation triggers still active after all recipients delinked from an event
An issue was reported with the delinking process where, even after all recipients were delinked from an event, the escalation triggers were still active. This was strictly a reporting issue; no notifications were sent. The issue was traced to a problem with the way the delinkAllExcept method works when deleting notification events. The code has been updated to properly terminate and deactivate related escalation triggers when recipients are delinked from an event.
FindGroups web service performs case-sensitive search
An issue was reported with the FindGroups SOAP web service returning only case-sensitive matches. The operation has been updated to ensure that the search is case-insensitive.
SMPP failed with null pointer exception
An issue was reported with the SMPP functionality. After upgrading to 5.1 patch 004, a customer reported that attempting to send messages via SMPP would result in a NullPointerException, and the logs would display a connection failure message. The code has been updated to address this issue.
User service provider missing from Device Details page
An issue was reported where it was possible to remove the last protocol provider from a user service provider, which caused the user service provider to be removed from an active device. The code has been updated so that it is no longer possible to remove the last available protocol provbider from a user service provider while the service provider is in use.
Company administrator unable to view group details
An issue was reported where the company administrator could not view group details on the Groups User Belongs To page in the web user interface if specific roles were set as group observers. The permissioning on this page has been updated to ensure that company administrators will be able to click through to the group details page of any group in the list.
Deleting a one-time coverage results in a stack trace
An issue was reported where attempting to delete a one-time coverage from a group resulted in a stack trace, and the coverage would not be removed. This was traced to the way the code was attempting to compare the dates of the coverage; this issue has been addressed.
Node does not log stack trace when there is an exception
An issue was identified with the node logging where stack traces were not being recorded when an exception occurred. This made it difficult to track and identify certain types of issues. The node has been updated to properly log stack traces.
Notifications timing out while waiting for a device engine
An issue was reported where notifications were failing with an error message of "Timed out waiting for a device engine". This was traced to a problem with the way internal timers were not handling exceptions properly, causing the timer to prematurely expire. This issue has been addressed.
Support user not able to logout after logging as another user
An issue was reported with the "Login as User" feature. If a support user logged in using SSO or SAML logged in as another user, they could not properly log out of the other user's account. This was traced to a problem with the way the logout URL was encoded. This issue has been addressed.
Duplicate (case-insensitive) recurring coverage names allowed on Oracle deployment
An issue was reported with the Add Recurring Coverage feature where it was possible to create duplicate coverage names - provided they used different capitalization. This issue was only present on Oracle deployments and has been addressed.
Users could modify or delete objects they do not have permission to access
An issue was reported where users could use some browser features to access and modify or delete web user interface features that their permissions should have prevented them from seeing. Additional checks and controls have been added to the web user interface to address this issue.
QueryGroup web service method returns a NullPointerException for rotation teams
An issue was reported with the QueryGroup SOAP web service where the operation would return a NullPointerException when trying to retrieve information about a rotation team. This was traced to a problem with the code expecting that a specific value would not be empty; this issue has been addressed.
UpdateDevice web service does not update the descrion field
An issue was reported with the UpdateDevice SOAP web service operation where it was not updating the descrion field in the database's device table. This issue has been addressed.
Appendix 2: Known Issues
xMatters 5.0 patch 007 included an upgrade to the included Java version from Java 6 to Java 7. The Automated-Speech-Recognition (ASR) functionality is currently not compatible with Java 7. If an xMatters deployment includes scripts that use ASR, the node will crash. The following are examples of script calls that use ASR:
(xMatters Reference: XFO-3472)
Some flavors of Linux with SELinux enabled will not run Java 7. After installing xMatters and trying to start the node, users may encounter an issue where Java fails to start, and an error similar to the following appears in log files:
Error: dl failure on line 864
Error: failed /opt/xmatters/staging/jre/lib/i386/server/libjvm.so, because /opt/xmatters/staging/jre/lib/i386/server/libjvm.so:
cannot restore segment prot after reloc: Permission denied
This is due to an issue with SELinux identifying the Java 7 libraries as a possible security threat. To resolve this issue, you must edit the /etc/selinux/config file and disable SELlinux.
(xMatters Reference: DTN-3158)
On Linux, serial modem Device Engines (TAP, GSM, etc.) that have experienced a connection failure due to a modem power failure (or deliberate power down) do not recover after the modem is powered on. Instead, to resolve the problem the node must be restarted. NOTE: this issue occurs only when Flow Control is set to "hardware".
(xMatters Reference: PRE-4832)
The xMatters Installer does not remove the Windows Services (i.e., the xMatters Webserver and the xMatters Node) when uninstalling. Instructions on how to manually remove the services have been added to the xMatters installation and administration guide, or are available on the Microsoft Windows Support site.
(xMatters Reference: XFO-2013, DTN-2960)
This release does not include DDL or DML changes.