Users file format
Each row in the users.csv file should contain:
Name | Data Type | Optional | Description |
---|---|---|---|
UUID | String | No | The record’s universal unique identifier |
Username | String | No | Login or user ID |
String | Yes | Email address (primary) | |
Description | String | Yes | Description |
UUID | String | Yes | UUID of the current user’s manager |
memberOf | List of UUID | Yes | UUIDs of which this group is a member (can be empty) |
Zero or more “additional attributes” fields | String | Yes | See “Additional Attributes” below |
User records can also have additional attributes in the form of name value pairs. Some of these attributes have predefined names (see below). A file containing an additional attribute should be defined as a regular expression of the following format:
[aA][tT][tT][rR]:(.+)/=/(.+)
Any name can be used for custom attributes. The attributes are stored as an associated array on the user object, and are used only for display. Examples include:
- wbsn_nt_domain - to display domain name and configure the user-based exclusion
- wbsn_login_name - the user login name (principal name on Windows-based systems) and to configure user-based exclusion
- wbsn_full_name - the user’s display name and incident’s manager display name
- wbsn_manager_dn - used to identify the source’s manager in the Incident Properties. However, to display the manager’s name, wbsn_full_name is required.
- wbsn_proxy_address - secondary (alternative) email address
- wbsn_department - department
- wbsn_telephone_number - the user’s telephone number
- wbsn_title - the user’s title
- wbsn_mailbox_store - the server on which the user’s Exchange mailbox is stored
The table below illustrates some attributes:
String | Name | Value |
---|---|---|
attr:wbsn_title/=/Manager | wbsn_title | Manager |
aTTr:my amazing attr/=/the value | my amazing attr | the value |
“ATTR:name/=/value1,value2” | name | value1,value2 |
For example:
0649fjef-c5be-3fa5-b3c4-267fa026f04f,TESTUSER,TESTUSER@TESTDOMAIN.com,Marketing,C7517900-3d9c-3ag9-a04c-bf71ce57af87,6db154cc-201c-44b1-b6c2-a4a2ad778335,attr:wbsn_nt_domain/=/TESTDOMAIN,attr:wbsn_login_name/=/TESTUSER,attr:wbsn_full_name/=/TEST USER,attr:wbsn_manager_dn/=/ C7517900-3d9c-3ag9-a04c-bf71ce57af87
6278ab76-2ce2-4f16-8e49-aa5104da7d0b, jdoe-mgr, jdoe.manager@example.com,CEO,7c9d4db6-1737-4b80-9e6e- 42f415300a05,attr:room/=/201,attr:parkingSpace/=/1
ff255105-4e43-4e9a-b2bd-e366872cd212, jdoe, jdoe@example.com, administrator, 6278ab76-2ce2-4f16-8e49- aa5104da7d0b,"08b3b46b-3631-46cb-adc7-176c2871e94c;7c9d4db6- 1737-4b80-9e6e-42f415300a05",attr:room/=/101
Ensure that every entry in the CSV follows the same attribute order as defined in the first line (header).