Upsert® Connector for Slack

Prerequisites

System requirements for installation

Supported Versions

• 11.x
• 12.x

Supported Editions

• Sell
• Serve
• Enterprise
• Professional

Supported Databases

• MySQL
• MSSQL
• Oracle
• DB2

Supported Languages

• English

Overview

Upsert® Slack Connector is an interface that opens a line of communication between a business’s SugarCRM and Slack applications. This functionality allows users to utilize two of their most important tools by giving them the ability to send both manual and automated messages directly to other users while keeping their focus in Sugar.

Upsert® Slack Connector is available to all users.

Installation

Once you have completed your order for the Upsert® Slack Connector plug-in, you should receive an email with instructions to download the necessary file. Once you obtain the file, complete these steps to install the plug-in to your Sugar instance:

1. Log in to your Sugar instance as an admin user
2. Go to Admin > Module Loader
3. Select the Upsert® Slack Connector ZIP file and click ‘Upload’
4. Click the ‘Install’ button
5. Review the license agreement, toggle the option to ‘Accept’, and click ‘Commit’

Once the installation completes, proceed to the ‘Configuration' section.

Configuration

Once Upsert® Slack Connector is installed, you will need to create a custom app through the Slack API, as well as enter your license key to enable functionality on the Configurations page.

Configuring the App in Slack

Create the custom app via the following steps:

1. Go to https://api.slack.com/apps
2. Click the ‘Create New App’ button

3. Select the ‘From scratch’ option from the pop-up window

4. Enter an App Name, select the appropriate workspace, and click ‘Create App’

Note: After clicking ‘Create App’ you should be redirected to the ‘Basic Information’ screen 5. In the left navigation, go to ‘Slash Commands’

6. Click ‘Create New Command’
7. Enter the following details:

8. In the left navigation, go to ‘Features’ > ‘OAuth & Permissions’

9. Scroll down to the ‘Redirect URLs’ section and click the ‘Add New Redirect URL’ button

10. Enter your Sugar instance’s URL and click ‘Add’

Note: The URL must contain ‘https’ and not just ‘http’. 11. Click ‘Save URLs’

12. Click ‘Save’
13. Scroll down to Scopes > Bot Token Scopes and click the ‘Add an OAuth Scope’ button

14. Select the "users:read" option from the dropdown

At this point, the app is now created. Scroll back up to the top of the screen, and from the left navigation go to Settings > Basic Information and scroll down to the ‘App Credentials’ section. When ready, you will need to enter the information listed in the ‘Client ID’, ‘Client Signing Secret’, and ‘Slack Signing Secret’ fields into Upsert® Slack Connector’s ‘Configuration Settings’ to complete the plugin’s configuration.

Configuring the License

Enable the functionality of the plugin via the following steps:

1. Go to Admin, and select ‘Configuration Settings’ from the Upsert® Slack Connector section
2. Enter your license key that you received via email from your initial purchase.
   Note: If you installed and configured other Upsert^® plug-ins, the license key will prepopulate into this screen and not require re-entry
3. Click ‘Save’

Validating the License

If access to the Upsert® Slack Connector functionality is interrupted, you can manually validate your license with the following steps:

1. Go to Admin, and select ‘Configuration Settings’ from the Upsert® Slack Connector section
2. In the right panel, click ‘Validate License’
3. If successful, the status will be updated to ‘Enabled’ and the service start and end dates will be populated. If unsuccessful, there will be a message indicating the reason for the failure with further instructions.
   Note: The server hosting your Sugar instance must be able to reach https://upsertconsulting.com to successfully validate your license.

Next Steps

You will receive an email within 24 hours of your purchase from Upsert with the full user guide for your plug-in.