User Management

Overview

The User Management module provides administrators access to create, edit, activate, and deactivate the profiles of all the users in their Sugar instance. This module and underlying settings control each individual's login credentials as well as some personalized settings. During the installation process, Sugar creates one system administrator by default. The system administrator can log in and create additional users, in a variety of capacities, to be able to access Sugar and utilize all of the other CRM functionality. In combination with the role and team security, administrators can fully establish a profile for each user in Sugar.

This documentation will cover the administration options which allow you to manage users in your system. For instructions concerning views and actions which are common across most Sugar modules, such as creating, editing, and deleting users, please refer to the Working With Sugar Modules section of this page.

User Types

There are four types of users in Sugar: Regular User, System Administrator, Group User, and Portal API User. Each user type has different functions in Sugar which will vary for each instance. Depending on an organization's use of Sugar, not all of these user types will be necessary. Only regular users and system administrators in an Active status count towards licensed user limits. The purpose of each user type is explained in the following sections.

Regular User

A regular user is the most common of the user types. A majority of employees of an organization will be regular users. This user can access most Sugar modules and perform most standard functions by default. Regular users are subject to be restricted in their abilities and what records they can access by an administrator using the Teams and Roles functionalities in Sugar.

Regular Users will appear in the Employees module. To create a Regular User, please review the Regular and Admin Users section of this page.

For SugarIdentity-enabled instances, the administrator can grant regular users "Admin & Developer" access to Users, Teams, and Roles in Sugar as well as access to SugarIdentity to manage certain user data (e.g., name, email address) and perform certain actions without having full system administrator access. For more information on configuring and assigning this role to users, refer to the SugarIdentity Guide.

System Administrator

System Administrator users, or "admins," have all of the abilities and functionality of a regular user, but also have administrative privileges as well. Admins can perform functions such as creating and editing users, editing system-wide settings, and have access to diagnostic and troubleshooting tools. In addition, admins can access all modules and records and are not subject to team or role restrictions. All instances of Sugar require at least one administrator, but it is also recommended to have more than one in case the original admin is unavailable or is no longer with the company.

System Administrators will appear in the Employees module. To create a System Administrator, please review the Regular and Admin Users section of this page.

Note: All administrators where the user status is active count as a licensed user.

Group User

A Group User is a bucket that is used for assigning records to a non-specific user (e.g., Sales, Support) in the organization. Unlike a Regular or System Administrator user, a Group user does not have access to log in to Sugar. Due to this, they do not have the same profile settings available, including the option to set a password. Since Group users cannot log in to Sugar, they do not count against an organization's license count.

Examples of uses for a Group user would be to assign all new leads to a group user named "Sales" or assign all newly-created support cases to "Support" before they are delegated to specific users (e.g., John Smith) in the organization.

Please note that Group users will not appear in the Employees module. For more information on how to create a Group user, please review the Group Users section of this page.

Portal API User

A Portal API User is similar to a Group User except that it is created specifically to communicate with the Sugar server using the Sugar Portal API functionality. It is intended only for use with Sugar Portal; the user with user name "SugarCustomerSupportPortalUser" is automatically enabled when the Sugar Portal is enabled via Admin > Sugar Portal. It must remain enabled in order for portal users to authenticate. This user can only be used to authenticate contact credentials against portal API methods and determine portal account permissions based on the Customer Self-Service Portal role. To create a Portal API user, please review the Portal API Users section of this page.

Portal API Users will not appear in the Employees module and are not counted in the user license agreement. More information about the Sugar Portal can be found in the Sugar Portal documentation. Sugar's API documentation can be found in the Web Services section of the Developer Guide.

Note: The Portal API user is not intended to be a free API user for external integrations and has very limited functionality through the API.

License Types

Users are given access to specific capabilities in the product by assigning them one or more licenses (e.g., Sugar Sell Premier, Sugar Serve) in the License Type field on the user record. See the License Management page for details on working with user licenses and license limits.

To compare which functionality each license type has access to, refer to the License Types Matrix page.

Users Record View

The Users record view displays thorough user information including all user fields which are grouped by default into the User Profile, Advanced, and Access tabs. You can also view information from records related to the Users module as subpanels below the record view. For more detailed information about adding relationships, please refer to the Studio documentation. The record view can be reached by clicking a user record's link from anywhere in the application including from the Users list view.

Note: If your instance uses SugarIdentity, then you can also view the user's basic and employment-related information in SugarIdentity.

Administrators have the ability to change what fields are visible in the User Profile tab of the record view by configuring the field groupings via Admin > Studio. For more information on editing record view layouts, please refer to the Studio documentation.

Tabs

The record view for a user is broken up into multiple tabs to better organize the different fields available in the Users module. Some of the available tabs in the user's profile are "User Profile", "Advanced", and "Access". A Downloads tab is also available when viewing your own profile. For more information on viewing your personal user profile, please review the Getting Started documentation in the Application Guide.

User Profile

The User Profile tab displays information specific to the user such as the user's name, user type, employment status, contact information, etc. Administrators have the ability to configure the User Profile layout via Admin > Studio.

Note: For instances that use SugarIdentity, certain fields (e.g., First Name, Last Name, Title, Work Phone) in the user's profile are read-only and can only be edited in SugarIdentity.

Advanced

The Advanced tab shows information specific to the user's preferences in Sugar. Information such as the user settings, locale settings, PDF settings, etc. can be easily viewed under this tab. Please note that the layout of this tab cannot be edited in Studio. However, you can edit the information under the tab by clicking the Edit button on the user's record view.

Access

The Access tab summarizes the user's Team and Role settings so that it can easily be viewed in one place via the Access table. The Access table summarizes the set of permissions assigned to the user and allows you to view the type of access they have along with the actions (e.g., View, Edit, Delete, etc.) they can perform in Sugar. This table is very similar to what appears in Admin > Role Management, but this table is not editable in the Users module. The table will list the modules in rows on the far left with column headers representing the type of action (e.g., Delete, Edit, Export, etc.) users can perform in each module. For more information on role settings, please refer to the Roles documentation.

Note: Users with more than one role assigned will have the more restrictive role setting prevail on the Access table. For example, if one role allows the user to delete records in the Contacts module, but the other role does not allow record deletion, the user will not be able to delete records in the Contacts module.

Subpanels

All available subpanels are visible at the bottom of the Users record view. Subpanels can be added to the Users module by creating relationships via Admin > Studio. For more information on adding relationships, please refer to the Relationships documentation.

Roles

The Roles subpanel lists all of the roles assigned to the user along with the description of each role. Roles work in conjunction with teams to form a robust security model for non-admin users in Sugar. Roles control three different layers of access for users within Sugar: module, field, and action-level access. System administrators can easily assign or remove roles for the user via the Roles subpanel.

Teams

Teams consist of one or more users who are assigned to manage records in Sugar. The Teams subpanel lists all of the teams assigned to the user along with the description of each team. The defined permissions determine what records a user is and is not able to access. Teams are used in conjunction with roles to form a robust security model for non-admin users in Sugar. The Teams subpanel displays the list of teams a user is associated with, which determines what records the user has access to in Sugar. Please note that every record is assigned to at least one team, but can be assigned to multiple teams as well if different users need access to it. The default team(s) set in the User Settings section under the Advanced tab will automatically be assigned to new records created by the user. Users assigned to the record, as well as system administrators can access the record regardless of team membership. When a user is created in Sugar, they are automatically associated with the Global team (universal team) and a Private team (users own personal team) is created by default. System administrators can assign users to additional teams via Admin > User Management or Admin > Team Management as necessary. For more information on teams as well as creating and assigning teams, please refer to the Team Management documentation.

User Holidays Subpanel

Administrators can record the days that users will not be working so that the time off is considered when calculating project timelines in the Projects module. Users will be able to select the scheduled holiday(s) via the Project Holidays subpanel in Projects-related modules. For more information on creating and managing projects, please refer to the Projects documentation. Additionally, administrators can utilize User Holidays to determine user availability for record assignment in SugarBPM.

Shifts and Shift Exceptions Subpanels

The Shifts and Shifts Exceptions subpanels show the shifts and shift exceptions to which the user is related. Using the Shifts and the Shift Exceptions modules, administrators can define the working hours and the exceptions (e.g., time off, team event, etc) of their employees. This allows you to view the shifts and the exceptions to these shifts that a user has so that you can understand their work schedule and their availability to be round-robin assigned records in SugarBPM. See the Shifts and the SugarBPM documentation for more details.

External Accounts

The External Accounts subpanel allows users to connect to external applications (e.g., Google, GoToMeeting, WebEx) from Sugar. Please note that you must have an existing account with the external application prior to connecting in Sugar.

Should you wish to prevent users from creating external accounts, you can disable the External Accounts module via a role assigned to those users. Doing so will remove the External Accounts subpanel from their User Profile. Please note the "Access Type" setting will not affect this module. For more information, refer to the Role Management documentation.

Note: While administrators can see the External Accounts subpanel, they cannot add external accounts for users. The user must be logged in and can add external accounts via their profile. For more information, refer to the Getting Started documentation.

Maps

The Maps subpanel allows you to quickly see which records are in close proximity to the user and generate driving directions between records. For more information, refer to the Sugar Maps documentation.

Creating Users

There are various methods for creating new users in Sugar. These are via the Users module, duplication, or import. Creating users is an imperative function in Sugar as it allows for other members of your organization to log in and work in Sugar. Please note that you will not be able to add more users of a particular license type than is allowed by your Sugar license. For more information on how Sugar's licensed user limits work, refer to the Understanding User Types, License Types, and Sugar Licenses article.

Creating via Module Tab

The most common method for creating users in Sugar is via the Users module. The record view layout opens when creating the user directly from the Users menu and includes all of the relevant fields to create a new user. The fields and options on the Create page will vary depending on the type of user you are creating.

Regular and Admin Users

Regular and Admin users are the most common users that will be created in a Sugar instance and contain the most detail and fields compared to the other user types. For more information about the use of Regular and Admin users, please review the Regular User and System Administrator sections of this page.

Use the following steps to create a new user:

1. Navigate to Admin > User Management.
2. Click the three-dots menu in the Users module tab to open the Actions menu and select "Create New User". 
   
3. Enter appropriate values for the fields in the record view layout. All required fields are marked with a red asterisk and must be completed prior to saving.
   • Enter the following information under the User Profile tab:
     • In "User Profile" enter a user name for this user which will define the specific user in Sugar and should be unique for every user. Sugar will default the user to being Active and a Regular User, which can be updated if the user is going to be an administrator.
     • In "Employee Information", additional contact information and other specific information about the user can be added. This will include phone numbers, who the user reports to, their business center, and any description information.
     • In the Email field, the user's email address or addresses can be added. The email addresses can also be marked as "Primary", meaning that this will be the first email address that shows for the user, and "Reply-to", where automatic notifications from Sugar will be sent. In this section, the user's outbound email client will be selected to default to Sugar or an external program, such as Microsoft Outlook.
       
     • If a mail server is configured in Admin > System Email Settings, additional options will display here for SMTP Username and SMTP Password. If the administrator has set up an OAuth2-based email account, there will be an Authorize button that will initiate a pop-up to authenticate the email account.
       
   • The Advanced tab includes preference-type settings (User Settings, Layout Options, Locale Settings, PDF Settings, Calendar Options) for the user. These are all specific to the user's account and will not affect system-wide settings or other users. Options such as assignment notifications, date and time formats, time zone, preferred currency, etc. are available to configure under this tab. The available fields are listed in the User Fields table above.
4. After entering the necessary information click the Save button.
   
5. Upon saving, a corresponding Employee record will be created for the user. Once the user is created, the administrator can assign Teams and Roles to the user.
6. Once the user setup is complete, the administrator will need to provide the user name and primary email address and instruct the user to click the "Forgot Password" link on the login page. Please note this also requires the instance to have the Forgot Password Feature enabled in Password Management.

Group Users

A Group user cannot log in to Sugar, but new and existing records can be assigned to the Group user. The Create page for the Group user consists of the User Name, Status, Name, User Type, and Email Address fields. For more information on how to use Group users in Sugar, please review the Group User section of this page.

Use the following steps to create a Group user:

1. Click the three-dots menu in the Users module tab to open the Actions menu and select "Create Group User".
    
2. Enter a name and user name (e.g., Support) for this user.
3. Enter an email address or addresses for the Group user. The group user's primary email address will be marked as "Primary" and you can also mark "Reply-to" if any automatic notifications from Sugar will be sent to this address.
   Note: If your organization has a group inbox or alias for a team represented by the group inbox, the email address can be added here for all notifications to be sent to the entire team.
4. Click "Save" to create the user.
   

Portal API Users

A Portal API user cannot log into Sugar via the web interface, but the name and user name will appear for other users as they view records assigned to the group user or assign records to this user. The Portal API user creation screen only contains five fields. For more information on the use of the Portal API user, please review the Portal API User section of this page.

Use the following steps to create a Portal API user:

1. Click the three-dots menu in the Users module tab to open the Actions menu and select "Create Portal API User".
   
2. Enter a name and user name for the user.
3. Enter an email address or addresses for the API user. The group user's primary email address will be marked as "Primary" and you can also mark "Reply-to" if any automatic notifications from Sugar will be sent to this address.
4. Click "Save" to create the user.
   
5. Once the user setup is complete, the administrator will need to provide the user name and primary email address and instruct the user to click the "Forgot Password" link on the login page. Please note this also requires the instance to have the Forgot Password Feature enabled in Password Management.

Creating via Duplication

Often, administrators will find themselves in situations where multiple users must be created at once, whether it be when they are first setting up Sugar, a new group of employees is going to be using Sugar, etc. For situations such as these, one user can be configured and additional users can be quickly set up using the Copy option available in the user record view. When duplicating a user, all fields are populated from the original record to the duplicated one, except for the User Name field.

Note: The Copy option is not available for instances that use SugarIdentity. 

Use the following steps to create a user by duplicating an existing user:

1. Navigate to the record view of the user you would like to duplicate.
2. Click the Actions menu and select "Copy". 
   
3. The displayed record view is pre-populated with the original user's values, except for the user name.
4. Populate the "User Name" for the new user and edit any other fields or preferences to be specific to the new user. Fill in any information for the new user that did not exist on the original user.
5. Click "Save".

The new user is now created and available for use. This process is applicable to all user types.

Creating via Import

The import function in Sugar allows you to push multiple user records into Sugar using a comma (or another character) delimited file instead of creating them one-by-one. Use the following steps to import users via the Import Users option. For more information on importing records to Sugar, please refer to the Import documentation.

Note: For instances that use SugarIdentity, the import option can only be used to update existing user records. Administrators can access SugarIdentity to import a list of new users using a CSV file. 

The following steps cover importing new user records as an example:

1. Click the three-dots menu in the Users module tab to access the Actions menu and select "Import Users".
   
2. In Step 1, select the source of the data you are importing. Click "Next".
3. In Step 2, select the import file and choose "Create new records only". Click "Next".
4. In Step 3, confirm the import file properties. Click "Next".
5. In Step 4, confirm the field mappings for the import. Click "Next".
6. In Step 5, configure any fields you would like to use for duplicate checking.
7. In Step 6, view the import results.
   • The Created Records tab will show all of the new user records.
   • The Duplicates tab will show any records in the file that were detected as a duplicate and thus not imported from the duplicate check in Step 5 of the Import Wizard.
   • The Errors tab will show records that were not imported due to errors detected during import.

Note: You can also update existing user records via import using a CSV file. For instances that do not use SugarIdentity, refer to the Import documentation for more information on updating existing records via import. For instances that use SugarIdentity, refer to the Importing Updates to Existing User Records section of this page for more information.  

Copying User Preferences, Dashboards, and Filters to Other Users

Administrators can reduce the learning curve for new users by broadcasting the setup of an existing user to individual users or users on a given team or role via the Copy Content (preferences, dashboards, and filters) and Copy User Settings (locale settings) options in the Users menu.

Copying Content

Administrators can save time setting up users with the Copy Content tool, which copies select user preferences, dashboards, and filters from one user to other users, teams, or roles. Content can be copied to individual or multiple users, teams, or roles. Copying user preferences will overwrite the recipient users' existing preferences.

To copy content such as dashboards, filters, and user preferences from one user to other users, follow these steps:

1. Navigate to the Users module via Admin > User Management.
2. Click the three-dots menu in the Users module tab to open the Actions menu and select "Copy Content".
   
3. From the "Copy item" dropdown, select the type of content to be copied. Refer to the Content Types section for descriptions of each type of content.
4. In the "From User" list, select the name of the user from which to copy the identified content.
5. Click into any of the "To" fields to open a Search and Select drawer to locate the users, teams, or roles, to which the content should be copied. 
6. Click the Copy button at the top right-hand corner of the page. A confirmation message displays when the copy has been completed.

Note: When content is copied to user accounts, the users are not notified of the change.

Content Types

The following lists contain the types of content that can be copied from a user.

User Preferences

• Default Teams: The teams set as default teams in the source user's profile user settings.
• Favorite Reports: The reports identified as favorites.
• Navigation Bar Module Selection: The modules and the order in which they are displayed in the navigation bar as defined in the source user's layout options.
• Notify on Assignment: Copies the "Email on Assignment" option as defined in the source user's profile user settings.
• Reminder Options: Copies the reminders as defined in the source user's profile user settings.
• Scheduled Reporting: Copies the source user's scheduled report settings.
• Sugar Email Client: Copies the email client as defined in the source user's profile email settings.

Dashboards

• From Modules: Select this option to copy all of the source user's dashboards from a designated module.
• Existing Dashboards: Select this option to locate specific dashboards to copy from the source user.

Note: When a dashboard is selected as a favorite by the source user, it will be identified as a favorite in all user accounts to which the dashboard is copied.

Filters

• From Modules: Select this option to copy all of the source user's filters from a designated module.
• Existing Filters: Select this option to locate specific filters to copy from the source user.

Copying User Settings

The Copy User Settings tool allows administrators to easily set the locale settings for individual users or users in a given team or role.

To copy user locale settings to other users, follow these steps:

1. Navigate to the Users module via Admin > User Management.
2. Click the three-dots menu in the Users module tab to open the Actions menu and select "Copy User Settings".
   
3. Select the checkbox next to the settings to be copied. Refer to the Getting Started documentation in the Sugar Application Guide for more information on these settings.
4. Click into any of the "To" fields to open a Search and Select drawer to locate the users, teams, or roles to whom the settings should be applied. 
5. Click the Copy button at the top right-hand corner of the page. A confirmation message displays when the assignment has been completed.
   

Importing Updates to Existing User Records

In addition to importing new user records via Sugar's Import Wizard, you can also import updates to existing user records in Sugar using a CSV file. Please note that the import process will vary between instances that use SugarIdentity and instances that do not use SugarIdentity.

For instances that do not use SugarIdentity, refer to the Import documentation for more information on updating existing records via import.

For instances that use SugarIdentity, use the following steps to update existing user records via import: 
Note: Fields that are only editable in SugarIdentity cannot be updated via import in Sugar. 

1. Click the three-dots menu in the Users module tab to access the Actions menu and select "Import Users".
   
2. In Step 1, select the import file and click "Next".
   Note: To create new user records via import, click the SugarIdentity link to perform the import in SugarIdentity.
    
3. In Step 2, confirm the import file properties. Click "Next".
   Note: Configuring the import file properties (e.g., Name Display Format) for fields (e.g., First Name, Last Name) that are not editable in Sugar will not apply to the data in the import file.
4. In Step 3, confirm the field mappings for the import then click "Import Now". 
   Note: Fields that are only editable in SugarIdentity will not be available to map. 
5. In Step 4, view the import results. The Errors tab will show records that were not imported due to errors detected during import.
   Note: If the import file includes any changes to fields that are only editable in SugarIdentity, it will not get updated in the record.

Resetting User Preferences

As users make changes while navigating around Sugar, their preferences are stored in the Sugar database. This includes preferences such as sort orders on list view, previous searches on both basic and advanced searches, and settings in the Advanced tab of the user profile. Users can reset their preferences back to the default out-of-the-box settings, which will revert the user's changes made in Sugar. Please note that this action cannot be undone. If the user is currently logged in, the changes will not take effect until the user is logged out and then back in.

Note: Resetting a user's preferences is the only way to allow a user access to Sugar if they have been locked out using the Login Lockout feature in Password Management.

Use the following steps to reset a user's preferences:

1. Navigate to Admin > User Management and select the user (e.g., Jim Brennan) from the list view.
2. Select "Reset User Preferences" from the Actions menu.
3. A pop-up box will appear confirming the reset. Click "Confirm" to proceed.

Resetting User Passwords

For instances without SugarIdentity, administrators can reset a user's password easily in Sugar. For SugarIdentity enabled instances, administrators can click the lock icon in the Users list view of SugarIdentity to send password reset emails to users. For more information, refer to the SugarIdentity Guide.

Note: The user needs to log out and then back in for the change to take effect.

Use the following steps to reset a user's password in Sugar:

1. Navigate to Admin > User Management and select the user (e.g., Jim Brennan) from the list view.
2. Select "Reset User Password" from the Actions menu.
3. A pop-up box will appear confirming the reset. Click "Confirm" to proceed.

Following your confirmation, an email is sent to the user’s primary email address with a link to reset their password. Please note, you must configure your system email in order to reset a users password.

Impersonating Users

If your instance uses SugarIdentity, you have the ability to log in as other users in your organization using the "Impersonate (Log in as)" option in SugarIdentity. When impersonating a user in Sugar, you will be able to access and view the same modules and settings as the user's actual account without having to obtain their login credentials. For more information on impersonating a user, refer to the SugarIdentity Guide. 

Deactivating Users

When a user is no longer a member of your organization, it is best practice to deactivate them instead of deleting them. This ensures that the user will no longer be able to log in to Sugar, but any historical information tied to the user will still be available. If your instance uses SugarIdentity, you will need to access SugarIdentity in order to deactivate a user from Sugar. While deactivating user records will not update any related records, the Reassign Records tool in Sugar can be used to reassign all of the user's records. You can also filter list views to show records that are assigned to or created/modified by inactive users by filtering the user list on the Status field and then mass updating the records to be assigned to an active user.

Note: Users that have been deactivated do not count towards your licensed user count.

Instances without SugarIdentity can use the following steps to deactivate a user in Sugar and reassign their records:

1. Navigate to Admin > User Management and click the user you wish to deactivate.
2. Edit the user record and change the Status field to "Inactive". Click "Save".
3. A pop-up message will display asking if you would like to reassign all of the user's records. Click "Yes" if you wish to proceed.
4. You will then be presented with the Reassign Records tool. Follow the steps on this page to complete the deactivation. For more information, please review the Reassigning Records section.
5. Once the reassignment is complete, the user will be deactivated and no longer able to log in to Sugar.

Deleting Users

If a user record is invalid or should no longer appear in your organization's Sugar instance, it may be deleted. Please note that deleting user records will not delete any related records and will only prevent the user from being selected (e.g., Assigned to). If your instance is SugarIdentity-enabled, you will need to access SugarIdentity to delete a user from Sugar.  When a user is no longer a member of your organization, it is best to deactivate them by changing the Status field to "Inactive" instead of deleting them. This way, any historical information tied to the user will still be available, but the user will no longer be able to log in to Sugar.

Please note, when a user record is deleted, the corresponding employee record will also be deleted. After the user is deleted, any SugarBPM processes, legacy workflow definitions, or reports involving the user may need to be evaluated and updated. Deleting a user record cannot be undone.

Instances without SugarIdentity can use the following steps to delete a user and reassign their records:

1. Navigate to Admin > User Management and click the user you wish to delete.
2. Select "Delete" from the Actions Menu.
3. A pop-up message will display asking for confirmation. Click "Confirm" to proceed.
4. You will then be presented with the Reassign Records tool. Follow the steps on this page to complete the deletion. For more information, please review the Reassigning Records section.
5. Once your reassignment is complete, the user will be deleted, and you can freely navigate around Sugar.

Reassigning Records

Reassign Records is a tool available in the Users module for administrators to change the Assigned To and Team fields for a specific user's records. This is best used when a user is changing departments, teams, or roles within the organization, or if the user is no longer an employee or using Sugar. The Reassign Records tool is automatically presented when deleting or deactivating a user in Sugar. Please note that reassigning records cannot be undone in Sugar.

Note: You can locate records assigned to Inactive users by filtering the module's list view.

Use the following steps to reassign records:

1. Navigate to the Users module via Admin > User Management.
2. Click the three-dots menu in the Users module tab to open the Actions menu and select "Reassign Records".
   
   
   The Reassigning Records tool can also be accessed during the process of deleting or deactivating a user, where it is used to reassign a user's records before deleting or deactivating them.
3. Select the user to whom the records are already assigned in the From User field.
4. Select the user to whom the records will be assigned to in the To User field.
   Note: You can select the same user in both fields if you are just changing the team for all of the user's records.
5. Select which team(s) the records will be assigned to in the Set Teams to field.
6. Select the module(s) you wish to include in the record reassignment. Multiple modules can be selected by holding down the Control key when using a PC or the Command key when using a Mac.
   
7. Selecting certain modules will display specific filters (e.g., Type) which can be applied to the module. Use these filters if you do not want to include all records assigned to the user. The list of modules and their filter fields are as follows:
   

   Module	Filter Field
   Accounts	Type
   Bugs	Status
   Calls	Status
   Cases	Priority Status
   Dashboards	Default Dashboard
   Opportunities	Sales Stage Type
   Tasks	Status

8. After selecting any filters, click "Next" to access the reassignment summary.
9. If you would like to see a detailed list of the changes that were made, click "Verbose Output". This list will include a link to the changed records and a summary of changes that were made.
10. If you would like the changes to show in the Change Log for the changed record, have any relevant workflows fire, or have assignment notifications sent out, please click the Include Workflow/Notifications/Audit checkbox.
    Note: This process performs a large set of actions at once and may take a long amount of time to complete.
    
11. Click "Next" to complete the reassignment.
12. The final summary page will show how many records were affected and if any errors occurred during the reassignment. Click "Return" to return to the main screen of the Reassigning Records tool.
    

Note: Due to PHP memory limitations on the server, there may be occasions when the application times out while reassigning a large number of user records. If you encounter an error when performing this action, we recommend reassigning records in smaller batches via each module's mass update option.

vCards and Users

vCards are electronic business cards that are exchanged between applications such as email and web browsers. User records may be saved as vCards for use in other software.

Downloading a User's vCard

The following steps cover downloading a vCard and saving it as a contact in Microsoft Outlook as an example:

1. Navigate to a users record view.
2. Select "Download vCard" from the Actions menu to download the vCard file.
   
3. Open the downloaded file in your mail or address book application. For this example, double clicking opens the vCard in Outlook.
4. Make any necessary changes to the information, then click "Save & Close" to save this lead in Outlook.
   

User Fields

The Users module contains a number of stock fields, which are included out-of-the-box with Sugar. Fields in the Users module are distributed across two tabs, "User Profile" and "Advanced". The User Profile tab contains the user's contact information and other important user-specific settings. System administrators have the ability to alter, remove, or add fields in the User Profile tab via Admin > Studio, minus a few noted exceptions. The Advanced tab in the user's profile includes settings to configure how Sugar will function for that specific user. The fields in the Advanced tab cannot be edited in Studio. For more information on adding or modifying fields, please refer to the Studio documentation.

The below definitions are suggested meanings for the fields in the Users module, but many of the fields can be leveraged differently to best meet your organization's needs.

¹ This field is in the Advanced Tab of the user profile page. Fields in the Advanced tab cannot be edited in Studio.
² This field is not editable in Studio.
³ For instances that use SugarIdentity, this field is read-only and can only be edited in SugarIdentity.

Understanding the Reports To Field

The Reports To field on the User record is used by various parts of Sugar to determine who a user's manager (i.e., supervisor) is. Some examples of how Sugar uses this relationship are described below:

Note: Only administrators can edit the Reports To field.

Working With Sugar Modules

While the Users module has some features that only apply to users, it also uses the Sidecar user interface that most Sugar modules are based on. The following sections detail menus, views, and actions common to Sidecar modules and contain links to additional information within the page or links to the User Interface documentation.

User Menus

The Users module contains various options and functionality which are available via menus in the module tab, list view, and record view. The following sections present each menu and its options with links to more information about each option in the User Interface documentation or, for Users-specific functionality, within this page.

Module Tab Menus

Click the Users module tab in the navigation bar, shown after selecting User Management in the Admin page, to access the Users list view. You may also click the three-dots menu in the Users module tab to display the Actions, Recently Viewed, and Favorites menus. The Actions menu allows you to perform important operations within the module. The Recently Viewed menu displays the list of users you most recently viewed. The Favorites menu displays the list of users you most recently marked as favorites.

The options in the Actions menu allow you to perform the following types of action:

For more information on module tab menus including reasons a module may not be included in the menu, see the User Interface documentation.

List View Menus

The Users list view displays all user records and allows for searching and filtering to locate specific users. You can view the basic details of each record within the field columns of the list view or click a user's name to open the record view. To access a module's list view, simply click the module's tab in the navigation bar.

List View Mass Actions Menu

The Mass Actions menu to the right of the checkbox option in the list header allows you to perform mass actions on all currently selected records. You can use the checkbox on each record's row to select individual user records or click the checkbox in the list header to select all records displayed on the current set of list view results.

The Mass Actions menu allows you to perform the following operations:

List View Record Actions Menu

The Record Actions menu to the far right of each record's row allows you to perform actions on the individual user directly from the list view.

The options in the Record Actions menu allow you to perform the following operations:

Record View Actions Menu

The User record view displays a single user in full detail including its relevant fields and subpanels of related records. To access a user's record view, simply click a hyperlinked user name from the Users list view, Users list view dashlet, or from report results. The record view's Actions menu appears on the top right of the page and allows you to perform various operations on the current record.

The Actions menu allows you to perform the following operations:

Common Views and Actions

In the table below, the left column contains links to the User Interface page covering topics that are applicable to all Sidecar modules. The right column has links to sections of the current page that cover topics specific to users.