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

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

Connection Lifetime

Compares a connection's creation time with the current time when the connection is returned to the pool, and destroys the connection 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

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 60.

Default Command Timeout

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

Domain

Specifies the address of your Adobe Commerce store.

Failover Retries

Specifies 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.

Initialization Command

Specifies a command to execute after establishing the connection.

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

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.

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 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

Draws the connection from the appropriate pool by default, or creates it and adds it to the appropriate pool, if true.

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 after establishing the connection. Unlike Initialization Command, it is not executed for connections obtained from the connection pool.

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.

StoreViewCode

Specifies the code of the store view that determines the scope of the data, such as product prices and inventory, retrieved from the Adobe Commerce store.

Token Server

Is not used for Adobe Commerce.

User

Specifies the Adobe Commerce user name to login with.

UTC Dates

Converts dates to UTC format during import when 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.