Note
You need admin privileges in both SalesScreen and SugarCRM to complete this setup.
Prerequisites
There are two requirements for this integration:
A SalesScreen Pro or SalesScreen Enterprise subscription
A SugarCRM Online subscription
SalesScreen does not support integration with SugarCRM on premise installations.
How the integration works
The integration uses the OAuth 2.0 protocol. You authorize SalesScreen to retrieve data from SugarCRM on behalf of your organization.
Before you initialize the integration from SalesScreen, you must configure a few settings in SugarCRM and note these three values:
Your SugarCRM base URL
Your SalesScreen Consumer Key
Your SalesScreen Consumer Secret
Configure settings in SugarCRM
Sign in to SugarCRM as an administrator.
Turn off IP validation
SalesScreen can use several IP addresses during a session. IP validation in SugarCRM can therefore block data access. To avoid this, disable IP validation.
Go to Administration > System Settings.
Find the Validate user IP address setting and disable it.
Click Save.
(No screenshot provided for this step.)
Allow SalesScreen to access the REST API
By default, SugarCRM only allows REST API access for known platform types. You must add salesscreen as an allowed platform.
Go to Administration > Configure API Platforms.
In the text field at the bottom of the list, type salesscreen and click Add.
Confirm that salesscreen now appears in the list, then click Save.
Get the base URL
While logged in to SugarCRM, look at the browser address bar.
Example URL:
Copy only the main part, in this example:
This is your SugarCRM base URL.
Create OAuth credentials in SugarCRM
In Administration, click OAuth Keys under the System section.
Click Create OAuth Key.
In the creation view, fill in the fields:
Consumer Key Name: SalesScreen
Consumer Key: a random string of letters and numbers.The best way to generate this is to use a GUID generator.
Consumer Secret: another random string of letters and numbers, different from the key
OAuth Version: set to OAuth 2.0
Client Type: set to Sugar User
Copy or write down the Consumer Key and Consumer Secret values.
Click Save to complete creation of the SalesScreen OAuth key.
You now have all three required values:
SugarCRM base URL
SalesScreen Consumer Key
SalesScreen Consumer Secret
Initialize the integration in SalesScreen
Sign in to SalesScreen with an admin user account.
Click Manage at the bottom left, then select Settings.
If you do not see Manage, you are not signed in as an admin.
Go to Integrations and click Integrate for SugarCRM.
In the SugarCRM Integration form, enter the five values:
Username – your SugarCRM username
Password – your SugarCRM password
Base URL – the base URL you copied from SugarCRM
Consumer Key – from the OAuth key you created
Consumer Secret – from the OAuth key you created
SalesScreen does not store your SugarCRM password permanently. It is used only by the OAuth 2.0 flow to complete authorization.
Click Integrate.
If everything is configured correctly, you are redirected to the SugarCRM Integration management dashboard after a short moment.
Manage the SugarCRM integration
From now on you can go to:
Manage > Settings > Integrations > Manage SugarCRM
From the integration dashboard you can:
Pause or resume synchronization
Terminate the integration
Create subintegrations that define exactly which SugarCRM data is synchronized to SalesScreen
Old TEXT
Note: You need admin privileges in both SalesScreen and SugarCRM to carry out this approach.
Prerequisites
There are two prerequisites for integrating SalesScreen with SugarCRM. The first one is that you need to have a SalesScreen Pro or Enterprise subscription, and the second is that you need to have a SugarCRM online subscription. In other words, SalesScreen does not support integration with SugarCRM on-premise solutions.
How to
The integration is authorized through the OAuth2 protocol. This means that you authorize SalesScreen to retrieve data from SugarCRM on your organization's behalf.
You need to configure some settings in your SugarCRM org before initialising the integration from your SalesScreen account.
There are a total of three variables you need to make note of in SugarCRM, which will be explained in the next section:
Your SugarCRM base URL
Your SalesScreen Consumer Key
Your SalesScreen Consumer Secret
In Sugar
As an administrator, sign in to your SugarCRM org.
Turn off IP validation
The SalesScreen client can utilize several different IP addresses in the course of a session. This can complicate the authorization process, resulting in SalesScreen being denied when requesting data from SugarCRM. To make sure this issue won't arise in the context of the integration, we recommend that you turn IP validation off in the administration dashboard.
Navigate to Administration > System Settings. Find the Validate user IP address setting and disable it. Finally click Save.
Allow SalesScreen to access REST API
By default, SugarCRM will prevent REST API access from unknown platform types – like SalesScreen. You therefore need to allow SalesScreen access by adding it as an API platform.
Navigate to Administration > Configure API Platforms. Input salesscreen in the text field at the bottom of the list and click Add. You'll notice that the value will become present in the list. Finally, click Save.
The base URL
Copy or write down the main part of the browser's URL. For instance, if your browser URL is the following:
https://myorganization.sugaropencloud.com/#Home/abc
You copy the https://myorganization.sugaropencloud.com part. This is referred to as the base URL.
The Consume Key and Consumer Secret
Navigate to Administration.
Click on OAuth Keys under the System section.
Once there, create a new OAuth key by clicking on Create OAuth Key.
In the creation view, there are several fields you need to fill out.
The Consumer Key Name field should be filled out with "SalesScreen".
The Consumer Key field should be filled out with a series of random numbers and letters. The best way to do this is to use a GUID generator.
The Consumer Secret field should be filled out with a series of random numbers and letters, just like the Consumer Key. Note that the values need to be different.
The OAuth Version dropdown field should be set to OAuth 2.0.
The Client Type dropdown field should be set to Sugar User.
Copy or note down the Consumer Key and Consumer Secret values.
Finally, click the Save button to complete the creation of the SalesScreen key.
In SalesScreen
To initialize the integration between the two systems, simply sign in to SalesScreen with an admin user account. Navigate to Company Settings by clicking Manage > Settings. If you don't see a the Manage button at the bottom left of the screen, it means you're signed in with a non-admin user account.
Once there, go to Integrations and proceed to click on Integrate for SugarCRM.
You will be prompted to enter 5 values in order to initiate the integration.
Your SugarCRM username
Your SugarCRM password
Your SugarCRM base URL
Your SalesScreen Consumer Key
Your SalesScreen Consumer Secret
The base URL, Consumer Key and Consumer Secret are the same values you found and defined in your SugarCRM org.
At no point will SalesScreen store your password. It is simply used by the OAuth2.0 protocol to execute the authorization process.
When all fields are filled out, click Integrate. If everything's done correctly, you should be taken to the SugarCRM integration management dashboard after a few seconds.
From now on, you can navigate to the integration management dashboard (Manage > Settings > Integrations > Manage SugarCRM) to pause/resume or terminate the integration.
Create subintegrations to decide what SugarCRM data should be synchronized to SalesScreen.