xMatters 5.1 patch 003 Release Notes

Contents

Document Overview

Release Overview

Installing This Patch

Appendices

Document Overview

These release notes are for the xMatters 5.1 release:

Release version: PATCH-510-003

Revision: 76885

Release date: September 12, 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.

Release Overview

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 003 (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 003 (for more information and complete migration tool instructions, refer to the xMatters 5.x Documentation).

Issues Fixed in This Release

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:

Reference Issue Fixed
Details
ARCH-2235 Apache HttpClient logs should be suppressed Details
ARCH-2329 User can still respond to an event after it has terminated Details
ARCH-2468 Node generating excessive database connection requests Details
HOTH-2647 English UK recordings inconsistent with other English recordings Details
HOTH-2749 Number displayed on Notifications report does not match number in drill-down report Details
HOTH-2827 Confirmation message not displayed when changing password on Change Web Login page Details
HOTH-2837 Replace confusing standard wording of response instructions in email notifications Details
HOTH-2941 Installer cannot install the web server only Details
KAM-502 Some roles able to remove user's supervisors, but not add new ones Details
SCO-5090 Super administrator unable to log into web user interface after temporary license expires Details
SCO-5293 QueryGroup SOAP operation does not return the correct value of userDefaultDevices Details
XFO-5259 No warning or indication is given when a notification has exceeded its retry limit Details
XFO-5308 FindDeviceNotifications web service call returns incorrect result Details
XFO-5309 Unable to adjust hard-coded SIP parameters Details
XFO-5311 An escalate response action escalates event after timeout has already expired Details
XFO-5315 Notifications report counts not the same in exported file Details
XFO-5318 UpdateSubscription web service does not allow for case-insensitive operators Details
XFO-5319 Incorrect duration when creating one-time coverage Details
XFO-5320 Triggered jobs skip their first run if scheduled within the next 30 minutes Details
XFO-5322 FindActiveUserNotifications returns users from other companies Details
XFO-5323 UpdateDevice web service initiates device validation for voice devices only Details
XFO-5324 AddGroup web service call is not consistent with web user interface Details
XFO-5328 HTML tags displayed in the coverage flyover when viewing host company members in tenant company groups Details
XFO-5404 SQL Server deadlock preventing updates Details
XFO-5405 Not including a country code in the AddDevice web service call results in an error Details

Installing This Release as a Patch

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 003. 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:

xmatters-installer-i586-5.1.3

For use on:

  • All Linux systems
  • Microsoft Windows 2008 R2 systems that require PSTN/Dialogic support

Note that this installer file also requires a 32-bit JRE.

xmatters-installer-x64-5.1.3 For use only on Microsoft Windows 2008 R2 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:

node\assets\resources\spring\integration\*.xml

webserver\webapps\cocoon\WEB-INF\classes\resources\spring\integration\*.xml

webserver\webapps\axis2\WEB-INF\classes\resources\spring\integration\*.xml

webserver\webapps\mobilegateway\WEB-INF\classes\resources\spring\integration\*.xml

Warning: Database Changes

Be aware that this release also includes database changes that may impact your replication mechanism (consult with your database administrator for further details).

This patch includes 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 this 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.

For a full list of the database changes, see Appendix 4: DDL and DML Changes in This Release.

Installation Steps

Before installing this patch:

  1. Shut down or stop all node processes.
  2. Shut down or stop all web server processes.
  3. Back up the xMatters Database.
  4. 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:

/opt/xmatters/

  • On Windows, the default install directory is:

C:\Program Files (x86)\xMatters\

2. Save the xmatters-installer-<version>-5.1.3.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.3.jar     

  • To run the installer in console mode, run the following command:

java -jar xmatters-installer-<version>-5.1.3.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.)

Post-Installation Steps

After installing this patch:

  1. Start the Node processes.
  2. Start the web server processes.

Important:

  • 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.

Node

<xMHOME>//logs/AlarmPoint.txt

Web Server

<xMHOME>//webserver/webapps/axis2/WEB-INF/logs/AlarmPoint_WebApp.log

<xMHOME>//webserver/webapps/cocoon/WEB-INF/logs/AlarmPoint_WebApp.log

<xMHOME>//webserver/webapps/mobilegateway/WEB-INF/logs/AlarmPoint_WebApp.log

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 (4.1.x/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 (4.1.x/oracle/02.xml)  
.  
.  
.  
2009-01-21 22:07:22,847 [AlarmPoint Node-main] WARN - - Package 8 of 8 (4.1.x/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.

Appendices

Appendix 1: Details For Issues Fixed In This Release

Apache HttpClient logs should be suppressed

The existing httpclient logging settings were including too much detail and rapidly filling the log files with unnecessary information. The settings have been updated to exclude the HTTP wire-level TRACE messages.

User can still respond to an event after it has terminated

A customer reported an issue where a user was able to submit a response to an event after the event had been terminated. This was traced to a situation where the response would be sent into xMatters unless the notification was delinked when the event terminated. In the case of systems under extremely heavy load, a delay could occur between the times when an event was terminated and all related notifications were delinked, particulary if the event caused a large number of notifications. The response handing process has been modified to greatly reduce the chances of this issue occurring.

Node generating excessive database connection requests

An issue was identified with a node running on an Oracle database creating 20 to 30 connection requests every minute. This was traced to a problem with a scheduler not using the connection pool. This issue has been addressed.

English UK recordings inconsistent with other English recordings

A customer reported an issue where the English UK recordings available on their deployment did not match other recordings, or were not available even though other English recordings existed. This was due to a change in personnel at the recording provider, and to some new recordings being made for English deployments without having a matching English UK version created. To address this issue, the recordings have been replaced or re-recorded as necessary, and processes implemented to keep recordings consistent across English and English UK deployments.

Number displayed on Notifications report does not match number in drill-down report

A customer reported an issue where the number of notifications displayed in the Notifications Report for a particular status (such as Responses) did not match the number of notifications listed in the drill-down report for that status, or in the exported list of notifications. This was traced to two related factors: first, if a user clicked the Search button to refresh the contents of the report, xMatters would use the minute listed in the time field as the cut off. This meant that any notifications since the last whole minute would not be included; for example, if the time field was set to 15:30, then an event at 15:30:47 would not be included. (This issue has been addressed.) Second, xMatters does not currently include responses submitted via the mobile application or web user interface in the Responses drill-down report, because the responses are tracked by the device to which they were submitted. (This is a design implementation and is working as intended.)

Confirmation message not displayed when changing password on Change Web Login page

An issue was detected with the password change process where a user could save a new password on the Change Web Login page and then be automatically redirected to their home page without receiving a confirmation message or other indication that their password change was successful. This was traced to an issue with the session attribute, and has been addressed.

Replace confusing standard wording of response instructions in email notifications

A customer requested that the wording used to explain the response process for email recipients be improved to reduce confusion. The default language has been clarified.

Installer cannot install the web server only

An issue was reported with the installer where choosing to install only the web server would cause the installer to fail. This was due to a file that is required by the web server not being included on the classpath without installing other xMatters components. The installer for the web server has been updated to address this issue.

Some roles able to remove user's supervisors, but not add new ones

Roles with the "Use Person" permission on other roles could view a user and remove their supervisors, but did not have permission to add other supervisors for that user. Roles with this permission should now be able to add and delete supervisors for other roles.

Super administrator unable to log into web user interface after temporary license expires

An issue was reported where a super administrator was unable to log into the web user interface after their temporary license had expired, which prevented them from uploading a new license. This issue has been addressed.

QueryGroup SOAP operation does not return the correct value of userDefaultDevices

A customer reported an issue with the QueryGroup SOAP operation where the web service call would not return the correct value of the Use Default Devices check box. This issue has been addressed, and the setting should be correctly included in the SOAP response.

No warning or indication is given when a notification has exceeded its retry limit

A customer reported that no indication or warning was given when the system would no longer attempt to deliver a notification that had reached its maximum number of retry attempts. A new audit event has been added to address this issue.

FindDeviceNotifications web service call returns incorrect result

An issue was detected with the FindDeviceNotifications web service call returing unexpected or incorrect results. This was traced to the web service not respecting the specified time and date range; this issue has been addressed.

Unable to adjust hard-coded SIP parameters

Some SIP parameters were hard-coded within a non-modifiable configuration file, making it difficult for developers and other support personnel to modify and test SIP deployments. These settings have been externalized to a Spring configuration file.

An escalate response action escalates event after timeout has already expired

A customer reported an issue where responding to a notification with an "escalate" response action would escalate the event, even when the escalation timeout had already elapsed. This issue has been addressed, and attempting to escalate a timed-out event will now display an error message in the log indicating the attempt.

Notifications report counts not the same in exported file

A customer reported an issue where the number of notifications displayed in the Notifications Report for a particular status (such as Responses) did not match the number of notifications listed in the drill-down report for that status, or in the exported list of notifications. This was traced to two related factors: first, if a user clicked the Search button to refresh the contents of the report, xMatters would use the minute listed in the time field as the cut off. This meant that any notifications since the last whole minute would not be included; for example, if the time field was set to 15:30, then an event at 15:30:47 would not be included. (This issue has been addressed.) Second, xMatters does not currently include responses submitted via the mobile application or web user interface in the Responses drill-down report, because the responses are tracked by the device to which they were submitted. (This is a design implementation and is working as intended.)

UpdateSubscription web service does not allow for case-insensitive operators

An issue was detected with the UpdateSubscription web service where using an operator that did not match the specific case would cause an exception. The logic has been updated to handle case-insensitive submissions.

Incorrect duration when creating one-time coverage

An issue was detected where creating a one-time coverage based on a recurring coverage would result in a coverage with an incorrect duration. This was due to the system assuming that weeks always started on a Sunday. xMatters will now retrieve the start date of the week from the server's current locale.

Triggered jobs skip their first run if scheduled within the next 30 minutes

An issue was reported with the scheduling of purge/archive jobs where the job would skip its first run if it was within 30 minutes of updating the setting. This issue has been addressed.

FindActiveUserNotifications returns users from other companies

An issue was discovered with the FindActiveUserNotifications where running the web service request on the default company would return active notifications for users with the same target name in other companies. This issue has been addressed.

UpdateDevice web service initiates device validation for voice devices only

When using the UpdateDevice web service call to modify the details for an existing device, the validation status of the device should be set to Untested.  This functionality was working only for voice devices, and not devices of other types. This issue has been addressed.

AddGroup web service call is not consistent with web user interface

An issue was reported with the AddGroup web service request where the handling of whitespace in certain values was not handled consistently between the web service call and the fields in the user interface. This issue has been addressed.

HTML tags displayed in the coverage flyover when viewing host company members in tenant company groups

An issue was detected with host company users belonging to tenant company groups where hovering the mouse over the user would display HTML tags in the flyover text. This issue has been addressed.

SQL Server deadlock preventing updates

A customer reported an issue with their SQL Server deployment where deadlocks would occur while generating performance statistics, resulting in unreliable statistics and preventing updates to the tables. To address this issue, an index was added to the RECIP_RESP_STATS table.

Not including a country code in the AddDevice web service call results in an error

An issue was detected with the AddDevice web service call where not including a country code would result in an Invalid Device Country Code error. This was inconsistent with the intended behavior and the documentation; the logic has been reworked so that the web service will use the site's country code as a default value; in addition, the web service will now return an Invalid Device Country Code error if the country code is not for a supported country.

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:

@phone::getVoice("alphabetic","")

@phone::getVoice("digit","")

@phone::getVoice("digits")

@phone::getVoice("grammar","yesno")

(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)

Appendix 3: DDL and DML Changes in This Release

This release includes the following DDL and DML changes:

DDL Changes

  • Add new index to RECIP_RESP_STATS to help prevent deadlocks.

DML Changes

  • Update QCP (QualifiedConfigurationParameter) value for the SMTP Device Engine Response Message.
  • Rename Audit Entry LIVE_NOTIFICATION_EXCEED_RETRY_LIMIT to JMS_DELIVERY_EXCEED_RETRY_LIMIT for auditing.
  • Added new permission ability.act.ViewAllEvents to allow a user to see events sent by any user.
  • Added new function View Own Events to allow an administrator to restrict the events a user can see to only those created by that user.
  • For new 5.1 installations ONLY - added the View Own Events function to the Standard User role.

xMatters Reference

JDN-4816 Originally created by Don Clark

 

Have more questions? Submit a request

2 Comments

Please sign in to leave a comment.
Powered by Zendesk