ExpandedToggleIcon        Connection Dialog

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

The following connection options are required:

1.API Version - the version of your Magento server - Ver 1 for Magento 1.x, or Ver 2 for Magento 2.x.
2.Domain - The address of your Magento store;
3.User Id - The user name to login with;
4.API Key - An automatically generated key that is used for connecting to Magento (this parameter is specific to Magento 1.x);
5.Password - Your Magento password (this parameter is specific to Magento 2.x);


You can find the API Key in the User information section of your Magento dashboard.

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:




Authentication Token

An automatically generated key that is used that is used for connecting to Magento.

Connection Lifetime

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 (in seconds) exceeds the value specified by Connection Lifetime. The default value is 0 (connection always returns to pool).

Connection Timeout

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

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


The address of your Magento store.

Failover Retries

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.

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 Magento 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 Magento API calls can be used. More complex SELECT statements will fail.

Max Pool Size

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.

Min Pool Size

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

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.


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

Proxy Host

The host name or IP address of proxy server.

Proxy Password

The password for the proxy server account.

Proxy Port

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

Proxy User

The proxy server account name.


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

Service Version

Magento version to connect to. Default value is Ver1, which means Magento 1.x. If you want to connect to Magento 2, set this property to Ver2.

Token Server

Not used for Magento.

User ID

The Magento user name to login with.

UTC Dates

If set to True, dates will be converted to UTC format during import, and the date values entered by the user (in SELECT statements, etc.) are considered UTC dates when sending them to the data source.