Adobe Commerce

ExpandedToggleIcon        Connection Dialog

To connect to Adobe Commerce, required connection parameters must be set.

The following connection options are required:

1.API Version - the version of your Adobe Commerce server - Ver 1 for Adobe Commerce 1.x, or Ver 2 for Adobe Commerce 2.x.
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 (this parameter is specific to Adobe Commerce 1.x);
5.Password - Your Adobe Commerce password (this parameter is specific to Adobe Commerce 2.x);

 

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

Authentication Token

Stores an automatically generated key that is used for connecting to Adobe Commerce.

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

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

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.

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

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.

Service Version

Specifies the Adobe Commerce version to connect to. The default value is Ver1, which means Adobe Commerce 1.x. If you want to connect to Adobe Commerce 2, set this property to Ver2.

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 ID

Specifies the Adobe Commerce user name to login with.

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.