SugarCRM

Devart SSIS Data Flow Components for SugarCRM support SugarCRM 7.0 or higher.  Devart SSIS Data Flow Components for SugarCRM do not support SugarCRM Community edition.

 

ExpandedToggleIcon        Connection Dialog

To connect to SugarCRM, required connection parameters must be set.

The following connection options are required:

1.Host - The login URL to SugarCRM service;
2.User Id - The SugarCRM login account;
3.Password - The password for the SugarCRM login account;

 

In addition to the required options, Advanced connection options may be set for more fine connection tuning.

 

ExpandedToggleIcon        Advanced Connection Options

The following table describes the options that you can include in the Connection String using the Advanced Connection Editor dialog box:

 

Option

Description

Connection Lifetime

Specifies the maximum lifetime (in seconds) of a connection. When a connection is returned to the pool, its creation time is compared with the current time, and the connection is destroyed if that time span exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).

Connection Timeout

Specifies the length of time (in seconds) to wait for a connection to the server before terminating the attempt and generating an error. The default value is 15.

Default Command Timeout

Specifies the time in seconds to wait while trying to execute a command before terminating the attempt and generating an error.

Failover Retries

Specifies the number of retry attempts to re-run a command in case when the command failed because of an exception, that indicates that the reason of the failure may be temporary.

Ignore Certificate Name Mismatch

Determines whether the certificate name mismatch error should be ignored.

Ignore Certificate Untrusted

Determines whether the untrusted root certificate error should be ignored.

Initialization Command

Specifies a data source-specific command to execute immediately after the connection is established.

Local SQL Engine

Determines whether to enable local SQL processing (enabled by default). Local SQL processing allows performing complex SELECT statements that cannot be directly compiled to SugarCRM API calls. In this case ll the data from the mentioned cloud objects is queried to the local cache, and then the query is performed against the cache.

If local SQL processing is disabled, only simple SELECT statements that can be directly translated into SugarCRM API calls can be used. More complex SELECT statements will fail.

Max Pool Size

Specifies the maximum number of connections allowed in the pool. Setting the Max Pool Size value in the connection string can affect performance. The default value is 100.

Metadata Cache

Specifies the path to the metadata cache database file.

Min Pool Size

Specifies the minimum number of connections allowed in the pool. The default value is 0.

NormalizeDbNames

Determines whether database object names are normalized when retrieved from the database.

Password

Specifies the user password.

Persist Security Info

Indicates if security-sensitive information, such as the password, is not returned as part of the connection if the connection is open or has ever been in an open state.

Platform

Specifies the SugarCRM platform to use when connecting to SugarCRM. You can read more about SugarCRM platforms in <a href="https://community.sugarcrm.com/community/developer/blog/2016/05/09/how-platform-parameter-works-in-sugar-v10-rest-api">SugarCRM developer blog</a>.

Pooling

Specifies whether, by default, the connection is drawn from the appropriate pool or is created and added to the appropriate pool.

Proxy Host

Specifies the host name or IP address of the proxy server.

Proxy Password

Specifies the password for the proxy server account.

Proxy Port

Specifies the port number of the proxy server. The default value is 3128.

Proxy User

Specifies the proxy server account name.

Readonly

Indicates whether the connection is read-only (allows only SELECT statements).

Run Once Command

Specifies a command to execute immediately after establishing the connection. Unlike Initialization Command, it is not executed for connections obtained from the connection pool.

Server

Specifies the login URL to the SugarCRM service.

Token Server

Issues an authentication token after a successful login.

Use Email Relationship

Determines how SugarCRM email-related data is processed. If set to False, the email1, email_addresses_non_primary, invalid_email, email_opt_out, and email_and_name1 fields are used. Otherwise, a single email field, storing a JSON array with emails and all their settings is used.

Note that SugarCRM Developers consider the old approach with using email1 and other email-related fields out-of-date, deprecated, and subject to removal in upcoming Sugar releases. We keep the ability to use it for compatibility purposes, but recommend using the new approach. Read more about this in SugarCRM developer blog.

User Id

Specifies the SugarCRM account login.

UTC Dates

Converts dates to UTC format during import if set to True, and treats the date values entered by the user (in SELECT statements, etc.) as UTC dates when sending them to the data source.