Adobe Commerce

ExpandedToggleIcon        Connection Dialog

The following connection options are required:

1.Service version - Specify whether you are connecting to Adobe Commerce (formerly Magento) 1.x or 2.0 (The default value is Ver1 - Adobe Commerce 1.x. If you want to connect to Adobe Commerce 2.0, switch it to Ver2);
2.Domain - The address of your Adobe Commerce store;
3.User Id - The user name to login with;
4.API Key - An automatically generated key that is used for connecting to Adobe Commerce (available for connections to Adobe Commerce 1.x);
5.Password - User password for token-based authentication (available for connections to Adobe Commerce 2.0).

 

You can find the API Key in the User information section of your Adobe Commerce 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:

 

Option

Description

API Key

An automatically generated key that is used that is used for connecting to Adobe Commerce (for connections to Adobe Commerce 1.x).

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.

Domain

The address of your Adobe Commerce store.

Failover Retries

The number of retry attempts to automatically re-run a command before displaying an error message in case when the command failed because of an error that may be temporary.

Local SQL Engine

Determines whether to use local SQL engine for SELECT queries, that are too complex to translate them directly to Adobe Commerce API calls or to show an error message.

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.

Password

User password for token-based authentication (for connections to Adobe Commerce 2.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.

Pooling

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.

Readonly

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

Service Version

Determines the Adobe Commerce version to connect to: Ver1 for Adobe Commerce 1.x or Ver2 for Adobe Commerce 2.0. The default value is Ver1.

Token Server

Not used for Adobe Commerce.

User

The Adobe Commerce 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.