xMatters 5.x (Premises) Documentation

This page contains links to downloadable versions of all of the xMatters 5.x documentation, updated to xMatters version 5.1 patch 012.

Note that the following guides and other documentation are intended for use with the PREMISES version of xMatters. If you're looking for xMatters On-Demand (our hosted solution) documentation, you can find that here

Release Notes

Release notes for our latest patch are:

xMatters installation and administration guide

xm5112_installadmin_guide.pdf: This guide covers installing and using the xMatters relevance engine as an Administrator. It also includes licensing, Node and Device Engine configuration, system administration and reporting information.

The updated guide also includes current information on the xMatters Data Migration tool.

xMatters user guide

xm5112_user_guide.pdf: This guide provides an introduction to the xMatters relevance engine for end users, supervisors, and administrators. Includes instructions for using the web user interface, dealing with alerts, and managing groups.

xMatters Integration Agent guide

xmia5181_integrationagent_guide.pdf: This guide includes installation and configuration instructions for the xMatters Integration Agent, updated to Integration Agent version 5.1 patch 8.1. The 5.1 version of the Integration Agent is compatible with xMatters 5.x  and xMatters On-Demand.

NOTE: If you are using an older, on-premise version of xMatters, please contact your Client Success Manager to obtain the correct version of the Integration Agent.

xMatters mobile access guide

xm5112_mobileaccess_guide.pdf: This guide provides an introduction to the xMatters mobile access component, and includes configuration and administration instructions.

xMatters Online Developers Guide

The xMatters Online Developer's Guide covers the xMatters scripting language (Action Script) and includes a full scripting reference. It also includes instructions for using the xMatters Developer IDE, subscription and messaging APIs, custom panels, and web services.

Note: As of xMatters 4.1 patch 014 and xMatters 5.0 patch 006, the Online Developer's Guide is no longer published as separate versions. Instead, the 4.0, 4.1, 5.0 and xMatters On-Demand versions have been consolidated into a single resource. Where applicable, script methods, web services, and feature changes are identified with the first patch release in which they became available.

You can view the xMatters Online Developers Guide at the following link:
https://help.xmatters.com/devguide/index.htm

xMatters enterprise pre-installation overview

xm5112_ent_preinstall.pdf: The purpose of this document is to help you prepare for an xMatters enterprise-level deployment. However, it is not meant to replace the more detailed information contained in the xMatters installation and administration guide.

 

Have more questions? Submit a request

9 Comments

  • 0
    Avatar
    David Dietz

    The Installadmin pdf download is broken.

  • 0
    Avatar
    Cameron Stewart

    Right you are, David. Thanks v. much for pointing that out. I'll have my team update the file, test it, and then I'll commence the floggings. I used to do the floggings first, but that really didn't put the customer first. We'll post a comment here when it's fixed.

  • 0
    Avatar
    Don Clark

    I've replaced the PDF with one that actually, you know, works.

  • 0
    Avatar
    Don Clark

    I just updated the integration agent guide to 5.1 patch 004, which includes a new section: Creating relevance engine events using the integration agent. It's exciting stuff!

  • 0
    Avatar
    Maxim Ozhogin

    Thank you for the new documentation of xMatters. Better if "version 5.1 patch 004" that we see in the properties of files will be included in the file names like "xm510p4_installadmin_guide.pdf". Because we have now many different files with same name like "xm510_installadmin_guide.pdf" but really different and that situation make me confusion.

  • 0
    Avatar
    Don Clark

    Updated the integration agent guide for the new integration agent 5.1 patch 5 - and renamed the file to include the patch number. Thanks for the suggestion, Maxim!

  • 0
    Avatar
    Don Clark

    Uploaded new manuals for 5.1 patch 006. Enjoy!

  • 0
    Avatar
    Don Clark

    Uploaded new manuals for 5.1 patch 007 (and integration agent 5.1.5).

  • 0
    Avatar
    Don Clark
    Uploaded new manuals for 5.1 patch 8.
Article is closed for comments.
Powered by Zendesk