SugarCRM SupportProduct GuidesPlug-insSugar ConnectSugar Connect User Installation Guide

Sugar Connect User Installation Guide

Overview

Sugar Connect is an email client add-in that lets you work with your Sugar data without navigating away from Outlook or Gmail. This guide walks through the steps that individual users should take to install and activate Sugar Connect.

Before users can start installing Sugar Connect, administrators should refer to the Sugar Connect Deployment and Administration Guide to find information on configuring Sugar Connect. 

Prerequisites

  • Sugar Connect must be purchased and configured for your Sugar instance by an administrator. Please refer to the Sugar Connect Deployment and Administration Guide for more details.
  • An administrator must enable you as a user of the connector. For more information on adding users, please refer to the Sugar Connect Deployment and Administration Guide.
  • To use Sugar Connect, each user will need an email account and a Sugar user account, and both accounts should use the same email address.
  • Please ensure that you have upgraded your Sugar instance to at least the minimum supported version of Sugar. For more information, refer to the Plug-Ins Supported Platforms.
  • Users must allow third-party cookies in order to use the Sugar Connect sidebar.
  • Some third-party browser extensions or Office add-ins may interfere with your installation of Sugar Connect. If you are having trouble launching or installing Sugar Connect, confirm that you have disabled any connectors listed in the Known Incompatibilities section of this page.

User Installation

An administrator must first set up your organization's Sugar Connect account and add you as a user. Upon doing so, you will receive an email invitation to set up and install Sugar Connect on your computer. You can use Sugar Connect on multiple devices (e.g., on your personal computer and your work laptop), but you must install it on each device you plan to use. Simply follow the same installation instructions and log in using the same email address each time. Your single user account can be used for multiple installations.

Follow the steps for the appropriate email client to install Sugar Connect once you have been invited:

Note: If you authenticate using a Google Workspace account, you must install and use Sugar Connect for Google Workspace in a Chrome browser with Gmail, Google Contacts, and Google Calendar. If you authenticate using an Office 365 account, you must install and use Sugar Connect with an approved version of Microsoft Outlook.

Your Sugar administrator must send you an invitation to install Sugar Connect as a member of your organization's Sugar Connect account. To avoid conflicts, do not attempt to install Sugar Connect without the invitation. For information on purchasing Sugar Connect for your organization and inviting users, please refer to the Sugar Connect Deployment and Administration Guide.

Installing Sugar Connect for Outlook

The steps in this section describe the installation of Sugar Connect used with an Office 365 subscription and Outlook on the Web or Outlook for Desktop (Windows or Mac OS). You will install Sugar Connect to the web version of Outlook even if you plan to use it on your desktop version of Outlook. Once you have installed and configured the add-in to Outlook for the Web, your add-in preferences will sync via Office 365 and you will be able to use Sugar Connect in the desktop version of Outlook, as well. 

  1. If you use a desktop version of Outlook, fully exit the application before continuing.
  2. Log in to your Office 365 account online and navigate to your Manage Add-ins page. 
    Note: You will install Sugar Connect to the web even if you plan to use it on your desktop version of Outlook.
  3. Search for Sugar Connect, click the Add button, and click "Continue" to agree to the license terms and privacy policy.outlookinstall2
  4. Next, navigate to your web inbox at https://outlook.office365.com/mail/inbox.
  5. Click on any email message to open it, then click on the More Actions overflow menu inside the message and select Sugar Connect > Open Sidebar, which will be toward the bottom of the list.
    Note: Once you open the sidebar, you may want to pin it open for ease of access later.
    outlook-web-open-sidebar
  6. Once Sugar Connect is installed, you may use the sidebar in either the web or desktop version of Outlook and proceed to Logging In.

Installing Sugar Connect for Gmail

The steps in this section describe the installation of Sugar Connect used with a Google Workspace subscription and Gmail. You must install Sugar Connect for Google Workspace on a Google Chrome browser. Once you have installed the extension, you can sync your browser settings to make it available on any computer where you access the browser profile to which it was installed. For more information on Chrome's browser sync, please refer to the Google Help article Turn Sync On or Off in Chrome.

  1. Open your Chrome browser and navigate to https://mail.google.com.
  2. Confirm that you are logged in to both Gmail and Chrome using the email address that you use to access Sugar. Please note that logging in to Gmail is different from logging in to Chrome.
    • To confirm your active Gmail account, click on the account icon or profile image at the top of the Gmail interface, just under your browser's toolbar:
      logged-in-user-gmail
    • To find your active Chrome profile, click on the avatar or profile image in Chrome's toolbar:
      logged-in-user-chrome
  3. Locate the Sugar Connect extension in the Chrome Web Store and click on "Add to Chrome" to install the extension.
  4. After installing, reload Gmail and find the Sugar Connect icon on the right side of your Gmail inbox. Click on the icon to expand the Sugar Connect sidebar and connect to your Sugar user account.
    gmail-sidebaricon
  5. Proceed to log in steps in the next section.

Logging In

The sections below outline the steps to log in to your Sugar Connect Sidebar based on the authentication type used by your Sugar instance which is either Standard Login or using SugarIdentity.

Note: Make sure that you or your admin have already registered a Sugar Connect account to avoid conflicts when you log in. If your Sugar instance does not have a valid TLS/SSL certificate chain, you will see a warning and will not be able to log in. If your Sugar instance has the "Validate user IP address" setting enabled, you will see a warning message after logging in. For more information on Sugar Connect prerequisites and recommended setup, please refer to the Sugar Connect Deployment and Administration Guide.

ipwarning

Standard Login

  1. In the Sugar Connect sidebar, select the region your Sugar Connect instance is hosted. Please note this may be different than your physical location. If you are unsure, please check with your administrator.
  2. Click "Log in" to get started configuring your connection.
    sidebarlogin
  3. In the pop-up window, select the appropriate option. If using the G-suite extension, you must Sign in with Google and if you are using the Office 365 Add-in, you must sign in with Microsoft.
  4. Enter your email credentials that are also associated with the Sugar Connect Portal. Please note, your organization may have SSO configured for this part of the log in process and you should follow the steps you normally would when using SSO.
  5. You must click "Allow" to grant permission for the connector to access your data when prompted. If your email address is associated with multiple organizations (tenants), you may be prompted to select one prior to logging in.
  6. Verify the URL shown under Sugar Login is correct (e.g. https://mysugar.sugarondemand.com). If it is not correct, you will need to contact the Sugar Connect Portal admin. Click the Log in button and enter your Sugar instance credentials.
  7. Click "Log in" to authenticate and start using Sugar Connect to work with your Sugar data.

After successfully authenticating the sidebar, you can start using Sugar Connect. For more information, please refer to the Sugar Connect User Guide for Google Workspace or Sugar Connect User Guide for Office 365.

Log in with SugarIdentity

  1. In the Sugar Connect sidebar, select the region your Sugar Connect instance is hosted. Please note this may be different than your physical location. If you are unsure, please check with your administrator.
  2. Click "Log in" to get started configuring your connection.
    sidebarlogin
  3. In the pop-up window, select the appropriate option. If using the G-suite extension, you must Sign in with Google and if you are using the Office 365 Add-in, you must sign in with Microsoft.
  4. Enter your email credentials that are also associated with the Sugar Connect Portal. Please note, your organization may have Single Sign On (SSO) configured for this part of the log in process and you should follow the steps you normally would when using SSO. If your email address is associated with multiple organizations (tenants), you may be prompted to select one prior to logging in.
  5. For Sugar Login, you will not have the option to enter/change the Sugar instance URL, as this will have been already set up by the Sugar Connect Portal admin. Click the Log in button. This will open a pop-up window where you must use your SugarIdentity credentials to log in.
  6. You must click "Allow" to grant permission for the connector to access your data when prompted. 
    allowaccess

After successfully authenticating the sidebar, you can start using Sugar Connect. For more information, please refer to the Sugar Connect User Guide for Google Workspace or Sugar Connect User Guide for Office 365.

Note: If you experience trouble during the log-in process and are using Google Workspace or Outlook on the web, please clear your browser cache. If you are using the desktop Outlook application follow these steps.

Logging in With SugarIdentity Using Multi-Factor Authentication

SugarIdentity supports multi-factor authentication, which provides an added layer of security for Sugar to prevent unauthorized users from gaining access to your account. When multi-factor authentication is enabled for your Sugar instance, you will need to use a mobile authenticator app (e.g., Authy, Google Authenticator, Microsoft Authenticator) when logging in to your Sugar account and enter the 6-digit code generated from the app to verify your identity.  

The following steps cover logging in to your Sugar Connect Sidebar using SugarIdentity with multi-factor authentication:

  1. Follow steps 1-5 in the Log in With SugarIdentity section above.
  2. If this is your first time logging in after multi-factor authentication has been enabled for Sugar, a QR code will appear on the screen. Scan the QR code using your authenticator app (e.g., Google Authenticator), then click "Continue". If you cannot scan the QR code using your mobile device, skip to step 3. 
    Note: If you have already paired an authenticator app with Sugar, then skip to step 4. 
    GettingStarted MFA QRCodeScreen
  3. If you cannot scan the QR code on step 2 using your mobile device, click the "Can't scan?" link and enter the secret key that appears on the screen into your authenticator app. Click "Continue".
    GettingStarted MFA SecretKeyScreen
  4. On the next step, enter the 6-digit code generated from your authenticator app, then click "Log In".
    Note: Once your authenticator app is paired with Sugar, for future logins, you will just be required to enter a new 6-digit code on this screen after entering your Sugar login credentials.
    GettingStarted MFA 6DigitCodeScreen
  5. A user consent window will appear requesting access to your Sugar account. Click "Allow access" to grant permission for the connector to access your data. 
    allowaccess

After successfully authenticating the sidebar, you can start using Sugar Connect. For more information, please refer to the Sugar Connect User Guide for Google Workspace or Sugar Connect User Guide for Office 365.

Note: If you experience trouble during the log-in process and are using Google Workspace or Outlook on the web, please clear your browser cache. If you are using the desktop Outlook application follow these steps.

Known Incompatibilities

Outlook add-ins and Chrome extensions that occupy the same area of the user interface as the Sugar Connect sidebar will likely cause conflicts and be incompatible with Sugar Connect. Please disable or uninstall any products that may compete with Sugar Connect for the right side of your email client's window.

The following Chrome extensions are known to be incompatible with Sugar Connect. Please disable or uninstall any of these extensions that you may be running if you plan to use Sugar Connect in Gmail:

  • AdBlock
  • Assistant.to (or similar extensions)
  • Boomerang (Calendar Events) and its features in Compose Form
  • Gmelius
  • Hubspot
  • LinkedIn Sales Navigator for Gmail extension
  • Loom for Chrome
  • MailTracker
  • Marketo Sales Connect (formerly ToutApp)
  • MixMax
  • Reply for Gmail
  • Yesware

Disabling Sugar Connect

Use the steps in this section to disable Sugar Connect without deleting it or its data. To fully uninstall Sugar Connect and all of its data, refer to the Uninstalling Sugar Connect section instead.

Note: If you have paid for a subscription to Sugar Connect, disabling it will not cancel your subscription.

To disable the extension in Outlook, follow these steps:

  1. Log in to your Office 365 account and navigate to your Add-ins Management page at https://outlook.office.com/owa/?path=/options/manageapps.
  2. Under the column labeled "Turned on", uncheck the box for the Sugar Connect row to disable the add-in for the online and desktop version of Outlook. 
    owa-turnedoff-addin

To disable the extension in Gmail (Chrome), follow these steps:

  1. Click the menu icon in the top-right corner of the Chrome browser window.
  2. In the drop-down menu that appears, select "More tools", and then "Extensions".
  3. In the Extensions tab, find Sugar Connect and click the toggle switch at the bottom-right of its extension box. This should turn it gray to indicate that it is disabled. You can revert the extension to its enabled (blue) state by clicking the switch again.

Uninstalling Sugar Connect

Use the steps in this section to uninstall Sugar Connect and delete all of its data. To simply disable Sugar Connect without fully uninstalling it, please refer to the Disabling Sugar Connect section.

Note: If you have paid for a subscription to Sugar Connect, uninstalling it will not cancel your subscription.

To uninstall the add-in from Outlook, follow these steps:

  1. Log in to your Office 365 account and navigate to your Add-ins Management page at https://outlook.office.com/owa/?path=/options/manageapps.
  2. Click on the row for Sugar Connect.
  3. At the top of the list of add-ins, click on the Uninstall (-) icon to delete the add-in for the online and desktop version of Outlook. 
    owa-uninstall

To remove the extension from Gmail (Chrome), follow these steps:

  1. Look for the extension's icon in the Chrome toolbar.
  2. Right-click the icon and select "Remove from Chrome".
    remove-chrome

If you do not see the Sugar Connect icon in your toolbar, refer to Google's instructions on how to uninstall an extension via the extensions page.

Last modified: 2021-08-26 15:33:39