These release notes are for the following xMatters patch release:
Patch version: PATCH-500-002
NOTE: This document is subject to change after the initial release of this patch.
This is a cumulative patch for version 5.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).
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. You do not need to install xMatters using the original 5.0 installer, and then apply this patch.
Microsoft SQL Server Support
This patch adds support for Microsoft SQL Server 2008 R2 to xMatters 5.0, including new configuration options in the xMatters installer.
(xMatters Reference: XFO-2509)
To see details about an issue, click the related link in the Details column:
|xMatters Reference||Issue Fixed||Details Link|
|XFO-2508||Unable to create a Node with the same name as a previously-deleted Node||Details|
|XFO-2524||Data synchronization resets Team escalation type on update||Details|
|XFO-2561||Single-Company deployments unable to customize "Default Company" scripts||Details|
|XFO-2590||Incorrect redirect after removing Coverage||Details|
|XFO-2660||Help not available on Schedule Jobs page||Details|
|XFO-2668||UDH split method not working for SMPP messages||Details|
|XFO-2820||Incorrect message encoding when Message Payload split method is set for SMPP||Details|
|XFO-2826||DeleteIncident and DeleteEvent web services could delete an Event in a different Company||Details|
|XFO-2827||DeleteTemporaryReplacement could delete a replacement in a different company||Details|
Apply this patch to all xMatters Application Nodes, Notification Nodes and Web Servers (and any DataSync installations, if applicable).
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: Database Changes
Note that this patch changes the way Template scripts are used by xMatters:
You should no longer make changes to the scripts in the Template Company. As of this patch, these scripts are now subject to automatic changes and updating. If you have already modified the Template scripts, export them (using the Developer IDE) from the Template Company and import them into the Default Company before installing this patch. Once the patch is applied, you can then change the associated Event Domains (in the web user interface) to use the Default Company scripts instead of the Template scripts.
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 .
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.
Previously, when deleting a Node from the web user interface, the Node remained in the database table. This prevented adminstrators from deleting and replacing Nodes using the same name. This issue has been addressed.
(xMatters Reference: XFO-2508)
When updating an existing Team using the Data Synchronization feature, any existing escalation type settings between Team members was reset to the default; i.e., None. This issue has been addressed. Note that this fix applies only when updating a Team within a Company. Escalation settings are not retained when exporting from one Company into another.
(xMatters Reference: XFO-2524)
Customers without an MSP (multiple-Company) license were unable to use the new feature that allowed Companies to switch between the default Template scripts and customized, Company-specific scripts. This issue has been addressed.
(xMatters Reference: XFO-2561)
In some cases, Users removing a Coverage from one Group were redirected to the Group Details page for a different Group after the Coverage was removed. This was due to an error in the Delete Coverage form; this issue has been addressed.
(xMatters Reference: XFO-2590)
Previously, clicking the Help link on the Schedule Jobs page resulted in an HTTP ERROR: 404 message. This issue has been addressed.
(xMatters Reference: XFO-2660)
On some deployments, specifying the UDH split method for SMPP Protocol Providers resulted in extra characters being added to the split sections of the SMPP message. This the issue has been addressed.
(xMatters Reference: XFO-2668)
The Message Payload split method setting was not being properly included in the data encoding settings for the message. This issue has been addressed.
(xMatters Reference: XFO-2820)
In certain (extremly rare) conditions, it was possible for a Web Services User to terminate an incident or event in a different Company on the same deploymet using the DeleteIncident or DeleteEvent web service. While this issue was unlikely to be abused (for example, the user would have to know the exact incident or event ID), the issue has been addressed.
(xMatters Reference: XFO-2826)
In certain (extremly rare) conditions, it was possible for a Web Services User to delete a Temporary Replacement in different Company on the same deployment. This issue has been addressed.
(xMatters Reference: XFO-2827)
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.
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)
The following changes have been made for this patch release:
- Add column IS_ACTIVE to CUST_MSG_PNLS
- Drop IS_DEFAULT_MULTILINE column from PROPERTY
- Update PROPERTY_VALUE to cascde deletes from PROPERTY
- Dropping NAME and DESCRIPTION columns from FORM_PERM and FORM_PERM_REV and cascading PERSONS deletes
- Add PERSON_DELIVERY_STATUS and RESPONSE columns to AUDIT_EVS_ALL and AUDIT_EVS_ALL_ARC tables
- Add DELIVERY_STATUS_ORDER and DELIVERY_STATUS_DISPLAY_ORDER columns to AUDIT_EVS_ALL and AUDIT_EVS_ALL_ARC tables
- Create tables SHARED_LISTS and SHARED_LIST_VALUES and associated indexes/triggers
- Add index on PERSON_ID column in AUDIT_EVS_ALL and AUDIT_EVS_ALL_ARC tables
- Add index IDX_AUDIT_EVS_ALL_PDS, IDX_AUDIT_EVS_ALL_DSO, IDX_AUDIT_EVS_ALL_PS_DVC in AUDIT_EVS_ALL table. Add indexes IDX_AUDIT_EVS_ALL_ARC_PDS, IDX_AUDIT_EVS_ALL_ARC_DSO, IDX_AUDIT_EVS_ALL_ARC_PS_DVC in AUDIT_EVS_ALL_ARC table
- Update EV_DMN_CONST so that name uniqueness is case-insensitive
- Add index IDX_AUDIT_EVS_ALL_EV_PSN, IDX_AUDIT_EVS_ALL_PED, IDX_AUDIT_EVS_ALL_PCD, IDX_AUDIT_EVS_ALL_PDED in AUDIT_EVS_ALL table. Add indexes IDX_AUDIT_EVS_ALL_ARC_EV_PSN, IDX_AUDIT_EVS_ALL_ARC_PED, IDX_AUDIT_EVS_ALL_ARC_PCD, IDX_AUDIT_EVS_ALL_ARC_PDED in AUDIT_EVS_ALL_ARC table
- Add NTFN_RECIPIENT_ID, ESCALATION_LEVEL, NTFN_CAT column to tables AUDIT_EVS_ALL and AUDIT_EVS_ALL_ARC
- Rename column CURRENT_USER to CUR_USER in table IMPORT_JOB
- Update COMP_CONST so that name uniqueness is case-insensitive
- Update GLB_CONST so that name uniqueness is case-insensitive
- Add VERSION column to tables EVS and EVS_ARC
- Rename PK and unique constraints to match convention
- Added DISPLAY_ORDER column to table CUST_FLDS_REV and to triggers
- Add columns HOLIDAY_START_HOUR, HOLIDAY_START_MINUTE, HOLIDAY_DURATION to table DATE_RPT_PATTERNS_REV
- Add column POST_METHOD to table PROT_BESS_REV
- Add columns DEST_PREPEND_PLUS and SPLIT_METHOD to PROT_GSMS_REV
- Add columns DEST_PREPEND_PLUS, SPLIT_METHOD and SHORT_CODE_COMP to PROT_SMPPS_REV
- Add column MULT_MSGS to PROT_SNPPS_REV
- Add columns REQUIRE_AUTH, BYPASS_PHONE_INTRO, VOICE_MAIL_OPTS, CONF_BRIDGE_TYPE, EXT_CONF_PHONE_NUM, PAUSE_BEFORE_NUM, EXT_BRIDGE_NUM, DIAL_AFTER_NUM, and DELETED_ID to SCENS_REV
- Add columns REQUIRE_AUTH, BYPASS_PHONE_INTRO, VOICE_MAIL_OPTS, CONF_BRIDGE_TYPE, EXT_CONF_PHONE_NUM, PAUSE_BEFORE_NUM, EXT_BRIDGE_NUM, and DIAL_AFTER_NUM to ENH_MSGS_ARC
- Add column INVALID_RESPONSE_COUNT to RECIPIENT_NTFN_ARC
- Add column DV_RM_BY_SCR to SNS_ARC
- Add NTFN_CONTENT, PARENT_NTFN_ID, ROOT_NTFN_ID and NTFN_ACTIONS columns to AUDIT_EVS_ALL
- Modify sequences SCEN_ATTACHMENT_SEQ and SCEN_INIT_SEQ to match naming conventions
- Fixing column precision/size that were incorrect in 5.0.0 installer
- Add sequences SCR_SEQ, SCR_PKG_VERS_SEQ, SCR_PKGS_SEQ
- Remove erroneous default values from WHEN_CREATED, WHEN_UPDATED, WHO_CREATED, WHO_UPDATED
- Fix NUMBER column precision that was incorrect in 5.0.1 installer
- Fixing column precision/size that were incorrect in 5.0.0 installer
- Add indexes IDX_AUDIT_EVS_ALL1, IDX_AUDIT_EVS_ALL2, IDX_AUDIT_EVS_ALL3, IDX_AUDIT_EVS_ALL4 on AUDIT_EVS_ALL.
- Add indexes IDX_BILLING_VOICE_1, UK_BILLING_VOICE on BILLING_VOICE.
- Add index IDX_PROP_LIST_PV_UNQ1 on PROPERTY_LIST_POSSIBLE.
- Update AUDIT_EVS_FILL_IDS_TR trigger.
- Add new STATUS_REPORTER component
- Adding META_ARC_TABLES and META_REV_TABLES data missing from the 5.0 seed
- Add heartbeat threshold config param for SIP device engine
- Make Default Company use the Template scripts
- Add fine-grained shared list permissions to the Build Applications function. Adding ability.act.ViewSharedList, ability.act.EditSharedList, and ability.act.DeleteSharedList permissions.
- Add ability.act.ViewPhoneRecordings permission to the Build Applications function
JDN-3204 Originally created by Don Clark