Cin7 Core

ExpandedToggleIcon        Connection Dialog

To connect to Cin7 Core you must specify the following parameters:

•Account Id - an automatically generated Account ID used for connecting to Cin7 Core. It is generated when you create an organization in the Cin7 Core account. Your Account ID can be found in your organization setup.
•API Key - an automatically generated API key that is used for connecting to Cin7 Core. Your API Key can be found in your Cin7 Core Integrations list. It is generated when you create an organization in the Cin7 Core account. Your API Key can be found in your organization setup. More information can be found here: https://dearinventory.docs.apiary.io/#introduction/api-introduction.

To get it, click the profile icon in Cin7 Core and then click User Settings. In the API KEY section of the User Settings page, copy your API Key and paste it to the connection editor.

In addition to the API Key, you can configure the Advanced connection parameters 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 Type

Not used for Cin7 Core. Do not change this parameter value.

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

Default Command Timeout

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

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. The default value is 7.

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

Password

This parameter stores the API Key - an automatically generated API key that is used for connecting to Cin7 Core.

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

Token Server

Not used for Cin7 Core.

Url

API URL. Do not change this parameter value.

User

This parameter stores the Account Id - an automatically generated Account ID used for connecting to Cin7 Core.

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.