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

Build: 1294

Revision: 65959

Release date: May 31, 2013

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 Following in on the Actions menu to the right of this document, and then select the Inbox check box.

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 xMatters 4.1 patch 018 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.

New Features

This release includes the following new features:

Plain text passwords removed from integration agent logs

In xMatters, custom password fields are encrypted when they are stored in the database. The field values can be accessed and decrypted from the scripting language. This patch adds a new flag to the getCustomFieldValue method that allows the action scripts to send requests to the integration agent with an encrypted password. This allows integrations to decrypt the password and authenticate with management systems and still keep passwords from being recorded in the integration agent logs as plain text. (Note that the default setting will not interfere with existing integrations.) For more information about this method, refer to the xMatters Online Developer's Guide, or see the article, Updating integrations to encrypt password values

(xMatters reference: ARCH-1305)

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-3528 Calling extension over ISDN results in unexpected exceptions Details
XFO-3745 waitForSilence scripting method fails silently Details
XFO-4031 Schedule Details page: team escalations are not displayed correctly Details
XFO-4042 Coverage bar not displaying correct hover text for Users with special characters Details
XFO-4044 Home Page/My Devices page displaying incorrect breadcrumbs Details
XFO-4273 FindGroups web service call returns unexpected results Details
XFO-4315 Application Audit Report: stack trace Details

Installing This Patch

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

Files Included With This Patch

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

WebSphere Files

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

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

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

  • PATCH-410-019-axis2-websphere7.war: Contains xMatters Web Services files.
  • PATCH-410-019-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 1 that may impact your replication mechanism (consult with your database administrator for further details). 

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

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

gunzip PATCH-410-019.tar.gz

tar -xvf PATCH-410-019.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, libalarmpoint_att_tts.so and libalarmpoint_att_tts_51.so files 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

chmod 755 libalarmpoint_att_tts.so

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

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

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

Calling extension over ISDN results in unexpected exceptions

On some customer deployments, phone calls using the same trunk line would report the same call result for different numbers. Users reported hearing no answer, or silence followed by a hang up. This issue has been addressed.

waitForSilence scripting method fails silently

An issue was identified with the @phone::waitForSilence script method where an end user could be on the line for an extended period before being dropped. Afterward, the phone line would be left in an unstable state and then reset. After ten resets, the line would be removed from the pool of available lines. This was due to a conflict between CTADE and the Windows API function. This issue has been addressed.

Schedule Details page: team escalations are not displayed correctly

An issue was identified with the Schedule Details page in the web user interface where changes to a Coverage would not be displayed until the page was refreshed. This issue has been addressed.

Coverage bar not displaying correct hover text for Users with special characters

The hover-text displayed over the shift bars on the Group details page would not display correctly if the Users included in the Coverage had special characters in their names. This issue has been addressed.

Home Page/My Devices page displaying incorrect breadcrumbs

An issue was identified where the breadcrumbs on a User's home page and Devices page would not display correctly. This issue has been addressed.

FindGroups web service call returns unexpected results

When attempting to use the FindGroups web service call with an invalid Users (i.e., a User that does not exist in the system, or a User that did not belong to any Teams), the results would include all Groups in the system, rather than the expected empty results set. This was due to an error in the processing code that treated an invalid User as though the User had not been specified. The code has been updated to prevent this issue.

Application Audit Report: stack trace

Some customers reported receiving a stack trace error when attempting to view Text Phone Device details on the Application Audit Report. This was due to a change to the way text phone numbers and country codes were stored, originally released in 4.1 patch 006. This issue has been addressed. 

Appendix 2: 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 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 3: Database Changes in This Release

There were no database changes required for this release.

xMatters Reference

JDN-4187 Originally created by Don Clark

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk