How To: Create Multiple User Accounts using CSV Upload

From Hornbill
Revision as of 22:29, 8 April 2019 by Jamesa (talk | contribs) (→‎Quick Check)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search


This How To looks at the requirements and steps used to create an multiple user accounts using a CSV Upload in Hornbill. When a large number of user accounts need to be created, a CSV file can be a quick and simple way to achieve this. A CSV template is provided which includes some of the standard fields that are required to create a new user account.

Related Articles

Quick Check

Checkbox.png You have the Roles needed to create users
Checkbox.png Know the User ID format to be used
Checkbox.png Are you creating Basic or standard Users
Checkbox.png Know the mandatory fields to create a user
Checkbox.png Know the Roles you need to assign to the Users
Checkbox.png Password Setup

Quick Steps

  1. Open Administration and navigate to System->Organisational Data->Users
  2. From the User List tool bar, select the Upload Users button.
  3. Click on the Download Template File button
  4. Populate the CSV Template File with the users that you wish to upload
  5. Click on the Select CSV File to Upload button
  6. View and check upload results

CSV Template Download

The CSV template consists of the following fields:

  • userId
The User Id should ideally be made up of alphanumeric characters although full stops (.) and underscores (_) are permissible. The User Id plays a key role in the database relationships so once it is created, it is not possible to amend. This is a mandatory field.
  • name
This field will form the "Handle" for the User. This is what will be visible when posting to a Workspace or Request Timeline eg: "Harry Hornbill posted on Workspace Hornbill Collaboration Discussion". In this example, Harry Hornbill would be the Handle. This field can be amended at any time. This is a mandatory field so a value must be provided for the upload. By default, the Handle must be a unique value, however the setting api.xmlmc.uniqueUserHandle.enable can be enabled to allow duplicates.
  • password
The password which the User will use to log on to the Hornbill Platform. This is a mandatory field.
  • firstName
The first name of the User. This is a mandatory field.
  • lastName
The last name of the User. This is a mandatory field.
  • jobTitle
The Users Job Title. This field is optional, and can be left blank.
  • phone
The Users telephone number. This field is optional, and can be left blank.
  • email
The email address of the User.This is a mandatory field.
  • mobile
The mobile number of the User. This field is optional, and can be left blank.
  • role
The Hornbill roles that this User requires to perform their day to day duties within Hornbill should be specified here. All those who will access the Platform require the "Collaboration Role" as a minimum. In addition, if they are a Support Desk Analyst, then they may also require the "Incident Management User" role. When specifying multiple roles in this field they should be separated by a colon (:). e.g. to associate the two roles mentioned here, the contents of the role field will look like: Collaboration Role:Incident Management User. The following wiki page will help provide background to the various Platform and Application Roles available.
  • userType
The User Type is used to specify whether the User will be an Application User (full platform access based on the Subscriptions) or a Basic User (access is restricted to the Hornbill Service Portal). This field should contain either "user" or "basic" which is case-sensitive. If nothing is specified in this field, the User account created will default to that of an Application User.
  • site
While a "Site" column doesn't appear in the downloaded template, the CSV mechanism is aware of this concept. An additional column can be added after "userType" (titled "site") and where a valid site ID is specified the CSV upload mechanism will make the site association successfully to the user. Of course, a list of sites must exist in your instance in order for you to identify and use the appropriate ID which can be found in the URL when viewing a site record. See Sites for more information on importing a list of sites.

Example of a prepared CSV Template


If you plan on using a third party automation tool to generate the CSV, the letter case of the field headings is important. The CSV upload function is expecting the field headings in the following order and format:

userId, name, password, firstName, lastName, jobTitle, phone, email, mobile, role, userType. If the headings are in any other form, out of sequence, or missing, the Upload will be unsuccessful.

CSV Upload

The result of a successful upload is shown below:

Example of a prepared CSV Template