Overview
This section includes options to configure system-wide settings that apply to all users in your organization.
System Settings
Use this option to configure the system-wide settings according to your organization’s specifications. Users can override some default settings, such as the datetime format, on their User Preferences page
User Interface
Use this section to configure the user interface.
To configure the user interface
1.
|
Configure the following fields:
|
Listview items per page. Enter the maximum number of records you want displayed in the list view. The system paginates lists that contain more than the specified number of records.
Prevent user customizable Homepage layout. Select this box if you want to prevent users from moving Sugar Dashlets on the Home page. However, users can still create additional Sugar Dashlets.
Maximum number of Sugar Dashlets on Homepage . Enter the maximumnumber of Sugar Dashlets you want displayed on the Home page. Users will not be able to add more than the number of Sugar Dashlets that you specify. The default value is 15.
Display server response times. This option is enabled by default. The footer on every page displays the time taken to respond when users attempt to perform an action, such as logging in or opening an item, in Sugar. Deselect this option if you do not want to display the response time.
System Name. This field displays your system name.
Current Logo. This field displays your organization’s logo that currently displays in the User Interface.
Select Logo. Enter the path to the location of the logo that you want to upload from your local machine. Or, click Browse to navigate to the location of the logo on your local machine. The dimension should be 212 X 40, with the standard transparent background color, in PNG or JPG format.
Lead Conversion Options. Use this option to enable users to copy, move or do nothing with the activities related to the converted leads.
Subpanel items per page. Enter the maximum number of records you want displayed in the List View. The system paginates lists that contain more than the specified number of records.
Prevent user customizable subpanel layout. Select this box if you want to prevent users from dragging and dropping sub-panels to a different location in their Detail View layout.
Show Full Names. Select this box if you want the full name for users displayed instead of their login names.
Display module icon as favicon. Select this option if you want to display the module icon in the browser’s navigation tab instead of the Sugar icon, which is the default. For example, when you are in the Accounts module, the navigation tab will display the Accounts icon.
Configure AJAX User Interface.The AJAX UI enables navigation through most of the Sugar application without requiring full page refreshes. This results in improved performance with reduced page rendering times. However, the AJAX UI cannot be applied to the following:
¢
|
Some older third party modules
|
¢
|
Some core modules with complex customizations
|
When users try to access the above modules in an AJAX UI, an error message displays, warning them of the issue with the module.
Use the Configure AJAX User Interface link to disable the AJAX UI for specific modules. The AJAX user interface has been disabled for the following modules by default:
¢
|
Emails
|
¢
|
Reports
|
¢
|
Users
|
Note:
|
The Admin UI is not AJAX UI-enabled so that admin users can access the Admin panel and disable the AJAX UIsystemwide.
|
2.
|
To save the settings, click Save.
|
3.
|
To restore the default settings, click Restore; to exit the page without saving your changes, click Cancel.
|
Proxy Settings
If you are using a proxy server to connect to the web, you will need to enter the information here to allow the system to check for Sugar updates.
1.
|
Configure the following fields:
|
Use proxy server. If you want to connect to the web through a proxy server, select this option.
The system displays fields to specify the proxy host and port number.
Proxy Host. Enter the name of the proxy server host
Port. Enter the port number for the proxy host.
Authentication. Select this box if you want to enable proxy authentication to allow Sugar to connect to the company’s proxy server.
User Name. Enter the user name.
Password. Enter a password for the user.
2.
|
To save the settings, click Save; to restore the previous settings, click Restore; to exit the System Settings page without saving your changes, click Cancel.
|
SkypeOut
Select this option to allow users to click a phone number field to make calls through Skype.
To enable Skype
1.
|
Select the Enable SkypeOut integration box.
|
2.
|
To save the setting, click Save; to restore the previous setting, click Restore; to exit the System Settings page without saving your changes, click Cancel.
|
Advanced
1.
|
Select any of the following advanced configuration options:
|
Validate user IP address: For security reasons, by default, this option is enabled to validate the IP addresses of users who log into Sugar.
Note:
|
Some high availability systems may change IP addresses for load balancing purposes. If the IP address changes during a user session, the user will be logged out, and will have to log back into Sugar.
|
Log slow queries. Select this option to log the system’s slow responses to user queries in the sugarcrm.log file. This information is for performance tuning investigation.
Maximum upload size. Enter the maximum file size, in bytes, that users are allowed to upload.
Note:
|
The upload size is also dependent on PHP’s upload settings.
|
Log memory usage. Select this option to record memory usage in the sugarcrm.log file.
Slow query time threshold. Specify a threshold, in milliseconds, to define slow queries. Queries that take longer than the threshold time are logged in the sugarcrm.log file. This information is for performance-tuning investigation.
Display stack trace of errors. When you select this option, if an error occurs when users are running the application, the system displays where the error occurred in the application’s stack trace. This information is for debugging purposes.
Developer Mode. Select this option to disable caching so that you can immediately view changes made to language, vardefs, and template files.
vCal Updates Time Period. Select this option to specify the number of months in advance of the current date that Free/Busy information for calls and meetings is published. The minimum value is one month, and the maximum value is 12 months. To turn off Free/Busy publishing, enter 0.
2.
|
To save the settings, click Save.
|
3.
|
To restore the previous settings, click Restore; to exit the System Settings page without saving your changes, clickCancel.
|
Logger Settings
The Sugar Logger logs events that occur in the Sugar application. By default, the logs are written to sugarcrm.log in the Sugar root directory. Hence, if a problem arises, you can refer to the log file for information that may help in troubleshooting it.
When you upgrade Sugar, the application parses your Logger settings automatically from the log4.php properties file of your previous Sugar version, and populates the Logger Settings sub-panel with the information.
You can, however, change the settings if necessary.
The logging levels are as follows:
•
|
debug: Logs events that help in debugging the application.
|
•
|
info: Logs informational messages.
|
•
|
warn: Logs potentially harmful events.
|
•
|
error: Logs error events in the application.
|
•
|
fatal: Logs severe error events that leads the application to abort. This is the default level.
|
•
|
security. Logs events that may compromise the security of the application.
|
•
|
off. The logger will not log any events.
|
When you specify a logging level, the system will create log files for the specified level as well as higher levels. For example, if you specify ‘Error’, the system creates log files for ‘error’, ‘fatal’, and ‘security’.
The default size of a log file is 10 MB. Downloading large log files from the web server can be a slow process. Hence, if you view log files frequently, it is recommended that you view actions that occurred since the last entry in the current log file.
To configure logger settings
1.
|
In the Logger Settings panel, enter the following information:
|
Log File Name. Specify a name for the log file.
Extension. Enter the file extension. The default is.log.
Append After File Name. From the drop-down list, select a time period to append to the file name. This makes it easier to identify the log that you want to view.
Maximum Log Size. Specify the maximum size of the log file in MegaBytes(MB). The default is 10MB.
Log Level. From the drop-down list, select the event level that you want to capture in the log file. The default is fatal.
Default Date Format. Enter the default date format for the log file. This format must be supported by s trftime. The default is %c.
Maximum Number of Logs. Specify the maximum number of log files to save. When the number of log files exceed this limit, Sugar deletes the log file that was created first. The default is 10 logs.
Configure Log Settings. Click this link to view the Sugar log file, as described in To configure log settings.
2.
|
To save the settings, click Save.
|
3.
|
To restore the previous settings, click Restore; to exit the System Settings page without saving your changes, clickCancel.
|
To configure log settings
1.
|
In the Logger Settings panel, click the Configure Log Settings link.
|
2.
|
Select one of the following:
|
¢
|
All. Select this option to view the entire log for the current session.
|
¢
|
Next. Select this option to view only new entries in the log file.
|
¢
|
Mark Point. Select this option to indicate that you want to view actions that were logged after the last entry in the current log file. Then click Refresh From Mark to view actions that occurred since the time you clicked MarkPoint.
|
For example, to debug a problem, select the debug logging level on the Logger Settings page, click Configure Log Settings, and then click Allto view all user actions in the log file. To view only new user actions since the time you clicked All, click Next. This action will display only new entries in the log file. To view new user actions since the last entry in the current log file, select Mark Point and then click Refresh from Mark. This action will append new entries to the current entries in the log file.
3.
|
To search the log by keyword, enter it in the Search box. To search for entries using a regular expression, enter it in the Search box, and select the Reg Exp box. Press Enteron your keyboard to begin the search.
|
Note:
|
The Ignore Self option is not used.
|
Sugar displays the log entries on the screen.
Import Wizard
Use this link to easily import data into the system for selected modules without having to visit each individual module. The process of importing the data is identical to the user data import.
Follow the steps listed below to import data using the Admin Import Wizard:
1.
|
Click the Import Wizard link.
|
2.
|
This displays the Step 1: Select Data Source page.
|
3.
|
Select the module you want to import data into, from the drop-down list.
|
4.
|
Click Next.
|
5.
|
Follow the instructions provided in the Import Wizard to complete the process.
|
Locale
Use this option to set system-wide default formats for date, time, language, name, and currency. If you are using MySQL, you can also specify the collation order for records in the application.
User Interface: Use this section to set the default values in the Sugar User Interface.
Default Date Format. Select a date format for all records from this drop-down list. Users can override the default format by setting a different date format in their User Preferences page.
Default Time Format. Select a time format from this drop-down list to display in all records such as Cases. Users can override the default format by setting a different time format in their User Preferences page.
Default Language. Select the default language for the Sugar User Interface from this drop-down list.
Default Name Format. Enter the default salutation and name format to display in list views and detail views. You can specify any combination of salutation first name, and last name. For example: Mr. John Smith, Mr. Smith, or John Smith.Users can override the default format by setting a different time format in their User Preferences page.
Default Currency. Use this section to override the default currency that you set during installation. On the User Preferences page, users can override the default currency that you specify in this panel.
Currency. Enter the name of the currency that your organization uses to conduct business.
Currency symbol. Enter the symbol for the currency.
ISO 4217 Currency Code. Enter the ISO code for the currency.
1000s Separator. Specify a delimiter to separate thousands when users specify a numeric value for the amount.
Decimal Symbol. Specify a default decimal symbol.
Export Settings
Use this panel to specify export settings such as the delimiter used to separate data in export files, and the default character set used to export data from Sugar. The settings you specify here apply to all users in the organization. However, users can define a different default export character set on their User Preferences page to export data from Sugar.
This character encoding is also used when importing data into Sugar.
By default, Sugar uses UTF-8 to store and export data. For locales that use character encoding other than UTF-8, you must specify the appropriate default character set. This ensures that the character set Sugar uses to create the exported file is mapped to the correct character set on the user’s machine. For example, MS Windows uses SJIS in Japan. So, for users in this locale, you will need to select SJIS as the default export character set.
By default, both users and administrators can export files from Sugar. However, you can prevent users from exporting files.
Export Delimiter. Specify the delimiter, such as a comma or a period, to use while exporting data.
Default Character Set for Import and Export. The default is UTF-8. For locales other than US and Western Europe, select the appropriate character set from the drop-down list.
Disable export. Select this option if you want to prevent end users and users with administrative privileges from exporting data.
Admin export only. Select this option to allow only users with administrative privileges to export data.
Database Collation
Sugar displays this sub-panel only if you are using the MYSQL database. This setting manages the connection layer between SugarCRM and your MySQL database, and should be set to match the collation of your database tables. You can select the desired collation order from the drop-down list. The default is utf8_general_ci. Changing this setting will not alter your existing tables, and all new tables created after this change will inherit the collation setting name.
CAUTION:
|
The database will return errors if you run queries against multiple tables, and if tables in the query have a different collation.
|
To save the settings, click Save; to exit the page without saving your changes, click Cancel.
Backups
Use this option to backup the Sugar configuration files. Note that this option does not backup the database.
To backup Sugar configuration files
1.
|
Click the Backups option in the System sub-panel on the Admin page.
|
2.
|
In the Directory field, specify a directory that is writable by the same user as the Apache process.
|
3.
|
In the Filename field, enter a file name for the zip file including the .zip extension.
|
4.
|
To ensure that backup can be performed, click Confirm Settings.
|
5.
|
Click Run Backup to create the .zip file of your Sugar application files.
|
Note:
|
To backup your database information, refer to your database vendor’s documentation.
|
Currencies
Use this option to define a new currency and rate.
For each new currency that you define, enter the name, symbol (for example, $), conversion rate to the US $, the currency code (such as CDN for the Canadian dollar). Set the Status to Inactive if you do not want users to use this currency for transactions.
Note: Install Adobe Flash 8 to display the Euro symbol in Charts.
Repair
Use this option to upgrade and rebuild data from a previous version of Sugar for the current version of the program.You also use this option to convert a Sugar installation to offline mode.
The options are listed below.
Quick Repair and Rebuild: Repairs and rebuilds the database, extensions, vardefs, Sugar Dashlets, and so on for selected modules. Click this option, select the modules you want to repair, and click Repair. You also use this option to clear any custom My Activity Stream link types from the cache.
Expand Column Width. Expands certain char, varchar, and text columns in MSSQL database.
Rebuild .htaccess file: Rebuilds the .htaccess file to limit access to certain files directly.
Rebuild Config File: Rebuilds the config.php file by updating the version and adding defaults when not explicitly declared. Click this option to check the file and, if necessary, clickRebuild.
Rebuild Extensions: Rebuilds extensions including extended vardefs, language packs, menus, and administration
Rebuild Relationships: Rebuilds relationship metadata and drops the cache file.
Rebuild Schedulers: Rebuilds your default Scheduler Jobs. Click this option and then click Rebuild.
Rebuild Sugar Dashlets:Rebuilds the cache file for Sugar Dashlets.
Rebuild Javascript Languages: Rebuilds Javascript versions of language files.
Rebuild JS Compressed Files: Copies original Full JS Source files and replaces existing compressed JS files.
Rebuild JS Grouping Files: Re-concatenates and overwrites existing group files with latest versions of group files.
Rebuild Minified JS Files: Copies original Full JS Source Files and minifies them, then replaces existing compressed files.
Repair JS Files: Compresses Existing JS files - includes any changes made, but does not overwrite original JS Source files.
Repair Non-Lowercased Fields: Repairs mixed-case custom tables and metadata files to fix issues where code expects lowercase field names.
Repair Roles: Repairs roles by adding all new modules that support access control aswell as any new access controls to existing modules.
Repair Inbound Email Accounts: Repairs Inbound Email accounts and encrypts account passwords.
Remove XSS: Removes XSS Vulnerabilities from the database. Click this option, select a module, and click Execute. If any XSSstrings are found, the system lists them in the Object(s) found field below.
Repair Database: This option is applicable to MYSQL databases only. It repairs your Sugar database based on values defined in the vardefs. You can choose to display the SQL that will be executed on the screen, export it, or execute it.
Repair Activities: Repairs Activities (Calls, Meetings) end dates.
Enable/Disable Seed Users: Enables or disables seed users populated during demo installation. Click this option, and if the seed users are enabled, click Deactivate to disable them. If the seed users are disabled, click Activate to enable them.
Scheduler
Use the Scheduler to ensure timely execution of custom processes such as workflows and email campaigns. You can schedule jobs such as monitoring inbound emails, executing workflows, running reports, and dispatching campaign emails.
The Scheduler integrates with external UNIX systems and Windows systems to run jobs that are scheduled through those systems.
The default scheduler jobs are as follows:
Prune Tracker Tables. This job removes entries from the tracker and tracker_sessions database tables after 30 days.
Check Inbound Mailboxes. This job monitors inbound emails in active mail accounts that you set up using the Inbound Email option in the Email panel of the Admin page.
Run Nightly Process Bounced Campaign Emails. This job polls any mail account in which, the Possible Actions parameter is set toBounce Handling. This is an essential component of monitoring mass email campaigns.
Run Nightly Mass Email Campaigns. This job processes the outbound email queue for your organization’s mass campaign emails.
Prune Database on 1st of Month. This job reads all the tables in your Sugar database, finds records that have been soft-deleted (deleted = 1), creates a large SQL file, and physically deletes those records on the 1st of every month. It is mostly a performance job, and is not essential to the use of Sugar. The backup files are placed in cache/backups with time-stamped filenames.
Removal of Documents From Filesystem. For records which contain a file such as the Documents or Notes module, the files are stored in the instance’s uploads directory on the filesystem. If the record is deleted by a user from Sugar, the Prune Databases on 1st of Month Scheduler will remove the deleted records from the database. Then when the Removal of Documents From Filesystem scheduler runs, it will remove any files which were associated with deleted records.
Configuring Settings for Scheduler Jobs
For Microsoft Windows, you can use the Task Scheduler. For UNIX and Linux systems, you will need to add a new cron job to the crontab.
To add a new cron job to your crontab for Unix and Linux Systems
1.
|
At the command prompt, type crontab -e.
|
2.
|
Add the following line to your crontab using the full path to the PHP directory in your Sugar installation:
|
* * * * * cd /path/to/sugar; /path/to/php -c/path/to/php.ini -f cron.php /dev/null 2>&1
where:
path/to/sugar is the path to where your Sugar installation resides.
path/to/php is the path to the PHP installation that you want to use.
path/to/php.ini is the path to the PHP configuration file that you want to use.
3.
|
Save your changes and close.
|
If you encounter problems, do the following:
1.
|
Determine the user ID that Apache server uses to run.
|
In a properly configured virtual host environment provided by your host, Apache will run as your Login User ID for files in your virtual directory. If you are unsure, contact the Customer Service department for your host.
a.
|
Search for a file named httpd.conf. Typically, this file is located in the /etc folder. It will vary with the distribution.
|
b.
|
Open the file using a text editor and locate the line that starts with “User”. The name that follows it directly is the name of the user that Apache will run as on your system.
|
2.
|
Determine the capabilities of your PHP installation.
|
The Sugar Scheduler is designed to work with PHP and its extensions; specifically, the database Connector, the IMAP libraries, and the cURL libraries.
Ensure that the PHP binary (php-cli or just php) is available and has those libraries available.
Search for the PHP binary as follows:
a.
|
Type which php. On most correctly configured PHP installations, you will find the binary in /usr/bin or /usr/local/bin. If so, move on to Step number 3.
|
Or
b.
|
Type find / -name php. Typically, this command will return a long list. Parse through the list to find an executable file named php.
|
c.
|
If you cannot find the PHP binary, scroll down to the Troubleshooting Tips at the end of this section and read item number 2.
|
3.
|
Create a cron job for the Apache user
|
a.
|
Type crontab -e -u [the Apache user].
|
b.
|
Enter the following line to your crontab:
|
* * * * * cd /path/to/sugar; php -f cron.php > /dev/null 2>&
c.
|
To fine-tune this job, change the first two *s. The first is the Minutes value, the second is the Hours value.
|
For example, to run the cron job every three minutes, enter:
"*/3 * * * * cd /path/to/sugar; php -f cron.php> /dev/null 2>&1
4.
|
Test the crontab line as follows to confirm that your system is ready to run:
|
a.
|
At a terminal prompt, copy and paste the command for your cron job, and run it; the logic here is that if the command will execute successfully when run manually, the crontab will be able to execute successfully as well.
|
b.
|
If your cron job looks as follows:
|
* * * * * cd /var/www/html/sugarcrm; path/to/php -f cron.php > /dev/null 2>&1
Enter the command from "cd.." to "2&>1" into a terminal and press Enter.
c.
|
If any errors occur, refer to Troubleshooting Tips.
|
5.
|
Save your changes and close.
|
To add a new cron job to your crontab for Microsoft Windows (2000, XP, Server)
Set up the Windows batch file as follows:
1.
|
Create a batch file that will execute all the necessary commands.
|
2.
|
Enter the following paths in the batch file:
|
¢
|
cd c:\path\to\Sugarinstance
|
where SugarInstance is your Sugar installation.
This folder should contain the cron.php file.
¢
|
c:\path\to\php.exe -c c:\windows\php.ini -f cron.php
|
3.
|
Run the batch file from a command prompt to ensure that the output has no errors.
|
4.
|
If you encounter problems, do the following:
|
a.
|
Determine the PHP binary to use for PHP 5.2.x.
|
For the 5.2x version of PHP, the PHP-CGI binary is named php-cgi.exe (not php-cli.exe) and is typically located in the root folder of your PHP install folder. To allow it to interact with the dynamic libraries, specify the location of the php.ini file. This can vary from system to system. If you are unsure, enter the command described above.
The system will identify the php.ini file and its location.
5.
|
Create the batch file.
|
a.
|
Click Scheduler in the Systems panel of the Admin page.
|
At the bottom of the default screen, you will see the contents of the commands you need to add to a batch file.
b.
|
Open notepad.exe, copy and paste what Sugar’s recommendation into a blank file.
|
c.
|
Change the Save As Type to "dropdown to All Files *.*. " and save it as a .bat file.
|
Note:
|
This is only a recommendation. It may not work for your particular instance. Check the folder paths because they are often the cause for problems with the Scheduler.
|
6.
|
Test the batch file.
|
a.
|
From the command prompt, navigate to the folder where you saved the batch file.
|
b.
|
Enter the full name of the batch file to execute it.
|
c.
|
Note and correct any reported errors, usually related to paths that cannot be found.
|
7.
|
Create a scheduled task.
|
a.
|
Click Start and navigate to Control Panel/Scheduled Tasks/Add Scheduled Task.
|
b.
|
Go through the Wizard, browse to the batch file you just created, and select it.
|
c.
|
Schedule a daily job, and ensure that you select Open advanced properties for this task when I click finish.
|
d.
|
On the Advanced Properties page, navigate to the Schedule tab, and click Advanced.
|
e.
|
Check off Repeat task to enable the fields below it, and select Every Minute or specify the interval you think is appropriate.
|
8.
|
Save your changes and close the Wizard.
|
To schedule a job
1.
|
On the Scheduler Actions bar, click Create Scheduler.
|
2.
|
In the Basic Setup sub-panel, enter the following information:
|
Job Name. Enter a name for the job.
Status. From the drop-down list, select Active to run the job at the specified intervals; select Inactive if you want to save the job schedule information but not run the job.
Job. Select a job from the drop-down list, or to run a script from a web server, enter the URL in the adjacent field.
Interval. Specify the time interval to check for new scheduled jobs.
By default, Sugar displays the basic option. Use this option to specify the time interval in minutes and hours. The default is every one minute daily.
To define a specific time, click the Show Advanced options link, and enter the time in minutes, hours, date, month, and day.
3.
|
In the Advanced Options sub-panel displays below, enter information for the following fields:
|
Execute If Missed. Select this box to run any jobs that the scheduler missed.
Date & Time Start. Click the Calendar icon and select the start date for the job; select the time, in hours and minutes, from the adjacent drop-down list.
Date & Time End. Click the Calendar icon and select the end date for the job; select the time, in hours and minutes, from the adjacent drop-down list.
Active From. From the drop-down list, select the time, in hours and minutes, when the job becomes active.
Active To. From the drop-down list, select the time, in hours and minutes, when the job becomes inactive.
4.
|
Click Save to create the job; click Cancel to exit the page without creating the job.
|
5.
|
To export one or more scheduler definitions in a .csv file format to a local machine, select them from the list and click Export.
|
To manage scheduled jobs
1.
|
Navigate to the System sub-panel on the Admin page, and click Scheduler.
|
Sugar displays the Schedule List page on the screen.
2.
|
Select any job from the job list to view its settings or the Job log. You can edit, duplicate, or delete the settings. You can also delete a job by clicking the del icon corresponding to the job in the Schedule list.
|
3.
|
To edit the settings, click Edit.
|
4.
|
Make the necessary changes and click Save to update the settings; click Cancel to exit the page without saving your changes.
|
Troubleshooting Tips
Linux
1.
|
The Sugar Scheduler fails to run even though the cron.log file shows that the crontab is triggering the new job.
|
¢
|
The Apache user’s PATH does not include the location of the PHP binary.
|
l
|
Change the crontab entry to include the FULL path to the PHP binary as shown below:
|
* * * * * /usr/local/bin/php -f cron.php > /dev/null 2>&1
¢
|
The Apache user’s PATH does not include the location of the php.ini file, and thus the external libraries (such asmod_mysql and mod_imap) are unavailable at run time.
|
l
|
Change the crontab entry to include a PHP switch to explicitly define a php.ini to use as shown below.
|
* * * * * php -c /path/to/php.ini -f cron.php > /dev/null 2>&1"
2.
|
No PHP binary found or it is broken.
|
¢
|
Change the mechanism by which your cron job calls Sugar’s cron.php.
|
l
|
Determine if this is an option at this time by finding either curl or wget on your system. This is done with the commands which curl and which wget.
|
If you use cURL, your crontab entry should look as follows:
* * * * * curl –silent http://Domain/sugarInstance/cron.php
where Domain is the website where your Sugar installation resides, and sugarInstance is your Sugar installation.
If you use wget, your crontab entry should look like:
* * * * * wget -q http://Domain/sugarInstance/cron.php
Note:
|
Both curl and wget have numerous switches that do not always map to different versions on different platforms. Experiment in the terminal until you find the perfect line, and add it as the line for your crontab entry.
|
Windows
1.
|
The most common problem is that the PHP binary does not have the proper libraries available at run time. As a result, it cannot make calls to your database or to your Email server. To force PHP to be aware of these libraries, it needs to access the php.ini file, which in turn tells it where to find everything that is available.
|
a.
|
Locate the php.ini file: if you are unsure, run the following command:
|
phpinfo();
The system identifies the php.ini file and its location.
2.
|
The second most common breakage is incorrect paths to the extensions that PHP needs; a map is useless if the information is bad.
|
a.
|
Open php.ini in your favorite text editor.
|
b.
|
Find the section named Paths and Directories.
|
c.
|
The relevant entry is extension_dir.
|
d.
|
Keeping in mind that this file piggybacks on Window’s $PATH$ variable, double-check the paths listed.
|
e.
|
Correct any errors - sometimes giving an absolute path solves hard-to-diagnose problems, for example, full path listing from c:... onwards.
|
Necessary extensions are disabled.
f.
|
Open your php.ini file in a text editor.
|
g.
|
Find the section named Dynamic Extensions.
|
h.
|
Scroll down to the Windows-specific list.
|
i.
|
Make sure that the necessary extensions are uncommented (no “;” preceding the line). The bare minimum for Sugar Scheduler to run is to have php_curl, your database Connector, typically php_mysql (for PHP5), and php_imap.
|
j.
|
Test the batch file again.
|
Diagnostic Tool
Use this option to capture system configuration for diagnostics and analysis. The diagnostic tool pulls up system information and stores it in a zip file on the server for download. This file summarizes the basic information required to resolve the problem. Attach this file to the help request you sent to Customer Support.
To capture system configuration
1.
|
On the Diagnostic Tool page, click Execute Diagnostic to run the tool.
|
The system displays a list of system configuration files. By default, the system captures configuration information for all the selected files.
The system performs the following actions of these files:
SugarCRM Config.php - Copies the config.php file from the root directory after replacing the DB password with an asterisk for security purposes.
SugarCRM Custom directory - Copies the custom directory to a zip file to enable Customer Support to know what has been customized through the Layout Editor.
phpinfo() - Executes phpinfo and stores it in a file.
MySQL - Configuration Table Dumps - copies a few tables from the database and replaces sensitive information with an asterisk for security purposes.
MySQL - All Tables Schema - writes the schema for all tables to an HTML file.
MySQL - General Information - Pulls up some general information, like MySQL version, character sets, etc.
MD5 info - Runs md5 checks on all files in the sugar directory and compares it against a stock Sugar installation’s md5s. This enables Customer Support to learn which, if any, files have been manually customized.
BeanList/BeanFiles files exist - If a custom module has been loaded, and the author did not define these references correctly, it can cause problems. This action checks all the references to ensure they are correct.
SugarCRM Log file - copies the log file.
Sugar schema output (VARDEFS) - copies the Sugar database schema.
2.
|
Deselect the ones you do not want to view, and then click Execute Diagnostic.
|
The system creates a zip file that contains the captured configuration information.
3.
|
To view the file, click the Download the Diagnostic file link at the bottom of the page; to delete the file, click theDelete the Diagnostic file link.
|
4.
|
If you choose to download the file, the File Download dialog box displays on the page. To view its contents, clickOpen, and click the file you want to view. To save the zip file contents, click Save, and select a location on your local machine.
|
Themes
Use this option to manage Sugar themes for your organization. You can enable or disable a theme. Sugar displays only enabled themes in the Theme drop-down list from which users make their selection. By default, all themes are available to users. For Community Edition, the Classic theme is the nly available theme.
Activity Streams
Sugar Feed has been renamed My Activity Stream in Sugar Release 6.2.0. Select this option to enable the My Activity Stream functionality for your organization. My Activity Stream enables users to be informed as soon as any user creates a new Contact, Lead, Opportunity, or Case. Users are also notified of status updates when a lead is converted, when a case is closed, and when an opportunity is closed. When a user performs any of these actions, Sugar displays a message in the My Activity Stream Dashlet on the Home page.
You can activate My Activity Stream for one or more of the following modules: Leads, Cases, Opportunities, and Contacts.
Additionally, you can enable the My Activity Stream to allow users to post status updates, external links, images, and YouTube videos. Your organization can also create custom link types.
To enable and manage My Activity Stream
1.
|
In the System sub-panel, click My Activity Stream Settings.
|
The My Activity Stream Settings page displays on the screen. Specify the following settings.
Enable My Activity Stream. Select this option to enable this functionality for users in your organization.
Activate My Activity Stream For: To activate My Activity Stream for a module, select the checkbox appropriate for the module.
Activate My Activity Stream.Select this option to enable users to post status updates, images, links, and YouTube videos.
2.
|
Click Save to save the settings. To delete all existing entries in the Activity Stream, click Delete My Activity StreamEntries and click OK to confirm your action.
|
My Activity Stream entries for images, links, and YouTube videos are automatically deleted after two weeks. If you add custom link types, you can clear them from the cache using the Repair - Quick Repair and Rebuild option.
Connectors
Use this option to manage Sugar Cloud Connectors to external data sources. Sugar provides Connectors to LinkedIn and InsideView.
Connectors are designed for company-type or person-type modules such as Accounts, Leads, and Contacts and for activity-type modules such as Meetings and Documents. You can enable all Connectors for any module, standard or custom, that is listed in Studio provided the module has a standard Detail View layout. For example, though the Knowledge Base module is listed in Studio, you cannot enable Connectors for it because it does not have a standard Detail View layout.
Note:
|
You can enable InsideView for Accounts, Opportunities, Leads and Contacts only.
|
For all Connectors except InsideView, you can also map Connector fields to fields in Sugar as described later in this section. InsideView displays as a separate panel within the Detail View pages of Accounts, Opportunities, Leads and Contacts records.
Connectors are enabled by default to allow users to search external data sources for new information from within a Sugar record in the module. Users can view the external data or merge it with the existing information in the Sugar record. For example, they can update addresses and phone numbers for an account. For information on merging data, see Integrating data from external sources. You can disable Connectors, if needed.
Developers in your organization can create Connectors to other data sources, and you can upload them into Sugar using the Module Loader. You can also search for other available Connectors on Sugar Forge at http://www.sugarforge.org and Sugar Exchange athttp://www.sugarexchange.com.
To configure Connector properties
You do not need to configure the Connector properties for InsideView. For all other Connectors, follow the steps listed below:
1.
|
Navigate to the System section of the Administration Home page, and click Connectors.
|
This displays the Connector Settings page.
2.
|
Click Set Connector Properties.
|
The Set Connector Properties page displays tabs for the Connectors in Sugar. Tabs for any other Connectors that you install also display on this page.
To enable or disable modules for Connectors
1.
|
Click Enable Connectors on the Connector Settings page.
|
2.
|
Drag and drop module names from the Disabled to the Enabled column to enable Connectors like LinkedIn and InsideView, for the desired modules.
|
To disable modules for Connectors like LinkedIn and InsideView, drag the modules from the Enabled list to the Disabled list.
3.
|
Click Save.
|
Mapping Connector Fields
You can map Connector fields to fields in a Sugar module to determine how the data is merged from the data source into the Sugar record. For the Connectors that Sugar provides, field mappings are set by default. You can change these mappings and also map additional fields.
To map Connector fields
1.
|
On the Connector Settings page, click Map Connector Fields.
|
Each Connector tab displays a list of fields in the Connector and a corresponding drop-down list of fields in Connector-enabled Sugar modules.
2.
|
To change a default mapping or to add a new mapping, select the Sugar field from the drop-down list corresponding to the field in the Connector.
|
3.
|
Click Save to save the mappings.
|
Sugar uses these field mappings when merging data.
Global Search
Administrators can select the modules that users can search on when using Global Search. This includes both standard and custom modules that have been deployed in Sugar.
To Enable/Disable modules for Global Search
To enable/disable modules for Global Search, follow the steps listed below:
1.
|
Click the Admin link on the top right corner of your page to go to the Administration page.
|
2.
|
Click Global Search in the System section.
|
This opens the Global Search page.
3.
|
Drag and drop modules between Enabled Modules and Disabled Modules to select which modules users can search on when using Global Search.
|
4.
|
Click Save.
|
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.
OAuth Keys
OAuth (Open Authorization) is an open standard for authorization that enables users to share their private resources such as photographs, videos, and contact lists, stored on one site with another site without divulging personal credentials such as username and password. For more information, see this wiki article.
You need a pair of keys (text strings) - a public consumer key and a private consumer key - to establish an OAuth connection. A good example of a public key is the username used in websites that require login. A good example of a private key is the password required for such websites. Note that this private key is not sent, making it more secure than a password. Together, these keys identify which application connects to the service. It is your choice, as an admin, to decide how many different keys to have and whom to give them to.
Use the OAuth Key link to create the pair of keys discussed above. Send the created keys to the consumer of the API (for example, application developers) to use for establishing an OAuth connection.
Tokens
Tokens are created when the user establishes OAuth connection with the OAuth key pair. These are the connections between the Sugar user, the OAuth keys, and the permissions and enable the external application/user to access data. Tokens created for each OAuth connection are listed in the Tokens sub-panel of the corresponding OAuth Consumer Keys Detail View page.