Thank you for installing Sugar Slack.
Table of Contents
The /sugar command uses the Sugar Search functionality to return results.
Here are the commands that I understand:/sugar search *terms*: Search for SugarCRM Accounts, Contacts and Leads/sugar accounts *terms*: Get information about Accounts/sugar contacts *terms*: Get information about Contacts/sugar leads *terms*: Get information about Leads/sugar login: Check your SugarCRM connection/sugar logout: Log out from SugarCRM/sugar help: Show this help information
Examples:
/sugar accounts faye business
Professional version users can search for any module that has been configured by your administrator to be available via the global search within Sugar. For example:
/sugar search *terms*: Search SugarCRM/sugar accounts *terms*: Get information about Accounts/sugar calls *terms*: Get information about Calls/sugar cases *terms*: Get information about Cases/sugar contacts *terms*: Get information about Contacts/sugar employees *terms*: Get information about Employees/sugar leads *terms*: Get information about Leads/sugar meetings *terms*: Get information about Meetings/sugar notes *terms*: Get information about Notes/sugar opportunities *terms*: Get information about Opportunities/sugar quotes *terms*: Get information about Quotes/sugar tasks *terms*: Get information about Tasks/sugar login: Check your SugarCRM connection/sugar logout: Log out from SugarCRM/sugar help: Show this help information
On the record view of modules, the administrator has enabled, an Add to Slack button has been added.
Upon pressing the button, the following will occur
Sugar will check if you have granted access to Sugar Slack to post to channels you are a member and send direct messages on your behalf.
If you have not granted access you will be prompted to add the permissions
Note: the security window as displayed below will appear in a popup window. Your browser may block the window. Please unblock the window to accept these permissions.
If you have granted access, a drawer will open
The Slack Channel dropdown will show you channels you are a member and users whom you can direct message.
Once you have selected a channel and entered your message. The Send button will be enabled. Pressing the send button will send your message along with a link to the Sugar record from which the Slack Message was sent
Individual users configure which Slack notifications they would like to receive module by module. Examples: Notification when assigned a record, notification when fields are changed, etc.
To access your preferences, a menu item has been added to mega-menu for each module which has Slack enabled
Upon pressing the Slack Preferences menu item
Each user can configure their notification preferences for the specific module.
You can be notified when you are assigned a record
You can be notified when you are the assignee of a record and a selected field has changed
Example Slack message when you have been assigned a record
Example Slack Message when data has changed
Log in to Sugar as a user with a User Type of System Administrator User.
Open the menu next to your profile picture and select Admin
On the Administration page, scroll to find the Sugar Slack section.
Enter the license key provided to you by FBSG.
Select which modules you would like to enable Sugar Slack.
When you press the save button, Sugar will check your system for enabled modules. For any modules not previously enabled, you will be prompted to Download a Module Loadable package to install.
Module Loadable installation instructions can be found here.