xMatters integration agent 5.0 patch 7 Release Notes


Document Overview

Release Overview



Document Overview

These release notes are for the following xMatters integration agent patch release:

Patch version: integrationagent-5.0.7

Revision: 66047

Download: xMatters Integration Agent 5.0

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 release of the xMatters integration agent version 5.0, and should be applied to all existing integration agents in your deployment.

Note that this version of the xMatters integration agent consolidates and replaces the 5.0 integration agent for premises deployments, and the 5.5.x version previously used for xMatters on demand. The 5.0 patch 7 version of the integration agent can now be used for xMatters 5.,0 deployments, and for xMatters on demand.

Features Added

The following features and fixes are included in this release:

Integration agent regex parser not accepting valid hostnames

An error was identified in the IAConfig.xsd file, which contains the hostname entity regex, that was preventing the integration agent from recognizing valid hostnames when parsing the SMTP-relay hostname in the IAConfig.xml file. This issue has been addressed.

(xMatters reference: APO-6922)

Integration agent not sending queued messages on restart

The integration agent's outbound queue consumer, used to pull messages out of the outbound queue for forwarding to xMatters, was being created the first time a message was added to the outbound queue. Until the message was added, no consumer existed, and therefore messages would remain queued and not sent. The integration agent has been updated to create the outbound queue consumer on startup.

(xMatters reference: APO-6909)

Integration agent extremely slow to send messages to xMatters

In some very rare cases, the ActiveMQ broker in the integration agent could cause the message exchanger to submit messages at a greatly restricted rate. This was traced to an issue with the spring-config.xml file, which contained different settings for two separate ActiveMQ connection factories. The spring-config.xml file has been updated to address this issue, and the xMatters integration agent guide has been updated to include the necessary changes.

(xMatters reference: XFO-3941)

Retry attempts counted incorrectly

An issue was identified where the integration agent would count any attempts to resend a problematic message to xMatters as retry attempts for all messages in the outbound queue. This was due to the way the delivery counter was being incremented for all messages in a batch, rather than for each individual message. This issue has been addressed.

(xMatters reference: APO-6898)


For detailed system requirements and installation information, refer to the xMatters integration agent guide.

Files included with this release:


Because the xMatters integration agent does not include an installer, patching an existing integration agent installation requires only that you extract the latest version of the integration agent archive over your existing deployment.

To patch the integration agent:

  1. Navigate to the/conf directory, and backup the following files:
    • IAConfig.xml
    • log4j.xml
    • deduplicator-filter.xml
    • Any other files for which you have modified the default configuration.
  2. If you have made any changes to the default files in the/integrationservices folder, backup the modified files.
    • Note that copying over the upgraded files will not overwrite or remove any additional files you may have created or installed for integrations.
  3. Download the integrationagent-5.0.7- file appropriate for your operating system, and extract the archive file to a temporary folder.
  4. Stop the integration agent you are upgrading.
  5. Copy the contents of the extracted archive over your existing installation.
  6. Restore the files you backed up in step 1.
    • If there were any files other than the three listed XML files for which you modified the configuration, you may need to compare them with their replacements to ensure that your configuration changes are applied to the patched integration agent.
  7. Restart the integration agent.

Repeat the above steps for each integration agent in your deployment.

After installing this patch

  1. Run the following command from the xMatters integration agent's bin directory:

iadmin get-status

  The following should be displayed:

            Version: 5.0.7 r66045


Appendix 1: Known Issues

Reloading integration service via iadmin reload command causes all web service endpoints to fail
After a single integration service is reloaded by running the iadmin reload command, all web service endpoints for all integration services (not just the service being reloaded) may stop working. This affects the functionality of mobile access requests, direct external service requests, and custom web service requests to all integration services. NOTE: issuing a subsequent iadmin reload all restores the web service endpoints.

(xMatters Reference: BUG-2206)

The integration agent has an undocumented dependency on TCP port 61618

The integration agent's conf/activemq.xml file contains the following element:


Because of this setting, during startup, the integration agent will attempt to bind a socket listener to port 61618.  If another process is using this port, the integration agent will fail to start with a "JVM Bind" error.  To restart the integration agent, either stop the process that is using port 61618 or change the transportConnector setting to refer to an unused port.

(xMatters Reference: BUG-2185)

Messages may continue to be processed after the inbound queues are purged

The iadmin purge command deletes all messages from the inbound/outbound queues of the specific (or all) integration services.  Messages that are "in-process" during the purge (e.g., delayed after a retriable exception or actively being processed by input/response action scripting), may remain in the inbound continues and continue to be (re)processed.  To work around this issue, either stop the integration agent or suspend the integration service prior to the purge, followed by a restart/resume.

(xMatters Reference:  BUG-2180)

Messages may be reprocessed after an integration service is suspended and resumed

Messages that are actively being processed by input/response action scripting during an iadmin suspend are allowed to complete without interruption.  However, when a suspended integration service is resumed (either after an iadmin resume command or restart), messages that were being processed during the suspension may be reprocessed.  Integrations are designed to handle reprocessing, but this may result in redundant updates (depending on the integration).

(xMatters Reference: BUG-2181)

iadmin purge may periodically fail if the integration agent is not running

The iadmin purge command sometimes fails to work when the integration agent is not running. This failure is indicated by an entry similar to the following in AlarmPointIAdmin.txt:

2012-08-09 10:00:46,502 [main] DEBUG - The command could not be executed because of the following problem:


at org.apache.activemq.broker.jmx.BrokerView.getQueues(BrokerView.java:185)

NOTE: re-issuing the iadmin purge command often succeeds, as the failure cause is transient.

(xMatters Reference: BUG-2205)

Although APClient.bin reports non-connection related network errors, it does not write the failed submissions to the recovery log.

(xMatters Reference: INTA-1912, INTA-1914)

No error message is thrown when messages are injected in APClient.bin with SSL enabled on apclient-gateway.

When SSL is enabled and a message is injected using APClient.bin, no error message is displayed in the user interface informing the user that APClient.bin does not support SSL. APClient.bin supports only HTTP communication with the integration agent, even if the value of the --http-post parameter is an https URL (however, the integration agent can communicate back to the Management System using any of the secure protocols supported by the Management System's API.).

(xMatters Reference: XFO-1705)

Enabling password-authentication prevents event injections for all Integration Services using APClient.bin.

Setting the parameter in the IAConfig.xml file to "true" will prevent any event injections for all Integration Services using APClient.bin. Note that password-authentication is typically not enabled out-of-the-box for integrations, so the impact of this issue should be very limited.

xMatters Reference

XFO-1676, JDN-4207

Originally created by Don Clark 

Have more questions? Submit a request


Please sign in to leave a comment.
Powered by Zendesk