Sugar CRM Component

SugarCRM is a CRM system with a a simple user interface, industry-leading customer experience, and an intuitive customization platform.

This is an open source component template for Sugar CRM which is developed specifically to run on elastic.io platform. You can clone it and change it as you wish.

Authentication

In order for the elastic.io platform to authenticate with SugarCRM, the following tasks need to be completed:

• An admin must manually create an OAuth App on the SugarCRM instance through SugarCRM's UI (step by step instructions below)
• If using a version of SugarCRM that was released after Winter '18, you must register a platform on your SugarCRM instance
  • With Sugar 8, this can be done through the UI (step by step instructions below)
  • It is also possible to load new platform values by creating and installing a module
• Finally, authentication information for your Sugar instance must be entered into the elastic.io UI (step by step instructions below)

Creating an app on a SugarCRM instance

In order the platform to connect to your SugarCRM instance, an app needs to be created on that instance. Below are the steps to do so. Once that is done, you will provide a valid username and password to the elastic.io platform. The platform will exchange that username and password for a token. In a production system, the best practice is to create a dedicated user for the elastic.io platform. This user should have the minimum required permissions.

1. As an admin on your SugarCRM instance, go to the Administration panel

   

2. Select OAuth Keys

   

3. In the top bar, select the dropdown for the now visible OAuth Keys option

   

4. Select Create OAuth Key

5. Fill in the following values:

   1. Consumer Key Name: Pick a name that is convenient to remember
   2. Consumer Key: Pick a strongly random string. You will need to provide this information as part of the SugarCRM component account information
   3. Consumer Secret: Pick a strongly random string. You will need to provide this information as part of the SugarCRM component account information
   4. OAuth Version: OAuth 2.0
   5. Client Type: Sugar User
   6. Description: Optional value for your convenience

   

6. Click Save

Registering a New SugarCRM Platform Value through the UI

1. As an admin on your SugarCRM instance, go to the Administration panel

   

2. Select Configure API Platforms

   

3. Enter a value of your choosing for the new platform and click Add and then Save.

   

Authentication on elastic.io

Fill in the following for your account:

• Name Your Account: Name to identify this account on elastic.io
• Your SugarCRM domain: URL of your Sugar CRM instance
• Your login: Username used to login to SugarCRM instance
• Your password: Password used to login to SugarCRM instance
• Your OAuth 2.0 Consumer Key: Value created in step 5ii.
• Your OAuth 2.0 Consumer Secret: Value created in step 5iii.
• Custom Platform Value: Platform value registered above.

For real-time tasks please use separate oauth keys to avoid login conflicts.

Parameter platform should be set to some custom string but should be unique per sugar component in order to avoid any potential login conflicts. So now platform is "$TASK_ID:$STEP_ID".

Triggers

Fetching New and Updated Objects from SugarCRM - Polling

It is possible to fetch any type newly created and/or updated object in your SugarCRM instance. Select the trigger Fetch new and updated objects and then configure the following:

• SugarCRM module to fetch: Type of object to fetch
• Number of records to fetch: Maximum number of records to fetch per call. If left blank then the default set on your SugarCRM instance.

Fetching New and Updated Objects from SugarCRM - Webhook

It is possible to have new and updated objects be pushed to the elastic.io platform via webhooks. In order to do so, select Fetch new and updated objects (getObjects - Webhook). When a flow with this trigger is started, the elastic.io platform will register webhooks on the SugarCRM instance. When the flow is stopped, this webhook will be destroyed by the platform.

Fetch Deleted Objects from SugarCRM - Webhook

It is possible to have the ids of deleted objects be pushed to the elastic.io platform via webhooks. In order to do so, select Fetch deleted objects (getDeletedObjects - Webhook). When a flow with this trigger is started, the elastic.io platform will register webhooks on the SugarCRM instance. When the flow is stopped, this webhook will be destroyed by the platform.

Actions

Lookup Object By ID

Given an object, looks up the object with that ID. You must select the type of object to lookup.

Delete Object By ID

Given an object, deletes the object with that ID. You must select the type of object to lookup.

Upsert Object By ID

Update an existing entry if the id provided. Otherwise create a new entry. You must select the type of object to lookup.

Configuration Info

Required environment variables

For the local testing (e.g. spec-integration) ELASTICIO_TASK_ID and ELASTICIO_STEP_ID envs should be provided.

Version and compatibility information

This component interacts with version 10 of the SugarCRM REST API. It has been tested with SugarCRM Enterprise, Version 7.9.1.0 (Build 1074) and SugarCRM Enterprise, Version 8.0.0 (Build 211) (Spring '18).

License

Apache-2.0 © elastic.io GmbH