Table of Contents

Administrative Functions

These tools are used by the administrator and are accessible through the admin panel in the top right of the SugarCRM interface.

Adding a New Data Field to a Module

  1. While logged in as administrator, click the Admin link at the top right.
  2. Scroll down to find the Dropdown Editor link and click it.
  3. Choose a dropdown to edit or click the Add Dropdown button.
  4. Dropdown items are added and can be placed in any order by dragging and dropping or sorted by name. It is often desirable to put a “none” item at the top of the list.
  5. After saving the dropdown, click the Studio button at the bottom of the page.
  6. Find the module you would like to add the new dropdown to, expand the folder, and click Fields.
  7. Click the Add Field button at the top of the center window.
  8. Choose the data type “DropDown” (or whatever else), and fill in the rest.
  9. Under “Drop Down List” find and choose the dropdown you created earlier.
  10. Choose a default value.
  11. Check the box next to “Mass Update” if you would like this field to be mass updatable.
  12. Click Save.
  13. Under the module folder you've selected, expand the “Layouts” folder.
  14. Click EditView.
  15. There are now 2 panels labeled “Toolbox” and “Layout.” You can drag items from the Toolbox into the Layout panel. Drag the “New Row” item from the Toolbox into one of the sections under Layout.
  16. There is now a new row. Scroll down in the Toolbox to find the new field you would like to add and drag it into the new row you created under Layout.
  17. Click the Save & Deploy button above the Toolbox. The new item you added to the Layout has changed. There is now a ”+” symbol next to it. Click the + and click the Save & Deploy button again.
  18. Now, under the Layouts folder on the left, click DetailView and repeat the process. EditView and DetailView refer to the page for editing a record and the page for viewing the details of a record. Fields must be added to them separately, which is why this process must be repeated.

Adding a New Lead Status

  1. While logged in as administrator, click the Admin link at the top right.
  2. Scroll down to find the Dropdown Editor link and click it.
  3. In the “Dropdowns” list on the left, scroll down and click on lead_status_dom.
  4. In the center window, enter an “Item Name” which shouldn't have a space in the name. This is the name used by the database. It will not be displayed.
  5. Enter a “Display Name”. This will be the name displayed while managing Leads, so choose a descriptive name.
  6. Click Add.
  7. Dropdown items can be placed in any order by dragging and dropping.
  8. When you are done, click Save.

Adding Field to List View

  1. If you would like to add a field to the List View, go to the Admin panel and click Studio.
  2. Expand the module folder of your choice, expand “Layouts”, and click ListView.
  3. Drag ant drop items from the “Available” column or “hidden” column into the “Default” column and click Save & Deploy.

Adding Field as a Search Parameter

  1. To make a field searchable, go to the Admin panel and click Studio.
  2. Expand the module folder of your choice, expand “Layouts”, expand “Search”, and click either Basic Search or Advanced Search.
  3. Drag items from the “Hidden” column into the “Default” column and click Save & Deploy.

Application Backup/Repair

The purpose of this tool is to assist in creating backups of the Sugar application files. (Database backups should also be performed regularly. Please refer to your database vendor's documentation for information on how to backup your database.)

Backup

  1. Click the admin link in the top right of the page.
  2. Scroll down to the “System” header and click Backups beneath it.
  3. Enter a directory which is writable by Sugar.
  4. Enter a filename. It will be saved as a .zip file.
  5. Click the Confirm Settings button.

The backup is now downloadable at http://yoursite.com/filename.zip

Repair

  1. Click the admin link in the top right of the page.
  2. Scroll down to the “System” header and click Repair beneath it.
  3. A list of application components is displayed. Choose the component you wish to repair.
  4. A successful repair is indicated by redirecting you to a page that says “Done.”

Database Backup

First, you need to find out the name of the database that SugarCRM is using. You only need to do this once (as long as you remember or write down the name of the database – it will never change).

  1. To find out the name of the database log in to your SugarCRM system using your administrator details.
  2. Then, click on admin at the top of the screen.
  3. Scroll down to the “System” section then click on the Diagnostic Tool option.
  4. Unselect all options except for the “SugarCRM config.php” one – the config.php file has all sorts of information about how the SugarCRM system works.
  5. Then, click on the Execute Diagnostic button. This will do the diagnostic and ask you to download the Diagnostic File.
  6. Click the link to download the Diagnostic File.
  7. The Diagnostic File is a ZIP file. Once downloaded to your computer, open it and you will see one file inside, the “config.php” file.
  8. Open the “config.php” file in a text editor and look for the section that starts with “dbconfig”. This is the part that tells SugarCRM where the database is and how to connect to it. The “db_name” bit contains the name of the database used by SugarCRM. The name may be different for each installation, but will never change.
  9. Now that you know the name of the database, you can track it down and make a backup of it. This can be done through your hosting provider's cPanel, phpMyAdmin, or done manually by your system administrator.
  10. Click the link to download the Diagnostic File.
  11. The Diagnostic File is a ZIP file. Once downloaded to your computer, open it and you will see one file inside, the “config.php” file.
  12. Open the “config.php” file in a text editor and look for the section that starts with “dbconfig”. This is the part that tells SugarCRM where the database is and how to connect to it. The “db_name” bit contains the name of the database used by SugarCRM. The name may be different for each installation, but will never change.
  13. Now that you know the name of the database, you can track it down and make a backup of it. This can be done through your hosting provider's cPanel, phpMyAdmin, or done manually by your system administrator.