SugarCRM SupportProduct GuidesSugar Versions10.010.0 ServeSugar Serve 10.0 Application GuideContacts



Sugar's Contacts module consists of individual people with whom your organization has an established relationship. Sugar enables you to convert lead records to contact records according to your organization's qualification process. Contact records are typically related to an account record, and multiple contacts may be associated with a single account. Each contact record may then relate to other Sugar records such as meetings, cases, opportunities, and many others, making the contact record a hub for viewing and continuing your interaction with the individual. This documentation will cover information and actions specific to the Contacts module. For instructions concerning views and actions which are common across most Sugar modules, such as creating, editing, and deleting contacts, please refer to the Working With Sugar Modules section of this page.

Please note that you will only be able to see contact records as allowed by your team membership, user access type, and assigned roles. For more information on teams and roles, please refer to the Team Management and Role Management documentation in the Administration Guide.

Contact Fields

The Contacts module contains a number of stock fields that come out-of-the-box with Sugar. For information on using and editing various field types, refer to the User Interface documentation. The below definitions are suggested meanings for the fields, but the fields can be leveraged differently to best meet your organization's needs. Administrators or users with developer-level role access have the ability to alter, add, or remove fields via Admin > Studio. For more information on configuring fields, please refer to the Studio documentation in the Administration Guide.

Field Description
Account Name The account to which the contact belongs
Alternate Address The contact's alternate address (e.g. billing or shipping)
Assigned To The Sugar user assigned to the contact
Assistant The name of the contact's assistant within his or her company
Assistant Phone The assistant's phone number
Birthdate The contact's date of birth
Business Center Name 1 The business center this contact belongs to. In Sugar Sell, contacts created during lead conversion inherit the lead's business center, which is then used for SugarBPM business hour calculations. For more information, refer to the Stock SugarBPM Templates documentation.
Campaign The campaign, if any, from which the contact originated
Note: This field's value is not visible to Sugar Serve users; when this field appears on layouts, users without a supported license type will see a placeholder containing the text "License Required" instead of the field's value. See the User Management page for more details on license types.
Comment Log A shared log of messages, comments, or other text, including the name of the user that added the log entry and the date and time it was added. It is possible to tag other users and link to other Sugar records in Comment Log entries by inserting a clickable pill; see the User Interface documentation for more details.
Confirm Portal Password When editing, confirmation of the contact's password for accessing Sugar Portal
Contact Source A system-level dropdown field that represents the origin of newly created contacts. It is set to External on contacts created via Portal and set to Internal on contacts created in Sugar. This field is not available in Studio or the user interface and is only available in SugarBPM.
D&B Principal ID Unique ID number associated with the contact in D&B
Date Created The date the contact record was created
Date Modified The date the contact record was last modified
Department The contact's department within his or her company
Description A description or other information about the contact
Do Not Call Indication that the contact should not be called
Email Address The contact's email address
Facebook Account The contact's Facebook account information
Fax The contact's fax number
First Name The contact's first name
Google Plus ID The contact's Google Plus ID
Home The contact's residence number
Last Name The contact's last name
Lead Source The source from which the contact originated
Note: The Lead Source field will be set to "Support Portal User Registration" for contacts created via portal registration.  
Mobile The contact's mobile number
Name When viewing, the contact's full name
Office Phone The contact's office number
Other Phone The contact's alternate phone number
Picture An image of the contact (e.g. business card or profile picture)
Portal Active Indication that the contact is enabled to access Sugar Portal
Portal Application The portal application name. Only used when integrating a custom portal solution with Sugar.
Portal Name The contact's user name for accessing Sugar Portal
Portal Password The contact's password for accessing Sugar Portal
Portal User Company Name The name of the company to which the customer belongs to
Note: This field will display the company name the customer enters when signing up for the Sugar Portal.
Preferred Language The contact's preferred language when accessing Sugar Portal
Primary Address The contact's primary address
Reports To The contact's manager in his or her company
Salutation Standard greeting for the contact (e.g. Mr., Ms., Mrs., etc.)
Sync to mail client Indication that the contact should be synced to mail client when using the Sugar Plug-in for Outlook, for example.
Note: This field must be set on a per-user basis.
Tags User-created keywords that can be used to identify records in filters, dashlets, and reports
Note: For more information on creating and using tags, please refer to the Tags documentation.
Teams The Sugar team(s) assigned to the contact record
Title The contact's title within his or her company
Twitter Account The contact's Twitter account information

This field's value is only visible to Sugar Serve and Sugar Sell users; when this field appears on layouts, users without a supported license type will see a placeholder containing the text "License Required" instead of the field's value. See the User Management page for more details on license types.

Working With Sugar Modules

While the Contacts module has some features that only apply to contacts, it also uses the Sidecar user interface that most Sugar modules are based on. 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 contacts.

General Instructions for Working With Sugar Modules Contacts-Specific Instructions
Use the links below to navigate to the User Interface page which covers topics generic to many Sugar modules. When Contacts-specific help exists for each topic, use the links below to navigate to sections of the current page.
Creating Records Contact Creation via Sugar Portal
Creating Contacts via vCard
Viewing Records  
Searching for Records  
List View List View Mass Actions Menu
List View Record Actions Menu
Record View Record View Actions Menu
Intelligence Pane  
Editing Records  
Deleting Records  
Emailing Records Emails and Contacts
Exporting Records Downloading a Contact's vCard
Recalculating Calculated Values  
Finding Duplicate Records  
Merging Records  
Viewing Record Historical Summaries  
Viewing Record Audit Logs  
Record PDFs  
Favoriting Records  
Following Records  
Sharing Records  

Contact Menus

The Contacts 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 Contacts-specific functionality, within this page.

Module Tab Menus

The Contacts module tab is typically located on the navigation bar at the top of any Sugar screen. Click the tab to access the Contacts list view. You may also click the triangle in the Contacts 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 contacts you most recently viewed. The Favorites menu displays the list of contacts you most recently marked as favorites.

The module tab's Actions menu allows you to perform the following operations:
Menu Item Description
Create Contact Opens the record view layout to create a new contact
Create Contact From vCard Imports a vCard file from your computer to create a new contact
View Contacts Opens the list view layout to search and display contacts
View Contact Reports Displays existing reports based on the Contacts module
Import Contacts Opens the import wizard to create or update contacts using external data

If you do not see the Contacts module tab in Sugar, please check the following:

  • The Contacts module may be marked as hidden in your user preferences which will prevent the module tab from being displayed. Navigate to your user profile (upper right of Sugar), click the Advanced tab, and check the Layout Options section. If you see the Contacts module in the Hide Modules list, simply move it to the Display Modules list. For more information on hiding and displaying modules, please refer to the Layout Options section of the Getting Started documentation.
  • The administrator may have disabled the Contacts module for your entire Sugar instance. Reach out to your Sugar administrator to have the Contacts module displayed. For more information on displaying and hiding modules throughout Sugar, please refer to the Developer Tools documentation in the Administration Guide.

List View Menus

The Contacts list view displays all contact records and allows for searching and filtering to locate specific contacts. You can view the basic details of each record within the field columns of the list view or click a contact's name to open the record view. To access a module's list view, simply click the module's tab in the navigation bar at the top of any Sugar page.

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 contact 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:

Menu Item Description
Email Email one or more contacts at a time
Mass Update Mass update one or more contacts at a time
Merge Merge two or more duplicate contacts
Delete Delete one or more contacts at a time
Export Export one or more contacts to a CSV file
Recalculate Values (Available in certain circumstances) Updates calculated values to reflect changes to calculated fields made in Studio

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 contact directly from the list view.
contacts listview recordactions

The lst view's Record Actions menu allows you to perform the following operations:

Menu Item Description
Preview (Eye icon) Preview this contact in the intelligence pane
Edit Edit this contact
Follow Follow this contact
Delete Delete this contact

Record View Actions Menu

The Contacts record view displays a single contact in full detail including its fields, subpanels of related records, and activity stream. To access a contact's record view, simply click a hyperlinked contact name from anywhere within Sugar. 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.
contacts recordview actionsmenu

The Actions menu allows you to perform the following operations:

Menu Item Description
Edit Edit this contact
Share Share a link to this contact via email
Download PDF Download contact information as a PDF file
Email PDF Email contact information as a PDF attachment
Manage Subscriptions Manage this contact's newsletter campaign subscriptions
Download vCard Download a vCard from Sugar and transfer this contact's information to another application (e.g. Outlook)
Find Duplicates Locate potential duplicates of this contact
Copy Duplicate this contact to create a new contact
Historical Summary View a historical summary of activities (e.g. calls, meetings, etc.) related to this contact
View Audit Log View a record of changes to this contact
View Personal Info Display this record's fields which an admin has designated as personal information
Delete Delete this contact

Contact Creation via Sugar Portal

The Sugar Portal allows your customers to file bugs, cases, and review knowledge base articles created in Sugar. Please note that customers have to be registered users of the portal in order to be able to access the portal. When a potential portal user visits the portal login page and completes the registration form, their information is entered into Sugar as a new contact record with the Lead Source field set to "Support Portal User Registration". Once the contact record is validated and approved for portal access, you can enable the Portal Active checkbox to activate their portal account. For more information on managing the Sugar portal, please refer to the Portal Deployment User Guide
Contacts PortalActiveCheckbox

Emails and Contacts

Contacts include an email address that can be used to email the contact as a recipient. The methods for doing so are covered in the Emailing Records section of the User Interface documentation. In addition to being a recipient or sender of an email, contacts may be related to emails by being selected in the email's Related To field. These relationships allow the contact to display all relevant email correspondence in the Emails subpanel and History dashlet on a contact's record view.

Emails Subpanel

The Emails subpanel in the Contacts module displays emails which are associated with the contact record in a variety of ways:

  • Explicitly related to the contact : If the contact is selected in the email's Related To field, the email and contact are explicitly related, and the email will appear in the contact's Emails subpanel and History dashlet. Instructions for using this flex relate field are available in the Emails documentation.
  • Implicitly related to the contact : If one of the contact's email addresses appears in the email's From, To, or Cc fields, the email and contact are implicitly related, and the email will appear in the contact's Emails subpanel and History dashlet. This implicit relationship is made for emails sent from Sugar as well as any email imported into Sugar via Inbound email contacts or email archiving.

The Emails subpanel allows the following functions to be performed:

  • Email Details : To view the details of an email, click the subject to open it in detail view.
  • Record Count : Subpanel headers display the total count of related records (e.g. "5 of 6+") next to the module name. The count captures the number of records currently displayed with an additional, hyperlinked number (e.g. "6+") where there are more records than currently displayed. Click the hyperlinked number to see the total count of related records.
  • Collapse or Expand : Click anywhere in the subpanel's header to collapse or expand it. Subpanels will remain collapsed or expanded on future visits to the module.
    • Note: Administrators can choose to disable collapse stickiness or to collapse all subpanels by default via Admin > System Settings. For more information, please refer to the System documentation in the Administration Guide.
  • Column Widths : Place your cursor on the column divider. When the double arrow cursor appears, click and drag the column to the desired size. Please note that the column width will not be preserved when you navigate away from the page.
  • Column Sort : Click a column header to sort the subpanel's items by that value. Clicking the same header again will reverse the sorting order (e.g. from ascending to descending).
  • Compose a New Email : Click the Plus button on the upper right of a subpanel to create a new email with, by default, both an implicit and explicit relationship to the contact you are currently viewing. The email will automatically select the contact in the Related To field as well as add the contact's primary email address as a recipient in the To field.
    • Note: To send email from Sugar, users must configure their outbound email server via Emails > Email Settings or, if using the system email account to send email, the system's outbound email server must be configured by an administrator in Admin > System Email Settings.
    • Note: Because creating a new related record opens a drawer on top of the current record view, you should use the Cancel button to return to record view. Using the browser's back button will return you to the previous page.
  • More Records : By default, Sugar displays up to five records in each subpanel, though administrators can alter the number via Admin > System Settings as described in the System documentation of the Administration Guide. If additional related records exist, click "More {Module Name}..." (e.g. "More Emails...") at the bottom of the subpanel to load the next set of records.

Accounts EmailsSubpanel

Calls, Meetings, and Contacts

Contacts can be related to calls and meetings in two ways. First, they can be selected in the event's Related To field, indicating that the contact was the topic of the call or meeting. Second, they can be included as invitees to the call or meeting. 

Calls and Meetings Subpanels

Each contact's record view includes a Calls subpanel and a Meetings subpanel. These subpanels display all calls and meetings which include the contact as an attendee. If the contact is not an attendee but is selected in the call's or meeting's Related To field, the call or meeting will not appear in the subpanels.

When relating an existing call or meeting to a contact via the subpanels on a contact's record view, the contact will automatically be added as an invitee. When creating a call or meeting from the subpanels, the contact will automatically be added as an attendee and the contact's account will automatically be set in the event's Related To field.

vCards and Contacts

vCards are electronic business cards that are exchanged between applications such as email and web browsers. Contacts may be created from vCards generated by another application or saved as vCards for use in other software.

Creating Contacts via vCard

Use the following steps to create a contact in Sugar via vCard:

  1. Click the triangle in the Contacts module tab and select "Create Contact From vCard".
    Contacts LV ActionsMenu CreateContactFromvCard
  2. Choose the vCard file from your computer and click "Create".
    Contacts ImportvCard

Downloading a Contact'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 Contacts record view.
  2. Select "Download vCard" from the Actions menu to download the vCard file.
    Contacts RV ActionsMenu DownloadvCard
  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.

Last modified: 2020-11-20 17:00:09