xMatters 4.1 patch 012 Release Notes

Contents

Document Overview

Release Overview

Installing This Patch

Appendices

Document Overview

These release notes are for the following xMatters patch release: 

Patch version: PATCH-410-012

Build: 1112

Revision: 52347 

Release date: April 4, 2012 

NOTE: This document is subject to change after the initial release of this patch. 

Release Overview

This is a cumulative patch for version 4.1.0 features and issues, and should be applied to all xMatters Application Nodes, Notification Nodes and Web Servers (and to the DataSync Server, if applicable). Before applying this patch, you must upgrade to xMatters 4.1.0. 

Because this is a cumulative patch, you should install the patch with the highest version number. For an overview of features and fixes included in previous patch releases, see the 4.1 patch 011 release notes

Support Policy Reminder

The xMatters Support Policy was updated in February 2009.  

Features Added In This Patch Release

Deleted User, Team, and Device data is purged relative to Process Expired Data settings

Whenever you delete data from xMatters, the database marks it as deleted, but continues to store the data until the system has removed all other data that may be related to it. To determine when it is safe to completely remove the data, xMatters uses the settings specified on the Schedule Job Details for Process Expired Data page in the web user interface. For more information, see the xMatters installation and administration guide.

(xMatters Reference: XFO-1830, XFO-1953)

Removed historical data from Group Details

Previously, the web user interface did not store information for previous shifts, but instead displayed details for historical shifts (those that occured prior to the current date) based on the Group's and Coverage's current settings. This led to some confusion as the details for previous shifts were not accurate. To reduce any potential confusion or issues, all historical data for shifts has been removed from the web user interface, and days prior to the current date are left blank. This applies to both Weekly and Monthly views.

(xMatters Reference: XFO-1833, XFO-1970)

Time and date formatting consistent across all Reports

The date, time, and time zone information has been made consistent across all Reports in the web user interface. This includes identifying the name of the time zone on which the Report is based, instead of representing it as a number of hours plus or minus GMT. The time and date information included with the Who's on Duty Report has also been updated.

(xMatters Reference: XFO-1834, XFO-1976)

Increased duration for BlackBerry messages

The length of time that BlackBerry messages will remain available on a recipient's Device has been increased to 36 hours.

(xMatters Reference: XFO-1835)

Issues Fixed in This Patch Release

To see details about an issue, click the related link in the Details column:

xMatters ReferenceIssue Fixed
Details Link

XFO-1839

Mismatched components starting, but causing stack traces

Details
XFO-1852 Who's on Duty Report inconsistent with Group Weekly View Details
XFO-1854 Who's on Duty Report showing incorrect One Time Coverage replacements Details
XFO-1856 Teams not being added correctly from the Team Details page Details
XFO-1864 Data Synchronization cannot update the Supervisor for a Group with two or more existing Supervisors Details
XFO-1994 Incorrect Event Summary status for messages left in recipient's voice mail Details
XFO-2020 MAPI Device Engine does not work with non-English characters Details
XFO-2028 Data synchronization unable to export Groups that have the same external keys Details
XFO-2045 Inaccurate description of Service Provider Access Role Details
XFO-2060 FindGroups web service treating underscore as wild card Details
XFO-2061 Manage Scenarios page not displaying correct Event and Message Domains Details
XFO-2135 Incorrect escalation count calculated for Group Performance Report Details
XFO-2224 Sample Messaging Panels returning stack trace when displayed Details
XFO-2290 SQL Server database locking up Details
XFO-2371 Deleting Subscription Domain predicates reassigns predicate rankings on the Event Domain Details

Installing This Patch

Apply this patch to all xMatters Application Nodes, Notification Nodes and Web Servers (and any DataSync installations, if applicable).

  • PATCH-410-012.tar.gz
  • PATCH-410-012.zip
  • PATCH-410-012-DataSync.tar.gz
  • PATCH-410-012-DataSync.zip

WebSphere Files

You can find the following archive files listed with their associated patches here:

  • PATCH-410-012-websphere.tar.gz
  • PATCH-410-012-websphere.zip

These archive files contain the following WAR files for use with IBM WebSphere 7:

  • PATCH-410-012-axis2-websphere7.war: Contains xMatters Web Services files.
  • PATCH-410-012-cocoon-websphere7.war: Contains web user interface files.

If you have already deployed these files on a previous xMatters deployment, you must uninstall the existing files and then reinstall the new files based on the instructions in the "Advanced xMatters Administration" chapter of the xMatters Installation and Administration Guide.

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

In particular, note that the following xMatters integrations may edit pre-existing xMatters Node or Web User Interface files:

  • HP NNMI: Updates web.xml in webserver\webapps\axis2\WEB-INF (see the section "Initialize the Incident Subscription Manager" in the integration guide)
  • HP Service Manager (Adv): Updates classpath on node-start.conf on Windows and node.sh on Unix (see the section "Initialize the Web Services Library" in the integration guide)
  • HP Service Center (Adv): Updates classpath on node-start.conf on Windows and node.sh on Unix (see the section "Initialize the Web Services Library" in the integration guide)

Warning: Database Changes

Be aware that this patch includes the following database changes that may impact your replication mechanism (consult with your database administrator for further details):

DDL

On all supported databases (Oracle, SQL Server, DB2):                                                                                                                    

  • Adds table DATABASECHANGELOG
  • Adds column CUS_FIELDS to table NTFN_EVS
  • Creates index IDX_DISPATCH on table LIVE_NTFN
  • Adds Procedure DISPATCH_QUERY

On DB2 Only

  • Adds Type NTFN_IDS BIGINT ARRAY[]

DML

On all supported databases (Oracle, SQL Server, DB2):

  • Updates table PROV_PROTS setting SESSION_MAX_SIZE
  • Adds Node Component: Notification Response Processor
  • If missing, re-add permission 18210 (view.menuitem.AddCustomPage) to function 100 (Super/Company Administrator)
  • If missing, re-add permission 18211 (view.screen.AddCustomPage) to function 100 (Super/Company Administrator)

Pre-Installation Steps

Before installing this patch:

  1. Shut down all Node processes.
  2. Shut down all Webserver processes.
  3. Back up the xMatters Database. 

Note:This patch includes path names longer than 100 characters. As a result, you must use a GNU-compatible version of tar to extract the tar archives.

Installation Steps

To install this patch:

  1. Back up the xMatters installation directory (<xMHOME>).
    • On Windows, default install directory is: C:\Program Files\AlarmPointSystems\AlarmPoint
    • On Unix, default install directory is: /opt/alarmpointsystems/alarmpoint
  2. Save the PATCH-410-012.zip or PATCH-410-012.tar.gz file to the xMatters installation directory.
  3. Do one of the following:
    • On Windows, extract (i.e., unzip) the PATCH-410-012.zip file to the installation directory and overwrite the existing files.
    • On Unix, run the following commands on the PATCH-410-012.tar.gz file and overwrite the existing files:

gunzip PATCH-410-012.tar.gz

tar -xvf PATCH-410-012.tar

  1. If you are applying this patch on:
  • Windows 32-bit, delete the following files from the Windows\system32 folder (if the files are present):
    • alarmpoint_sapi_tts.dll
    • alarmpoint_mapi.dll
  • Windows 64-bit, delete the following files from the Windows\system32\sysWOW64 folder (if the files are present):
    • alarmpoint_sapi_tts.dll
    • alarmpoint_mapi.dll
  • AIX, move the libjspAixPpc.so file from /AIX (located in the extracted patch directory) to <xMHOME>/jre/bin
    • Navigate to the <xMHOME>/jre/bin directory and set the proper permissions by executing the following command line:

chmod 755 libjspAixPpc.so

  • HP-UX Itanium, move the libjspHpxIa64.so file from /HPUX (located in the extracted patch directory) to <xMHOME>/jre/bin                                                                            
    • Navigate to the <xMHOME>/jre/bin directory and set the proper permissions by executing the following command line:

chmod 755 libjspHpxIa64.so

  • HP-UX PA-RISC, move the libjspHpxPaRisc.sl file from /HPUX (located in the extracted patch directory) to <xMHOME>/jre/bin                                                                            
    • Navigate to the <xMHOME>/jre/bin directory and set the proper permissions by executing the following command line:

chmod 755 libjspHpxPaRisc.sl

  • Linux 32-bit, move the libjspLux86.so file from /Linux (located in the extracted patch directory) to <xMHOME>/jre/bin                                                                            
    • Navigate to the <xMHOME>/jre/bin directory and set the proper permissions by executing the following command line:

chmod 755 libjspLux86.so

  • Linux AMD 64-bit, move the libjspLux86_64bit.so file from /Linux (located in the extracted patch directory) to <xMHOME>/jre/bin                                                                            
    • Navigate to the <xMHOME>/jre/bin directory and set the proper permissions by executing the following command line:

chmod 755 libjspLux86_64bit.so

  1. Do one of the following:
    • If you have not installed the DataSync component, skip to "Post-Installation Steps", below.
    • If you have installed the DataSync component, complete the remaining steps.
  2. Back up the xMatters DataSync installation directory.
    • On Windows, default DataSync install directory is: C:\Program Files\AlarmPointSystems\AlarmPoint_DataSync
    • On Unix, default DataSync install directory is:/opt/alarmpointsystems/alarmpoint_datasync
  3. Do one of the following:
    • Extract (i.e., unzip) the PATCH-410-012-DataSync.zip file to the installation directory and overwrite the existing files.
    • Run the following commands on the PATCH-410-012-DataSync.tar.gz file and overwrite the existing files:

gunzip PATCH-410-012-DataSync.tar.gz

tar -xvf PATCH-410-012-DataSync.tar 

Post-Installation Steps

After installing this patch:

  1. Restart the Node processes.
  2. Restart 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.
  • Due to a relative paths issue, the database cannot be patched when the webserver is running on IBM WebSphere.

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 (default locations shown; only one log will include the MUTEX entries):

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. 

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

Mismatched components starting, but causing stack traces

Previously, it was possible to start components that did not match the database version; for example, you may have a database patched to 4.1 patch 018, but a web server still running on 4.1 patch 017. This would cause stack traces and other communication issues. This has been addressed by preventing the startup of any component with a version that does not match the database.

(xMatters Reference: XFO-1839)

Who's on Duty Report inconsistent with Group Weekly View

The Who's On Duty Report, when displaying a weekly Group schedule, contained details that were inconsistent with the hover-over information displayed in the Weekly View on the Group Details page. This issue has been addressed.

(xMatters Reference: XFO-1852)

Who's on Duty Report showing incorrect One Time Coverage replacements

When adding a One Time Coverage to replace an existing shift, the Who's On Duty Report would often display both the replaced shift and the original shift, even though the original shift would never occur. The Report now shows only the replacement One Time Coverage.

(xMatters Reference: XFO-1854)

Teams not being added correctly from the Team Details page

When creating a nested Team (i.e., adding a Team to an existing Team using the Team Details page), xMatters would occasionally omit one of the added Teams. This was due to an issue in the way Teams were ordered, and has been addressed.

(xMatters Reference: XFO-1854)

Data Synchronization cannot update the Supervisor for a Group with two or more existing Supervisors

When attempting to add or update the Group Supervisor for a Group using the Data Synchronization feature, the update would not be correctly applied if the Group already had two or more Group Supervisors. This issue issue has been addressed; Data Sync should now update the Group Supervisors correctly.

(xMatters Reference: XFO-1864)

Incorrect Event Summary status for messages left in recipient's voice mail

When a notification is delivered to a User's voice mail, the Event Summary status would display as "Not yet notified" instead of "Delivered to Device". This has been addressed by bringing the handling of notifications delivered to voice mail more in line with the handling of other notifications, and displaying the status as delivered to a Device.

(xMatters Reference: XFO-1994)

MAPI Device Engine does not work with non-English characters

In previous versions, the MAPI Device Engine could not properly process non-English characters, and would display incorrect characters. This was due to the way extended ASCII characters were escaped in the HTML. This has been addressed by pushing the data to the MAPI engine as explicitly Unicode.

(xMatters Reference: XFO-2020)

Data synchronization unable to export Groups that have the same external keys

The Data Synchronization tool was unable to export Groups that had the same external keys. This issue has been addressed by changing and simplifying the way external keys are generated during an export: all external keys generated and assigned during an export now use a universal unique identifier (UUID) rather than the method detailed in the documentation for previous versions.

(xMatters Reference: XFO-2028)

Inaccurate description of Service Provider Access Role

The Service Provider Access Role was inaccurately described in the Role Details page in the web user interface, and in the related topic in the online help. Both descriptions have been updated to better describe the Role and its intended purpose.

(xMatters Reference: XFO-2045)

FindGroups web service treating underscore as wild card

The FindGroups web service (and the Find Groups page in the web user interface) would treat an underscore entered in the Search field as a wild card. This led to unexpected results in the returned Groups; for example, some Groups that did not have underscores in their names would be included, and Groups that did have underscores would be excluded. This issue has been addressed by changing the way the web services and Group search queries handle underscores in Group names.

(xMatters Reference: XFO-2060)

Manage Scenarios page not displaying correct Event and Message Domains

The Manage Scenarios page should now correctly display the Event Domain and Message Domain for the Scenarios listed on the page.

(xMatters Reference: XFO-2061)

Incorrect escalation count calculated for Group Performance Report

An issue was identified with the Group Performance Report where an escalation occurred, but the related event was completed before the escalated User accepted the notification. This resulted in the escalation being excluded incorrectly; this issue has been addressed.

(xMatters Reference: XFO-2135)

Sample Messaging Panels returning stack trace when displayed

Incomplete or outdated code in the Sample Message Panels (located in the jsp/messaging/samples folder) was resulting in a stack trace when attempting to use the panels in the web user interface. The sample panels have been updated and retested.

(xMatters Reference: XFO-2224)

SQL Server database locking up

An issue was identified with a revision trigger in the NODES table that could cause a dead lock on SQL Server deployments. This issue has been addressed.

(xMatters Reference: XFO-2290)

Deleting Subscription Domain predicates reassigns predicate rankings on the Event Domain

When removing predicates from a Subscription Domain, the ranking of those predicates on the associated Event Domain could be incorrectly adjusted. The code related to predicate removal has been updated to no longer update predicate rankings on the Event Domain.

(xMatters Reference: XFO-2224)

Appendix 2: Notice of Name Change

AlarmPoint Systems, Inc. is now xMatters, inc. This change extends to how we name our products: the AlarmPoint Integration Agent is now the xMatters integration agent; AlarmPoint Enterprise is now xMatters enterprise; and so on.

You can learn more about why we changed our name here.

During the ongoing transition to the new naming conventions, legacy corporate and product names will still appear in some parts of our products, such as directory paths, logs, and messages. This document reflects the new names whenever possible, while respecting the need for clarity when referring to older products, legacy issues, existing knowledge base articles, etc.

For more information (including instructions on how to switch between the AlarmPoint and xMatters interfaces), see Common questions about rebranding from AlarmPoint to xMatters.

Appendix 3: Known Issues

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)

xMatters (alarmpoint) engine version 4.0 patch 10 and version 4.1 patch 2 introduced an upgrade script that added Oracle function-based indices to improve performance. However, these indices will not become effective and used by the Oracle Cost Based Optimizer (CBO) until the statistics are gathered for the related tables and the indices themselves. For more information, see Why isn't Oracle using available indices?.

(xMatters Reference: PRE-68)

Even when the xMatters integration agent submits a message to a Company other than the Default Company, the integration agent log indicates that the message was submitted to the Default Company.

(xMatters Reference: APE-13596)

Appendix 4: DDL Changes in This Release 

The following DDL changes have been made for this patch release:

  • Updated NODES to all have existing URLs starting with ‘tcp://’ instead of ‘http://’
  • Updated QCPS COMPONENT_TYPE for QCP_KEY HM_EXECUTABLE
  • Increased the size of USER_AGENT column to 1200

xMatters Reference

JDN-3136 Originally created by Don Clark

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk