- 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-004
Release date: December 11, 2014
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 004 (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 004 (for more information and complete migration tool instructions, refer to the xMatters 5.x Documentation).
This patch adds support for xMatters 5.1 to be installed on Windows Server 2012 R2.
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:
|APO-8669||Total at bottom of Users page shows incorrect value||Details|
|ARCH-2660||Help and error messages for email domain white list are improperly formatted||Details|
|HOTH-3142||Users may be able to delete items without permission||Details|
|HOTH-3317||Users may be able to delete items without permission||Details|
|KAM-663||User export includes devices that are not selected or used||Details|
|KAM-757||Users page does not sort on columns in Internet Explorer version 8||Details|
|KAM-758||Error when resizing browser window in Internet Explorer version 8||Details|
|SCO-5357||Modify URL alias encoding to also encode semi-colons||Details|
|SCO-5361||Expired Simple Response Choices Job does not remove responses choices for expired events||Details|
|XFO-5586||Node fails to start after migration||Details|
|XFO-5587||Moscow time zone change||Details|
|XFO-5591||Migrating call-in-progress data causes node to fail to start||Details|
|XFO-5593||Running an adopt-orphan query could cause deadlocks on SQL Server||Details|
|XFO-5597||Phone annotations no longer working for integrations||Details|
|XFO-5644||Error when accessing Past Group Alerts on SQL Server deployment||Details|
|XFO-5650||FindDeviceNotifications SOAP method throws null pointer exception||Details|
|XFO-5705||Web server logs an incorrect error message||Details|
|XFO-5708||Logging configuration update required for Windows||Details|
|XFO-5711||Dialogic issues: outbound calls not dialing out, and inbound calls go unanswered||Details|
|XFO-5733||Nofity Next option suppresses next escalation||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 004 . 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 ).
- 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.4.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.4.jar
- To run the installer in console mode, run the following command:
java -jar xmatters-installer-<version>-5.1.4.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.
Total at bottom of User page shows incorrect value
The total number of users displayed at the bottom of the Users page would occasionally display an incorrect or invalid number. This was traced to the way the table calculates the number of rows both on-screen and in the table itself. The logic has been updated to provide accurate values.
Help and error messages for email domain white list are improperly formatted
An issue was reported with the formatting of the help and error messages associated with the email domain white list feature, making them hard or impossible to read. The styling has been updated to ensure that the messages are accessible.
Users may be able to delete items without permission
An issue was detected where users might be able to manipulate the user interface to delete items that they do not have permission to modify. The logic and behavior of the web user interface has been updated to address this issue.
Users may be able to delete items without permission
The fix provided for HOTH-3142 has been expanded to cover other potential permission violations.
User export includes devices that are not selected or used
A customer reported an issue with the User Export feature where devices that were not selected or not used in the company were still included in the exported file. To address this issue the export logic has been updated to check that the export only includes device names that are in use for the company and tied to an enabled device type.
Users page does not sort on columns in Internet Explorer version 8
An issue was reported with the Users page in Internet Explorer version 8 where the column headers would not display the arrow indicating that you could click them to sort the column contents, and clicking the header would have no effect. This issue has been addressed, and the Users page should now allow IE8 users to sort the table contents by column.
Error when resizing browser window in Internet Explorer version 8
An issue was reported by users of Internet Explorer version 8 where resizing the browser window while using xMatters would cause an exception error. This issue has been addressed.
Modify URL alias encoding to also encode semi-colons
A customer reported an issue where responding to a notification would not work if the URL contained a semi-colon. This was due to the way Java's native URL encoding works; in some cases, the semi-colon would be encoded as '%3B', which would cause xMatters to be unable to decode the URL. This issue has been addressed.
Expired Simple Response Choices Job does not remove responses choices for expired events
An issue was reported with a clean-up job that was failing to remove expired data from the database, and that could potentially cause unnecessary database growth. This issue has been addressed.
Node fails to start after migration
An issue was detected where a node would fail to start after migrating the data from xMatters 4.1 to 5.x. This was due to the way the migration process handled deleted and recreated event domains; this issue has been addressed.
Moscow time zone change
Due to changes in the way that Moscow Time is being calculated (changing to UTC-3 permanently, as opposed to UTC-4), the JRE time zone was updated and tested against the web user interface.
Migrating call-in-progress data causes node to fail to start
An issue was detected where the migration of call- in-progress data could cause the node to fail to start. This issue has been addressed.
Running an adopt-orphan query could cause deadlocks on SQL Server
An issue was detected with instances using SQL Server where running an adopt-orphan query could cause deadlocks in the system. The query has been updated and the issue has been addressed.
Phone annotations no longer working for integrations
An issue was detected with some integrations where the scripts handling phone calls would not properly indicate or process the correct state of the interaction. This meant that some interactions that should have happened based on whether the call was answered, hung up, or responded to would not occur. The scripts handling this interaction have been updated to address this issue.
Error when accessing Past Group Alerts on SQL Server deployment
An issue was reported on SQL Server instances where users who supervised a large number of groups (more than 2,000) would encounter a stack trace error when attempting to view the Past Group Alerts page. This was traced to the way the page accessed the database records; to address this issue, the logic of the database query has been updated.
FindDeviceNotifications SOAP method throws null pointer exception
An issue was reported with the FindDeviceNotificatons SOAP method where if a request was submitted without specifying a start and/or end date, a null pointer exception was thrown. This was due to the start and end date defaulting to a null, rather than the anticipated default of the current date. The method has been updated.
Web server logs an incorrect error message
An issue was reported with the web server logs where an error message indicated that SAML was incorrectly configured even though SAML was not enabled on the deployment at all. The error reporting has been updated so that the message appears only for the appropriate situation.
Logging configuration update required for Windows
An issue was reported with the way log files were being created on Windows deployments: rather than rolling over into a new log file, new content was overwriting the existing log file once it reached its maximum file size. This issue was traced to a conflict between the file name utility and the rolling file appender, and has been addressed.
Dialogic issues: outbound calls not dialing out, and inbound calls go unanswered
An issue was reported with a deployment using Dialogic for phone notifications where, despite the instance working successfully for a long period of time, outbound calls could not dial out and inbound calls would not be picked up. This issue has been addressed.
Notify Next option suppresses next escalation
An issue was reported with the Notify Next response option where attempting to use it to escalate an issue would return a message indicating that the escalation had already occurred. The logic used to calculate the next recipient has been updated to address this issue.
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.