The xMatters Agent is a service that you install on a local system so that you can process Integration Builder scripts behind your company firewall. This means integrations can access your company's local network resources, enabling them to interact with the file system or communicate with systems that cannot be accessed externally by xMatters.
The xMatters Agent currently supports outbound integration processing. Outbound integrations run when an xMatters trigger occurs, such as when a notification is delivered, the status of an event changes, or a recipient responds to a notification. The xMatters Agent can update internal systems when these triggers occur, for example, by assigning a service desk ticket to the recipient who responds to a notification, closing a ticket when an event is terminated, or by creating a log of xMatters events on the local file system.
If your outbound integration does not need to access resources located behind your company firewall, you do not need to install an xMatters Agent.
The xMatters Agent is designed to replace the Integration Agent with management and integration capabilities that are easier to use. Both the xMatters Agent and the Integration Agent can update customer systems that are located behind a firewall; however, the Integration Agent currently supports some functionality that will be added to the xMatters Agent over time. This functionality includes buffering inbound requests from your system to xMatters, and using Integrated Properties to query information to use in the xMatters user interface. We encourage you to use the xMatters Agent for new integrations.
To get started with the xMatters Agent, first install it on a system behind your company firewall, ensure that it connects to xMatters, and then configure outbound integrations to run on the agent. The customized outbound integration scripts can then access network resources that are located behind your company firewall.
You will need to perform the following steps:
- Check system requirements. Before installing the xMatters Agent, verify that your system meets the minimum requirements.
- See System requirements for more information about the supported systems and their requirements.
- Download and install the xMatters Agent. Install the xMatters Agent from the web user interface.
- See Download and install the xMatters Agent for information about installing the xMatters Agent.
- Verify that the xMatters Agent is connected. Once the xMatters Agent is installed, verify that it can connect to xMatters, and give it a name so you can easily identify it.
- Configure outbound integrations to run on the agent.
- See Outbound integrations for more information about configuring integrations to run on an agent.
The xMatters Agent processes outbound integrations the same way they are processed in the xMatters cloud, with the key difference being that the xMatters Agent is installed behind your company firewall and can use local resources that are not accessible from the xMatters cloud.
The xMatters Agent queues outbound integration jobs and then processes them in order. You can configure multiple xMatters Agents to distribute processing or to co-locate them with the services they need to access.
Use the monitoring endpoints to view the status of an agent, including how many jobs are queued on any particular agent. For more information about using the monitoring endpoints, see Monitor and troubleshoot the xMatters Agent.