These release notes are for the xMatters 5.1 release:
Release version: PATCH-510-006
Release date: June 29, 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 006 (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 006 (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-2920||Escalation triggers still active after all recipients delinked from an event||Details|
|HOTH-3683||A 400 error results when clicking a user or group in Internet Explorer 11||Details|
|KAM-882||View Holiday List not displaying properly in Internet Explorer 8||Details|
|KAM-1065||Assigned Subscription page retains device handling values||Details|
|KAM-1115||isAnyRecipientNotifiable returns "Device is inactive" even if the user has active devices||Details|
|KAM-1116||Warning when removing a user supervisor is incorrect||Details|
|SCO-6152||AddCompanyCustomAttributes web service does not add multiple attributes||Details|
|VOR-140||Encoded special characters causing an exception in the integration agent||Details|
|VOR-248||SMPP device engine does not close session/connection when provider rejects bind request||Details|
|XFO-6010||Voice call not retried if user hangs up during notification||Details|
|XFO-6064||Changes from previous fix need to be applied to other recipient script objects||Details|
|XFO-6104||Users are logged out when using URL-based session management||Details|
|XFO-6171||Invalid reponse message sent to unrelated devices||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 006. 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.
|xmatters-installer-x64-5.1.6||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.6.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.6.jar
- To run the installer in console mode, run the following command:
java -jar xmatters-installer-<version>-5.1.6.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.
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.
A 400 error results when clicking a user or group in Internet Explorer 11
View Holiday List not displaying properly in Internet Explorer 8
Users of Internet Explorer 8 reported an issue where the list of holidays would initially open in the center of their browser window, but would move slightly after it opened. The issue has been addressed.
Assigned Subscription page retains device handling values
An issue was reported where the Assigned Subscription page would retain values specified in the Device Handling section for a few minutes after they were changed. This could result in notifications being sent to incorrect device types if the subscription was triggered before the new values took effect. This issue has been addressed; changes to the Device Handling section should now take effect as soon as they are saved..
isAnyRecipientNotifiable returns "Device is inactive" even if the user has active devices
An issue was reported with the @event::isAnyRecipientNotifiable method where the 'reason' field would contain a "Device is inactive" message if a recipient had an inactive device, even if the recipient was otherwise notifiable. The issue has been addressed, and the reason field will now be blank if the recipient is notifiable.
Warning when removing a user supervisor is incorrect
An issue was reported where the warning dialog box popup that was displayed when removing a supervisor contained incorrect wording. The warning referred to removing users, not removing a supervisor. The functionality has been tested, and the language adjusted accordingly.
AddCompanyCustomAttributes web service does not add multiple attributes
An issue was reported with the AddCompanyCustomAttributes SOAP web service, where only the first custom attribute specified in the method was being added. This issue has been addressed, and the method should now add all of the custom attributes specified in the request.
Encoded special characters causing an exception in the integration agent
An issue was reported where certain values that included special characters (such as ampersands and angle brackets) cause the integration agent to return an exception. The issue has been addressed and the special characters should now be properly encoded and/or escaped.
SMPP device engine does not close session/connection when provider rejects bind request
An issue was detected with the SMPP device engine where it would not close a session or connection if the provider rejected its bind request. Instead, the device engine would continually retry and not be able to connect. The device engine should now properly close the session.
Voice call not retried if user hangs up during notification
An issue was reported where xMatters would not call back if a user hung up during a voice notification. This was because xMatters marked the notification as delivered to a device as soon as the connection was made. This has been updated so that the notification is marked as delivered only after the person-detection has been performed.
Changes from previous fix need to be applied to other recipient script objects
A previous fix addressed an issue where adding an interaction::getRecipient call to a callin script could cause a NullPointerException due to the way the Group object handled service objects. This fix has been extended to the Device object.
Users are logged out when using URL-based session management
An issue was reported where using xMatters with cookies disabled in the browser would cause users to be inadvertently logged out when attempting to view certain pages. This was traced to an issue with some redirects in the web user interface not correctly adding the jsession ID; this issue has been addressed.
Invalid reponse message sent to unrelated devices
A customer reported an issue where a particular database query would inadvertently match parts of a text phone number with other devices in the system. A message targeting a device with a subset of numbers that matched another device in the system would send messages to both devices. This issue has been addressed and the code updated to target only the intended device.
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.