DS_GROUPS.csv
The DS_GROUPS.csv file contains information necessary to create and maintain groups in xMatters. All groups created and updated via EPIC are on-call groups; you can only create or modify broadcast groups using the web user interface or the xMatters REST API.
|
Column Name |
Maximum Character Length |
Comments |
|---|---|---|
|
EXTERNAL_KEY |
250 |
See Standard CSV Fields. |
|
GROUP_NAME |
100 |
Target name that outside systems use to identify this group. Values in this column must not match any USER_ID value in the ds_users table. |
|
DESCRIPTION (optional) |
200 |
Description of the group. This value is specified on the group details page in the xMatters web user interface. |
|
STATUS |
30 |
Indicates whether this group is active or inactive (ACTIVE or INACTIVE; case-sensitive). This value is specified on the group details page in the xMatters web user interface. |
|
USE_DEFAULT_DEVICES |
1 |
Specifies whether to use failsafe (default) devices (Y or N). Failsafe devices may be contacted outside of their active timeframes when the user is targeted as part of a group and has no other active devices. |
|
TIMEZONE |
100 |
Name of the time zone for this group (case-sensitive; see below for valid values). The xMatters super administrator specifies in the web user interface which time zones are available (Admin > Time Zones). |
|
GROUP_SITE_NAME (optional) |
100 |
SITENAME value from the DS_SITES.csv file for the site the group uses for site holidays. |
|
OBSERVED_BY_ALL (optional) |
1 |
Indicates whether all roles can observe this group (Y or N). If this field is set to Y, values specified in OBSERVER_LIST are ignored. |
|
OBSERVER_LIST (optional) |
2000 |
Comma-separated list of roles that are group observers for this group (case-sensitive). That this list can change depending on the roles specified for a particular company. The <<<NONE>>> token can be used with this field. See Valid field values for valid out-of-the-box values |
|
SUPERVISOR_LIST |
2000 |
Comma-separated list of users (by external key) who are group supervisors for this group (case-sensitive). The <<<NONE>>> token can be used with this field. A NULL value with control of “optional” is equivalent to setting overwrite=”false”. |
|
ALLOW_DUPLICATES |
1 |
Indicates whether to allow duplicate notifications (Y or N). This value is specified on the group details page in the xMatters web user interface. |
|
IS_EXTERNALLY_OWNED |
1 |
See Standard CSV Fields. |
|
ACTION |
1 |
See Standard CSV Fields. |
Valid TIMEZONE Values
Values must include the general area or country, and the specific zone or location within that area, formatted as <Area>/<Location>; for example:
Asia/Hong_Kong
| Area | Locations |
|---|---|
| Asia | Hong_Kong, Seoul, Shanghai, Singapore, Taipei, Tokyo |
| Australia | Melbourne, Perth, Sydney |
| Canada | Atlantic, Central, East-Saskatchewan, Eastern, Mountain, Newfoundland, Pacific, Saskatchewan, Yukon |
| Europe | Amsterdam, Athens, Berlin, Brussels, Budapest, Copenhagen, Dublin, Helsinki, Lisbon, London, Moscow, Oslo, Paris, Prague, Stockholm, Vienna, Warsaw, Zurich |
| GMT | |
| US | Alaska, Aleutian, Arizona, Central, East-Indiana, Eastern, Hawaii, Indiana-Starke, Michigan, Mountain, Pacific, Samoa |