Sugar CRM

1 Connecting to SugarCRM

Specify the following to establish a connection to SugarCRM:

• URL: Set this to the URL associated with the SugarCRM account in the form 'http://{sugar crm instance}.com'.

• Platform: If you're encountering a login conflict during authentication, set this to one of the platforms that you have created in the SugarCRM UI.

2 Authenticating to SugarCRM

SugarCRM uses the OAuth 2.0 authentication standard. It uses the "password" grant type to retrieve the access token, therefore it does NOT open a browser tab during the authentication process.

You can authenticate with your SugarCRM account using your user-credentials.

After setting the following properties, you are ready to connect:

• User: Set this to the username of the SugarCRM account you're trying to access.

• Password: Set this to the password of the SugarCRM account you're trying to access.

• Url: Set this to the URL of the SugarCRM instance you're trying to access.

In addition to the above 3 properties you can (optionally) specify your own OAuth Consumer Keys to be used during the authentication process. This is done using properties OAuthClientId and OAuthClientSecret. To create a new set of OAuth Consumer Keys you must first be logged in as an admin. After that, follow the below steps:

1. Open SugarCRM on your browser and navigate to the Admin Dashboard.

2. On the top-right of the site click on your profile and then click on "Admin".

3. In the "System" section select "OAuth Keys". Now all your default Consumer Keys will appear.

4. On the main navigation bar (on top of the site) find "OAuth Keys" and click the arrow to open the dropdown list.

5. Click on "Create OAuth Key".

6. Fill the required fields. Set "OAuth Version" to "OAuth 2.0". The values you'll be filling for "Consumer Key" and "Consumer Secret" are your OAuthClientId and OAuthClientSecret, respectively.

7. Hit "Save" and your new OAuth Consumer Key will be created.

2.1 Persisting OAuth Values

You do not need to reauthenticate when you open a new connection: The provider saves the temporary tokens resulting from the OAuth exchange into OAuthSettingsLocation to be persisted across connections.

The following are the connection properties for SugarCRM. Not all properties are required. Enter only property values pertaining to your installation. Several properties will be automatically initialized with the appRules defaults.

Property	Description
Authentication
APIVersion	The version of the SugarCRM API used.
Password	The password of the Sugar CRM account.
URL	The URL of the SugarCRM account.
User	The user of the Sugar CRM account.
Firewall
FirewallPassword	A password used to authenticate to a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallType	The protocol used by a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
Logging
Logfile	A path to the log file.
MaxLogFileCount	A string specifying the maximum file count of log files. When the limit is hit, a new log is created in the same folder with the date and time appended to the end and the oldest log file will be deleted.
MaxLogFileSize	A string specifying the maximum size in bytes for a log file (for example, 10 MB). When the limit is hit, a new log is created in the same folder with the date and time appended to the end.
Verbosity	The verbosity level that determines the amount of detail included in the log file.
Misc
ConnectionLifeTime	The maximum lifetime of a connection in seconds. Once the time has elapsed, the connection object is disposed.
ConnectionString	***
MaxRows	Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other	These hidden properties are used only in specific use cases.
Platform	The SugarCRM platform that you want to use during your session.
PoolIdleTimeout	The allowed idle time for a connection before it is closed.
PoolMaxSize	The maximum connections in the pool.
PoolMinSize	The minimum number of connections in the pool.
PoolWaitTime	The max seconds to wait for an available connection.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
Readonly	You can use this property to enforce read-only access to SugarCRM from the provider.
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.
SupportEnhancedSQL	This property enhances SQL functionality beyond what can be supported through the API directly, by enabling in-memory client-side processing.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
UseConnectionPooling	This property enables connection pooling.
OAuth
InitiateOAuth	Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthAccessToken	The access token for connecting using OAuth.
OAuthClientId	The consumer key obtained from the OAuth token settings.
OAuthClientSecret	The consumer secret obtained during application registration.
OAuthSettingsLocation	The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
OAuthVerifier	The verifier code returned from the OAuth authorization URL.
Proxy
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyAutoDetect	This indicates whether to use the system proxy settings or not. This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.
ProxyExceptions	A semicolon separated list of hosts or IPs that are exempt from connecting through the ProxyServer .
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.