Difference between revisions of "Create Multiple User Accounts using CSV Upload"
Jump to navigation
Jump to search
| (19 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| + | This document can now be found at its new location in the [https://docs.hornbill.com/esp-config/organizational-data/user-accounts/csv-user-import Hornbill Document Library]. | ||
| + | |||
| + | [[file:hornbill-document-library.png|Creating Multiple User Accounts using CSV Upload|link=https://docs.hornbill.com/esp-config/organizational-data/user-accounts/csv-user-import]] | ||
| + | <!-- | ||
| + | |||
{{DISPLAYTITLE:'''''How To''''': Create Multiple User Accounts using CSV Upload}} | {{DISPLAYTITLE:'''''How To''''': Create Multiple User Accounts using CSV Upload}} | ||
<div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;"> | <div style="border:1px solid #90C0FF; background:#D0E0FF; width:99%; padding:4px; margin-bottom:10px;"> | ||
| Line 11: | Line 16: | ||
|style="width:73%"| | |style="width:73%"| | ||
== Introduction == | == Introduction == | ||
| − | This ''How To'' looks at the requirements and steps used to create an multiple user accounts using a CSV Upload in Hornbill | + | 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. |
|style="width:5%"| | |style="width:5%"| | ||
| Line 24: | Line 29: | ||
== Quick Check == | == Quick Check == | ||
| − | :[[File:checkbox.png|8px|baseline|link=]] Roles needed to create users | + | :[[File:checkbox.png|8px|baseline|link=]] You have the Roles needed to create users |
| − | :[[File:checkbox.png|8px|baseline|link=]] User ID | + | :[[File:checkbox.png|8px|baseline|link=]] Know the User ID format to be used |
| − | :[[File:checkbox.png|8px|baseline|link=]] Basic or standard | + | :[[File:checkbox.png|8px|baseline|link=]] Are you creating Basic or standard Users |
| − | :[[File:checkbox.png|8px|baseline|link=]] | + | :[[File:checkbox.png|8px|baseline|link=]] Know the mandatory fields to create a user |
| − | :[[File:checkbox.png|8px|baseline|link=]] | + | :[[File:checkbox.png|8px|baseline|link=]] Know the Roles you need to assign to the Users |
:[[File:checkbox.png|8px|baseline|link=]] Password Setup | :[[File:checkbox.png|8px|baseline|link=]] Password Setup | ||
<br> | <br> | ||
| − | + | == Quick Steps == | |
| − | + | # Open Administration and navigate to ''System->Organisational Data->Users'' | |
| − | + | # From the User List tool bar, select the ''Upload Users'' button. | |
| − | + | # Click on the ''Download Template File'' button | |
| − | + | # Populate the CSV Template File with the users that you wish to upload | |
| − | + | # Click on the ''Select CSV File to Upload'' button | |
| − | + | # View and check upload results | |
| − | < | + | <br> |
| − | == CSV Template == | + | == CSV Template Download == |
The CSV template consists of the following fields: | The CSV template consists of the following fields: | ||
| − | :* '''userId''' | + | :* '''userId''' |
| − | :* '''name''' | + | :: 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''' | :* '''password''' | ||
:: The password which the User will use to log on to the Hornbill Platform. This is a mandatory field. | :: The password which the User will use to log on to the Hornbill Platform. This is a mandatory field. | ||
| Line 68: | Line 75: | ||
[[File:User Upload Template.PNG|1000px|center|Example of a prepared CSV Template]] | [[File:User Upload Template.PNG|1000px|center|Example of a prepared CSV Template]] | ||
<br> | <br> | ||
| − | If you plan on using a third party automation tool to generate the CSV, the case of the field headings is important. The CSV upload function is expecting the field headings in the following order and format: | + | |
| + | <blockquote style="background-color: #f2f2f2; border: solid thin #ffdab3;padding-top: 10px; padding-right: 10px; padding-bottom: 10px; padding-left: 10px;"> | ||
| + | [[File:Information.png|24px|left|link=|Information]] 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. | '''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. | ||
| + | </blockquote> | ||
| + | |||
<br> | <br> | ||
<br> | <br> | ||
| + | |||
| + | == CSV Upload == | ||
The result of a successful upload is shown below: | The result of a successful upload is shown below: | ||
[[File:User Upload Success.PNG|1000px|center|Example of a prepared CSV Template]] | [[File:User Upload Success.PNG|1000px|center|Example of a prepared CSV Template]] | ||
<br> | <br> | ||
| + | --> | ||
| + | [[Category:HDOC]] | ||
Latest revision as of 22:17, 15 April 2024
This document can now be found at its new location in the Hornbill Document Library.
