Overview
This guide assumes that you have the required resources to access the Sugar application and you are familiar with how to use them. Contact your system administrator for issues and concerns.
Prerequisites
Ensure that you have the following installed and configured on your machine before using Sugar:
- A web browser application on your computer. For information on the supported browsers, see Supported Platform Components for Sugar.
- JavaScript support and cookie support enabled within the web browser used to access Sugar.
- Network access to a server that is running the Sugar software.
Your system or network administrator can provide you with a web address (URL) from which the system can be accessed.
Note: For detailed information on supported versions for all the Sugar components, see Downloading and installing Sugar.
Web browser window controls
Sugar dynamically generates the HTML pages that the web browser displays when you click certain buttons on a web page. Sugar may not display these pages if you use the browser’s Back and Forward buttons. It is recommended that you use the Actions bar on the module tab to navigate back and forth in the application.
Note: Sugar is designed for a minimum 1024x768-pixel screen display resolution.
Accessing Sugar and setting your User Preferences
Use a supported web browser to access the Sugar application. You will need a user account and login credentials to log into the application. The System Administrator must provide you with your user name and password. You can change your password after you log into Sugar.
Troubleshooting tips
Perform the tasks listed below if you cannot log into Sugar:
- Verify that the username and password are correct, including any upper-case letters
- Verify with your system administrator that you have the correct username and password
- Contact your system administrator to ensure that your account has not been disabled
The Forgot Password? link displays in the Log In window if the Administrator has enabled this feature. Click this link if you cannot remember your password, enter your username and password in the relevant fields, and click Submit. Sugar will send you a link to the page where you can reset your password. Contact the administrator for a new password if this link is not available to you.
Available languages
The default language in Sugar is US English. Administrators can install additional languages if necessary. Language packs are available at http://www.sugarforge.org.
Configuring User Preferences
Follow the steps listed below to access Sugar and configure your User Preferences:
- Enter the Sugar URL in the address bar of your web browser.
This displays the Sugar Log In page with fields to enter your Sugar credentials. The Sugar Log In page also displays a Language drop-down field from which you can select the language that you want to display in Sugar.
For information on using the Admin Wizard that displays when you login as an administrator, see Configuring Settings in Sugar. - Enter your username and password.
- Click Log In.
This displays the User Wizard if you are a regular user. The Sugar User Wizard guides you through the process of entering your Profile information and Locale settings in Sugar. You can change your profile information and locale settings in the Wizard if the administrator has already configured these settings for you. You can also change them from the User Preferences page after you log into Sugar.
The administrator also configures a default SMTP email server to send out email notifications and alerts. An Email Settings tab displays in the Wizard if the administrator has enabled users to use this email server for outgoing emails. Specify your username and password in the Email Settings tab to send out emails from that email server.
For information on user preferences, see Editing your User Preferences. - Click Next to navigate from one page to the next; make the desired changes to your settings, and click Finish to exit the wizard.
This displays your Sugar Home page. You can now begin using the Sugar application. For information on using your Home page, see Home Module .
User session rules
Sugar has set the following rules for user sessions for security purposes:
- You cannot log into a Sugar instance simultaneously using the same account from two different machines or browsers.
- Two different users cannot log into a Sugar instance separately with two simultaneous sessions using the same username. When you are logged into a Sugar instance, if another person logs in using your credentials, you will be automatically logged out. Hence, to avoid conflict, it is recommended that you do not share your credentials with other users.
Sugar enables you to do the following:
- Concurrently log into Sugar through the Sugar Plug-in for Outlook (or other plug-ins and extensions using Web Service APIs) when logged into Sugar through a browser
- Open an unlimited number of pages of a Sugar instance within a single browser
Editing your User Preferences
When you log into Sugar, your name displays on the top right corner of the page. You can click it to view and edit your default settings. You can also view the list of modules you are allowed to access and your access permissions, such as View, Edit, and Delete, for each module. You can edit some of these settings to suit your requirements, such as the Sugar modules that you want to view when you login. You cannot change your level of access to modules or view modules that you are not allowed to access.
User Profile
This tab displays your profile information such as your full name, your Sugar username, phone number, address, title, and email address.
Employee Information
Employee Information is entered by the administrator and displays information such as your title, your supervisor’s name, and your contact information.
Email Settings
The Email Settings section displays your email address and email client. The system administrator has the ability to setup one or more email addresses and specify your primary email address for automated responses to emails. For information on editing this information, see Editing your Email Settings.
You can send emails automatically if the administrator has setup an SMTP server and has enabled you to use the associated mail account to send emails. Fields for the SMTP username and password are displayed if the administrator has not enabled you to use the mail account. Enter the username and password for your mail account to send out emails using this SMTP server. For information on specifying another SMTP server from the Emails module see Configuring Email Settings.
Password
Use the Password tab to change your password. For more information on changing your password, see Managing your password.
Advanced
The Advanced tab displays the following sections:
User Settings
In this section, you can change the default settings for the following:
Export Delimiter. This is the character that will be used to separate field values when you export data from Sugar. The default is a comma (,).
Import/Export Character Set. Select a character set from this drop-down list to export and import data and generate Vcards.
The administrator sets the default export settings such as the delimiter used to separate data in export files and the default character set used to import and export data from Sugar. You can override the administrator’s settings with your own. The default character set to export data is UTF-8. Specify the appropriate character encoding for your locale if your locale is not USor Western Europe. This ensures that the character set used by the Sugar system to create the exported file is mapped to the correct character set on your machine. For example, MS Windows uses SJIS in Japan. Users in this locale need to select SJISas the default export character set instead of UTF-8. This character encoding setting is also used when importing data into Sugar.
Show Full Names. Select this option to display your full name in My Activity Stream and in the Assigned to field in records.
Notify on Assignment. When you enable this option, you will receive an email notification when a record from any of the following modules is assigned to you:
Accounts
Contacts
Opportunities
Leads
Meetings
Calls
Tasks
Cases
Bugs
Quotas
Campaigns
Projects
Reminders. Select a default time interval as a reminder for calls and meetings from the Reminders drop-down list.
Mail Merge. You can enable this option to merge data such as names and addresses from Sugar with form letter templates created in Word if you are using Sugar Plug-in for Word. This needs to be enabled by the System Administrator.
You can also assign yourself to the role of a Group User through the User Management option on the Administration Homepage if you are an administrator.
Layout Options
You can change the default settings for the following in this section:
Grouped Modules. Select this checkbox to view module tabs in the navigation bar, based on pre-defined groups. All modules with appear in the navigation bar if this feature is not selected.
Edit Tabs. Enables you to hide modules that you do not require. Move the module from the Display Tabs list to the Hide Tabslist using the right arrow to hide the module. Use the left arrow to move a module name from the Hide Tabs list to the Display Tabs list to display the module. These settings can be applied globally by the administrator.
You can change the order in which module tabs display in Sugar. Select the module in the Display Tabs list and click the Up arrow to move up a module; click the Down arrow to move down the module.
Number of tabs.Enter a value to specify the maximum number of module tabs to display at the top of page before the overflow menu, indicated by a down arrow, appears.
Subpanel Tabs. Enable this option to group subpanels into tabs in the Detail View of records.
Locale Settings
In this section, you can change the default settings for the following:
Date Format. Select a format for date stamps from this drop-down list. The default is mm/dd/yyyy.
Time Format. Select a format for time stamps from this drop-down list. The default is in hours.
Time Zone. Set your time zone.
Name Display Format. Specify display of names in records. The default is Salutation, First Name, and Last Name (sfl).
Sugar uses the specified Name Display Format in Quick Search to find related records when you enter a character in theRelated to field within a record, such as a Call or a Meeting. When you type a character in the field, the system performs a quick search of possible values and presents a list of values starting with that character. If the Name Display Format specifies “s f l”(Salutation First Last), then Sugar displays a list of first names that start with the specified character. For example, if you enter “A”, the system displays first names starting with “A”. Similarly, if the Name display format specifies “s l f”, then the system displays last names starting with “A”.
User Wizard Prompt. This is available to users with administrator privileges only. Select this to enable new users to go through the New User Wizard during first login.
Currency. Select the currency to use in records from this drop-down list. The default is US Dollar.
Currency Significant Digits. Select the number of digits that display after a decimal from this drop-down list.
1000s separator. Enter the character used to separate thousands. The default is comma (,).
Decimal Symbol. Specify the decimal symbol to use. The default is a period (.).
First Day of the Week. Specify the first day of the week that displays in Week, Month, and Year Views.
Calendar Options
Publish Key. Enter a key number to publish available/busy information from an external calendar application, such as Microsoft Outlook. Provide this key to users of other calendar applications if they want to view your calendar. Sugar allows access to your calendar to individuals who can provide this key.
External Accounts
The following Connectors are available in Sugar:
- LinkedIn — View your LinkedIn contacts at a specific company (Sugar matches the company name in a Sugar field)
- InsideView — View key sales intelligence directly in Lead, Account, Contact and Opportunity records, and get relevant company information, contacts, news, and social media insights within Sugar
You can access your LinkedIn records within Sugar if you have an existing LinkedIn account.
Note: You do not need to have an InsideView account. InsideView identifies user accounts by their email addresses. If you have an existing account with InsideView, you are immediately connected to the their service. You can use their free trial version if you do not have an account with InsideView. For more information, see Accessing InsideView.
LinkedIn and InsideView are enabled by default in all upgrades and new installs. Request your administrator to disable InsideView, if your organization does not want to use it.
Access
This tab displays the module access permissions that the administrator has granted you to perform specific actions such as editing and deleting records. The administrator can enable or disable access to any Sugar module. You cannot edit these settings.
Roles
Scroll down the Access page to view roles that the system administrator has assigned to you. You cannot edit your roles.
Downloads
This tab displays links to Sugar Plugins for Microsoft Outlook, Microsoft Word, and Microsoft Excel. Click the appropriate link to download a plug-in to your local machine. You can then install it on your machine.
Click Reset User Preferences and OK to revert to your default settings after saving any changes that you made.
Similarly, you can restore the default settings by clicking the Reset Homepage after customizing your Home Page.
Editing Email Settings
You can view and edit your default email address. The default SMTP email server is used to send emails from Sugar if this has been enabled by the administrator.
Follow the steps listed below to change your email settings:
- Click your name on the top right corner of the Sugar page.
This displays the Users module. - Scroll down to the Email Settings sub-panel on the User Profile tab.
- Overwrite existing email address with new email address and click Save to change an existing email address.
Click the plus (+) sign, populate new field, and click Save to add another email address.
You can add multiple email addresses. The first email address that you enter is selected as the primary email address by default. Click the Primary button corresponding to the email address that you want to specify as the new primary address to select a different email address as the primary address.
Select the Reply-to radio button corresponding to the email address that you want to specify as the new reply-to address to specify a different email address for automated responses to emails. - Select the email client of your choice from the Email Client drop-down list. Select Sugar Email Client to send emails using the default email client that the administrator has configured, or External Email Client to use an external email client such as Microsoft Outlook.
- Email Provider. This field displays the email server address if you selected External Email Client.
- Enter the SMTP user name and password for your email account if you selected Sugar Email Client. (You will be using the administrator-configured SMTP server to send out emails).
- Click Send Test Email to send out a test email to ensure that the settings are correct.
- Click Save to save your settings; click Cancel to exit the page without saving your changes.
Managing your password
You will be provided with a temporary password when the administrator initially grants you access to Sugar. Change this password after you log into Sugar. Ensure that you choose a password that is easy for you to remember, but difficult for others to guess. You can change your password at any time. For security reasons, it is recommended that you change your password periodically.
Changing your password
Follow the steps listed below to change your password:
- Log into Sugar and click your name on the top right corner of any Sugar page.
This displays the Edit User page. - Click the Password tab.
If there are password rules, they will display in this section. Your new password must adhere to these rules. Each rule will be marked with a red cross. When you enter your password, as each rule is met, the cross will be replaced with a green checkmark. You can save your new password only after all the rules have checkmarks. - Input current and new passwords in the relevant fields and click Save.
Resetting a forgotten password
The Forgot Password? link displays in the Log In window if the administrator has enabled the Forgotten Password feature.
Follow the steps listed below to request for a new password if you have forgotten your existing one:
- Click the Forgot Password? link in the Sugar Log In window.
- Input relevant information in the User Name and Email Address fields and click Submit.
This displays a message confirming that your request has been submitted. You will also receive an email with a link to access the Password Reset page. Populate fields with required information and click Save.
Contact your system administrator for a temporary password if you do not see the Forgot Password? link in the Log In window. Log into Sugar with the temporary password and change it.
Security timeout
For security reasons, the system automatically logs you out if you do not perform any tasks for a specified period of time. This timeout period is determined by two factors:
- The lifetime of the PHP Session Cookie (PHPSESSID). The default lifetime is until the browser is closed.
- The PHP session timeout period. The default value is 1440 seconds (24 minutes).
If you do not perform any tasks for a certain time period, the system logs you out either because the browser session or the PHPsession timed out.
Click any button on the page when you are ready to resume working. This automatically directs you to the Log In page. You can also close the web browser and navigate to the Log In page in a new browser window.
