xMatters 4.1 patch 014 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-014

Build: 1201

Revision: 55038 

Release date: August 16, 2012 

DEPRECATED: This patch has been deprecated due to a known issue that has been addressed in 4.1 patch 018. It is recommended that you install the latest available patch instead. 

If you choose to install this patch, it is MANDATORY that you follow the steps outlined in this knowledge base article.

NOTE: This document is subject to change after the initial release of this patch. If you would like to be alerted when the document is modified, click Receive email notifications on the Actions menu to the right of this document. 

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 013 release notes

It is strongly recommended that you review the Patch Release Notes for all patch levels between your current patch level and this latest release before applying the upgrade. Some patches may require specific configuration changes not included in these release notes. 

Features Added In This Patch Release

For more information about these features, see the 4.1 Patch 14 and 4.0 Patch 22 New Feature Overview.

Automated SMS Phone Deactivation

This patch adds the capability for SMS Phone Devices to be automatically deactivated in xMatters when the phone service provider sends a response indicating that the phone is delisted or otherwise no longer valid. xMatters can also send notifications to the User and their Supervisor. This feature also includes the ability to specify which deactivation codes - specific to each Protocol Provider - will result in an SMS Device being deactivated.

(xMatters reference: XFO-3032) 

Email Domain Whitelist

When adding an Email Device Type, Administrators can now specify which domains are allowed as part of an email address. Note that this feature necessitated a small change in the Add Device Type process when using the web user interface, but does not affect existing Email Device Types.

(xMatters reference: XFO-2921) 

Revised Access Control for Tenant Company Users

This patch overhauls the functionality of the Service Provider Admin Role and the way in which Users log in to Tenant Companies. Users can now be mapped directly to a specific User in the Tenant Company.

(xMatters reference: XFO-2942) 

SMS Short Code Compliance

The MMA Compliance features for SMS Devices were back-ported from the 5.0 version and are now available in xMatters 4.1.

(xMatters reference: XFO-3033) 

Issues Fixed in This Patch Release

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

xMatters ReferenceIssue FixedDetails Link
XFO-2981 FindGroups web service is slow to process results when searching by Group member Details
XFO-2994 Hover-over ability in Group weekly view removed in recent patch 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-014.tar.gz
  • PATCH-410-014.zip 
  • PATCH-410-014-DataSync.tar.gz
  • PATCH-410-014-DataSync.zip 

WebSphere Files

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

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

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

  • PATCH-410-014-axis2-websphere7.war: Contains xMatters Web Services files.
  • PATCH-410-014-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: 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: c3p0.properties file

It is recommended that you backup the c3p0.properties file for each of the Nodes in your deployment as this file may also be affected by the patch process. Once the patch process is complete, you can use any text editor to compare your back up copy with the one installed by the patch and copy over any customization or other configuration changes. 

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-014.zip or PATCH-410-013.tar.gz file to the xMatters installation directory.
  3. Do one of the following:
    • On Windows, extract (i.e., unzip) the PATCH-410-014.zip file to the installation directory and overwrite the existing files.
    • On Unix, run the following commands on the PATCH-410-014.tar.gz file and overwrite the existing files:

gunzip PATCH-410-014.tar.gz

tar -xvf PATCH-410-014.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-014-DataSync.zip file to the installation directory and overwrite the existing files.
    • Run the following commands on the PATCH-410-014-DataSync.tar.gz file and overwrite the existing files:

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

tar -xvf PATCH-410-014-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. 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. 

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

FindGroups web service is slow to process results when searching by Group member

Previously, the FindGroup web service was slow to execute queries when searching by a member who belongs to more than 100 Groups. The web service has been redesigned to achieve better performance; no change in any existing web service client behavior is required.

Hover-over ability in Group weekly view removed in recent patch

A recent patch removed the ability for Users to hover over a Group's Schedule and view the Team members for each shift. This was due to a regression issue and has been addressed.

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. 

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

  • Add new DOMAINS column in ORG_DVC_NAMES and ORG_DVC_NAMES_REV
  • Create tables PERSON_MSPS and PERSON_MSPS_REV
  • Create triggers PERSON_MSPS_REV_TR and PERSON_MSPS_IA_TR
  • Modify column AUDIT_UNAME in table SEC_AUDIT to a larger size (500)
  • Add columns DEACTIVATION_ERROR_CODES and NOTIFY_ON_DEACTIVATION to PROT_SMPPS and PROT_SMPPS_REV
  • Update triggers PROT_SMPPS_REV_TR and PROT_SMPPS_IA_TR to include new columns
  • Modify column SHORT_CODE_COMP to size 500 in tables PROT_SMPPS, PROT_SMPPS_REV, PROT_SMPP_ROUTE_OV, PROT_HTTPXMSMS, PROT_HTTPXMSMS_REV, PROT_HTTPXMSMS_ROUTE_OV, ORGS, and ORGS_REV
  • Update default value for SHORT_CODE_COMP to ‘NONE’ on tables PROT_SMPPS, PROT_SMPPS_REV, PROT_SMPP_ROUTE_OV, PROT_HTTPXMSMS, PROT_HTTPXMSMS_REV, PROT_HTTPXMSMS_ROUTE_OV, ORGS, and ORGS_REV
  • Drop column AUDIT_RETN from ORG, ORGS_REV and alter associated triggers

DML Changes in this release

  • Add permission ability.manage.Proxy
  • Add role 'Service Provider Admin'
  • Add function 'Service Provider Admin'
  • Add Generic APS script
  • Create the generic_response APS Script and event domain in the Default and Template companies
  • Create the sms_confirmation APS Script and event domain in the Default and Template companies
  • Create the sms_deactivation APS Script and event domain in the Default and Template companies

xMatters Reference

JDN-3247 Originally created by Don Clark

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk