SiteGround Tutorials

SugarCRM Tutorial

Introduction to SugarCRM

Sugar CRM Suite is one of the most popular customer relationship management (CRM) systems available
today developed by SugarCRM Inc. In fact there are three different versions of this software. In this
tutorial we'll be talking about Sugar Open Source. Sugar CRM OS is freely distributed and customizable,
and possesses a rich set of features. The implementation of SugarCRM in your business will improve
your customer service and will help you to closely monitor your company performance. SugarCRM is
suitable for all kinds of businesses. With SiteGround hosting you can use all  Sugar CRM OS features. 

The application is very well supported and there are many language packs, plugin for Outlook and many
free themes. Also Sugar Suite is written in a simple, popular programming language (PHP) that can be
customized in an instant. Further more if you are a programmer you can take a look at the source and
modify it. Due to its open source nature there is a big devoted community with thousands members
who develop and test all the time new useful stuff. 

Currently the latest stable release of Sugar CRM is version 4.0. In this tutorial will focus mainly on it but
most things should apply for other versions too. 

SugarCRM Tutorial covers the following areas:

Clean SugarCRM installation* of version 4;  
How to upgrade SugarCRM version;  
How to create backups and restoration of SugarCRM;  
Selection of the most common problems with SugarCMS and troubleshooting them;  
Working with SugarCRM  ­ creating contacts and accounts, sharing documents,  email
options.  

Check the  CRM Hosting package if you would like to start your SugarCRM website immediately! 

Please note, that with SiteGround CRM Hosting package you get a free installation of SugarOS 

(c) Copyright 2006 SiteGround SugarCRM Hosting Services. All rights reserved 

You may use this tutorial for your own use. You may not distribute it in any form without the express permission of 
the publisher. You may provide a link to the publisher's web site, where this tutorial can be used from. This tutorial 
is provided free of charge and without any warranty of any kind.

SugarCRM installation

Get a FREE SugarCRM installation with SiteGround SugarCRM hosting  Package! 

MySQL database setup and adding a user for SugarCRM

Before installing Sugar OS we need to create a MySQL database and add a user with all privileges to it.
This can be done following these simple steps: 

Log into your CPanel (located at https://yoursite.com:2083 for your domain, use the login
for your Customer's Area at Siteground).  
Go to MySql databases  
Scroll down to where it says: Db: _________ [add]. Enter your preferred database name.
Click Add.  
This will create a database in the format of account_databasename, where account is your
username with Siteground. Databasename is the name you've chosen for your database ­ in
this tutorial we've used sugarcrm  
Now scroll down to Users. Enter a username and password, then click Add User.  
This will create a username in the format of account_username, where account is your
username with Siteground, and username is the one you have just created for your new
 Click Add.  
This will create a database in the format of account_databasename, where account is your
username with Siteground. Databasename is the name you've chosen for your database ­ in
this tutorial we've used sugarcrm  
Now scroll down to Users. Enter a username and password, then click Add User.  
This will create a username in the format of account_username, where account is your
username with Siteground, and username is the one you have just created for your new
database.  
Please, scroll back up to locate the two drop down boxes with a button that says [Add User
to Db].  
In the drop down select box on the left, choose your newly created username, and in the
box on the right, choose your newly created database. Click Add User to Db.  

SugarCRM download and installation

That's all about the database setup. Next we proceed with getting the necessary package. Sugar OS
can be downloaded freely from: 

http://www.sugarcrm.com/crm/download/sugar ­suite.html 

We are going to need the full core package at the top  ­ Sugar Open Source. There are also installers
which contain besides Sugar CRM a full running version of the server needed. We won't consider this
option because we are using Siteground's premium services which provide the necessary hosting
solution. 

So after following the link to the download we should have locally on our PC the file SugarSuite ­4.*.zip
(* would correspond to the current stable branch). Then we unzip the file and upload only the
contents inside the extracted folder to our web space at Siteground. This can be easily done with
Filezilla ­  a   f r e e   o p e n   s o u r c e   f t p   c l i e n t   ( L e a r n   m o r e   a b o u t   F T P   c l i e n t s   a n d   a c c o u n t s   h e r e   :
http://siteground.com/ftp_client_account.htm). When uploading please use passive mode and carefully
fill in your username, password and ftp address. You can either create a directory on the remote server
called SugarCRM or directly upload all the files to your public_html folder. The second option should be
considered when you would like to have SugarCRM as your main site. 

Now we have uploaded the files and we go to the corresponding url ­ in our case: 

http://yoursite.com/SugarCRM  

If you have followed correctly all the steps up to now you will be taken to a default welcome page. At
the bottom of it you'll find a link to start the installation.  

When we click the Start button, we are taken to a page with the License Acceptance. We check
"Accept" at the bottom and proceed to the next step. Now we have a system check, which has to
ensure all files have the necessary permissions and the server is compatible with our installation. All
options must be green "OK". Only after this we can proceed next.Step 3 is the most important in the
setup process. We have to specify the database configuration:  

For Host Name we use localhost. This is our server's default name. In Database Name we specify the
database we have already created. Mind to specify your full database name, which includes your
account name with Siteground  ­ e.g. "accountusername_sugarcrm". For User name we use again the
already created and added to the database user  ­ its full name including our account name. Last we
specify the password for the database user. 
  

For Host Name we use localhost. This is our server's default name. In Database Name we specify the
database we have already created. Mind to specify your full database name, which includes your
account name with Siteground  ­ e.g. "accountusername_sugarcrm". For User name we use again the
already created and added to the database user  ­ its full name including our account name. Last we
specify the password for the database user. 

We leave unchecked Create database and Create user because we have already done it. It is not
necessary to check Drop and recreate existing SugarCRM tables because we are doing a clean
installation. If you prefer, you can check the "Populate database with demo data" button. This would
be useful if you want to explore a working system and you intend only to test the current installation.
Otherwise it may confuse you because you would have to delete all the data later.  

Next page can be left with the values populated by default. You have to specify only your
administrator's password for the application and retype it. 

We click Next and we're taken to a page in which we have to confirm our settings until now. Here you
should have no problems and just proceed with next. Then the installation is performed and you should
see at the bottom:  

"Your system is now installed and configured for use. You will need to log in for the first time using the
"admin" user name and the password you entered during setup."  

Finally you have the opportunity to register your installation. This would be helpful for the developers
and their future plans. If you are not interested you just click Finish at the bottom. 

Well done! This is the end of the SugarCRM installation process and you are automatically redirected to
your default start page.  

(c) Copyright 2006 SiteGround SugarCRM Hosting Services. All rights reserved 

SugarCRM Upgrades

For SiteGround Customers: SugarCRM upgrade currently requires too many specific
server setup changes, which is not secure for a shared server. That is why SugarCRM
upgrade is not possible. If you would like to use the latest SugarCRM version on a
shared server you would need to make a fresh installation instead of upgrading an
existing SugarCRM. 

Upgrading previous releases of SugarCRM to the latest one

This section will guide you how to upgrade from Sugar Suite 3.5.x to 4.0. We consider you already
have a running application and you have decided to upgrade. Prior to upgrading you are strongly
advised to backup all you files and database. Please refer to the  SugarCRM backup section  in this
tutorial or ask our friendly Support team at Siteground to do the backup for you. 

In order to begin the upgrade process you would need to download SugarCRM 4.0 Latest Stable Patch
file. Then please log in your SugarCRM with the admin username and password. After that go to Admin
link in the up right corner.  

Next find the link to the Upgrade Wizard and proceed. At this step you would have to upload the
upgrade file you've downloaded recently. Then click on the Install button. Next will appear a list of the
changes that will be applied. You have the option to uncheck values and thus not to upgrade them,
In order to begin the upgrade process you would need to download SugarCRM 4.0 Latest Stable Patch
file. Then please log in your SugarCRM with the admin username and password. After that go to Admin
link in the up right corner.  

Next find the link to the Upgrade Wizard and proceed. At this step you would have to upload the
upgrade file you've downloaded recently. Then click on the Install button. Next will appear a list of the
changes that will be applied. You have the option to uncheck values and thus not to upgrade them,
which is not recommended unless know what you are doing. Next you click on Commit. After this all
applied changes are listed and at the end should be:  

"Upgrade applied successfully!"  

Still there are more things to be done. You have to click on Return to Upgrade Wizard at the bottom.
You might have to update your Time zone too, which is fairly easy clicking on the button and choosing
the right one.  

After this go back to the Admin page (click on the Admin link up right). Then navigate and click on the
Repair option which is in the right corner of the first table on the page. Next we'll follow the links
Rebuild Relationships first and then Rebuild Extensions. Both should return Done at the end.  

Well done! That's the end of the process and now your SugarCRM is upgraded.  

(c) Copyright 2006 SiteGround SugarCRM Hosting Services. All rights reserved 

SugarCRM Backups

Creating backups of SugarCRM and its MySQL database and restorating them

There is a backup tool included in the application. We won't consider using it though because it is not
complete  ­ it does not take care of your database which is very important. 

In order to restore fully your SugarCRM you need to have the database restored and the files copied
backed to the server.  

So first we need to export the database. It can be done from PhpMyAdmin. In order to reach it you
have to log in your Cpanel, go to MySql databases and at the bottom of the page is the link to
PhpMyAdmin. Exporting your database is simple. First on the left side choose your SugarCRM database.
Then click the Export tab. Next select all the tables. From Structure options check also Add DROP
TABLE and then click Go. Thus you'll download a sql file. Now we have the MySql file needed for
backups. 

We can restore our backup by importing the mentioned sql file into an empty database or into a
SugarCRM database. In order to do that we go again to our PhpMyAdmin and choose the database
we've specified to use with our SugarCRM. Then we click on the SQL tab and from the second menu
we browse to the sql file on our PC and click Go. If the query is successful our database has been
populated with the backup data.  

After clearing out the database backup procedure we'll proceed with managing the files. The easiest
option is to copy the whole folder with SugarCRM from the server to your local PC by ftp. Later when
you want to restore your old SugarCRM just copy back the files from your pc to the server in the
proper directory. 

(c) Copyright 2006 SiteGround SugarCRM Hosting Services. All rights reserved 

SugarCRM Common Problems and Troubleshooting

At the time this tutorial was written, the 4.0 SugarCRM version was quite fresh in the stable branch.
Thus many problems are just to be discovered. Fortunately, as we've mentioned there is a big
community around the project and very helpful and  supporting forum. 

Usually problems are connected with files permissions and database issues. That's why it is important to
upload files intact as they have been extracted. Also when upgrading make sure you follow the
instructions from the manual. Trying manually to overwrite files may result in various errors. If this
happens try again to use the mentioned upgrade package and see if you can follow the rest of the
At the time this tutorial was written, the 4.0 SugarCRM version was quite fresh in the stable branch.
Thus many problems are just to be discovered. Fortunately, as we've mentioned there is a big
community around the project and very helpful and  supporting forum. 

Usually problems are connected with files permissions and database issues. That's why it is important to
upload files intact as they have been extracted. Also when upgrading make sure you follow the
instructions from the manual. Trying manually to overwrite files may result in various errors. If this
happens try again to use the mentioned upgrade package and see if you can follow the rest of the
instructions. If you end up with total mess, don't hesitate to contact Siteground's Support team and
the least we can do is to restore your backup on the server from last week.  

(c) Copyright 2006 SiteGround SugarCRM Hosting Services. All rights reserved 

How to use SugarCRM

SugarCRM web interface is very intuitive. A very detailed User Admin Guide can be downloaded from
Developers' site. Here we'll give you basic directions to get you started and accustomed to working
with the application. 

All main features have corresponding tabs for fast access at the top of the screen. There is a possibility
to export the data contained within components to a .csv (Comma Separated Value) file. It can be
imported in many applications like MS Excel for example. Next we'll take a look at the most important
ones: 

How to create contacts, accounts and how to share documents in SugarCRM  
Emails options in SugarCRM  

(c) Copyright 2006 SiteGround SugarCRM Hosting Services. All rights reserved 

How to use SugarCRM

How to create contacts in SugarCRM?

First, contacts are people related to sales accounts. There is a tab Contacts which brings you to a list
with all the contacts. You can add contacts from this page. Contacts may also be added directly from
the left Shortcuts menu on the home page. 

By clicking on the link Create Contact on the left Shortcuts menu you are taken to a page with
numerous fields. There you can store quite detailed information for your contact. You don't have to fill
all the fields, but the Family Name by which the contact is saved. 

Another way to add a contact is by the shortcut Enter Business Card from the left menu. The
difference is that here are provided less details. There is also a possibility to import a contact from a
vCard by uploading the file. The link to this can be found on the Shortcuts menu in Contacts tab.  

It is useful to know that Contacts can be exported to a .csv file (Outlook compatible). This is done by
checking the box next to the Contact's name and clicking the red Export link at the top/bottom of the
list. 

How to create accounts in SugarCRM?

For managing your accounts, please click on the Accounts tab. Creating account is just as easy as
everything else in this very user friendly application. You have a link for creating contacts on your left
Shortcuts menu. It is recommended to fill in as much information as you have so that everyone can
benefit from it. Make sure you fill in Account Name as it is used for the name by which the account will
be stored.  

Creating Leads, Opportunities, Cases, Tasks or scheduling Meetings and Calls is similar to the mentioned
above. Just follow the link on the Shortcuts menu on the home page. Click on the corresponding tab
for more details and operations.  
benefit from it. Make sure you fill in Account Name as it is used for the name by which the account will
be stored.  

Creating Leads, Opportunities, Cases, Tasks or scheduling Meetings and Calls is similar to the mentioned
above. Just follow the link on the Shortcuts menu on the home page. Click on the corresponding tab
for more details and operations.  

How to share documents in SugarCRM?

Sharing documents is an incredibly useful and convenient feature in SugarCRM which allows you to
upload files and share them with your team. You can specify revision details, full description and
expiration date for them. Efforts have been again focused on making working with it very intuitive. 

(c) Copyright 2006 SiteGround SugarCRM Hosting Services. All rights reserved 

How to use SugarCRM

Email features in SugarCRM: E­mail Options 

Mail features in SugarCRM have some sophisticated options. On one hand you can send emails from
your account at SugarCRM provided you've specified the right settings. If you haven't done that
already, a red link will appear: 

Warning: Your email settings are not configured to send email. Edit 
My Settings 

Click on "Edit My Settings". On the new page find E ­mail Options. In the general case your settings
should look like this: 

The new fields will open when you choose to use SMTP as Mail Transport Agent and check the box
next to Authentication SMTP Username. You can use your mail account at Siteground for sending mails
so just specify the corresponding values. At the end click Save. Now you'll be able to send mails right
from SugarCRM. 

Inbound Email Setup

Next we'll take a look at the incoming mail options. For this purpose please navigate to your Admin
section (Admin link up right). Then go to Inbound Email link at the bottom and choose Manage
Mailboxes. You have 2 settings for editing. The first one is ­ Monitor new mailbox. 

Specify the above settings in the first box corresponding to your account. You can leave the middle
box untouched. The bottom box is quite interesting. You can choose from the possible actions what
to do with the incoming mails. There is also a possibility to assign the received mails to a group. Please
explore all possibilities and choose the appropriate for you. 

Please, find more information about email settings at the Email tutorial. 
Specify the above settings in the first box corresponding to your account. You can leave the middle
box untouched. The bottom box is quite interesting. You can choose from the possible actions what
to do with the incoming mails. There is also a possibility to assign the received mails to a group. Please
explore all possibilities and choose the appropriate for you. 

Please, find more information about email settings at the Email tutorial. 

Those were among the most important features we've covered. As we've mentioned working with
the application is intended to be intuitive and user friendly. It might be useful to have your first
installation populated with sample data (refer to the Clean installation at the beginning of the tutorial),
so you can explore all features with sample values.  

Please, feel free to contact us if you have any questions or recommendations about this tutorial at:
tutorials 'at' siteground.com  

(c) Copyright 2006 SiteGround SugarCRM Hosting Services. All rights reserved