|
|
| (30 intermediate revisions by 3 users 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/about-user-accounts/ Hornbill Document Library]. |
| | + | |
| | + | [[file:hornbill-document-library.png|Hornbill Cloud|link=https://docs.hornbill.com/esp-config/organizational-data/user-accounts/about-user-accounts/]] |
| | + | <!-- |
| | + | |
| | <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;"> |
| | __NOTOC__ | | __NOTOC__ |
| | {| style="width:100%" | | {| style="width:100%" |
| − | |[[Main_Page|Home]] > [[Administration]] > [[System Administration|System]] > [[Organisational Data]] > Users | + | |[[Main Page|Home]] > [[Configuration]] > [[Platform Configuration]] > Users |
| − | |style="text-align:right;"|[[:Category:Administration|Index]] | + | |style="text-align:right;"|[[:Category:Configuration|Index]] |
| | |} | | |} |
| | </div> | | </div> |
| Line 11: |
Line 16: |
| | | | |
| | ==Introduction== | | ==Introduction== |
| − | The Users area within Administration is used to manually create and manage Hornbill User Accounts. Hornbill User Accounts are generally used for people that are internal to your organization who wish to interact within Hornbill, either by using the main Hornbill client or within the Service Portal. The User Management includes the creation of user accounts, profile information, security settings, and regional settings.
| + | Hornbill user accounts are used for people that are internal to your organization who wish to interact within Hornbill, either by using one of the applications or to request service via the [[Employee Portal]] (self-service). User Management includes the creation, archiving, suspending, and deletion of user accounts. |
| | + | <br> |
| | + | <br> |
| | + | User accounts are created and managed via '''Configuration > Platform Configuration''' under the section '''User & Guest Access'''. To create and manage user accounts your user must be assigned the "'''Admin Role'''" security role. |
| | |style="width:5%"| | | |style="width:5%"| |
| | | | | | |
| Line 21: |
Line 29: |
| | :* [[Sites]] | | :* [[Sites]] |
| | :* [[Organisation|Organisation Structure (Groups)]] | | :* [[Organisation|Organisation Structure (Groups)]] |
| | + | :* [[Select the Best Method to Create Users]] |
| | |} | | |} |
| | | | |
| | == User List == | | == User List == |
| − | {{#ev:youtube|3CnIOTnWMYk|320|right}}
| + | [[File:Configurationuserlist.PNG|400px|thumb|<div align="center">The User accounts list can be found under Platform Configuration</div>]] |
| − | Filters | + | '''Filters''' |
| | + | <br>Several filters are available at the top left of the user list: |
| | :* '''Search for User''' | | :* '''Search for User''' |
| | :: Begin typing to filter the list of user accounts. The filter operates on User id, handle, first name, last name. | | :: Begin typing to filter the list of user accounts. The filter operates on User id, handle, first name, last name. |
| | :* '''User Account Type''' | | :* '''User Account Type''' |
| − | :: Select to view Application User accounts only, Basic User accounts only, or All User accounts. | + | :: Select to view ''Full'' User accounts only, ''Basic'' User accounts only, or ''All'' User accounts. |
| | :* '''User Account Status''' | | :* '''User Account Status''' |
| | :: Filter the list to see which accounts are Active, Suspended, or Archived. | | :: Filter the list to see which accounts are Active, Suspended, or Archived. |
| | <br> | | <br> |
| − | Action Buttons to manage the user accounts | + | '''Action Buttons''' |
| − | :* '''Create New Users''' | + | <br>These can be found at the top right of the list and are used to manage the user accounts. Where applicable, multiple user accounts can be acted upon when using the checkbox against each user account in the list. |
| − | :: Manually create individual user accounts | + | :* [[File:createnewuserbutton.png|150px|link=]] '''Create New Users''' |
| − | :* '''Reactivate Users''' | + | :: Manually create individual user accounts. If [[User Templates]] have been created, an additional drop-down selector will be available to select a user template when creating a new user. |
| | + | :* [[File:csvuploadusersbutton.png |35px|link=]] '''Upload Users''' |
| | + | :: The Upload option provides a way to create multiple accounts using a CSV file. This is useful for small, one time imports. Other import options include the Hornbill [[LDAP User Import]] and Auto-provisioning. |
| | + | :* [[File:deleteuserbutton.png |35px|link=]] '''Delete Users''' |
| | + | :: Deleting a user completely removes the account from Hornbill and cannot be reversed. Deleting a user should only be used when the user has not had any interaction in Hornbill. This can be used to remove accounts that have been mistakenly added or uploaded. This option is only available when the user who performs the deletion has allocated the Super User Role. |
| | + | :* [[File:reactivateuserbutton.png|35px|link=]] '''Reactivate Users''' |
| | :: When one or more users have been suspended or archived, you can select these users from the list and reactivate them. | | :: When one or more users have been suspended or archived, you can select these users from the list and reactivate them. |
| − | :* '''Suspend Users''' | + | :* [[File:suspenduserbutton.png|35px|link=]] '''Suspend Users''' |
| | :: The suspension of a user prevents the account from logging on to Hornbill. Other Hornbill users will be able to continue to interact with a suspended account. Suspended users can be reactivated. A user can be automatically suspended by providing too many incorrect passwords at login. | | :: The suspension of a user prevents the account from logging on to Hornbill. Other Hornbill users will be able to continue to interact with a suspended account. Suspended users can be reactivated. A user can be automatically suspended by providing too many incorrect passwords at login. |
| − | :* [[File:archiveuserbutton.png |25px]] '''Archive Users''' | + | :* [[File:archiveuserbutton.png |35px|link=]] '''Archive Users''' |
| | :: Archiving a user prevents the account from logging on to Hornbill and will also prevent other users from interacting with this account. Historic contributions within the collaboration features will be intact and visible, but they will no long be available as a co-worker. This is the recommended option for when someone leaves. Archived users can be reactivated. | | :: Archiving a user prevents the account from logging on to Hornbill and will also prevent other users from interacting with this account. Historic contributions within the collaboration features will be intact and visible, but they will no long be available as a co-worker. This is the recommended option for when someone leaves. Archived users can be reactivated. |
| − | :* [[File:deleteuserbutton.png |25px]] '''Delete Users'''
| |
| − | :: Deleting a user completely removes the account from Hornbill and cannot be reversed. Deleting a user should only be used when the user has not had any interaction in Hornbill. This can be used to remove accounts that have been mistakenly added or uploaded, and they have never logged on to Hornbill.
| |
| − | :* [[File:csvuploadusersbutton.png |25px]] '''Upload Users'''
| |
| − | :: The Upload option provides a way to create multiple accounts using a CSV file. This is useful for small, one time imports. Other import options include the Hornbill [[LDAP User Import]] and Auto-provisioning.
| |
| | <br> | | <br> |
| | | | |
| | == Account Types == | | == Account Types == |
| − | Users are categorized into two account types, Users and Basic Users. Users are used for full access to Hornbill Collaboration and the different available apps and require a license to login. Basic Users are used for Service Portal access only and are license free. Basic Users are included as co-workers within Hornbill and can be referenced within the different Hornbill Apps. | + | Users are categorized into two account types, Full Users and Basic Users. Full User type accounts are used for full access to Hornbill Collaboration and the different available apps and require a subscription to login. Basic Users accounts are used for [[Employee Portal]] access only and are subscription free. The term "[[Co-Workers]]" is used to collectively describe Users and Basic user accounts. The term Co-Worker is used outside of Hornbill Configuration. |
| | <br> | | <br> |
| | <br> | | <br> |
| − | :* '''Application Users''' | + | :* '''Application (Full) Users''' |
| − | :: Users are those that can have access to the entire suite of Collaborative features and Business Applications you have installed on the Hornbill Platform. The level of access to each of the applications is controlled by the Roles that are associated to these User accounts. The number of Application User accounts is governed by your paid for Subscriptions. You will be allowed to create Application user accounts as long as you have enough subscriptions available. | + | :: Full Users are those that can have access to the entire suite of Collaborative features and Business Applications you have installed on the Hornbill Platform. The level of access to each of the applications is controlled by the [[Roles]] that are associated to these User accounts. The number of Application User accounts is governed by your paid for Subscriptions. You will be allowed to create Application user accounts as long as you have enough subscriptions available. |
| | <br> | | <br> |
| | :* '''Basic Users''' | | :* '''Basic Users''' |
| − | :: Basic Users are people that are internal to your Organisation that will consume the content and Services that your Application Users deliver via the Hornbill Applications. Basic Users are restricted to accessing this content and services via the '''Hornbill Service Portal'''. As such, Basic Users do not require a Subscription, and the number allowed is unlimited. | + | :: Basic Users are people that are internal to your Organisation that will consume the content and Services that your Application Users deliver via the Hornbill Applications. Basic Users are restricted to accessing this content and services via the [[Employee Portal]]. The content that a Basic User can access is controlled by the [[Roles]] that are associated to these user accounts. Basic Users do not require a Subscription, and the number allowed is unlimited. |
| − | <br>
| |
| − | | |
| − | <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]] When creating a User account in any of the ways outlined below, you will be asked to specify the User Type. If in future you wish to promote a Basic User account to an Application User account in order for them to take advantage of the Collaborative features and other Business Apps, this can be done quickly and easily by changing the user type when viewing the user record. | |
| − | </blockquote>
| |
| − | <br>
| |
| − | <br>
| |
| − | | |
| − | == User Account Management Overview ==
| |
| − | | |
| − | User Accounts are created and managed via Hornbill Administration. To Create more Users, you will need to ensure your User account has the following roles associated:
| |
| − | :* '''Admin Role'''
| |
| − | :: This role provides administrative functionality to the collaboration core and should only be granted to an administrator.
| |
| − | | |
| − | To view the details of a specific User Account, click the Login ID. The symbol along side indicates the status of the account. Hovering your cursor over the Login ID will display a tool-tip showing the current status of the account.
| |
| − | <br>
| |
| − | | |
| − | == Creating User Accounts ==
| |
| − | There are a number of ways in which User accounts can be created in Hornbill and details can be found in the sections below. When creating User accounts you will be required to associate appropriate roles in order to provide access to Application features and functionality. Information on roles can be found [[Roles|'''here''']].
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Creating an Individual User Account===
| |
| − | <div class="mw-collapsible-content">
| |
| − | <ol>
| |
| − | <li>Click on ''Create New User'' located at the top right of the list</li>
| |
| − | <li>Supply the mandatory information in ''Basic Information''</li>
| |
| − | <li>Change any regional settings as required</li>
| |
| − | <li>Under ''Security settings'' select the appropriate roles for that user</li>
| |
| − | <li>Click on 'Create User''</li>
| |
| − | </ol>
| |
| − | <br>
| |
| − | </div>
| |
| − | </div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Creating Multiple User Accounts via CSV Upload===
| |
| − | <div class="mw-collapsible-content">
| |
| − | 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.
| |
| − | <ol>
| |
| − | <li>From the User list menu, select ''Upload Users'' action from the Account Management Actions drop down menu.</li>
| |
| − | <li>Click on the ''Download Template File'' button</li>
| |
| − | <li>Populate the CSV Template File with the users that you wish to upload</li>
| |
| − | <li>Click on the ''Select CSV File to Upload'' button</li>
| |
| − | <li>View and check upload results</li>
| |
| − | </ol>
| |
| − | | |
| − | 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.
| |
| − | :* '''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 [[Roles|'''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|'''Sites''']] for more information on importing a list of sites.
| |
| − | <br>
| |
| − | [[File:User Upload Template.PNG|1000px|center|Example of a prepared CSV Template]]
| |
| − | <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:
| |
| − | '''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.
| |
| − | <br>
| |
| − | <br>
| |
| − | The result of a successful upload is shown below:
| |
| − | [[File:User Upload Success.PNG|1000px|center|Example of a prepared CSV Template]]
| |
| − | <br>
| |
| − | </div>
| |
| − | </div>
| |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | | |
| − | ===Auto Provisioning via SSO===
| |
| − | <div class="mw-collapsible-content">
| |
| − | In a Collaboration only environment this is a very effective approach. The creation of user accounts can be automated as part of the Single Sign-on (SSO) configuration meaning no physical import is required if SAML is available. Your users are self-provisioned automatically when they first navigate to your Hornbill instance.
| |
| − | | |
| − | :# Create User Template
| |
| − | :# Configure Single Sign-on
| |
| − | :# Define Auto Provisioning settings
| |
| − | | |
| − | Information regarding the configuration of Hornbill for use with Single Sign On can be found here: [[Single Sign On with SAML 2.0|'''Single Sign On with SAML 2.0''']]
| |
| − | </div>
| |
| − | </div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | ===Hornbill User Import Utilities===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Application User and Basic User accounts can be created based on the content of another data source such as your Directory Service or an MSSQL database using one of [[Hornbill_Open_Integration_Tools|'''Hornbill's Open integration Utilities''']]. A user import utility is the preferred choice for an implementation involving Service Manager. All Hornbill user import utilities can be scheduled to create new, and update existing, end user accounts.
| |
| − | </div>
| |
| − | </div>
| |
| − | | |
| − | <div class="mw-collapsible mw-collapsed" data-collapsetext="Show Less" data-expandtext="Read More" style="width:1050px">
| |
| − | | |
| − | ===What Method of User Account Creation Should I use?===
| |
| − | <div class="mw-collapsible-content">
| |
| − | Hornbill offers a range of mechanisms that can be used to create user accounts. The one that is right for you will typically depend on the size of your organisation and staff turnover. Below you will find some frequently asked questions in relation to the import mechanisms that were outlined above.
| |
| | <br> | | <br> |
| − | ====When is an account created?====
| |
| − | '''CSV Upload:''' A user account is created when the upload is initiated via Hornbill Administration.
| |
| − |
| |
| − | '''Auto-Provisioning:''' A user account is created when a user navigates to live.hornbill.com/[your_instance_name]/ or service.hornbill.com/[your_instance_name]/ for the first time.
| |
| | | | |
| − | '''Import Utility:''' A user account is created at the time the chosen utility is scheduled to run. All the Hornbill utilities are scheduled using windows task scheduler. The time the utility is scheduled is dependent on your organisations requirements (i.e. when you need user accounts to be available in Hornbill).
| + | {{infobox|When creating a User account you will be asked to specify the User Type. If in future you wish to promote a Basic User account to a Full Application User account in order for them to take advantage of the Collaborative features and other Business Apps, this can be done quickly and easily by changing the user type when viewing the user record.}} |
| | <br> | | <br> |
| − | <br>
| |
| − | ====What Information is used when creating the account?====
| |
| − | '''CSV Upload:''' The account is created using the contents of the CSV template selected.
| |
| − |
| |
| − | '''Auto-Provisioning:''' The account is created based on the contents of your directory services transported through the attributes specified in the outgoing claim of your Identity Provider. The directory attribute-to-Hornbill mappings are stored in the Hornbill SSO Profile.
| |
| − |
| |
| − | '''Import Utility:''' The account is created based on the contents of your directory services transported via the import utility. The directory attribute to Hornbill mappings are stored in the conf.json file.
| |
| − | <br>
| |
| − | <br>
| |
| − |
| |
| − | ====Do all methods update existing Hornbill user accounts when user information changes?====
| |
| − | '''CSV Upload:''' No. The CSV upload is designed only for the creation of new accounts. It is not capable of updating existing user accounts.
| |
| − |
| |
| − | '''Auto-Provisioning:''' Yes. Updates to existing user accounts are supported via auto-provisioning.
| |
| − |
| |
| − | '''Import Utility:''' Yes. Updates to existing user accounts are supported by all the user import utilities.
| |
| − | <br>
| |
| − | <br>
| |
| − | ====Is there a difference in the user account information that can be maintained by each method?====
| |
| − | Auto-provisioning does not maintain department (Group) associations and the site associations are limited to a single site specified in the Auto-Provisioning template. Only a single user template can be used in conjunction with a Hornbill Security profile (Single sign on configuration).
| |
| − |
| |
| − | The import utilities have the ability to maintain a greater range of user account properties. They also have the ability to make associations between user accounts and site records and also department (group) membership based on the contents that exist in your directory services.
| |
| − | <br>
| |
| − | </div>
| |
| − | </div>
| |
| | | | |
| − | [[Category:Administration]] | + | [[Category:Configuration]] |
| | + | --> |
