Formatting spreadsheets

The Import Data feature loads data into xMatters from Microsoft® Office Excel 2003 XML spreadsheets. To load correctly, each spreadsheet must have a consistent, specific format, as outlined in the following tables.

Persons Sheet

The following table explains the columns and fields on the Persons sheet in the spreadsheet.

Column

Description

UserID

The User ID for the User you want to add. All entries in this row apply to this User ID.

Operation

Specifies whether you want to Add this Item or Remove this Item. The default is to add the User.

FirstName

First name of the new User.

LastName

Last name of the new User.

Authentication

To indicate the authentication to use for this User, select one of the following options:

  • Native: uses standard xMatters authentication for this User.
  • LDAP: uses the User’s Web Login ID to authenticate against the LDAP servers.

WebLoginID

The Web Login ID to assign to this User. If not specified, xMatters assigns a default Login ID using the User’s first and last names in lower case and separated by a period (i.e., “firstname.lastname”).

WebLoginPwd

The Web Login Password to assign to this User. If not assigned, xMatters assigns the User ID for this User as a default web password.

Note that this field displays the password in clear text, but the Import Data feature stores an encrypted version in the database.

LDAPDomain

If required, the name of the LDAP domain to authenticate for this User. For more information about naming LDAP domains, see LDAP Servers.

PhoneLoginID

The Phone Login ID to assign to this User. The contents of this field must be all integers, or the Import Data operation will return an error.

If no value is specified, the phone credential for this User is not created, and the contents of the PhoneLoginPwd field are ignored.

PhoneLoginPwd

The Phone Login Password to assign to this User. The contents of this field must be all integers, or the Import Data operation will return an error.

If no password is specified, xMatters assigns the PhoneLoginID for this User as a default phone password.

Site

The Site to which the new User should be assigned. The choices available in this drop-down list are based on the Sites column on the Admin sheet.

Role

The User’s primary Role. The choices available in this drop-down list are based on the Roles column on the Admin sheet.

DeviceName1-5

The name of each Device you want to add for this User. The choices available in these drop-down lists are based on the Devices column on the Admin sheet.

Note that all Devices are added with a default 24x7 Timeframe, and you can add up to five Devices for each User.

ServiceProvider1-5

The Service Providers for each new Device you want to add. The choices available in these drop-down lists are based on the Service Providers column on the Admin sheet.

Note that in the example spreadsheet, “Phone Engine” should be used for Voice Phone Devices; either “MAPI EMail” or “SMTP Email” should be used for Email Devices.

DeviceAddress1-5

The address or phone number for each new Device.

Note: The format for phone number is the area code in brackets, followed by the phone number. For example:

(925) 2260300
 

Extensions and other details, such as country codes, must be entered using the xMatters web user interface.

Groups Sheet

The following table explains the columns and fields on the Groups sheet in the spreadsheet.

Column Description

GroupName

The name of the new Group. All entries in this row apply to this Group. Note that all Groups are created with a default 24x7 Coverage.

Description

An optional, brief description for this Group.

Timezone

The time zone to assign to this Group. The choices available in this drop-down list are based on the Timezones column on the Admin sheet.

Operation

Specifies whether you want to Add this Item or Remove this Item. The default is to add the Group.

GroupMembers Sheet

The following table explains the columns and fields on the GroupMembers sheet in the spreadsheet.

Column Description

GroupName

The name of a Group to which you want to assign a User. The choices in this drop-down list are based on the GroupName column on the Groups sheet.

UserID

The User you want to add to the Group. The choices in this drop-down list are based on the TargetID column of the Persons sheet.

Admin Sheet

The following table explains the columns and fields on the Admin sheet in the spreadsheet.

Column Description

Sites

The entries in this column determine the choices available in the Site drop-down list for each User entered on the Persons sheet.

Roles

The entries in this column determine the choices available in the Role drop-down list for each User entered on the Persons sheet.

Devices

The entries in this column determine the choices available in the DeviceName drop-down lists for each User entered on the Persons sheet.

Timezones

The entries in this column determine the choices available in the Timezone drop-down list for each Group entered on the Groups page.

Service Providers

The entries in this column determine the choices available in the ServiceProviders drop-down list for each User entered on the Persons sheet.

Note: The information on the Admin sheet is not imported into xMatters. The information on the Admin sheet is used only to populate the fields and drop-down lists on the first three sheets.

Spreadsheet template

xMatters includes a pre-formatted Excel 2003 XML spreadsheet you can use as a template when entering your data. The template is named DataLoad_Example.xml, and is stored by default in the <xMHOME>\webserver\examples subfolder of your xMatters installation folder.