These release notes are for the following xMatters patch release:
Patch version: PATCH-500-004
Release date: August 16, 2012
NOTE: This document is subject to change after the initial release of this patch.
This is a cumulative patch for xMatters version 5.0.
This patch should be applied to all xMatters Application Nodes, Notification Nodes and Web Servers (and to the DataSync Server, if applicable).
Note that this version of the xMatters installer is capable of installing a new xMatters deployment, including all of the updates released in this patch, or of patching an existing installation. (I.e., you do not need install xMatters using the original 5.0 installer and then apply this patch afterwards.)
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.
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 5.0 patch 003 Release Notes.
Support Policy Reminder
The xMatters Support Policy was updated in February 2009.
Features Added In This Patch Release
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)
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)
Internationalization Added for MMA Compliance and SMS Deactivation
This patch allows xMatters Administrators to create alternate language versions of the SMS messages sent in response to MMA Comliance keywords (HELP, STOP, etc.) and verification. Administrators can also specify alternate language versions (based on the User's preferred language, or their Site's assigned language) of the welcome text displayed when adding a new SMS Device. For more information about how to implement this and other SMS -related features, see the new "SMS Configuration" section in the "Process Configuration Examples" area of the xMatters installation and administration guide.
(xMatters reference: XFO-3074)
New and Updated Reports
As part of a long-term series of upgrades to the Reporting structure in xMatters, the Event Summary and Notification Summary Reports have been replaced with a new Tracking Report that allows real-time updating of notifications and statuses. You can also drill down into each of the status categories for more information. The Exhaustive Report has been replaced with an Event Log Report that features an improved search capability and stream-lined presentation. Also in this patch, the "See All" link in the Event Summary Report has been promoted to its own tab, and renamed the Event Properties Report; it also features the Event Replay option. For more information about all of these changes and features, see the "Reporting" chapter in the xMatters installation and administration guide.
(xMatters reference: COR-40)
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)
- Updated translations for the web user interface.
- Additional translations for the web help.
- Revised "View-Only" permissions.
- "Quality of protection" added for SIP messages.
- Improved the selection of recipients and the Fill Count controls for Scenarios.
To see details about an issue, see Appendix 1:
|xMatters Reference||Issue Fixed|
|XFO-2920||Export Integration feature causes a stack trace on AIX|
|XFO-2979||Updated Country Table supports ISO-3166-1 Country Names, Codes, Numbers, etc|
|XFO-2981||FindGroups web service is slow to process results when searching by Group member|
|XFO-2994||Hover-over ability in Group weekly view removed in recent patch|
|XFO-3000||Template-callin script selectable for SIP Device Engine and Phone Device Engine|
|XFO-3073||SQL Server default values set to GETDATE instead of GETUTCDATE|
|XFO-3140||POP3 email does not work for SSL|
Apply this patch to all xMatters Application Nodes, Notification Nodes and Web Servers (and any DataSync installations, if applicable).Installing This Patch
Files Included With This Patch
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 this patch also includes database changes that may impact your replication mechanism (consult with your database administrator for further details). For a full list of the database changes, see Appendix 4: DDL Changes in This Release.
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.)
The following instructions describe how to use the installer to patch an existing xMatters 5.0 deployment. For information about installing a new xMatters deployment, see the xMatters installation and administration guide.
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.3.jar file to <xMHOME>.
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 <version> 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.)
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 (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.
Export Integration feature causes a stack trace on AIX
On AIX systems, using the Export Integration feature on the Event Domains page results in a stack trace. This is due to a conflict between libraries in the JVM. For information on how to solve this issue, see the knowledge base article at http://community.xmatters.com/docs/DOC-3209 http://community.xmatters.com/docs/DOC-3209 .
Updated Country Table supports ISO-3166-1 Country Names, Codes, Numbers, etc
Certain countries listed in the xMatters database have been updated to meet ISO-3166-1 standards.
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.
Template-callin script selectable for SIP Device Engine and Phone Device Engine
A regression issue was preventing Users from assigning a default callin script for the SIP Device Engine and Phone (Voice) Device Engine. This issue has been addressed.
SQL Server default values set to GETDATE instead of GETUTCDATE
For SQL Server databases: WHEN_CREATED times stored in database tables as default values were being stored in the local database time, not the UTC time required for accurate reporting. Note that, after patching, these values will be correctly generated but existing values will not be updated.
POP3 email does not work for SSL
An internal library change resulted in SSL not working for POP3 email messages. This issue has been addressed.
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.
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)
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)
- Add new DOMAINS column in ORG_DVC_NAMES and ORG_DVC_NAMES_REV. Updated associated triggers
- Adjust precision of FK fields ROLE_ID, ACTIVITY_UPDATES_ID, RECIPIENT_ID, PERSON_ID and MESSAGE_PANEL_ID to match corresponding PK columns
- Adjust precision of FK fields ORG_ID in table APPLICATION
- 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
- Fix data in table ALERT_GENERATOR
- Add permission ability.manage.Proxy
- Add role 'Service Provider Admin'
- Add function 'Service Provider Admin'
- Create functions SPLIT_CSV and GET_NEXT_SIMP_RESP_CHOICE. Create procedure SIMP_SMS_RESP_QUERY
JDN-3245 Originally created by Don Clark