Companies

Companies represent the highest level of organization in xMatters. As an xMatters super administrator, you can create, modify, and manage Companies through the xMatters web user interface.

In a multiple-Company deployment, some system components are common to the xMatters infrastructure and controllable only by the Super Administrator. These components are not Company-specific, and include Nodes, Device Engines, Protocol Providers, and Clusters. Other features viewable only by the Super Administrator include Component Status Reports, Scheduled Jobs, and Clear Runtime History. Where appropriate, this document identifies whether components are Company-specific in the section introducing and describing each component.

In an xMatters deployment with multiple Companies, each xMatters Java Client <agent_client_id> must be unique across the deployment (i.e., not just unique across a Company), because agent client IDs are not qualified by Company. This restriction is the responsibility of the host Company, and is not enforced by the xMatters application. If this restriction is violated, external service requests and messages may not be routed properly.

Note: The number of Companies available in an xMatters deployment is controlled by your licenses.
To view and manage the Companies list:
  1. On the Company menu, click Companies.
    1. xMatters displays a list of the Companies currently in the system.
  1. From the Current Companies list, do any of the following:
    1. To modify an existing Company, click the name of the Company in the list to view its Company Details. For more information about editing Company Details, see the following section, Defining Company details.
    2. To remove a Company from the list, select the check box next to the Company or Companies you want to remove, and then click Remove Selected. For more information, see Companies.
    3. To create a new Company, click the Add New link, and specify the Company details for the new Company, as explained in the Company Details settings table below. Click Save to create the Company.
Note: When you add a new Company to a multiple-Company deployment, xMatters automatically creates the default out-of-box Event Domains, script packages, Sites, and other required settings for the new Company.

Users, Groups, and Teams in Multiple-Company Deployments

In multiple-Company xMatters deployments, all Users, Groups, Teams, Team templates, and Dynamic Teams are Company-specific. However, identifiers are only unique within a Company, not across the entire deployment.

For example, each User within a Company must have a unique User ID, but a User in one Company might have the same User ID as a User within another Company in the same deployment.

Defining Company details

You can define the details for each Company using the Company Details page.

To modify Company details:
  1. On the Companies page, in the Current Companies table, click the name of the Company you want to modify.
  2. On the Company Details page, enter the following information into the form:
Company Details settings

Setting

Description

State

Specifies the current state of the Company and controls access; select one of the following options:

  • Active
  • Test
  • Maintenance
  • Assigned
  • Terminated

For more information about these options, see "Company States".

Name

Name of the Company.

Note that if you rename a Company, you must also update the companyName parameter in the signOn.jsp file, as described in Creating Company Login Pages.

If you are using the mobile gateway component, you must also update the mobile gatewaylogin.jsp file for the Company; refer to the xMatters Mobile Gateway Guide for more information.

Description

Description of the Company.

Call In Number

Specifies the Company’s call-in number. This number appears in notifications as the number Users should call when responding to notifications or calling in to check for Alerts.

Allow Single Sign On

When selected, permits Users accessing xMatters through an authorized portal to bypass the xMatters Sign In screen. For more information, see Configuring Single Sign On.

Note that xMatters does not support SSO for multiple-Company deployments.

Clusters

Specifies which Clusters are available for this Company. For more information, see Clusters.

  1. When you are satisfied with the information you have provided, click Save.

Once the Company is created, configure a login page so the Company’s Users can access it via the xMatters web user interface. For more information, see Creating Company Login Pages.

You can also create a Company Administrator, who can then create Sites, and assign Countries, Time Zones, and Languages. For more information, see Company Administrators.

Deleting Companies

When you delete a Company from xMatters, all Company-specific objects (Groups, Users, Events, etc.) and data are also deleted from the database.