SugarCRM SupportProduct GuidesPlug-insSugar ConnectSugar Connect Deployment and Administration Guide

Sugar Connect Deployment and Administration Guide

Overview

The Sugar Connect administrator performs required deployment operations and can access admin-only areas of the Sugar Connect Portal in order to add and invite users, organize the users into teams, and set some high-level user permissions. This guide will walk you through deploying and administering Sugar Connect.

For information on installing Sugar Connect as an individual user and using Sugar Connect's general features, please refer to the Sugar Connect User Installation Guide and the relevant user guide: Sugar Connect User Guide for Google Workspace (formerly G Suite) or Sugar Connect User Guide for Office 365.

Supported Regions

Sugar Connect is supported in the following regions:

  • North America
  • EU
  • APAC

Prerequisites

  • Your Sugar instance's hosting environment must meet one of the following criteria:
    • Your Sugar instance is hosted on SugarCloud.
    • Your Sugar instance is hosted on an internet-accessible platform such as AWS, Google Cloud Platform, Azure, etc.
    • Your Sugar instance is hosted on a platform that has a public (non-RFC 1918) IP, an FQDN that can be resolved via public DNS infrastructure, and accepts connections from the IPs listed in the Sugar Connect Outbound IP Addresses section of this page.
  • The site that hosts your Sugar instance must have a trusted TLS/SSL certificate chain for Sugar Connect to function.
  • Your Sugar instance must have the "Validate user IP address" setting disabled under Admin > System Settings > Advanced.
  • Your organization must use a paid version of Office 365 or Google Workspace. Sugar Connect cannot be used with Microsoft Exchange on-premise or hosted. For more information, please refer to the Plug-ins Supported Platforms.
  • All users on your Sugar Connect account must register under an email address within the same domain (e.g., '@:.com').
  • A company with multiple domains will need to create separate and uniquely named tenants by following the steps in Register as Your Organization's Administrator for each domain.
    Note: If your Sugar instance is not using SugarIdentity, you must have a unique admin user for each tenant set up in the "CRM Data Source" area of the Sugar Connect Portal.
  • Your organization's email domain cannot be a generic one such as @gmail.com or @microsoft.com; it must be your organization-specific domain issued with your Office 365 or Google Workspace account.
  • Group Policy (for Office 365) or Google Apps Console (for Google Workspace) may be used to deploy Sugar Connect to users as required by your organization. Otherwise, please follow the steps in this guide to set up and add users to Sugar Connect and then allow them to install Sugar Connect locally as explained in the Sugar Connect User Installation Guide. You may need to contact your organization's IT department or work directly with Microsoft or Google support to troubleshoot issues with the installation process.

Getting Started With Sugar Connect

The initial installation of Sugar Connect requires an administrator to perform important setup steps on the systems that interact with Sugar Connect.

Once these steps are completed, users can install and start using Sugar Connect, as described in the Sugar Connect User Installation Guide.

Adding Sugar Connect's API IDs to Sugar

In Sugar, the API Platforms configuration panel holds a list of client IDs that have been given permission to interact with your Sugar instance. This makes it easy for a Sugar administrator to configure which API platforms are allowed to access their instance via Admin > Configure API Platforms.

An administrator must use the following steps to add Sugar Connect's API platform in order for their Sugar Connect extension to fully work.

Note: These steps are only required for customers using Sugar version 9.0.x or lower. Beginning with version 9.2, the API IDs are pre-configured in the Sugar instance. If you are using Sugar 10.0 or higher, please proceed to the next section, Registering as The Sugar Connect Administrator.  

  1. Log in to Sugar as an administrator and navigate to Admin > Configure API Platforms (found in the Developer Tools section).
  2. Find the "API Platforms" panel and enter the following two platform parameters, clicking "Add" after each one:
    • collabspot
    • collabspotbackend 
      apiplatforms
  3. Click Save.

Your Sugar instance is now ready to work with Sugar Connect and you can get started setting up your account by registering as the Sugar Connect administrator for your organization.

Note: If your Sugar instance is running 11.0 or higher, you can disable notifications for Sugar Connect under the Enable Notifications column for the "collabspot" API platform.

Registering as The Sugar Connect Administrator

After purchasing Sugar Connect, you must decide who will set up and administer the software for use with Sugar in your organization. This person, the Sugar Connect administrator, must also be a Sugar administrator. The Sugar Connect administrator should then follow these steps to register your company and create a unique tenant with Sugar Connect:

  1. You should have received an email from Sugar with a link to create a Sugar Connect tenant. Click the link to begin the process. You can also click the following links to create a Sugar Connect tenant that will be hosted in the applicable region:
  2. Complete the following fields on the signup form:
    • Company name : Enter the name of your company.
    • Tenant name : Enter the desired name of your tenant, which must begin with a letter. It must also be unique as this will become part of the URL where your users will log in to the Sugar Connect Portal.
    • SugarCRM License Key : Enter your SugarCRM License Key that was provided to you or can be found within your SugarCRM instance via Admin > License Management.
    • Email provider : Select which email provider, either Google Workspace or Office 365, that your email domain (i.e. *@yourcompany.com) is purchased from.
      tenantcreate
  3. Read and click to accept the terms of service.
  4. Click on "Sign up" to continue the registration process.
  5. Click on "Sign in with Google" or "Sign in with Microsoft" to authenticate your Google Workspace or Office 365 account.
    • If you authenticate using a Google Workspace account, your users must install and use Sugar Connect for Google Workspace in a Chrome browser with Gmail, Google Contacts, and Google Calendar.
      google
    • If you authenticate using an Office 365 account, your users must install and use Sugar Connect with an approved version of Microsoft Outlook.
      office
  6. Click on "Create New" to complete the registration process. This can take a few minutes to finish.
  7. Upon authenticating as the first user from your domain, you will automatically be assigned "Admin" portal user status and will be redirected to the Sugar Connect Portal, where you must enter your Sugar admin credentials to continue. Click on "CRM Data Source" located on the left side of the portal under Admin Center.
    Note: If you have started adding users already, you will see an alert icon warning you that users have been invited without having a data source (i.e. your Sugar instance) set up. 
    crm-data-source
  8. Enter your SugarCRM instance URL. You will see a message that your instance has been verified.
  9. Enter your Sugar admin credentials in the CRM Data Source form and then click "Save". Please note, this is required whether your instance is SugarIdentity enabled or not.

Once your admin credentials have been accepted, you can start adding more users to your Sugar Connect account. The SugarCRM admin credentials can also be updated at any time from CRM Data Source > SugarCRM Administrator Credentials. You will receive a notification if the credentials were entered successfully or not. When your Sugar credentials change or expire, you will receive an email notification with a link to the Sugar Connect Portal where you will be asked to log in to Sugar with your updated credentials.

Note: With SugarIdentity, the Sugar administrator credentials used to link your Sugar Connect Portal to your Sugar instance are managed automatically.

Sugar Connect User Management

Once you have become a Sugar Connect admin via registration or configuration, you can start setting up users via the Sugar Connect Portal.

Note: Sugar Connect can be deployed to users via Group Policy or Google Apps Console. However, these deployment methods are not supported by Sugar. Instead, please follow the steps below to add users to Sugar Connect and then allow them to install Sugar Connect locally as explained in the Sugar Connect User Installation Guide.

Adding Users to Sugar Connect

You should be prepared for users to receive a welcome email the moment you add them to Sugar Connect as a user. The welcome email will direct them to the Sugar Connect Portal to get started using Sugar Connect.

Use the following steps to create a new Sugar Connect user:

  1. Navigate to the Sugar Connect Portal.
  2. Click on "Users" in the Admin Center section of the navigation.
    adminusers
  3. Click on the Add User button, enter the email address for the user, and then click "Invite". The user will receive an email message with a link to accept the invitation and the Users page will show the user's invitation is pending.
    invite-user
  4. While the invitation is pending, you may choose to resend the invite or cancel the invitation by clicking the appropriate button adjacent to the invited user's name.
    pending-invite
    Note: If the user has an email address in your organization's domain and you have enabled the "Auto-add new users" option for your Sugar Connect account, then canceling the invitation will not prevent the user from clicking through their invitation email and registering as a user on your subscription.
  5. The new user can now click on the Accept button in their invitation and log in to the Sugar Connect Portal with their Google Workspace or Office 365 account.

Once the user has accepted the invitation, their name will be moved from the Pending Invitations section and into its alphabetical position in the Users list. The User Actions menu will also become available for the user record at this time, which allows you to perform actions such as removing or disabling the user account or making the user an administrator.

Auto-Adding New Users From Your Domain

If enabled, Sugar Connect will also allow users to join your account automatically by simply authenticating through the Sugar Connect Portal from an email address at your organization's domain. For example, if you signed up for Sugar Connect using the email address admin@yourcompany.com, then any person who logs in to the portal with an email address ending in "@yourcompany.com" will automatically be added as a user to your account.

This option is disabled by default but can be enabled via the setting at the bottom of the Users page:
auto-add-users

User Actions Menu

The User Actions menu to the right of each user's name allows you to perform actions on the individual user directly from the list view. The options available will vary based on the admin and enabled status of the adjacent user.
user-menu

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

Menu Item Description
Make Admin / Revoke Admin Rights Assign or revoke Sugar Connect admin status for the user.
Remove User Removing a user will revoke their ability to log in as a Sugar Connect user but will not prevent them from re-registering as a user on your account if you have enabled the "Auto-add new users" option for your Sugar Connect account.
Manage Sync Map this Sugar Connect user to their Sugar account.
Disable / Enable User Enabling and disabling users controls whether the user will be able to authenticate as a Sugar Connect user.

Creating Administrator Users

Any Sugar Connect administrator can assign or revoke admin status for a user via the User Actions Menu once the user has accepted their new-user invitation. To grant admin rights to a Sugar Connect user, navigate to the Sugar Connect Portal and click on "Users", open the User Actions Menu next to the user's name, and select "Make Admin". 
make-admin

To remove admin access from a user, select "Revoke Admin Rights" from the User Actions Menu next to their name.

Mapping Users to Their CRM Accounts

In order for SugarCRM data to properly sync, the users must be mapped by connecting their Sugar Connect user to their Sugar CRM user within the Sugar Connect Portal. Users can be mapped automatically or manually.

Automatically Mapping

When users install Sugar Connect, they will be prompted to enter their Sugar credentials, which automatically maps their Sugar Connect account to their correct Sugar user account. The mapping process may also be automated via Auto-Link for users. This option is recommended and enabled by default. It can be toggled on or off in the CRM Data Source page in the Sugar Connect Portal. Auto-Link runs hourly to link unmapped Sugar Connect users with Sugar users based on a matching email address and makes the association automatically. Administrators can manually trigger the auto-link to run when they click "Add User Link" and if matching email addresses are not found, can also use this to manually map users.
crmdatasource

Manually Mapping

Administrators also have the ability to map Sugar Connect users to their Sugar user accounts through the Sugar Connect Portal by clicking "Add User Link", selecting an unmapped Sugar Connect user, and selecting the appropriate SugarCRM user. Properly mapping user accounts will ensure that calendar sync and contact sync behave as expected for users. Portal admin users can use the list which is synced from the CRM Data source to link Connect Portal users to SugarCRM users. If a user is deleted in the SugarCRM instance, the user will be unlinked and will no longer appear as an option within the Sugar Connect Portal.

Note: Changing a user's Sugar mapping will stop any active calendar or contact sync activities for the user.

Disabling and Removing Users

The Sugar Connect administrator can remove, enable, and disable users via the User Actions Menu in order to control whether those users can authenticate with Sugar Connect. The expected behavior will vary depending on whether the "Auto-add new users" option is enabled for your Sugar Connect account.

Action Auto-add new users: enabled Auto-add new users: disabled (default)
Disable User The user will not be able to log in and will be prohibited from creating a new user account The user will not be able to log in
Remove User The user will not be able to log in but will be able to create a new user account The user will not be able to log in
Cancel Invite Canceling the invite will have no effect; The invitee will be able to accept the canceled invitation and join as a new user Canceling the invite will succeed; The invitee will be prohibited from accepting the canceled invitation

Subscription Details

Sugar Connect administrators can view and edit the SugarCRM License Key from the Subscription Details page in the Sugar Connect Portal. The page will display the details of your subscription(s) including the product, number of licenses, and the expiration date of your subscription.

When your subscription is nearing its expiration date, you will see an alert icon next to "Subscription Details" and a corresponding message. Additionally, should your subscription key change in SugarCRM you will need to update it here.

subsdetails

Customization

Sugar Connect administrators can view and edit the fields that appear in the Sugar Connect sidebar record view for all available modules from the Customization page in the Sugar Connect Portal. The page displays the modules in a dropdown and available fields from Sugar. 

To make changes to your Sugar Connect sidebar Record View, begin by selecting the module from the dropdown field and enable or disable each field as appropriate. You can use the search bar at the top of the page to narrow the field list and be sure to click the Save button at the bottom of the field list to successfully update the record view in your sidebar.

Note: Required fields appear as enabled and the ability to toggle these fields off is disabled. Fields that are unsupported by Sugar Connect appear as disabled and the ability to toggle these fields on is disabled. 
customization

Settings

Sugar Connect administrators can set the default email tracking and calendar sync settings for users from the Settings page in the Sugar Connect Portal.
settings2

Tracking

The email tracking settings dropdown contains four options for you to choose from. You will need to click "Save" for the settings to be applied to your users. 

  • Always Enabled: Emails are always tracked and individual users are unable to override this setting.
  • Always Disabled: Users in this tenant are not allowed to enable email tracking.
  • Disabled by Default: Emails are not tracked by default, but individual users can choose to enable tracking.
  • Enabled by Default: Email tracking is enabled by default, but individual users can choose to disable tracking.

For information on Email Tracking statistics in the portal, please refer to the Email Tracking section in the Sugar Connect Portal User Guide. For information on Email Tracking within your email client, please refer to the Email Tracking section in the User Guide for Google Workspace or the User Guide for Office 365.

Calendar Sync

The calendar sync settings dropdown contains four options for you to choose from. You will need to click "Save" for the settings to be applied to your users. 

  • Two-way Sync by Default: Users' external calendar and Sugar calendar events will sync bidirectionally by default. Users can choose to override this setting by disabling "Two-way Synchronization" in their Synchronization settings. Selecting this option will not change existing users' active sync profiles.
  • Two-way Sync Always Enabled: Users' external calendar and Sugar calendar events will sync bidirectionally. Users cannot override this setting. Selecting this option will change all users' sync profiles including those with an active sync.
  • One-way Sync by Default: User's external calendar events will sync to their Sugar calendar in a single direction by default. Users can choose to override this setting by enabling "Two-way Synchronization" in their Synchronization settings. Selecting this option will not change existing users' active sync profiles.
  • One-way Sync Always Enabled: User's external calendar events will sync to their Sugar calendar in a single direction. Users cannot override this setting. Selecting this option will change all users' sync profiles including those with an active sync.

For information on calendar sync in the portal, please refer to the Calendar Sync section in the Sugar Connect Portal User Guide.

Sugar Connect's Outbound IP Addresses

The following outbound IP addresses are used by Sugar Connect. SugarCloud instances will automatically accept calls made from these IPs. For on-site hosted instances, please confirm that these IPs are added to the allowlist for your Sugar server in order for Sugar Connect to successfully make network calls to your Sugar database.

  • 52.88.151.74
  • 52.40.34.59
  • 52.43.45.176
  • 52.58.11.13
  • 3.124.84.100
  • 3.121.108.6

Adding Sugar Connect to Your Google Workspace Account's Trusted List

If your users will authenticate using a Google Workspace account, you may need to tell Google that Sugar Connect is a trusted third-party application that has permission to access your Google Workspace data. 

To add Sugar Connect to the trusted list, ask your Google Workspace administrator to follow Google's instructions under "Add or remove an app from the trusted list" on this Google Workspace Admin Help page. To search for and add the Sugar Connect app, they may need the following Sugar Connect Client ID

830549683689-3d8sk3jeufed8bptrmv1feppfbsksls7.apps.googleusercontent.com

Last modified: 2021-10-11 19:14:35