ODBC Driver for Dynamics 365 Business Central

Connection String Parameters - ODBC Driver for Dynamics 365 Business Central


Dynamics 365 Business Central ODBC Connection String Parameters

The following table lists the connection string parameters for Dynamics 365 Business Central.

Parameter Description

Authentication

 The authentication type to use when connecting to Dynamics 365 Business Central.
The possible values are:
  • Basic - The basic user/password authentication type.
  • OAuth 2.0 - The OAuth 2.0 authentication type.

Server

The URL of the Dynamics 365 Business Central server.

User ID

The Dynamics 365 Business Central username. Available when the User ID and Password authentication type is selected.

Access Key

The web service access key generated in the user account allowing authorization of a specific application to access Dynamics 365 Business Central data. To save your access token in the DSN settings, select the Save Key checkbox.

Company Name

Specify a custom company name by selecting the appropriate option from the drop-down menu.

Company Id

Сustom Company Id for the Dynamics 365 Business Central OAuth 2.0.

Environment Name

Specify a custom environment name by selecting the appropriate option from the drop-down menu.

Refresh Token

The Dynamics 365 Business Central OAuth 2.0 token. Available when the OAuth 2.0 authentication type is selected.

Proxy Settings

Proxy Server

The proxy hostname or IP address.

Proxy User ID

The proxy hostname or IP address.

Proxy Password

The proxy password.

Proxy Port

The proxy port.

Advances Settings

AllowNullStringsInMetadata

Some parameters don't accept null values when retrieving metadata. If a third-party tool passes a null value to such a parameter, the driver returns an error. By default, these options are enabled for compatibility with such third-party tools.

EmptyStringsAsNullInMetadata

Cache Metadata

 This is a configurable parameter, which allows caching and storing metadata in a temporary database. The parameter settings specify the frequency of resetting cached metadata ranging from 1 hour...to 1 month.
  • False - The metadata caching is disabled.
  • Hour - Cached metadata is reset one time per hour.
  • Day - Cached metadata is reset once a day (i.e. every 24 hours).
  • Month - Cached metadata is reset once per month.
  • True - Metadata caching won't reset until the driver is unloaded.

Connection Timeout

The time (in seconds) to wait for a connection to open before terminating an attempt. The default value is 60.

ODBC Behavior

 Sets the behavior corresponding to the ODBC specification version expected by a third-party tool. The behavior of the ODBC driver can be changed by calling the SQLSetEnvAttr function to set the SQL_ATTR_ODBC_VERSION environment attribute. Some third-party tools expect the driver to exhibit ODBC 2.x behavior, but forget to call SQLSetEnvAttr with the needed version, or pass the incorrect value. In this case, the behavior can be explicitly set in the Connection String.
  • 0 - The default value. ODBC behavior is determined by a third-party tool.
  • 2 - ODBC 2.x behavior is explicitly set.
  • 3 - ODBC 3.x behavior is explicitly set.

QueryTimeout

The time to wait for a query execution result before terminating and generating an error.

RegionalNumberSettings

Enables the use of local regional settings when converting numbers to strings.

RegionalDateTimeSettings

Enables the use of local regional settings when converting dates and times to strings.

ReturnForeignKeys

Use the parameter to specify whether the driver must return foreign keys. Retrieving metadata about foreign key constraints is a time-consuming operation; many third-party tools request foreign key metadata even whey they do not actually need this information. Note that enabling the option may degrade performance of data access operations. The default value is False.

String Types

 Sets the string value types returned by the driver as Default, ANSI, or Unicode.
  • Default - The driver defines the string types.
  • Ansi - All string types are returned as SQL_CHAR, SQL_VARCHAR, and SQL_LONGVARCHAR.
  • Unicode - All string types are returned as SQL_WCHAR, SQL_WVARCHAR, and SQL_WLONGVARCHAR.

Set the parameter to Ansi or Unicode, if your third-party tool supports only Ansi or Unicode strings.

UTC Dates

Specifies whether all the datetime values retrieved from the data source are returned as UTC values or converted to local time and whether the date values specified on the application side (e.g., in SQL statements) are considered UTC or local. The default value is false.

Sample Dynamics 365 Business Central ODBC Connection String

DRIVER={Devart ODBC Driver for Dynamics 365 Business Central};Refresh Token=mytoken
© 2015-2024 Devart. All Rights Reserved. Request Support ODBC Forum Provide Feedback