The objects available within our connector are accessible from the "cdata.sugarcrm" module. To use the module's objects directly:

1. Import the module as follows:
   

   import cdata.sugarcrm as mod

2. To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:
   

   mod.connect("InitiateOAuth=GETANDREFRESH;URL=http://mySugarCRM.com;User=myUser;Password=myPassword;")

Connecting to SugarCRM

To establish a connection to SugarCRM, set URL to the URL associated with your SugarCRM account in the form http://{sugar crm instance}.com.

Authenticating to SugarCRM

To authenticate the connector to SugarCRM, set the following:

• User: The user of the SugarCRM account.
• Password: The password associated with the SugarCRM user.
• Platform (optional): If you're encountering a login conflict during authentication, set this to one of the platforms that you have created in the SugarCRM UI.

By default, SugarCRM uses the "sugar" client id for authentication, but users can optionally specify the client Id and client secret values of a custom app. See Creating a Custom OAuth Application for more information.

• OAuthClientId: Client Id of your custom OAuth app.
• OAuthClientSecret: Client secret of your custom OAuth app.

Caching SugarCRM Metadata

Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in Caching Metadata.