xMatters pim

< integrations

This page documents the enPortal integration for xMatters Enterprise.

  • Vendor: xMatters
  • Product: xMatters Enterprise
  • Supported Version(s): 5.0
  • Name of enPortal Integration Package: xmatters.enterprise_v50
  • Required enPortal Version: 4.6.1 and above


The following section documents supported platforms, installation, and configuration of the xMatters Enterprise Product Integration Module on enPortal versions 5.0 and above.

Page Contents

1. Support Matrix

The following Operating System, Database, and Web Browser platforms are supported:


1.1. Operating System

Please see the list of supported Operating Systems on the System Requirements page.


1.2. Database

A special database is not required to implement this integration module. The AppBoard/enPortal database is used to store all configurations related to this integration module.


1.3. Web Browser

Please see the list of supported Web Browsers on the System Requirements page.


2. Installation

Perform the following steps to install the xMatters Enterprise PIM:

  1. Install AppBoard/enPortal as detailed in the Installation documentation
  2. Download the file xmatters.enterprise_v50.jar
  3. Start enPortal and login as an administrator
    1. User Name: administrator
    2. Password: administrator
    3. Domain: System
  4. Under the Advanced tab, select PIMImport
  5. Click the Browse... button
  6. Locate the xMatters Enterprise PIM JAR file in the Open dialog
  7. Click the Start button to extract the files from the PIM .jar archive
  8. Under the Advanced tab, select XMLImport
  9. Click the Start button to load the PIM into the system
  10. Confirm that the following message is displayed: "Import completed; loaded the following file(s): load_xmatters.enterprise_v50.txt"
  11. Under the Advanced tab, select Explore System
  12. Navigate to the /Directory/system/proxy/ folder and locate the “Manage Proxy” channel
  13. Right-click on the “Manage Proxy” channel and select Open to launch the channel
  14. In the Manage Proxy tool, click “Reset All”
  15. Refresh the browser

3. Integration Details

The following sections provide special details for configuring the integration module after installation.


3.1. Channel Types

  • Home - Channel that displays the default Home page for the logged in user, including full navigation controls
  • Groups - Channel that displays the Groups (group management) page for users that have adequate permission. This channel includes full navigation controls.
  • ActiveAlerts - Channel to display the user's current list of active alerts. This list is reached by normally navigating to Alerts -> Active Alerts. Only the Active Alerts content is shown without any navigation controls.
  • PastAlerts - Channel to display a search dialog for past alerts. This page is reached by normally navigating to Alerts -> Past Alerts. Only the Past Alerts content is shown without any navigation controls.
  • QuickMessage - Channel to display only the Send a Quick Message dialog. This dialog is normally reached by navigating to Messaging -> Quick Message.
  • ViewSentMessages - Channel to display only the sent messages search dialog. This dialog is normally reached by navigating to Messaging -> View Sent Messages.
  • Proxy - Channel that is used by the system to display xMatters Enterprise channels


3.2. Configuration

After installing the xMatters Enterprise PIM, perform the following steps to configure access to the host xMatters Enterprise server:

  1. Click on the Applications tab
  2. Right-click on the name "sample" in the row for xmatters.enterprise and select "Modify"
  3. Fill in the items in the Modify Application Wizard dialog:
    1. Select the protocol used to access your xMatters Enterprise server (http or https)
    2. Change the host name from "changeme" to the hostname or ip address that will resolve to your xMatters Enterprise server
    3. Change the port to the port number of your xMatters Enterprise server
    4. Click "Save" to keep your changes
  4. Click on the Integrations tab
  5. In the Explorer, under Packages, expand the xmatters.enterprise_v50 tree and click on the Sample target. Confirm that the information you entered is displayed for your xMatters Enterprise server
  6. Under the Sample target, click on the Home channel. A login prompt should be displayed.
  7. Log in using the same credentials you would use for accessing the xMatters Enterprise application in a browser. Confirm that the xMatters Enterprise Home page is displayed.


3.3. Create Channels

After installing the xMatters Enterprise PIM and configuring access to the host xMatters Enterprise server, perform the following steps to create channels to display xMatters Enterprise content:

  1. Click on the Applications tab
  2. Right-click on the name "sample" in the row for xmatters.enterprise and select a channel type
  3. In the "Channel Name" box, enter the name you want to give to the new channel
  4. For "Channel Type", select "3rd Party Pims"
  5. Click Next
  6. Click Finish
  7. Click on the Integrations tab
  8. In the Explorer, under Packages, expand the xmatters.enterprise_v50 tree and click on the Sample target. Confirm that the new channel is listed along with the other sample channels.


Repeat the above steps to create additional channels. Select a different Channel Type in step 2 to create a different type of channel.


4. xMatters Enterprise Upgrades

4.1. Upgrading from an older version of xMatters Enterprise

Older versions of xMatters Enterprise are not supported by this PIM, so this upgrade path is not supported. It is recommended that you validate the PIM in your xMatters Enterprise environment to confirm that it supports the required functionalities.


4.2. Upgrading xMatters Enterprise to a newer version

Perform the following steps when the xMatters Enterprise server is upgraded to a newer version of xMatters Enterprise:

  1. Check the AppBoard/enPortal PIM online documentation to see if the new xMatters Enterprise version is supported by the existing xmatters.enterprise_v50 PIM.
    1. To test if the new xMatters Enterprise version is supported by the existing PIM that you have installed, perform the following steps:
      1. Click on the Applications tab
      2. Right-click on the row for the old xMatters Enterprise server and select "Modify"
      3. Update the protocol, host, and port to reference the server where the new version of xMatters Enterprise is running
    2. If the new xMatters Enterprise version is not supported by the existing PIM that you have installed, perform the following steps to upgrade the PIM:
      1. Download the new PIM version from the PIM download site
      2. Follow the steps in the Installation section above to install and configure the new PIM version
      3. Re-create all xMatters Enterprise channels to reference the new PIM
      4. [Optional] Perform the steps outlined in the Uninstall section below to remove the old PIM from the system


5. Uninstall

Uninstalling the xmatters.enterprise_v50 PIM will break all of the channels in your AppBoard/enPortal system that reference this integration.

Perform the following steps to uninstall the xmatters.enterprise_v50 PIM:

  1. Click on the Integrations tab
  2. In the Explorer, under Packages, locate the xmatters.enterprise_v50 integration
  3. Right click on the integration name, and select "Delete"
  4. Click "Ok" to confirm that you want to delete the integration package