5. A list of roles available to the system will be displayed; if you want to edit a role, click the '''pencil icon '''next to the name of the role. To create a new role, click the '''New '''button (+ icon).
:: [[File:Add new role.png|800px|border]]
==Creating a Role==
There are only two fields that need to be defined in order to '''create ''' a role: the name of the role and a narrative description.
:: [[File:New role.png|600px|border]]
==Editing or Creating a Role==To edit a RoleHowever, take the following steps: # Click on [[Roles & Permissions|Roles and Security]] (located on the [[Configuration Menu]] on the left-hand navigation bar)# Click on the hyperlink for User Roles# Click the ''Edit'' button next it is best practice to fill out as many of the role you wish to editfields as possible, or click on the ''New'' button to create a new Rolewith as much explanatory detail as possible. For detailed instructions on creating a role, see the [[Creating User Roles]] page. ==Role Settings==[[Image:EditRoleButtonsNoHeader.png|link=]]<br />The following buttons are displayed at the top of each ''Edit Roles'' page: * '''Back''' - navigates the user back to the list of all User Roles* '''New''' - opens a new Edit Roles page for the creation of a new User Role* '''Menu''' - sets menu permissions for User Role. See [[Menus and Roles]] for further information.* '''Portal''' - see [[Creating a Role Based Portal]] for detailed instructions.* '''Custom Fields''' - see [[Role Based Custom Fields]] for detailed instructions.* '''Reports''' - presents a list of [[reports]] in the system for which access can be granted to the selected Role. See [[Assigning Multiple Reports to a Role]] for further information. The following settings are available on the General tab of the ''Edit Roles'' pagedescribed below: * '''Role Name''' - The unique name of the Role.* '''Caption '''- The name of the role as it appears throughout the system. If you prefer to change the name of a role, changing the caption will accommodate this.* '''Description''' - Narrative description of the role.* '''Role Formula''' - Sets a calculation that is performed whenever a contact record possessing this role is saved. See [[Role Formula]] for instructions.* '''Two Factor Authentication''' - enable Two Factor Authentication if required.* '''Enable Menu Icon''' - Displays a Menu Icon on the right of the screen for this Role.* '''UTA Role Only''' - Role that is only relevant relative to records in a [[UTA|Universal Tracking Application™]]. See [[UTA Role]]s for more information. If selected, the role will not be able to be assigned to a contact's profile, but will be able to be selected as a role when a contact is assigned to a UTA record.* '''Internal User Role Only''' - if set then this role can only be added to Internal users,
{| class="wikitable"
|-
||'''Role Name'''
||The unique name of this user role.
|-
||'''Caption'''
||The caption of this user role; this is the name of the role as it appears throughout the system. If you prefer to change the name of a role, changing the caption will accommodate this.
|-
||'''Description'''
||The narrative description of the role.
|-
||'''Role Formula'''
||The role formula sets a calculation that is performed whenever a contact record possessing this role is saved. See [[Role Formula]] for more information and instructions.
|-
||'''Two Factor Authentication'''
||Enable two factor authentication for this role if required.
|-
||'''Enable Menu Icon'''
||This will display a menu icon on the right of the screen for this role.
|-
||'''Internal User Role Only'''
||If set, then this role can only be added to [[Internal]] users. [[External]] users will not have the option to be associated with this role.
|-
||'''UTA Role Only'''
||This will mean that the created role is relevant only relative to records in a {{UTA}}. See [[UTA Roles]] for more information. If this option is toggled on, then the role created will not be able to be assigned to a contact's profile, but rather will be selected as a role only when that contact is assigned to a UTA record.
|}
: Once you are done filling out the general edit fields for creating a new user role, click the '''Save '''button at the bottom.
When a user is added to a role, the role will be visible on the role list of that user's [[profile]].
: When a user is added to a role, the role will be visible on the role list of that user's [[profile]].
: [[Image:RoleOnProfile.png|link=|750px]]
==See Also==
