How to install and configure Integration Agent

Question

I have an integration that says I need the Integration Agent installed and configured. How do I do that?

Environment

All versions of xMatters

Answer

Below is a checklist of steps to get things started with the Integration Agent. You can find detailed information for each of these steps in the online help, and the most recent Integration Agent guide is available here.

1. Download the Integration Agent, making sure to choose the version for your operating system.

2. Unzip the folder on the server where the application you want to integrate with xMatters resides.

3. Download and extract the integrationagent-utils.zip archive to the same folder that was created for Integration Agent, and allow the extracted lib and integrationservices folders to merge with the ones already present.

4. Create a Web Service User in xMatters.

5. Configure the IAConfig.xml file in the Integration Agent /config folder.

   After you update IAConfig.xml, restart the Integration Agent so it attempts registration and heartbeats using the new values.

6. Contact xMatters Support to have us add your Agent ID to the access-control list (ACL) for your instance.

7. Start the agent and verify its heartbeat from the xMatters side and in the Integration Agent logs.

The online help gives an overview of how to set up a sample integration to make sure the agent is able to process something basic. You should be able to add any integration requiring Integration Agent to this base install by following the instructions provided with that integration.

Setting Up Multiple xAgents for High Availability

If you need high availability for your integrations, you can set up multiple xAgents:

1. Install two or more xAgents on separate systems following the steps in the xMatters Agent installation guide.

2. Register all agents in xMatters.

3. Update your workflow steps or outbound integrations to use multiple xAgents.

When configuring your flow, you can select multiple xAgents which will then operate in a round-robin distribution method, helping ensure continued operation if one agent becomes unavailable.