Module administration privileges allow users to have administrator access to records or to have control over the customization and administration of the modules. The System Administrator can grant this type of access to a user to allow the individual to manage a specific module. For more information, see
Role Management.
When you log into Sugar as an administrator, the Admin link displays on the top right corner of your page. Click this link to view the Administration page. The Administration page displays sections that group tasks according to the area of administration.
The Admin Wizard displays when you log into Sugar for the first time after installation. This wizard guides you through the process of branding, localizing, and configuring email settings in Sugar that will be applicable to all users in your organization. You can skip this step if you prefer to do it at a later time.
|
1.
|
Click Next on the Welcome to Sugar screen to view the Branding screen.
|
Name. Enter the name that you want displayed in the title bar of your browser.
Select Logo. Specify the image file, in .png or .jpg format, containing your organization’s logo. Click
Browse to navigate to the file’s location and upload it. The recommended size of the logo is 212x40 pixels.
|
3.
|
Click Next to view the System Locale Settings page.
|
|
5.
|
Click Next to view the SMTP Server Specification page.
|
|
¢
|
To use Microsoft Exchange, click Exchange, and enter the server name and port number. To enter SMTP over SSL or TLS, select the appropriate option from the drop-down list. Optionally, to use SMPT authentication, enter the Exchange username and password.
|
A Regular user can access and use Sugar modules but does not have administrative privileges.
A System Administrator is a user who has administrative privileges in Sugar to perform tasks such as creating users. The System Administrator can access all modules and records. Role restrictions, discussed later in this chapter, do not apply to System Administrators.
A Group User is a bucket that is used for inbound emails, and does not count toward the number of Sugar licenses that you purchase for your organization. For example, creating a group mail account for Support creates a group user named
Support to handle customer support issues. Users can distribute the emails to other users from the group inbox. You can create a group user from the Users Home page or when you create a group for incoming emails as described in
Inbound Email.
The user name displays in the list on the Users Home page and the employees list on the Employees Home page after you create a Regular user or an Administrator. Group user names display in the Users list but not in the employees list.
You can assign users to roles and teams depending on the tasks they perform for the organization. If necessary, you can reassign a user’s records to other users. For example, when a user leaves the organization you can reassign that individual’s tasks to other members of the team.
|
1.
|
Click User Management in the Users panel of the Administration Home page.
|
|
2.
|
Select Create New User from the Actions drop-down list on the Users tab,and enter the following information under User Profile:
|
|
b.
|
In the Employee Information section, specify information such as the user’s current status, title, department, phone numbers, IM (Instant Messenger) type, and home address. You can add additional comments in the Notes field.
|
|
c.
|
In the Email Settings section, you can set one or more email addresses for the user’s mail accounts. You can further specify whether an email address is the user’s primary email address or whether it will be used for an automated response to email. You can also specify an email client from the drop-down list, and specify the user’s account information for the pre-configured email provider. For more information on setting up and configuring emails, see Configuring Email Settings.
|
|
3.
|
If the system-generated password feature is not enabled, you can create a password on the Password tab. You can manually send the password to the user along with the username. Alternatively, you can enable the system to generate a temporary password automatically and email it to the user. For more information on system-generated passwords, see Password Management. The user will need a username and password to log into Sugar and change the password on the User Preferences page.
|
|
4.
|
On the Advanced tab, you can specify default system settings, such as locale settings, as described in Editing your User Preferences. You can enable the Mail Merge option to enable Sugar Plug-in for Word to merge names and addresses from Sugar with form letter templates created in Word.
|
|
5.
|
On the Access tab in the Detail View, you can add or remove a role to change the user’s access permissions for a Sugar module, and to perform specific actions, such as editing and deleting records within the module. You can enable or disable access to any Sugar module and to any action within a module. By default, the user has permissions to access any module and perform any action.
|
|
1.
|
Select Reassign Records from the Actions list on the Users tab.
|
|
7.
|
Click Submit to reassign the records.
|
|
8.
|
On the Record Reassignment page, do the following:
|
|
9.
|
Click Continue to proceed with the reassignment.
|
|
10.
|
Click Return to return to the Record Reassignment page.
|
|
•
|
To duplicate the user details, click Duplicate on the user’s Detail View page, edit the information as necessary, and click Save. The following field values cannot be duplicated: Publish key, Layout options, Email addresses, User Preferences, and Locale settings.
|
|
•
|
To import user data, click Import Users from the Actions drop-down list on the Users tab and follow the steps listed in the Import Wizard.
|
|
1.
|
Select Create Group User from the Actions drop-down list on the Users tab.
|
|
3.
|
In the Status field, select Active to indicate the Group User is being used; or else, select Inactive.
|
|
4.
|
In the Email Settings section, set one or more email addresses for the user’s mail accounts. You can further specify whether an email address is the primary email address or whether it will be used for an automated response to emails.
|
|
5.
|
Click Save to create the user; click Cancel to exit the page without creating the user.
|
Teams provide data security because users can access a record only if they are members of a team that is assigned to manage the record. Teams apply to every record in Sugar. All records are assigned to at least one team, and can be assigned to more than one team.
|
•
|
Private: Sugar creates a private team for every user. Only the user can access and manage records assigned to the user’s own private team. Private teams include the reporting hierarchy. Users can see the records of any user who is below them in the hierarchy, regardless of their team membership.
|
|
•
|
Global: This is the universal team. When users are created, they are members of the Global team by default. Every user can view records assigned to the Global team.
|
|
•
|
East: This team is provided for your use and has no special characteristics.
|
|
•
|
West: This team is provided for your use and has no special characteristics.
|
Users can be both explicitly and implicitly assigned to teams, and will appear as either Member, or
Member Reports-to. When a user is manually, or explicitly, assigned to a team, the
user
’s reporting hierarchy is implicitly added to the team as well. This ensures that members of the user’s management hierarchy also have visibility into the user’s records
. For example, if Will and Chris both report to Jim, and Will is a member of the East team, and Chris is a member of the West team, then Jim will be an implicit member of the East and West teams. To delete Jim from the West team, either Chris must be removed from the West team, or he must no longer report to Jim.
Implicit members appear as Member Reports-to in the Membership column.
You can create any number of teams, depending on the needs of your organization. For example, based on the reporting hierarchy, you may want to create a team of users who report to the same manager. Based on product management requirements, you may want to create a cross-functional team of users who report to different managers but who manage the same product.
By default, all Sugar records such as accounts, contracts, and opportunities are assigned to a specific team and can only be accessed by the members of that team. If users spread across teams need to access a record, it can be assigned to multiple teams. In such cases, the user who creates the record can select a primary team and one or more secondary teams.
|
1.
|
Click Create Team in the Actions drop-down list in the Teams tab or click the Create button in any Teams page.
|
|
4.
|
Click Select in the Users sub-panel in the team’s Detail View page to view the Users list.
|
|
5.
|
To delete the team, click Delete on the Detail View page; to delete multiple teams, select the teams from the Teams home page, and click Delete. If the team has existing record assignments, follow the process described in the section below.
|
|
2.
|
Click Team Management in the Users section of the Administration page to view a list of teams in Sugar.
|
|
4.
|
Select Delete from the Actions drop-down menu.
|
For each team, you can create team notices to broadcast team-specific information to team members. These broadcasts display as a scrolling marquee in the Team Notices Dashlet of the each team member’s home page.
|
1.
|
Click Team Notices on the Teams tab.
|
|
2.
|
Click Create Team Notice on the Team Notice home page.
|
The Team Notices page displays on the page.
Date Start. Click the
Calendar icon and select the date to begin broadcasting the team notice.
Date End. Click the
Calendar icon and select the date to end the broadcast.
Team. Click
Select to view the team from the team’s List View; click a team name to select it.
Status. Select
Visible from the
Status drop-down list to make the notice visible to team members; select
Hidden to hide the notice.
Title. Enter the message title.
URL Title. Enter a title for the notice URL. This title is a hyperlink to the URL.
URL. Enter the notice URL. The URL hyperlink is inserted into the Team Notices.
Roles control user actions on records, teams control record data access. A role defines a set of permissions to perform actions such as viewing, editing, and deleting information. You can control user actions by using roles to restrict access to modules and module fields, and to limit the actions that a user can perform in Sugar.
Users are affected by a role only if they are assigned to it. That is, users who are not assigned a role can, by default, access and take any action in any module. Users can have multiple roles assigned to them, and a role can be assigned to multiple users.
For more fine-grained access control, you can restrict access to specific fields within a module. For example, you can restrict access to the billing address within the Accounts module. You can grant limited access or hide the fields completely.
For organizations that would like to delegate ownership of specific tasks in certain modules to groups or individuals, Sugar provides different access types within roles. Roles can provide users with administrator access to manage all records in a specified module, and developer access to customize modules using the Developer Tools and to configure any administrative settings specific for the module.
|
•
|
Normal: The user granted this access type can view and manage records depending on team membership. Regular users are granted Normal access.
|
|
•
|
Admin: The user granted this access type can administer all records in the specified module regardless of team membership. However, the user does not have access to administration tools, such as Studio and Workflow Management.
|
|
•
|
Developer: The user granted this access type has developer privileges for the specified module. This allows the user to access the administration and development tools, namely Studio, Workflow Management, and Dropdown Editor, that are required to customize the module. Additionally, the user can access any administration tools that are available to manage the modules. For example, the user may be able to access the Releases tool for the Bugs module or the Time Periods tool for the Forecast module. However, appropriate team membership is required to view records in the module. Users with Developer access to Users, Teams, and Roles are allowed to manage users, passwords, teams, and roles.
|
|
•
|
Admin & Developer: The user granted this access type has both Administration and Developer privileges for the specified module. This allows the user to not only view and manage all records but also access administration and development tools available to manage the module. The user does not require team membership to view records in the module.
|
For complete control over record access, you must set access control at both the module level and the field level. For example, if the field level access is set to
Read Only, and you want to restrict actions such as Edit and Delete at the record level, you must set access control at the module level.
|
¢
|
Marketing Administrator: This role has administration and developer privileges for Accounts, Contacts, Leads, Campaigns, Targets, and Target Lists.
|
|
¢
|
Sales Administrator: This role has administrator and developer privileges for Accounts, Contacts, Forecasts, Forecast schedule, Leads, Opportunities, and Quotes.
|
|
¢
|
Tracker: This role grants access permission to create and manage tracker reports. Users assigned to this role can view the Tracker page and its contents in the Home module, run pre-defined tracker reports, and create custom tracker reports, you will need to add them to this role.
|
When you create a role, you specify whether access is permitted or not, the modules that the role can access, the access type such as Normal (for Regular users) or administrator, and the actions that they can perform.
When a user is assigned multiple roles, the more restrictive settings prevail. For example, if a user is assigned to two roles pertaining to a module where one role grants administrator access and the other grants Regular User access, then the user has only Regular User access because it is more restrictive.
A special case is the Not Set value in a role definition. You can use this setting to ensure that a role does not affect a particular setting. This allows simple roles to be constructed and then combined to achieve the desired security level.
When new roles are created, the default value of Access, User Type, and Operations is Not Set. The default value of Not Set applies a permission to each role option as follows:
Access: This setting specifies which modules the role is permitted to access. Options are as follows:
|
¢
|
Not Set: Ensures that the role does not affect a particular setting. This is the default setting for new roles.
|
|
¢
|
Enabled: Permits the user to view the module.
|
|
¢
|
Disabled: Hides the module from the user’s view.
|
Actions: This setting lists the following actions:
|
•
|
Delete: Grants permission to delete records in the module. If None is selected, the Delete button is disabled on the Detail View page.
|
|
•
|
Edit: Grants permission to edit records in the module. If None is selected, the Edit button is disabled on the Detail View page. Additionally, the user cannot use the Mass Update panel to update records for the module.
|
|
•
|
Export: Grants permission to export record data in the module. The Export link located at the top of List View page is removed when this privilege is not available to the user.
|
|
•
|
Import: Grants permission to import record data in the module. The Import link in the navigation bar does not appear when this privilege is not available.
|
|
•
|
List: Grants permission to access the List View pages in the module.
|
|
•
|
View: Grants permission to view records in the module.
|
The current role permissions for the module display at the top and the module fields display below. A plus sign (+) next to a field name indicates grouped fields. For example, the Billing Street field also includes the city, state, postal code and country. The permissions that you set for Billing Street also apply to the other fields that are grouped with it. You can click the plus sign to view grouped fields.
Read/Write. Permits role members to view and edit the field value.
Read/Owner Write. Permits role members to view the field value and the record owner to view and edit the field value.
Read Only. Permits all users, including record owners to only view the field value.
None. The field is hidden from all users.
|
1.
|
Click List Roles by User on the Actionsdrop-down list on the Roles tab.
|
As a System Administrator, you can use the Password Management section to create and manage passwords and password rules that apply to all users in your organization.
You can enable the System-Generated Password option to generate and send temporary passwords automatically to new users when you create a record for them. Users can log into Sugar with this password and create a new password for themselves on the User Preferences page. If you do not enable this option, you will need to create the password manually and provide it to the user.
You can create and manage templates to send system-generated passwords and links to reset passwords. Sugar provides default email templates to send system-generated passwords and links to reset user-generated passwords. You can view these two templates when you select Email Templates from the
Emails tab
Actionsdrop-down list. Sugar uses these templates, unless you specify a custom template. For more information on creating and editing email templates, see
Creating Email Templates.
Sugar also provides an option to display the Forgot Password link in the Sugar Login window. Users who forget their passwords can click this link to submit their request for a new password. When Sugar receives such a request, it automatically sends a link to a page where the user can create a new password.
For security purposes, you can set an expiration date for user-generated password and system-generated passwords. When a password expires, you can send the user a system-generated link to the page where the person can create a new password. You can also set an expiration date for these page links.
You can create password rules that specify password requirements for user-created password, for example minimum length, the number of characters, uppercase and lowercase letters, numbers, and special characters in passwords.
You can use regular expressions to specify characters and words that are not permitted in user-generated passwords. These rules display in the
Change Password section of the User Preferences page. Users will have to follow these rules to successfully change their passwords.
When you enable new password rules, they apply only to new passwords. Existing passwords will work, even if they do not meet the requirements of the new password rules. When users attempt to reset their password using the Forgot Password feature or on their User Preferences page, they need to create a password that meets the criteria of the new password rules.
You can also enable the Login Lockout feature to lock users out of the system after a specified number of failed login attempts. The system restores the ability to log in after the specified time interval has elapsed. Sugar displays an alert in the Detail View of the user’s record to notify you that the user has been locked out.
As an additional precaution, you can enable Captcha validation to prevent automated programs from gaining unauthorized access to user accounts. You need to create an account with reCAPTCHA for your organization and obtain a public key and private key for your Sugar instance to use Captcha validation in Sugar. You need to enter these keys on the Password Management page. Navigate to the reCAPTCHA website at
http://recaptcha.net/ and create the account. When you enable Captcha validation, the Captcha image displays in the Sugar Login window when a user clicks the Forgot Password link. The user must submit the characters from the image in order to receive the link to reset the password.
You can enable authentication in Sugar if your organization has implemented Lightweight Directory Access Protocol (LDAP) or Active Directory authentication. When users in your system attempt to log into Sugar, the application authenticates them against your LDAP directory or Active Directory. If authentication is successful, the user is allowed to log into Sugar. You need to specify the encryption key for the system and forward it to your users if you are using LDAP with SOAP.
Users need to enter the key number in Outlook if they are using the Sugar Plug-in for Microsoft Outlook. The Sugar Plug-in for Microsoft Outlook uses this key to encrypt user passwords before forwarding them to Sugar for authentication. Sugar decrypts the password with the same key and forwards the user names and passwords to the LDAP server for authentication. Users are allowed to access Sugar through the Sugar Plug-in for Microsoft Outlook if authentication is successful.
If your organization has implemented Security Assertion Markup Language (SAML) for single sign-on, you can enable it in Sugar.
|
1.
|
Click Password Management in the Users sub-panel of the Administration Home page.
|
Password Requirements. In this section, enter the minimum and maximum number of characters that passwords can contain. You can also specify more detailed requirements, such as uppercase and lowercase characters, numbers, and special characters that the password can contain.
For security reasons, you can set an expiration date for system-generated passwords. You can specify a time period or the number of logins after which the password expires. To specify a time period, select
Password Expires in and enter the time period in days, weeks, or months. To specify the number of logins, select
Password Expires upon and enter the number of logins.
Enable Forgot Password Feature. This option, which is enabled by default, enables users who forgot their passwords to use the Forgot Password link on the Login window to submit their user name and email address to Sugar. The system automatically sends them an email with a link to the page where they can reset their password.
Generated Link Expiration. Use this option to specify whether the Forgot Password link expires or not. Select
None if you do not want the link to expire. Or else, select
Link Expires in and enter the time period in minutes, hours, or days, when the link remains active.
Enable reCAPTCHA Validation. You can select this option only when the Enable Forgot Password feature option is enabled. When you enable reCAPTCHA validation, the
Public key and
Private key fields display below. Enter the Public key and the Private key that you received from reCAPTCHA for your Sugar instance in the appropriate fields.
None. The password never expires.
Password Expires in. The time period, in days, weeks, and months, after which the password expires.
Password Expires after logins Enter the number of times a user can log into Sugar with the current password. When this number is met, the password expires and the user must specify a new password.
Login Lockout. In this section, you can specify how many times a user can unsuccessfully attempt to log in before being locked out of the system for security reasons, and when the lockout ends.
If you do not want to impose a lockout, select None. If not, select
Lockout users after unsuccessful login attempts and enter the number of attempts a user is allowed. To enable login after a certain time period, select
Enable login again after and enter the time period in minutes, hours, or days.
Server. Enter the LDAP server name.
User DN. Enter the user DN name; for example, ou=people, dc=example, dc=com.
User Filter. Enter any additional parameters to apply when authenticating users. For example,
is_user_id=1.
Bind Attribute. Enter the attribute name that is used to bind the user’s name in LDAP. For example, in openLDAP, the attribute name is
userPrincipleName.
Login Attribute. Enter the attribute name that is used to search for the user in LDAP. For example, in openLDAP, the attribute name is
dn.
Group Membership. Select this checkbox if you wish to specify that the user is a member of a specific group, and enter the following information:
Group DN. Enter the group DN name; for example,
ou=groups, dc=example, dc=com.
Group Name. Enter the
group name; for example,
cn=sugarcrm.
User Attribute. A unique identifier used to check if the user is a member of the group. For example,
uid.
Group Attribute. The attribute of the group that will be used to filter against the User Attribute. For example,
MemberUid.
Authentication. Select this checkbox to use specific user credentials to bind to the LDAP server, and enter the user name and password in the fields that display below.
Auto Create Users. Select this checkbox to create the user name in the Sugar database if it does not already exist.
Encryption Key. If you are using LDAP with SOAP, enter the encryption key to encrypt user passwords in the Sugar Plug-in for Microsoft Outlook. The
php_mcrypt extension must be enabled in the
php.ini file.
Select the Enable SAML Authentication checkbox and enter the following information:
Login URL: Enter the SAML URL for authentication. This is the path to the SAML server you are authenticating to.
Use this option to access the SugarCRM forums, search FAQs (Frequently Asked Questions), download the latest Sugar version, buy network subscription, log into the network, file bugs, research reported bugs, and request new features.
The SugarCRM forums cover discussions on a broad range of topics such as setting up the Sugar application and Frequently Asked Questions (FAQs) . You need to register your organization with SugarCRM to participate in the discussions. You can view postings on any of the Sugar forums without registering your organization.
Use this option to check automatically or manually for Sugar updates. By default, the option to check for updates automatically is enabled.
If you choose to check for Sugar updates automatically, you will be notified when new Sugar versions or updates are available. To perform a manual check, uncheck the
Automatically Check for Updates option and click
Check Now. If you already have the latest version,
You have the latest version available message displays at the bottom of the panel.
SugarCRM provides a Download Key number to download the application. During installation when you purchase Sugar. You need to enter the key number along with associated information, such as the expiration date. This information is displayed in the
License Management sub-panel and you can edit it, if necessary. When you save the updated information, the system automatically checks it against the information in SugarCRM database. If the information in the SugarCRM database is different from what you entered, then it overrides your revised information. For example, if you change the expiration date, the system checks the SugarCRM database for the expiration date based on when you purchased the application. If that number is different, then the
License Management panel will override your change with the expiration date stored in the SugarCRM database. Contact Customer Support if the displayed information is incorrect.
Typically, licenses are purchased for one year. Periodically re-validate the license information with SugarCRM during this time. Sugar automatically re-validates the license information twice a week if you enable automatic checks for Sugar updates as described in
Sugar Updates. Manually revalidate the license information once every three months if you have not enabled automatic Sugar updates or if you have a firewall. Sugar displays the date and time of revalidation in the
License Validation sub-panel if the revalidation is successful.
|
1.
|
Click License Management in the Sugar Connect sub-panel in the Administration page to view the License Properties page.
|
|
2.
|
Click Edit in the License Management section, and enter information for the following fields:
|
Download Key. The download key that you received from SugarCRM when you purchased the application.
|
3.
|
Click Save to save the information.
|
|
3.
|
In the Manual Validation panel, click Export Download Key to export the sugarkey.lic file.
|
|
4.
|
Select Save to Disk to copy the sugarkey.lic file on your local machine and click OK. Your machine must have a browser and Internet access.
|
|
5.
|
Go to http://updates.sugarcrm.com/license and submit the sugarkey.lic file for validation.
|
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
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.
Maximum number of Sugar Dashlets on Homepage. Enter the maximum number 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.
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.
Subpanel items per page (Mobile). Enter the maximum number of records you want displayed in the list view when users log into Sugar from a wireless device. The default is three records per page. The system paginates lists that contain more than the specified number of records.
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.
Minimum Dashlet Auto-Refresh Interval. Use this to specify system-wide auto-refresh interval of data in Dashlets for all users. When you select a value from this drop-down list, users will be able to see and set values more than your selected value in their drop-down lists. For example if you select Every 3 minutes, values displayed in user’s drop-down lists are Every 3 minutes, Every 5 minutes, and Every 10 minutes. Users can customize their auto refresh intervals within this range only.
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:
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:
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 and to validate license keys as described in
License Management.
Use proxy server. If you want to connect to the web through a proxy server, select this option.
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.
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.
|
|
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.
|
If your users have installed the Sugar Plug-in for Microsoft Word, this option allows them to perform a mail merge with Word documents. For example, you can merge contact information from Sugar with form letters created in Microsoft Word. The Mail Merge link displays at the top of a List View.
Validate user IP address: For security reasons, by default, this option is enabled to validate the IP addresses of users who log 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.
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. If you have enabled the Tracker Queries option on the Tracker Settings page, you can run the pre-defined Slow Queries report to view slow queries.
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.
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.
|
•
|
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.
|
1.
|
In the Logger Settings panel, enter the following information:
|
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.
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.
|
1.
|
In the Logger Settings panel, click the Configure Log Settings link.
|
|
¢
|
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 Mark Point.
|
For example, to debug a problem, select the debug logging level on the
Logger Settings page, click
Configure Log Settings, and then click
All to 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.
|
Note:
|
The Ignore Self option is not used.
|
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.
|
4.
|
Select the (My data is in:) an external application or service button.
|
|
5.
|
Click Sign in if you have not already entered your Google account credentials.
|
|
6.
|
Select Google from the Application drop-down list.
|
This displays the Step 2: Confirm External Source Properties page. You can modify the mapped module field names in this page.
|
10.
|
Click Import Now to import your Google Contacts.
|
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 such as Quotes and Contracts 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. Users can select a different language from the login page, provided they have installed the appropriate language pack. For more information on displaying/hiding available languages, see
To display/hide available languages.
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.
1000s Separator. Specify a delimiter to separate thousands when users specify a numeric value for the amount.
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.
Export Delimiter. Specify the delimiter, such as a comma or a period, to use while exporting data.
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.
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.
To save the settings, click Save; to exit the page without saving your changes, click
Cancel.
|
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.
|
|
5.
|
Click Run Backup to create the .zip file of your Sugar application files.
|
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.
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.
Upgrade Teams: Scans all users to ensure that they each has a personal team, and that they are members of the global team, automatically fixing any discrepancies after an upgrade. It may also be useful to restore the private teams for all users in the event they become corrupted or are removed for any reason.
Expand Column Width. E
xpands 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, click Rebuild.
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 Workflow: Rebuilds the workflow cache and compiles plug-ins.
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 Teams:
Rebuilds private team membership based on user reporting hierarchy. Click this option, select one or all of the following: Global team, Private team, and team hierarchy, and click
Rebuild.
Repair Roles: Repairs roles by adding all new modules that support access control as well 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 XSS strings 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
.
Check Reports: Checks whether reports are still valid after an upgrade and lists any invalid reports that are found during the check
.
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.
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.
Prune Tracker Tables. This job removes entries from the tracker and tracker_sessions database tables if they are older than the number of days specified on the Tracker Settings page.
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.
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.
Process Workflow Tasks. This job processes workflow events. If you set a timed trigger for an event, for example, when a lead is a week old, then it finds the predefined workflow actions and fires them when appropriate.
Run Report Generation Scheduled Tasks. This job runs reports and emails them to the assigned user as per the schedule specified for a given report. The reports are sent to the user through an email from a PHP script that runs at regular intervals to send out the emails at the appropriate time. The user can choose which reports to receive and how often to send the reports in the Reports module of the Sugar application.
Update Tracker Session Tables. This job sets all active entries in the tracker_sessions table to be inactive if they are older than 20 minutes. The tracker_sessions table keeps track of the current number of users logged into the system and the time of their most recent activity. A user session will be marked as inactive if the user has not registered a tracker entry in the past 20 minutes.
* * * * * cd /path/to/sugar; /
path/to/php -c/
path/to/php.ini -f cron.php /dev/null 2>&1
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.
|
a.
|
Search for a file named httpd.conf. Typically, this file is located in the /etc folder. It will vary with the distribution.
|
|
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.
|
|
b.
|
Type find / -name php. Typically, this command will return a long list. Parse through the list to find an executable file named php.
|
|
a.
|
Type crontab -e -u [the Apache user].
|
|
b.
|
If your cron job looks as follows:
|
Enter the command from "cd.." to "2&>1" into a terminal and press
Enter.
where SugarInstance is your Sugar installation.
|
¢
|
c:\path\to\php.exe -c c:\windows\php.ini -f cron.php
|
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.
|
a.
|
Click Scheduler in the Systems panel of the Admin page.
|
|
b.
|
Open notepad.exe, copy and paste what Sugar’s recommendation into a blank file.
|
|
a.
|
Click Start and navigate to Control Panel/Scheduled Tasks/Add Scheduled Task.
|
|
e.
|
Check off Repeat task to enable the fields below it, and select Every Minute or specify the interval you think is appropriate.
|
|
1.
|
On the Scheduler tab Actions drop-down list, click Create Scheduler.
|
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.
|
3.
|
In the Advanced Options sub-panel displays below, enter information for the following fields:
|
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.
|
If you use cURL, your crontab entry should look as follows:
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:
|
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.
|
|
a.
|
Locate the php.ini file: if you are unsure, run the following command:
|
|
a.
|
Open php.ini in your favorite text editor.
|
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.
|
1.
|
On the Diagnostic Tool page, click Execute Diagnostic to run the tool.
|
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 - 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.
|
3.
|
To view the file, click the Download the Diagnostic file link at the bottom of the page; to delete the file, click the Delete 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, click Open, and click the file you want to view. To save the zip file contents, click Save, and select a location on your local machine.
|
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.
|
1.
|
Click the Admin link on the top right corner of your page to go to the Administration page.
|
|
2.
|
Click Themes link in the System section of the Administration page.
|
Tracker actions. Enable this option to track user actions such as modules accessed on a particular day and the actions performed in those modules such as viewing or editing records. Sugar records tracker actions in the database. You can run a trackers report to view this data.
Tracker sessions. Enable this option to track a user's session data such as session round trips, start and end dates.
Tracker performance. Enable this option to track performance-related information such as database access, file access, server response time, and memory usage.
Tracker queries. Enable this option to track SQL queries that exceed the
slow_query_ time_msec limit set in the
config.php file. If the
Log Slow Queries option is enabled on the System Settings page, then any query exceeding the number of milliseconds defined in this setting will be logged in the database. The queries tracked will substitute the runtime SQL values with the ‘?’ character so that the SQL pattern is treated as a single slow query entry.
Log Slow queries. Enable this option to log slow queries. This information is for performance-tuning investigation. If you have also enabled the
Tracker Queries option, you can run the pre-defined Slow Queries report to view slow queries.
Slow query time threshold. Specify the threshold, in milliseconds, that defines slow queries. Queries that take longer than the threshold time are logged in the
sugarcrm.log file. This information is for performance-tuning investigation. If you have also enabled the Tracker Queries option, you can run the pre-defined Slow Queries report to view slow queries.
|
2.
|
Click Save to save the settings.
|
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 a team member creates a new Contact, Lead, Opportunity, or Case. Team members 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 of team members.
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. These posts can be viewed only by members of the specified team.
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 Stream Entries and click OK to confirm your action.
|
Use this option to manage Sugar Cloud Connectors to external data sources. Sugar provides Connectors to LinkedIn, Hoover’s, Zoominfo
©-Person, Zoominfo
©-Company, Twitter, Facebook, Google Docs, Citrix GoToMeetings, IBM LotusLive, Cisco WebEx meetings, 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 except Facebook, Google Docs, GoToMeeting, Lotus Notes, and WebEx 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.
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 at
http://www.sugarexchange.com.
|
1.
|
Navigate to the System section of the Administration Home page, and click Connectors.
|
|
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.
|
¢
|
API key. This field displays the introductory API key for Hoover’s. You will need to replace this with the API key that you obtain from Hoover’s.
|
|
¢
|
Person Search Query URL: This is the location that services your SOAP calls while searching for individuals by name or email address.The URL for Zoominfo-Person is:
|
Person Detail Query URL: This is the location that services your SOAP calls while searching for details about a person such as the job title, company name, company phone number, company address, and a brief biography. The URL for Zoominfo-Person is:
|
¢
|
Partner Code: Enter the Partner code that you obtained from Zoominfo.
|
|
¢
|
API Key. This field displays the introductory API key for Zoominfo-Person. You will need to replace this with the API key that you obtain from Zoominfo.
|
|
¢
|
Company Search URL. This is the location that services your SOAP calls while querying for company names. The URL is:
|
|
¢
|
Company Detail URL.This is the location that.services your SOAP calls while searching for company-specific information. The URL is:
|
|
¢
|
Partner Code: Enter the partner code that you obtained from Zoominfo.
|
|
¢
|
API Key. This field displays the introductory API key for Zoominfo-Person. You will need to replace this with the API key that you obtain from Zoominfo.
|
|
5.
|
Click Save to add the settings; to exit the page without saving the changes, click Cancel.
|
|
1.
|
Click Enable Connectors on the Connector Settings page.
|
You can choose the fields by which users can search a data source. However, your choices are limited by the Search parameters that the data source supports. The table below lists the supported and default Search fields for Hoover’s and Zoominfo.
|
|
|
|
|
|
|
|
|
|
First Name, Last Name, Company Name, Email Address, Current Job Company Name, College/University.
Note: The Company Name field serves as an additional filter for the convenience of filtering the results based on company name. But the Company Name field will not work by itself.
The First Name, Last Name, and/or Email Address search values should be provided in conjunction with the Company Name.
|
First Name, Last Name, Email Address, Current Job Company Name
|
|
|
|
Company Name, State, Company.
|
|
1.
|
On Connector Settings page, click Manage Connector Search.
|
|
2.
|
To use a field in Connector Search for a module, drag it from the Available list to the Default list.
|
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.
For each data source, you can map a module field to one Connector field. The Connector fields that appear in the Data List View are determined by which Connector fields are mapped. However, some of the Connector fields display data in the Data Merge form but not in the List View. Other Connectors may or may not display data in the List View or Merge Form.
|
|
|
|
|
|
|
Company Name, City, State, Country, Phone Office, Annual Sales, Street Address 1, Street Address 2, Postal Code, Total Employees
|
|
|
First Name, Last Name, Current Job Company Name, Job Title, College/University
|
First Name, Last Name, Current Job Company Name, Current Job Start Date, Current Job Industry, Current Job Title, Current Job Street Address, Current Job City Address, Current Job State Address, Current Job Zip Address, Current Job Country Code, Biography, Collection/University, Image URL, Zoominfo Person URL, Email Address, Direct Phone, Fax, Affiliation Job Title, Affiliation Company Name, Affiliation Company Phone, Affiliation Company Website
|
|
|
|
Company Name, City, State, Website, Postal Code, Country, Industry, Phone, Website, Description, Company Ticker, Company Profile URL, Annual Revenue, Employees
|
|
1.
|
On the Connector Settings page, click Map Connector Fields.
|
|
3.
|
Click Save to save the mappings.
|
|
Note:
|
Developers in your organization can customize the Sugar code to change the order in which connectors are prioritized when using the Smart Copy feature during data merge. Currently, your developers can manually edit the display_config.php file located in custom/modules/Connectors/metadata. In this file, the Connectors are grouped by the modules for which they have been enabled. The Connectors for each module are listed in the order that they will appear on the Data Merge screen.
|
Use this section to configure settings for PDF files of reports and quotes. These settings display in the Document Properties window of the PDF file when you select Properties from the File menu. Administrators can specify other settings such as the logo, keywords for search, and document title.
By default, the page orientation for report PDFs and project PDFs is set to Landscape. The page orientation for quote PDFs is set to Portrait. Developers in your organization can change these configurations, if needed. Users can configure the default font type and size for PDFs from the User Preferences page.
You can add additional fonts for PDF files. To do this, you will need to create a package containing the required fonts and load it into Sugar using the Module Loader.
|
1.
|
In the Document Properties section, you can configure the following settings:
|
Title. Enter the title of the document.
Subject. Enter the subject of the document.
Author. The name of the user who created the PDF file.
Keyword(s). The keywords associated with the document to help users find the document when they perform a keyword search.
|
2.
|
In the Images section, you can configure the following settings:
|
Select New Image for Quotes. The default image that displays on this page is the logo that you specify in System Settings. Click
Browse to select a different header logo for quotes.
Select New Image for Reports. The default image that displays on this page is the logo that you specify in System Settings. Click
Browse to select a different header logo for reports.
|
3.
|
Click Save to save your settings; click Restore to revert to default settings; click Cancel to exit the page without saving your settings.
|
To enable users to create PDF versions of quotes and email them to customers directly from the Quotes detail view, you must ensure that the correct fonts are installed and specify the appropriate character set from the Import/Export Character Set drop-down list in the User Preferences page. On Microsoft Windows, if you are using USD or Western European fonts, you can select ISO-8859-1 (Western European and US) or CP 1252. The default character set in Sugar is UTF-8.
Sugar Mobile enables users to access Sugar modules, including custom modules within a web browser on a smartphone or PDA.
Sugar Mobile for iPhone is a native mobile application that enables users to access Sugar from their iPhone.
|
1.
|
Select Mobile Settings from the System section.
|
On the Mobile Settings page, modules that are enabled by default are listed in the Enabled column. Modules that are not enabled are listed in the
Disabled column.
|
2.
|
In the Listview items per page (Mobile) field, you can change the number of records that display per page in List View on a mobile device. The default is 10 records per page.
|
|
3.
|
In the Subpanel items per page (Mobile) field, you can change the number of related records that display in a sub-panel in Detail View. The default is three records per page.
|
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.
|
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.
|
To verify that your language selection has been deployed, logout of Sugar and view the available languages from the
Language drop-down list in the Sugar login page.
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 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.
Use this option to configure a mail server for outbound emails, enable email notifications to users when records are assigned to them, and specify which HTML tags, such as applets and frames tags, to strip from incoming emails before displaying them in Sugar.
|
1.
|
In the Email section of the Administration page, click Email Settings.
|
|
2.
|
In the Outgoing Mail Configuration sub-panel, enter information for the fields listed below.
|
To add Google’s Gmail server, click Prefill Gmail Defaults. The system fills in the
SMTP Server and
SMTP Port fields with the Gmail server’s address and port number respectively.
From Name. Enter the sender’s name; for example, the name of your organization.
|
5.
|
Allow users to use this account for outgoing email. Select this option to allow all users to use the account, for which username and password were provided, to send emails using the outgoing mail server used to send system notifications and alerts. If you do not select this option, users will have to provide their own account information when using the outgoing mail server.
|
|
6.
|
Click Send Test Email to check if the settings are valid. If they are not, Sugar displays an error message.
|
Assignment Notifications. Enable this option to send email notifications to users automatically when records are assigned to them.
|
8.
|
In the Email Security Settings section, you can specify the following information:
|
Toggle all options. Check this box to strip all the listed tags from emails in the Email client. To strip some of the listed tags, uncheck this box and then select individual tags to strip.
|
9.
|
Click Save to save the settings ; click Cancel to exit the page without saving your changes.
|
Group Mail Accounts: Allow multiple users, such as team members, to view and import emails from an external mail account. When you receive emails that are addressed to your organization but not to any particular user, you can route it to a Group mail account such as
support@example.com or
sales@example.com. Users can subsequently distribute emails in the Group mail account to other team members.
Bounce Handling Accounts. A bounce handling account stores campaign emails that bounce back to you due to incorrect email addresses. You can create a bounce handling inbox separately for each campaign, or you can create one that is common to all campaigns. The system tags every bounced campaign email with a unique identifier that enables you to identify the campaign.
Creating Cases from Emails. When you create a group mail account, you can set it up to automatically generate cases from inbound emails. When the case is created, it is assigned to a team and an email notification is sent out. The email’s subject line is copied to the case’s subject line and the body is copied as the case description. The email is related to the case and is listed in the History sub-panel of the case’s Detail View.
Optionally, you can use the auto-reply template to automatically notify customers that you received their email. You can also to set up the template to notify them that a case has been created to resolve the issue. The Subject line of the email contains the number of the newly created case. The case number format follows the Case Macro setting that displays on the Inbound Email Home page. Sugar imports an email and associates it with a case based on the Subject line. When users send an email from the detail page of a case, the case number appears in the Subject field of the email.
|
1.
|
From the Actions drop-down list on the Inbound Email tab, click New Group Mail Account.
|
In the Mail Account Information section, enter information for the following fields:
Name. Enter the user’s name, or an alternate name for the mail account.
Mail Server Protocol. Select IMAP from this drop-down list. Additional fields display on the screen to select the folder you want to monitor, a Trash folder to store deleted emails, and a Sent folder to store copies of outgoing emails.
Monitored Folders. This field displays when you select IMAP as the protocol. By default, the system monitors the Inbox. To monitor other folders, click
Select to view a list of available folders in the external mail account. To select multiple folders, hold down the Shift key or the Ctrl key. After you select the folders that you want to view in Sugar, click
OK to view them in your inbox.
Trash Folder. To select a Trash folder from the Folders list, click
Select. After you specify the trash folder, click
OK.
Sent Folder. To add a folder to view your outbound emails, click
Select. After you specify a folder, click
OK.
Status. From the drop-down list, select
Active to activate the Group mail account or
Inactive to deactivate it. Users cannot view emails from a deactivated account.
User Name. Enter the username to access the mail server.
Password. Enter the user’s password to access the mail server.
Use SSL. If your mail server supports secure socket connections, selecting this box will force SSL connections when importing emails into Sugar.
|
2.
|
In the Email Handling Options section, enter information for the following fields:
|
Assign to Teams. Select the team from this drop-down list to permit access to the Group mail account.
From Name. Enter the name of the person or company that will send the emails.
From Address. Enter the email address from which emails will be sent.
Reply-to Name. Enter the name to which you want replies to be addressed.
Create Case from Email. Select this option to create cases automatically from inbound emails. When you select this option, you will need to specify how the emails are distributed in the
Distribution Method field.
Distribution Method. This field displays only when you select the
Create Case option and allows you to select
Round-Robin or
Least-Busy. With the Round-Robin option, the system distributes cases evenly among all users within the specified team. With the Least-Busy option, the system distributes cases to the least busy user within the team assigned to the Group folder.
New Case Auto-Reply Template. This field displays only when you select the Create Case option. You can use a
Case Reply template to set up an automated response notifying email senders that a case has been created to resolve their issue. You can select an existing template from the drop-down list, or click
Create to create a new template. The response contains the system-generated case number in the subject line of the email. The body of the email for which the case was created displays below the template text.
Leave Messages on Server. This option, which applies to imported emails, displays only when you select a Group folder. Select
Yes if you do not want to delete the emails from the external server when you import them into Sugar. Select
No if you want to delete emails from the external server.
Auto-Reply Template. Use this template to set up an automated response notifying email senders that you received their email. From the drop-down list, select an existing template, or click
Create to create a new one. If both templates are selected, Sugar will respond to the sender with the
Create Case Reply template instead of the
Auto-Reply template.
No Auto-reply to Domain. To exclude a domain from receiving the automatic email response, enter the domain name. It is common to specify your organization’s domain to prevent auto-replies from being sent to your organization’s members.
Number of Auto-responses. Set the maximum number of auto-responses to be sent to a unique email address during a period of 24 hours.
|
4.
|
Click Save to save the settings.
|
|
1.
|
Select New Bounce Handling Account from the Inbound Emails tab drop-down list.
|
|
4.
|
Click Save to save the settings.
|
|
•
|
To duplicate an account, click Duplicate in the Detail View. The system creates a new mail account and displays the Edit View. Edit the details as needed and click Save.
|
You can specify settings for email campaigns from the Campaigns module. From the Administration Home page, you can change some default values, namely, the number of emails sent per batch and the location of the campaign tracking files. You can also specify whether you want to keep copies of campaign messages or not.
The Email Setup section displays the default values for the following. You can enter new values, if needed:
From Name. Sugar display the name entered on the Email Settings page.
Mail Transfer Agent. Select the mail transfer protocol from the drop-down list.
SMTP is the default protocol.
SMTP Port. The system displays the SMTP port number.
Use SMTP Authentication. To use SMTP authentication, check this box and enter the email account username and password in the fields that display below.
In the Mass Mailing Options section, enter the information shown below. You can also enter this information using the
Campaign Email Settings option on the Administration Home page.
Location of campaign tracking files. Campaign tracking files log responses from campaign targets. If you are running Sugar on an external network, select
Default to accept the default location. However, if your Sugar instance is behind a firewall, then choose
User Defined and specify the path to your external web server in the field below. Ensure that you create a file named
index.php to handle requests for three different types of entry points: campaign_trackerv2, removeme, and image, and place the
index.php file in the path to your external web server. This
index.php file must point to the
index.php file located in the root directory of your Sugar instance.
Keep copies of campaign messages. The Default is
No. Selecting
No will store only the template of the campaign message and the required variables to recreate the message.
Selecting Yes will save a copy of all email messages sent during all campaigns in the Sugar database. This takes up space in the Sugar database and slows down performance. Hence, it is strongly recommended that you use the default setting.
|
5.
|
Click Save to save the settings and create a bounce handling inbox; to navigate back to the previous screen, click Back; to go back to the Campaigns Home page without saving any of the specified information, click Cancel.
|
|
1.
|
Navigate to the Emails section on the Administration Home page, and select Campaign Email Settings.
|
Use this option to view, send, and delete mass campaign emails that are in the queue for dispatch. The system sends out the email only after the start date/time has passed. After a campaign email has been processed, you can view its status in the Campaign module. The system tracks statistics such as the Sent date and number of times an email delivery was attempted.
Sugar Email Archiving is an automatic email importing service. Enable this feature to allow users to import emails into Sugar by sending them from any mail client or service to a Sugar-provided email address.
|
1.
|
Go to Admin>Email and click the Email Archiving link.
|
|
2.
|
Read the Email Archiving feature description, Master Subscription Agreement, and privacy policy.
|
|
3.
|
Select the I agree to the above terms and the privacy agreement checkbox.
|
|
4.
|
Click Enable Email Archiving.
|
This displays a second Admin >>
Email Archiving page where
Status displays as
Enabled. You can mouse-over the Information icons
(i) next to each field name to read quick tips and info on the field.
|
5.
|
Copy the Email Archiving Address available in this page to send to all users.
|
By default, only emails with [CASE:{number}], in the subject attach to the respective case.
|
2.
|
Click the Inbound Email link in the Email section.
|
This displays the Inbound Email »
Home page with default
Case Macro value set to
[CASE:%1].
|
3.
|
Update the Case Macro value, keeping the %1 in the new string, for example [TICKET NUMBER:%1]. The %1 value decides where there the case number is positioned in the string.
|
Follow the steps listed below to disable Sugar Email Archiving for all users in the system:
|
1.
|
Go to Admin>Emails and click the Email Archiving link.
|
|
2.
|
Click Disable Email Archiving.
|
After you build a module in Module Builder, you can deploy the module directly within the current instance, or you can use the Module Loader to install it in another Sugar instance. For more information, see
Module Loader.
Use the Module Builder to create custom modules in Sugar. You can also make custom modules available for mobile views using the Mobile Settings option.
Basic. This template provides basic fields such as ID, Date Entered, and Created By. Use this template to create a module from scratch.
Company. This template provides organization-specific fields such as Company Name, Industry, and Billing Address. Use this template to create a module that is similar to the Accounts module.
File. This template provides document-specific fields such as File Name and Document Type. Use this template to create a module that is similar to the Documents module.
Issue. This template provides case and bug-specific fields such as ID, Description, and Created By. Use this template to create a module that is similar to the Cases module or Bug Tracker module.
Person. This template provides individual-specific fields such as salutation, title, name, address, and phone number. Use this template to create a module that is similar to the Contacts module or the Leads module.
Sale. This template provides opportunity-specific fields such as Lead-Source and Probability. Use this template to create a module that is similar to the Opportunities module.
|
¢
|
Publish. This option is designed for distribution to specific users or customers. The system creates a zip file, which you can save on your local machine. You can then email it to one or more individuals who can use the Module Loader to upload the zip file into their Sugar instance.
|
|
¢
|
Deploy. This option is designed to install the custom module on your Sugar instance and make it available to users in your organization. After deployment, if needed, you can make further changes to the module in Module Builder and deploy it again to update the installed module.
|
|
¢
|
Export. This option is designed for distribution to developers. The system creates a zip file, which you can save on your local machine and email to other developers. Using the Module Loader, developers can install it on their Sugar instance and customize it further in Module Builder if necessary. The package is visible only in Module Builder and, hence, only administrators can access it until it has been deployed.
|
|
1.
|
In the Developer Tools sub-panel, click Module Builder to view the Module Builder page.
|
Author. Enter your name as the creator of the package.
Key. Enter an alphanumeric key to distinguish modules with similar names. The system will prefix all class names, directories and tables names with this key.
|
5.
|
Click Save to create the package; to delete the package, click Delete.
|
|
9.
|
Click Export to save the package as a zip file on your local machine.
|
|
1.
|
Click the New Module icon on the Package page.
|
Label. Enter a name for the module that you want displayed in the Sugar User Interface.
Importing. Selecting this option to allow data import into the module.
Team Security. By default, this option is enabled to allow you to assign a team to access and manage records created in the module. Deselect the box to disable team security, if necessary.
Navigation Tab. By default, this option is enabled to create a tab for the module that is identical to other Sugar module tabs.
Type. Click a template to select it for your module
|
3.
|
Click Save to save the module and add it to the package.
|
When you select Publish or
Export, the system saves it as a zip file that you can export to your local machine and distribute as needed. When you select
Deploy, the system installs all the custom modules in the package on your Sugar instance.
You can delete a package if necessary. When you delete a package, all the files that it contains are also deleted. If you delete a package after it has been deployed, you can uninstall the deployed package using the Module Loader. When you uninstall a package, you have the option of retaining or removing the database tables.
You do not need to delete a package before you install a newer version. The files from the new version will override any existing files from the earlier package. That is, any updates that you made to the package before re-deploying will override files from the earlier package.
You can create custom modules in the Module Builder. A custom module is contained within a package. When you deploy the package, it becomes available to other users in your organization. When you publish or export the package, you can save it as a zip file on your local machine and then use the Module Loader to upload them it into Sugar. For more information on creating packages, see
Module Builder.
If you delete a package in Module Builder after it is already installed or deployed, you can uninstall the deployed module in the Module Loader. You can also disable installed modules through the Module Loader.
|
2.
|
Click Browse to navigate to the location of the module’s zip file on your local machine.
|
|
6.
|
Select Accept to accept the agreement and then click Commit to install the module.
|
|
2.
|
Click Accept to accept the agreement.
|
|
4.
|
Click Back to Module Loader.
|
|
3.
|
Click Commit to uninstall the module; click Cancel to retain the module.
|
Studio enables you to customize modules by adding new fields, editing existing fields, field labels, page layouts, sub-panels, and Quick Create forms. You can also customize mobile views for Sugar modules that can be accessed from a mobile device. After you customize a module, you can export it to your local machine and upload in into another Sugar instance using the Module Loader.
The Studio home page displays a list of existing modules in the left panel. These include the default Sugar modules as well as any custom modules that have been deployed. The associated fields, labels, layouts, and sub-panels for each module are grouped within the module. You can click the Plus sign (+) preceding the module name to view them. The right panel displays the same information in the form of icons. You can click a module in either panel to drill down to its fields, labels, layouts, and sub-panels.
You can create and edit custom fields, drop-down lists, and field labels for a module. You can also edit the default fields, layouts, and sub-panels. After you edit a module, the updated version will not be available to other users until you publish it. You can use Studio to make changes to a published module.
Fields: Select this option to create custom fields, and to edit default fields and custom fields. For more information, see
To add fields. Select this option to edit and create drop-down lists. For more information, see
Dropdown Editor.
Layouts: Select this option to edit the List View, Detail View, Edit View, Search, and Quick Create forms. For the Leads module, you can also edit the Convert Lead form. For more information, see
Editing Layouts for Sugar Modules.
Relationships: Select this option to view existing relationships and create new ones between modules. After you create a relationship, you will need to deploy it to make it available to users. For more information, see
Creating Relationships.
You can edit field labels, button labels, link labels, module titles, and pop-up window messages using the Label editor. You can also change the default field labels for all the language packs that you have installed. Every module list displays the database fields and the labels they map to in the user interface.
You can add custom fields to any module in Sugar. When you add a custom field, the application adds the field to the appropriate database table and stores the generated metadata. You can then add the fields to the desired layout, such as Edit View and Detail View. For custom modules, you can create fields in the Module Builder.
The Field Editor allows you to edit some properties of custom fields and change the display label and some properties of standard fields such as the field length, row size, and column size. You can also mark a standard field as a required field or an audited field. These properties are described in
To add fields.
|
3.
|
In the Field Editor, enter values for the following:
|
Data Type. From the drop-down list, select one of the data types listed below.
|
¢
|
Text Field. Creates a text field for fields such as first name and last name.
|
|
¢
|
Address. Creates fields for street, city, postal, state, and country.
|
|
¢
|
Checkbox. Creates a checkbox for data fields with a Yes/No action; users can click the checkbox to turn on or turn off the action.
|
|
¢
|
Currency. Creates a field to enter a currency. The system automatically creates a field of the currency type if the field does not exist.
|
|
¢
|
Date. Creates a field to enter a date.
|
|
¢
|
DateTime. Creates a field to enter the date and time. Enter the default values in the field that displays when you select this data type. You can select a date and time, such as first day of next month, 12:00pm from the drop-down list below.
|
|
¢
|
Encrypt. Creates a field for information, such as social security numbers, whose value is stored in an encrypted format in the Sugar database. Sugar uses Blowfish encryption to encrypt passwords. The value is not encrypted in the user interface and is visible to users.
|
|
¢
|
DropDown. Creates a field that you can associate with a drop-down list of values. For more information on drop-down lists, see Dropdown Editor.
|
|
¢
|
Decimal. Creates a field to hold a number with a specified precision past the decimal point. Sugar stores the exact representation of the number in the database. For example, 1.23 is stored as 1.23.
|
|
¢
|
Float. Creates a field to hold a number with a specified precision past the decimal point. Sugar stores a very close approximation of the specified value. For example, 1.23 may be stored as 1.2345670000. Because using the Float data type instead of the Decimal data type enhances performance, it is recommended that you use it if exact precision is not required.
|
|
¢
|
HTML. Creates static HTML-formatted text to display in record views.
|
|
¢
|
Image. Creates an image field to upload an image to display in a record. By default, this field is available in Contacts, Users, and Employees.
|
|
¢
|
Integer. Creates a field to specify positive or negative numbers. You can specify a range with the Min and Max Value fields.
|
|
¢
|
MultiSelect. Creates a drop-down list of values. Users can select one or more values from the list.
|
|
¢
|
Flex Relate. Creates a drop-down list from which you can associate a related record. Because you can add only one Flex-Relate field to a module, this option does not display in the Data Type drop-down list if you attempt to add it to a module that already contains a Flex Relate field.
|
|
¢
|
Phone. Creates a field to enter a phone number.
|
|
¢
|
Radio. Creates a radio button.
|
|
¢
|
Relate. Creates a field to associate a record with another record as a one-way relationship. You can add multiple Relate fields to a module. The Users module can be selected for custom Relate fields that can be used to relate records to Users.
|
|
¢
|
Text area. Creates a large field for a block of text.
|
|
¢
|
URL. Creates a field that links to a URL.
|
|
¢
|
Field Name. Enter a name for the field. The system adds it to the Sugar database. Do not use spaces or special characters.
|
|
¢
|
Display Label. The system uses the field name as the label that will display in the Sugar User Interface. You can enter a new value if needed.
|
|
¢
|
System Label. Sugar auto-populates this field with the label that it uses internally to refer to the field. This is the label that Sugar displays on the module’s Edit Labels page in Studio. You can change this value.
|
|
¢
|
Help Text. Enter descriptive text for the field. Sugar displays this text when the user points the cursor at the field. Regular users cannot view this text.
|
|
¢
|
Comment Text. Enter additional comments, if needed, about the field.
|
|
¢
|
Width. Enter the width in pixels to scale an uploaded image to this width.
|
|
¢
|
Height. Enter the height in pixels to scale an uploaded image to this height.
|
|
¢
|
Border. Check this box if you want a border around the image.
|
|
¢
|
Default Value. Enter a default value for the field, if necessary.
|
|
¢
|
HTML. Sugar displays this text box when you select the HTML data type. Enter the HTML code in this box.
|
|
¢
|
Max Size. Enter the maximum number of characters that users can enter in the field. This is for text data fields.
|
|
¢
|
Mass Update. Sugar displays this option when you select the DropDown data type or the Date data type. Use it to add the field to the module’s Mass Update section.
|
|
¢
|
Min Value. Sugar displays this field if you select the Integer data type. Enter a minimum value during data input.
|
|
¢
|
Max Value. Sugar displays this field when you select the Integer data type. Enter a maximum value during data input.
|
|
¢
|
Auto Increment Next Value. You can specify an incremental value for the next number for numerical fields such as bug numbers, case numbers, and quote numbers.
|
|
¢
|
Precision. Sugar displays this field when you select the Decimal data type. Enter a number to specify the number of digits to the right of the decimal point.
|
|
¢
|
Calculated Value Field. Select this option to create a field for calculated values. You can enter the formula in the Formula field, or click Edit Formula to use the Formula Builder. For more information, see Calculated Value Fields.
|
|
¢
|
Required Field. Select this option to specify that users must enter a value for the field when creating a record.
|
|
¢
|
Reportable. By default, this box is selected to enable you to specify this field when you run reports. Enabling this option also makes the field available to you in workflows.
|
|
¢
|
Audit. Select this option to display field values when a user clicks View Change Log on a record’s Detail View.
|
|
¢
|
Importable. From the drop-down list, select one of the following:
|
Select Yes to enable users to import a value into the field.
Select No to prevent users from importing a value into the field.
Select Required to make it a required field during import.
|
¢
|
Duplicate Merge. From the drop-down list, specify one of the following options for the Duplicate Merge functionality that allows users to merge records from a record’s Detail View.
|
|
l
|
Enabled: The field will appear on the Merge Duplicates page, but will not be available as a filter condition on the Find Duplicates page.
|
|
l
|
Disabled: The field will not appear on the Merge Duplicates page, and will not be available as a filter condition on the Find Duplicates page.
|
|
l
|
In Filter: The field will appear on the Merge Duplicates page and will also be available in the Find Duplicates page.
|
|
l
|
Filter Only: The field will not appear on the Merge Duplicates page, but will be available on the Find Duplicates page.
|
|
l
|
Default Selected Filter: The field will be used for a filter condition by default on the Find Duplicates page, and will also appear on the Merge Duplicates page.
|
|
4.
|
Click Save to create the field.
|
The Edit Fields page displays custom fields in the
Custom section and default fields in the Default section.
A Calculated Value field is one in which a formula determines the field value, enabling you to calculate data automatically based on user input. For example, you can calculate estimated sales commission based on the opportunity amount. You can use any available field in the module for which you are creating the Calculated Value field.
A formula specifies one or more field values along with operators and functions that are mathematical or logical. When you execute a formula, Sugar performs the calculation to derive the value. When a field is used in a formula, Sugar recalculates the value whenever a user updates it and saves the record. Similarly, if you update a formula, Sugar recalculates the field value based on the updated formula.
You can use a Calculated Value field in formulas for other Calculated Value fields. For example, you can use a Calculated Value field to display a field value across tabs in Detail View and Edit View. You can also use Calculated Value fields in workflows and reports. Any changes you make to the value of the original field, manually or through a workflow, are reflected in the calculated field on the selected tabs of the layout.
Import, mass update, and data merging are automatically disabled for Calculated Value fields. When a Calculated Value field is deleted, the associated formula is deleted as well.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Returns a collection of the keys in the supplied dropdown list. This list must be defined in the DropDown editor.
|
|
|
|
|
|
|
|
Returns a collection of keys in the supplied dropdown list. This list must be defined in the DropDown Editor.
|
|
|
|
|
ifElse (true,”first”,” second”) = “ first”
ifElse(false,”frist”,” second”) = “ second
|
|
|
Returns the value at position index in the collection values
|
valueA( 1,createList(:”a”,”b”,”c”) =” b”
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
transateLabel(“LABEL_NAME”,”Accounts”) = “Name”
|
getDropdownValue(String list_name, String key)
|
Returns the translated value for the given key found in the list_name DropDown list. This list must be defined in the DropDown editor.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Returns the value of the field in the related module. If the link is to many, the first record's value is returned
|
related($accounts, "name") = The name field from a related Account record
|
|
|
Returns a count of the records related via the link to the current record. Works on one or many links
|
count($cases) = The number of cases related the current record
|
|
|
|
|
|
|
Returns the lowest value of the number field provided from all of the records related by a given link
|
rollupMin($opportunities, "amount") = The lowest amount of all the Opportunities related to the current record.
|
|
|
Returns the highest value of a given number field from the records related by a given link
|
rollupMax($opportunities, "amount") = The highest amount of all the Opportunities related to the current record.
|
|
|
Returns the average value of a given number field across records related by a given link
|
rollupAve($opportunities, "amount") = The average amount of all the Opportunities related to the current record.
|
|
7.
|
Click Save to create the formula.
|
|
Note:
|
In Sugar Mobile , you can add it to the Edit View layout. However, the values are calculated and displayed only after you save the record.
|
Relationships between the calculated value fields are not displayed to users, posing a challenge for them to figure out which functions to use. The only solution is to have the developer at the customer-end look into the
vardef files and view the relationships (that are hidden from the user). On-demand customers need to download the Sugar files or request for a copy of the file system from Sugar Support.
The following are some examples of creating formulas for Calculated Value fields.
ifElse(equal($refered_by, ""), 0, 10),
createList("MT", "WY", "CO", "NM", "ND", "SD", "NE", "KS", "TX")), "Mountain",
createList("ME", "NY", "PA", "WV", "VA", "NC", "SC", "GA", "DL")), "East",
When the value of Industry field on the
More Information tab changes, the value of the
Industry field on the
Other tab changes as well.
Formulas can be created to determine whether a field is visible within the Edit and Details View layouts. The created formulas have outputs that are either True or False. Fields created using dependent values will display only when the output of the formula is True. Follow the steps listed below to create dependent fields for example in the
Date Created field in
Accounts module
|
2.
|
Select Fields under Accounts in the Modules section.
|
|
3.
|
Select date_entered in the Edit Fields pane.
|
|
4.
|
Select the Dependent checkbox in the Edit Field pane.
|
This displays the Formula Builder pop-up box. Items listed in the Functions column display the function details, description and examples when you mouse-over them to help you create functions.
|
7.
|
Click Save in the Edit Field pane.
|
Follow the steps listed below to enable users to run searches on date and number ranges in date/datetime and number fields, for example Date Created fields in Accounts module
|
1.
|
Click Studio in the Developer Tools section of the Administration page.
|
|
4.
|
Select the Enable Range Search checkbox in the Edit Field pane and click Save.
|
Every record’s Detail View displays sub-panels for related records from other modules. You can add or remove fields for these sub-panels depending on the information that you want to display to users. You can also rename a sub-panel if needed.
You can edit the page layouts for modules in Sugarand Sugar Mobile. You can move fields, add fields, and remove fields. You can also change the tabbing order to move from field to field.
The breadcrumbs to navigate back to Studio display above the layout. The Toolbox stores fields that are not currently displayed in the layout. It also provides new rows to add to the view and a list of available fields that you can add.
When you select List View, the system displays separate columns of fields that are currently displayed in the view, fields that are available for display, and hidden fields. You can click and drag a field from one column to the other depending on what you want to display to users.
When you select Detail View or
Edit View, the system displays the various sections of the current layout, along with the fields in each section. You can click and drag a field to a different location within the layout.
For Edit View, Detail View, and Quick Create forms, you can also change the order in which the user tabs from field to field. For example, when users create a new account, they can tab from the
Account Name field to the
Website field and so on. You can change the tabbing order to so that users tab from account name to email.
|
2.
|
Click Layouts, and then click ListView.
|
Sugar displays the List View page on the screen. The
Default column lists fields that currently display in the User Interface. The
Available column lists fields that are available to users through Advanced Search. Users can search for and add any of these fields that they want to view in the search results. The
Hidden column lists fields that you do not want users to view when they perform an advanced search.
|
7.
|
Click Save & Deploy to display the updated List View in the User Interface.
|
|
8.
|
Click View History to view a list of previous changes along with the date and time of each change.
|
|
Note:
|
In the Edit View layout of the Leads module, the First Name and Last Name fields are used to input the lead’s name. Sugar concats these two values to display the lead’s name in the Detail View.
|
|
¢
|
To edit the tabbing order, click the Edit icon within the field and enter a numeric value in the Tab Order field of the Properties panel; click Save. The tabbing order for each field is represented by numbers such as 1, 2, and 3. You can change one or more numbers to change the order in which users tab to those fields.
|
|
3.
|
Click Save to save your changes.
|
|
4.
|
Click Save & Deploy to display the updated view in the Sugar User Interface.
|
|
5.
|
Click View History to view a list of previous changes along with the date and time of each change.
|
Modifications made to the Edit View in Layouts can be copied to the Detail View. The Layouts Detail View can also be synced with the Edit View so that any changes made to the Edit View are automatically reflected in the Detail View.
|
1.
|
Click Studio in the Developer Tools section of the Administration page.
|
|
2.
|
Select Layouts under Accounts in the Modules section.
|
|
3.
|
Click EditView in the Accounts Layouts pane.
|
|
7.
|
Go to the Accounts module in Sugar to verify that the changes have been deployed
|
|
1.
|
Click View History to view a list of time stamps for changes that were made to a layout, a Search form, or a sub-panel.
|
The Preview page provides a
Restore button that corresponds to each timestamp. You can use this button to restore the changes made for a specific timestamp. Alternatively, click a timestamp to restore the layout that existed before the changes made at that time.
|
2.
|
Select Convert Lead to view the Convert page.
|
|
4.
|
To copy values from fields that exist in both Leads and a related module to the newly created records, select the Copy Data box corresponding to the related module. The fields must have the same name in both modules. For example, if you add a custom field called Category to both Leads and Notes, and then enable the Copy Data option for the Notes module, the Category field in Leads will be copied into any new Notes created during the convert Lead process.
|
You can export a module’s customized layouts, fields, and field labels from one Sugar instance to other Sugar instances. To do this, you will need to package the customizations in Studio, export it to your local machine, and upload it into another Sugar instance. The system applies the customizations to the appropriate layouts, fields, and field labels.
The Export Customizations page displays a list of customized modules and the type of customization, such as customized layouts, fields, or labels.
Package Name. Enter a name for the export package. The package will contain the customizations that you select.
Author. Enter your name as the author.
|
5.
|
Select Save to Disk and click OK.
|
A Link field allows you to store a URL in a record such as a customer's website or a link to a related internal or external system. The URL can either be entered as a normal field in an Edit View, or it can be dynamically generated based on other fields in the record. For example, you can automatically generate a link to a Google map of an account’s address. To do this, click the
Generate URL check box and insert the following in the Default Value field:
Next, select billing_address_postalcode from the drop down above the Default Value field and click the
Insert Field button.
http://maps.google.com/?q={billing_address_postalcode}
|
1.
|
From the Data Type drop-down list, select IFrame or URL.
|
|
5.
|
Click Save to create the field.
|
|
1.
|
From the Data Type drop-down list, select IFrame or URL.
|
|
6.
|
Click Save to create the field.
|
Typically, a Sugar module has relationships with other Sugar modules. For example, Accounts is related to Contacts, Leads, Opportunities, and several other modules. Related records from these modules display in fields or sub-panels on an account’s detail page. You cannot edit these pre-defined relationships.
In Module Builder, you can create relationships between undeployed modules, and between undeployed modules and deployed modules. If you want to change a relationship after you have deployed the module, you can redefine or delete the relationship and then re-deploy the module package.
You create one relationship at a time from the Relationship Editor. When you create a relationship for a module, it is considered to be the primary module and the module that you relate it with is the related module. Depending on the relationship type, the relationship is expressed with sub-panels and related-to fields. When you create a new relationship between two modules, the system automatically creates the necessary sub-panels, related-to fields, and metadata relationships.
You can also create a relationship between a module and itself. In this case, the relationship becomes a parent-child relationship. For example, you can create a relationship from Accounts to Accounts in order to create sub-accounts within the primary account.
In Module Builder, you can select Activities as the related module but not its sub-modules such as Tasks, Calls, and Meetings. The relationship is automatically reflected in these sub-modules.
In Studio, you can select a sub-module of Activities when you create a relationship. So, when you select Activities as a related module in the Module Builder, you can use Studio to define the relationship further for its sub-modules.
One-to-one: Records in the primary module and the related module are uniquely related to each other. For example, an account can be associated with only one contact and a contact can be associated with only one account. This account value will display in the contact’s Detail View, and the contact value will display on the account’s Detail View.
One-to-many: A record in the primary module can have relationships with many records in the related module. For example, an account can be associated with many contacts, and many contacts can be associated with the same account. The Detail View of the primary module will display a sub-panel for the related module, and the Detail View of the related module will display a Related-to field containing a link to the related record.
Many-to-one: Records in the primary module can have a relationship with one record in the related module. For example, an account can be associated with one contact. The Detail View of the primary module will display a field for the related module from which you can select a record, and the Detail View of the related module will show a sub-panel for the primary module from which you can create or select records.
Many-to-many: In this relationship, records in both the primary module and the related module can have relationships with multiple records in each module. For example, an account can be associated with many bugs, and a bug can be associated with many accounts. The Accounts Detail View will display a Bugs sub-panel. Similarly, the Bugs Detail View will display an Accounts sub-panel.
The type of relationship that you can create depends on your choice of primary and related modules. This is because only a module with sub-panels can have a one-to-many or a many-to-many relationship with another module. A sub-panel is needed to show all the related records from the other module.
For example, with Accounts as the primary module and Knowledge Base as the related module, you can create only a one-to-one relationship between them. This is because Knowledge Base lacks a sub-panel. Therefore, Accounts cannot display related records from Knowledge Base. However, if Knowledge Base is the primary module and Accounts is the related module, you can create a one-to-many relationship between them because Accounts has sub-panels and, therefore, Knowledge Base can display related records from Accounts.
If you are creating a relationship between a custom module and a Sugar module, then you can choose any relationship type because all custom module types include at least one sub-panel.
Sugar provides many sub-panel types for your use. When you create a relationship that involves sub-panels, Sugar displays all sub-panel types available for that module for your selection. A sub-panel can display different sets of fields depending on the primary module to which it is related. For example, there are several types of sub-panels for Contacts. The Contacts sub-panel that appears under Accounts contains different fields than the Contacts sub-panel that appears under Cases.
The Default type of sub-panel contains the most commonly used fields in the module. Every module has a
Default type that contains a set of fields to display as a sub-panel. Select
Default if you want to display the most commonly used fields in the sub-panel in the relationship that you create.
For example, if you create a one-to-many relationship between Calls and Accounts, you can select a sub-panel type for the Accounts sub-panel in the Calls Detail View. To use a sub-panel consisting of the most commonly used fields from Accounts, select the
Default sub-panel type; to use the Accounts sub-panel from the email’s Detail View, select
ForEmails.
|
2.
|
Click View Relationships.
|
If you select a One-to-One relationship, you can choose a related module. Sugar displays the related module as a field in the primary module, and the primary module as a field in the related module.
If you select a One-to-Many relationship, you can select a related module. Sugar displays sub-panels of the related modules in the Detail View of the primary module. The sub-panel options vary depending on the related module that you select.
If you select a Many-to-One relationship, you can select a related module. Sugar displays a the primary module as a sub-panel in the Detail View of the related module.
If you select a Many-to-Many relationship, you can select sub-panels for the primary module as well as the related module.
|
6.
|
From Related Module drop-down list, select the module you want to relate to the primary module.
|
|
8.
|
From the Subpanel field for the primary module, select the sub-panel that you want displayed on the detail page of the related module.
|
|
9.
|
Click Save to create the relationship.
|
Rename Tabs is now labeled
Rename Modules. With this feature, module names are displayed in singular and plural form, depending on their use. For example, if the module name is Contact (for singular) and Contacts (for plural), the module tab is displayed as
Contacts and options in the
Actions drop-down list display as
Create Contact,
View Contacts, and so on. This also applies to every instance of the module name across the system.
You can also change the names of the modules appearing within the application using singular and plural labels for the module names. For example, Contact can be modified to Person and Contacts can be modified to People.
When you hide a module tab from a user, it is not visible to the user upon logging into Sugar. However, if the hidden module is related to a module that is visible to users, it displays as a sub-panel in the Detail View of the related module. Therefore, users can still access related records of the hidden module from the Detail View of the related module. Hidden modules are also available to users through the Reports module. Therefore, use roles to block users completely from accessing a module. For more information, see
Role Management.
You can allow users to configure tabs for modules that they can access from their User Preferences page. This will enable users to override the global settings that you set with this option.
|
1.
|
In Developer Tools, select Display Module Tabs and Subpanels.
|
|
2.
|
To hide a module, drag it from the Displayed Tabs column and drop it in the Hidden Tabs column; to display a module, drag it from the Hidden Tabs column and drop it in the Displayed Tabs column.
|
|
5.
|
To hide a sub-panel, drag it from the Displayed Subpanels column and drop it into the Hide Subpanels column. To display a sub-panel, drag it from the Hidden Subpanels column and drop it in the Displayed Subpanels column.
|
|
6.
|
Click Save to save the configuration; click Cancel to exit the page without saving your changes.
|
Use this option to select the modules for which Quick Create forms would be available on the Shortcut bar. By default, Cases, Bug Tracker, Documents, and Targets are disabled, hence icons for these modules do not display in the Shortcuts bar.
|
2.
|
Click Save to update the settings.
|
You can use the Configure Grouped Modules feature to organize modules within groups. Users can select these groups to view the modules within those groups. For example, you can group the Contacts, Leads, and Opportunities modules under a Sales group, and the Cases, Bug Tracker, and Products modules under a Support group. Users can then select either the Sales group or the Support group to view the corresponding set of modules.
Most modules display at least one drop-down field containing a list of values from which users can choose. For example, when users create an account, they can choose a specific industry type and an account type in the respective drop-down fields.
As the administrator, you can use the Dropdown Editor to create new drop-down lists, and to edit values of a drop-down list to suit your organization’s needs. When you create a new drop-down field in Studio, you must associate it with an existing drop-down list.
The Name field displays the name that you specified. The system automatically appends
_list to the drop-down name to identify the data type in the database. You can use your own data type naming convention if needed.
|
3.
|
From the Language drop-down list, select a pre-installed language pack of your choice.
|
|
4.
|
In the Item Name field, enter a name for the item.
|
|
6.
|
In the Display Label field, enter a label name for the item.
|
|
9.
|
Click Save to save the drop-down list.
|
|
5.
|
Click Save to save your changes; to undo your changes, click Undo; to redo your changes, click Redo.
|
Workflows enable you to track events, set out alerts, and execute necessary actions when the specified conditions are met; for example, when a time period expires or a record changes, Sugar can send out an alert to the assigned user and team.
Name. Enter a name for the workflow.
Execution Occurs. From the drop-down list, select the event to trigger the workflow. Execution can occur when a record is saved or when a specified period of time has elapsed.
Status. From the drop-down list, select
Active to implement the workflow; select
Inactive if you do not want to implement the workflow yet.
Target Module. From the drop-down list, select the module to which the workflow applies.
Applies to. From the drop-down list, select the records to which the workflow applies.
Processing Order. From the drop-down list, select the sequence in which to execute the workflow.
Description. Enter a brief description of the workflow.
|
3.
|
Click Save to create the workflow; click Cancel to exit the page without creating the workflow.
|
|
5.
|
Click Save to create the condition.
|
You can create individual alerts, or you can use alert templates. After you create an alert, you can specify one or more users as the recipients of the alert. You can send out alerts as emails or as invitations.
|
2.
|
On the Alerts Templates page, select the module from the drop-down list and click Create.
|
Name. Enter a name for the template.
Description. Enter a brief description of the template.
Target Module. From the drop-down list, select a record or a specific field, which when updated, triggers the alert. For example, if you want to send out an alert when the ownership of an account changes, select
Ownership from the drop-down list.
|
4.
|
Related Module. To trigger an alert in case of a change to a related module, select the module from the drop-down list.
|
|
6.
|
Alt Text. If your system cannot render HTML, then select this box to send out the alert as a plain text message, and enter the message in plain text in the field below.
|
|
7.
|
Click Save to create the template; click Cancel to exit the page without saving the template.
|
|
1.
|
In the Alerts sub-panel, click Create to create a new alert.
|
|
2.
|
On the Alerts page, enter information for the following fields:
|
Name. Enter a name for the alert.
Alert Type. From the drop-down list, select the type of alert.
Source Type. From the drop-down list, select
Normal Message if you will be entering the alert message in the
Alert Text box; select
Custom Template if you want to use a pre-existing alert template.
Alert Text. If the source type is
Normal Message, enter the message in this box.
Custom Template. This field displays existing alert templates if you select
Custom Template as the source type. Select the template from the drop-down list.
|
3.
|
Click Save to create the alert; click Cancel to exit the page without creating the alert.
|
The Alert Recipient List sub-panel displays to enable you to create a list of recipients of this alert.
|
1.
|
In the Alert Recipient List sub-panel, click Create.
|
|
1.
|
On the Workflow detail page, click Create in the Actions sub-panel.
|
|
4.
|
Click Save to create the action.
|
|
2.
|
On the Workflow Sequence page, select the module from the drop-down list, and click Select.
|
|
2.
|
Click the Admin link at the right-hand corner of the page.
|
|
4.
|
Ensure that the Enable Notifications On? option is selected. This is required to send a Workflow Alert to the intended recipient.
|
The following example describes how to automatically create and assign a task when an opportunity closes as
Closed Won. This involves creating a workflow definition that specifies the conditions for executing the workflow, the users and/or teams who receive the alert, and the actions that occur during execution
|
b.
|
Click Next, and click the specific field link, select Sales Stage from the Field Drop-down list, and select Sales Stage Equals Closed Won as the field in the target module.
|
|
b.
|
Select Email as the Alert type, and enter the message in the Alert Text field.
|
|
c.
|
Select Normal Message as the Source type, and save the alert.
|
|
e.
|
Click Next, and select User who is assigned the record.
|
|
¢
|
Click the record link that displays below and select Task as the module.
|
|
¢
|
Click Next, and select the fields that you want to populate in the task record, such as the subject line, due date, and assigned user.
|
|
b.
|
Click Scheduler, and ensure that the Process Workflow Tasks job is active. You can click the job to view or edit its details, such as the Start date and time.
|
This section consists of the following options that enable you to manage the product catalog, along with the related information on manufacturers and shipping providers.
Products can be broadly classified into product types; for example, Software and Hardware. Each product type can be further organized into several categories. For example, the software product type can contain product categories such as Spreadsheets and Word Processors. You can create categories within a category.
From the Product Catalog Home page, you can view a list of current products. You can add new products to the catalog or import the data from CRM applications such as Salesforce.com or through a .csv file.
The Product Categories option enables you to create new categories to further group records under a Product Type. You can also import product category information from an external location.
The Manufacturers option enables you to maintain a list of product manufacturers and specify the order in which they are presented for selection in the Quotes module. You can also import manufacturer data from an external location.
|
1.
|
On the Administration Home page, click the Product Catalog option in the Product and Quotes sub-panel.
|
|
2.
|
On the Product Catalog tab, click Create Product for Catalog.
|
|
3.
|
On the Product Catalog page, enter information for the following fields:
|
Category. Click
Select to choose the category to which the new item belongs; click
Clear to delete the selection.
Product URL. Enter the URL to where the product information is located.
Tax Class. From the drop-down list, select the appropriate option to specify whether the item is taxable or not.
Manufacturer. From the drop-down list, select the manufacturer of the item.
Currency. From the drop-down list, select the currency in which the price is quoted.
Cost. Enter the cost price of the item. This price will not appear in quotes.
Discount Price. This is the minimum price of the item. The system calculates this price based on the percentage that you specify in the Default Pricing Formula field, described below.
Availability. From the drop-down list, select whether the item is in stock or not.
Date Available. If the item is out of stock, click the
Calendar icon and select the date when it will be available.
Weight. Enter the item weight.
Type. From the drop-down list, select from product type to which the item belongs.
Support Name. Enter the name of the Customer Support person.
Support Contact. Enter the person’s contact information, such as the phone number.
Support Desc. Enter a brief description for the type of support provided to customers.
Support Term. From the drop-down list, select the length of the support period.
|
4.
|
Click Save to add the product to the catalog; click Cancel to exit the page without creating the product.
|
When you create a product for the catalog, you can specify one of the following pricing formulas to calculate the discount price. Each formula includes a factor that is a percentage represented as a whole number. For example, 15% would be a factor of 15.
|
1.
|
On the Product Catalog Home page, click Product Types, and then click Create. Alternatively, on the Administration Home page, click Product Types in the Products and Quotes sub-panel, and then click Product Type List from the module tab.
|
Description. Enter a brief description for the product type.
Order. Enter a number to specify the order in which the product type will appear in the drop-down list.
|
1.
|
On the Administration Home page, click the Product Categories option in the Product and Quotes sub-panel.
|
|
2.
|
In the Product Categories Home page, click Create.
|
Parent Category. If the product category is a sub-set of another category, click
Select to choose the parent from the
Product Categories list; click
Clear to remove your selection.
Description. Enter a brief description of the category.
Order. Enter a number to specify the order in which this category will appear in the Product Category drop-down list.
|
1.
|
On the Admin Home page, select Manufacturers in the Products and Quotes sub-panel. Alternatively, select Manufacturers from the Product Catalog, Product Categories, or Product Types tabs.
|
Status. From the drop-down list, select
Active to add the name to the Manufacturers drop-down list.
Order. Enter a number to specify the order in which the name displays in the drop-down list.
|
1.
|
On the Admin Home page, click Shipping Providers in the Products and Quotes sub-panel.
|
|
2.
|
On the Shipping Provider Home page, click Create.
|
|
3.
|
In the Shipping Provider sub-panel that displays below the list, enter information for the following fields:
|
Status. From the drop-down list, select
Active to display the name in the Shipping Provider drop-down list.
Order. Enter a number to specify the order in which the name is displayed in the drop-down list.
|
2.
|
On the Tax Rate page, click Create.
|
|
3.
|
In the Tax Rate sub-panel that displays below the list, enter information for the following fields:
|
Status. From the drop-down list, select
Active to display the name in the
Tax Rate drop-down list.
Order. Enter a number to specify the order in which the tax rate is displayed in the drop-down list.
This section provides the Releases option that enables you to maintain a list of releases for your product. This list will be available in the
Release drop-down box that is displayed when reporting a new bug in the Bug Tracker module.
|
1.
|
On the Administration Home page, select Releases from the Bug Tracker sub-panel.
|
|
2.
|
On the Releases Home page, click Create.
|
|
3.
|
In the Release sub-panel that displays below the list, enter information for the following fields:
|
Status. From the drop-down list, select
Active to display the name in the Release drop-down list.
Order. Enter a number to specify the order in which the release is displayed in the drop-down list.
This section provides the Time Periods option that enables you to define time periods for the Forecasts module. These time periods display in the Time Periods drop-down list in the Forecasts Module.
You must define at least one time period to represent a fiscal year. Then you can choose to define quarters and months as time periods within a year, as needed. Time periods can overlap and can include times from other periods.
After you create a time period, you can create a schedule to run the forecast automatically for a specific user. Some schedules might need to include start dates for a quarter prior to when the quarter officially begins. When you create a forecast schedule for a user, you can select the
Cascade checkbox if you want it to be available for all the user's direct and indirect reports as well as just the specified user.
|
1.
|
On the Admin Home page, click Time Periods in the Forecast sub-panel.
|
|
2.
|
On the Time Periods Home page, click Create Time Period.
|
Time Period. Enter a name for the time period; for example, Q1 2006.
Start Date. Click the
Calendar icon and select the start date of the time period.
Is Fiscal Year? Select this box if the time period represents the fiscal year.
End Date. Click the
Calendar icon and select the end date for the time period.
|
1.
|
In the Forecast Schedule sub-panel of the time period’s detail page, click Create.
|
|
2.
|
On the Forecast Schedule page, enter information for the following fields:
|
Schedule For. From the drop-down list, select the user for whom you are creating the forecast.
Status. Select
Active to run the forecast as scheduled; select
Inactive to stop running the forecast.
Cascade? Check this box if you want all the user's direct and indirect reports to receive the forecast as well.
This section provides the Contract Type option that enables you to define contract types for the Contracts module. When a user creates a contract, the
Types drop-down list displays the contract types for selection.
Because a contract can reference multiple documents such as Statements of Work and Non-Disclosure Agreements, you can associate one or more documents with a contract type. When users create a contract of a specific type, the associated documents display in the Documents sub-panel. Users can then edit and manage these documents as needed.
|
1.
|
On the Admin Home page, click Contract Types in the Contracts sub-panel.
|
|
2.
|
On the Contract Types home page, click Create.
|
|
3.
|
In the Contract Type sub-panel that displays at the bottom of the page, enter information for the following fields:
|
Name. Enter a name for the contract type.
List Order. Enter a number to specify the order in which the name is displayed in the
Types drop-down list in the
Contracts module.
|
1.
|
In the Documents sub-panel of the contract’s detail page, click Select to display the Documents List.
|
As an administrator, you can create and manage employee records. When you create an employee record, it is automatically added to the Employees list as well as the Users list. Similarly, when you delete an employee, the associated user record is also deleted.
|
2.
|
Click the Employees link located at the top right-hand corner of the page.
|
|
3.
|
From the Actions drop-down list on the Employees tab, select Create Employee.
|
|
4.
|
On the Employees page, enter information for the following fields:
|
Picture. If you have downloaded the person’s picture in .jpg or .png format on your local machine, click
Browse to navigate to the location and upload the picture into the record.
Employee Status. From the drop-down list, select one of the following status options:
Active: Select this option to specify a current employee of your organization.
Terminated: Select this option if the employee is no longer working for your organization.
Leave of Absence: Select this option if the employee is going to be absent from work for an extended period of time.
Title. Enter the employee’s official title.
Department. Enter the name of the department to which the employee belongs.
Reports to. Enter the name of the employee’s supervisor.
Mobile. Enter the employee’s cell phone number.
Other. Enter an alternative phone number for the employee, if any.
Fax. Enter the fax number for the employee.
Email. Enter the email address for the employee.
Home Phone. Enter the home phone number for the employee.
Other Email. Enter an alternative email address for the employee, if any.
IM Type. From the drop-down list, select the type of Instant Messenger service that the employee has.
IM Name. Enter the employee’s user name for the IM service.
Notes. Enter any comments concerning the employee.
City. Enter the name of the city.
State. Enter the name of the State.
Country. Enter the name of the country.
|
5.
|
Click Save to create the employee record; click Cancel to exit the page without saving your changes.
|
|
•
|
To duplicate a record, on the detail page, click Duplicate, modify the information if needed, and click Save. Duplication is a convenient way of creating a new employee. You can change the information in the duplicate record to create the new employee.
|
|
•
|
To go back to the Employees Home page from a detail page, select Employees from the Actions drop-down list on the module tab.
|
Knowledge Base enables users to write articles on any subject for the benefit of other Sugar users. For more information on loading modules, see
Module Loader. For more information on creating and managing articles, see
Creating Articles.
Similar to other Sugar records, each article must have an assigned team and an assigned user. Only members of the assigned team can access and manage articles. .
Knowledge Base articles reside in the Sugar database. Users and administrators can use tags to group articles according to the subject or any other criteria. When you tag an article, the system creates a link between the article and the tag. You can apply multiple tags to an article. By default, the Knowledge Base module includes the FAQs root tag.
A tag can be of two types: root tags and sub-tags. A sub-tag is nested within a root tag. Both root tags and sub-tags can contain other sub-tags to further group articles into smaller categories.
The number of articles that a tag contains is displayed within parentheses next to the tag name. Select a tag to view a list of associated articles in the right panel. By pointing the cursor at the article’s title or by clicking the title, you can view its contents.
Administrators can create, rename, and delete tags. Users can create tags during the process of creating or editing articles. However, they cannot rename or delete tags.
|
1.
|
On the Knowledge Base tab, select Knowledge Base Admin.
|
Sugar displays the Knowledge Base Admin page on the screen. This page displays existing tags. By default, the
Knowledge Base module includes the FAQs root tag. The number of articles that a tag contains is displayed within parentheses.
|
4.
|
Click Save to create the tag.
|
|
1.
|
Select Apply Tag to Articles from the Admin Actions drop-down list, and select the tag that contains the articles from the Tags list below.
|
|
1.
|
Select Rename Tag from the Admin Actions drop-down list and select the tag from the Tags list below
|
|
2.
|
Select Delete Tag from the Admin Actions drop-down list, and select the tag from the Tags list below.
|
You can delete outdated articles that have passed their expiration date. If you want to delete a tag, you will need to first either delete or move the articles that it contains. Deleting an article from a tag removes the association between them. However, the article still exists in the Sugar database and associations with other tags, if any, remain unchanged.
|
1.
|
Select Move Selected Articles from the Admin Actions drop-down list and select the tag that contains the articles from the Tags list below.
|
|
1.
|
Select Delete Selected Articles from the Admin Actions drop-down list and select the tag that contains the articles from the Tags list below.
|
In order to use Knowledge Base, your database must have the capability to perform a full text search. MySQL provide this feature, but if you are using Microsoft SQL Server, you need to perform additional steps as detailed below:
If you are managing multiple instances of the Sugar application, you can maintain complete control over the Sugar instances by preventing users with administrative privileges from making any changes. To do this, you can lock down the Upgrade Wizard, Module Builder, and Backups.
To ensure that users with administrative privileges do not load sub-standard modules into Sugar, you can restrict the Module Loader to a specific directory that you control. This allows you to check modules before they are loaded into Sugar.
where ml directory is the name of the directory from which module will be loaded into Sugar.
By default, Sugar terminates any request or post that runs more than 1000 queries. For reports, export, import, administration, and synchronization, the maximum number of queries allowed is 50,000 per request. This prevents user-initiated processes from taking up too many system resources. You can change these settings as desired in the
config.php file.
If you are running Sugar on Linux platform, you can control ownership and accessibility to all Sugar files and folders by configuring default user and group permissions.
For dir_mode, you may see a value of 1528, which is the decimal equivalent of the octal value 02770. For
file_mode you may see a value of 432 which is the decimal equivalent of octal value 0660.
You can specify settings in Outlook so that the free/busy information from the Outlook calendar for a user is shared with the user's Calendar in Sugar. The settings must be configured on each user's computer.
|
1.
|
Select Tools > Options. Then click Calendar Options.
|
|
3.
|
Select the Publish at my location checkbox, and enter the path for the Sugar email account information following the syntax:
|
where myemail@servername is the email address specified under
Email Options in the user's
User Preferences page in Sugar. On the
User Settings page in the Calendar Options, the URL for publishing free/busy information is displayed in
Your Publish URL.
where %NAME% and %SERVER% are Outlook replacement variables to construct the email address.
