Dynamics 365 Business Central Connection Details

Introduction

Connector Version

This documentation is based on version 21.0.8662 of the connector.

Get Started

Dynamics 365 Business Central Version Support

The connector supports read/write access to Dynamics 365 Business Central through OData Web services.

Establish a Connection

To connect to data, specify OrganizationUrl. The OrganizationUrl should be set to one of the following:

• The endpoint to your business central account such as https://businesscentral.dynamics.com/abc123/
• The web services root.
• The custom API base URL.

Please see Business Central Endpoints for more details on how to specify the OrganizationUrl and which endpoints are available.

If you have multiple companies in your organization, you must also specify the Company to indicate which company you would like to connect to. Company does not need to be specified if you have only one company.

User and Access Key Authentication

Note: User and Access key Authentication will not be supported for cloud version starting in Apr 2021. For on-premises, Web Service Access Key (Basic Auth) will remain an option for the time being.

To use Access Key auth, set the AuthScheme to Access Key. To authenticate to Dynamics 365 Business Central, you may provide the User and AccessKey connection properties. Microsoft recommends these for testing and development purposes, but discourages their use for production environments.

To obtain the User and AccessKey values, navigate to the Users page in Dynamics 365 Business Central and then click on Edit. The User Name and Web Service Access Key values are what you will enter as the User and AccessKey connection string properties. Note that the User Name is not your email address. It is a shortened user name.

Connect to Dynamics 365 Business Central

To authenticate to the Dynamics 365 Business Central source, you should first set the OrganizationUrl to the URL of the organization you are connecting to, such as https://businesscentral.dynamics.com/abc123/.

Authenticate using Access Key

Set the User along with the AccessKey to authenticate to the Dynamics 365 Business Central source.

Authenticate using Azure AD

Azure AD is a connection type that goes through OAuth. Set your AuthScheme to AzureAD and see Using OAuth Authentication for an authentication guide.

Authenticate using Azure Service Principal

Azure Service Principal is a connection type that goes through OAuth. Set your AuthScheme to AzureServicePrincipal and see Using Azure Service Principal Authentication for an authentication guide.

Authenticate using MSI Authentication

If you are running Dynamics 365 Business Central on an Azure VM, you can leverage Managed Service Identity (MSI) credentials to connect:

• AuthScheme: Set this to AzureMSI.

The MSI credentials will then be automatically obtained for authentication.

Use OAuth Authentication

OAuth requires the authenticating user to interact with Dynamics 365 Business Central using the browser. The connector facilitates this in various ways as described below.

Embedded Credentials

See Embedded Credentials to connect with the connector's embedded credentials and skip creating a custom OAuth app.

Custom Credentials

Instead of connecting with the connector's embedded credentials, you can register an app with Custom Credentials to obtain the OAuthClientId and OAuthClientSecret.

When to Create a Custom OAuth App

Creating a custom OAuth app is optional as the connector is already registered with Dynamics 365 Business Central and you can connect with its embedded credentials. You might want to create a custom OAuth app to change the information displayed when users log into the Dynamics 365 Business Central OAuth endpoint to grant permissions to the connector.

Create a Custom OAuth App

See Creating a Custom OAuth App for a procedure.

Admin Consent

Admin consent refers to when the Admin for an Azure Active Directory tenant grants permissions to an application which requires an admin to consent to the use case. The embedded app within the Dynamics 365 Business Central connector, contains no permissions that require admin consent. Therefore, this information applies only to custom applications.

Admin Consent Permissions

When creating a new OAuth app in the Azure Portal, you must specify which permissions the app will require. Some permissions may be marked stating "Admin Consent Required". For example, all Groups permissions require Admin Consent. If your app requires admin consent, there are a couple of ways this can be done.

The easiest way to grant admin consent is to just have an admin log into portal.azure.com and navigate to the app you have created in App Registrations. Under API Permissions, there will be a button for Grant Consent. You can consent here for your app to have permissions on the tenant it was created under.

If your organization has multiple tenants or the app needs to be granted permissions for other tenants outside your organization, the GetAdminConsentURL may be used to generate the Admin Authorization URL. Unlike the GetOAuthAuthorizationUrl, there will be no important information returned from this endpoint. If the admin grants access, it will simply return a boolean indicating that permissions were granted.

Once an admin grants consent, authentication may be performed as normal.

Use Azure Service Principal Authentication

The authentication as an Azure Service Principal is handled via the OAuth Client Credentials flow, and it does not involve direct user authentication. Instead, credentials are created for just the app itself. All tasks taken by the app are done without a default user context, but based on the assigned roles. The application access to the resources is controlled through the assigned roles' permissions.

Custom Credentials

You will need to register an OAuth app to obtain the OAuth property values before connection to the Dynamics 365 Business Central data source. You can check the Custom Credentials guide on how to set the OAuth properties.

Create a Custom OAuth App

See Creating a Custom OAuth App for a procedure.

Create a Custom OAuth App

Creating a custom OAuth app and a service principal that can access the necessary resources is required when authenticating using an Azure Service Principal.

Follow the steps below to create a custom OAuth app and obtain the connection properties for the Azure Service Principal authentication.

Steps to Create a Custom OAuth App

Follow the steps below to obtain the OAuth values for your app.

1. Log in to https://portal.azure.com.
2. In the left-hand navigation pane, select Azure Active Directory then App Registrations and click on New registration button.
3. Enter an app name and set the radio button for "Any Azure AD Directory - Multi Tenant". Then set the redirect URL to something such as http://localhost:33333, the connector's default.
4. Copy the Application (client) ID value displayed on the Overview section after creating the app, since this value is used as the OAuthClientId
5. Define the app authentication type by going to the Certificates & Secrets section. There are two types of authentication available: using a client secret and using a certificate. The recommended authentication method is via a certificate, but you can also create an application secret.
   • Option 1 - Upload a certificate: In the Certificates & Secrets section, select Upload certificate and select the certificate to upload from your local machine.
   • Option 2 - Create a new application secret: In the Certificates & Secrets section, select New Client Secret for the app and select its duration. After saving the client secret, the key value is displayed. Copy this value as it is displayed only once, and it is used as the OAuthClientSecret.
6. In the Authentication tab, make sure to check the option: Access tokens (used for implicit flows).
7. Open the Subscriptions page by searching and selecting the Subscriptions service from the search bar.
8. Select the particular subscription to assign the application to, then open the Access control (IAM) section, and click on the Add role assignment button.
9. Select Owner as the role to assign to your created OAuth app.

Custom Credentials

Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.

Authentication with Your OAuth App

There are two types of app authentication available: using a client secret and using a certificate. You can use any of them depending on the configured app authentication.

Get an OAuth Access Token

You are ready to connect after setting one of the below connection properties groups depending on the authentication type.

1. Authenticating using a Client Secret
   • AuthScheme: Set this to the "AzureServicePrincipal" in your app settings.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • AzureTenant: Set this to the tenant you wish to connect to.
   • OAuthClientId: Set this to the Client ID in your app settings.
   • OAuthClientSecret: Set this to the Client Secret in your app settings.
2. Authenticating using a Certificate
   • AuthScheme: Set this to the "AzureServicePrincipal" in your app settings.
   • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
   • AzureTenant: Set this to the tenant you wish to connect to.
   • OAuthClientId: Set this to the Client ID in your app settings.
   • OAuthJWTCert: Set this to the JWT Certificate store.
   • OAuthJWTCertType: Set this to the type of the certificate store specified by OAuthJWTCert.

Business Central Endpoints

Dynamics 365 Business Central supports several different endpoints to connect to data, with the two main categories being the Common Service endpoints, and the Web Services endpoints. Beyond that, each set of endpoints are split into Production and Testing endpoints. Production endpoints require an OAuth connection, whereas Testing endpoints may be connected to via User and AccessKey. Note that both Production and Testing endpoints access and interact with the same data - they just have different restrictions on what authentication methods are allowed.

The OrganizationUrl by default will attempt to resolve to a Common Service Production endpoint if any https://businesscentral.dynamics.com/ URL is specified. However, this may be configured by modifying the EndpointType. In addition, specifying any https://api.businesscentral.dynamics.com/ will override both EndpointType and UseSandbox as the specified OrganizationUrl supplied will be used without alteration.

Common Service Endpoints

Common Service endpoints contain the business data associated with Dynamics 365 Business Central. For instance, accounts, sales orders, and sales invoices will all be found on the Common Service.

Common Service Endpoints - Production

• https://api.businesscentral.dynamics.com/v2.0/{environment name}/api/v2.0
• https://api.businesscentral.dynamics.com/v1.0/api/v2.0
• https://api.businesscentral.dynamics.com/v2.0/sandbox/api/v2.0

Common Service Endpoints - Testing

• https://api.businesscentral.dynamics.com/v2.0/{tenant id}/{environment name}/api/v2.0
• https://api.businesscentral.dynamics.com/v1.0/{tenant id}/api/v2.0
• https://api.businesscentral.dynamics.com/v2.0/{tenant id}/sandbox/api/v2.0

This may be obtained by logging into portal.azure.com, selecting your user name, and going to Switch Directory. It may also be found under portal.azure.com, going to Active Directory, and Overview. Environment names may be found under https://businesscentral.dynamics.com/{tenant id}/admin.

Web Services Endpoints

Web Service endpoints include anything that has been custom exposed in Dynamics 365 Business Central. This may include KPIs, reports, individual entites, or other feeds. In Dynamics 365 Business Central, click the magnifying glass and search for Web Services to get an idea of what all are exposed by these endpoints.

Web Services Endpoint - Production

• https://api.businesscentral.dynamics.com/v1.0/ODataV4/

Web Services Endpoint - Testing

• https://api.businesscentral.dynamics.com/v1.0/{tenant id}/ODataV4/

Custom API Endpoints

To connect to custom API endpoints you need to set the OrganizationUrl property to your custom base URL which is in the format: *https://api.businesscentral.dynamics.com/v2.0/{tenant}/api/{API publisher}/{API group}/{API version}*

Endpoint Default Changes from 2019

In the 2019 version, the default endpoint resolved to was the Web Services testing endpoint if a https://businesscentral.dynamics.com/ url was supplied to OrganizationUrl. The new default is the Common Service production endpoint. To continue using the Web Services testing endpoint, either set it directly or change the EndpointType to WSTesting.

Important Notes

Configuration Files and Their Paths

• All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

This section details a selection of advanced features of the Dynamics 365 Business Central connector.

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using private agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

User Defined Views

The Dynamics 365 Business Central connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

• Create a JSON-formatted configuration file defining the views you want.
• DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
    "MyView": {
        "query": "SELECT * FROM Accounts WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model

The Dynamics 365 Business Central connector models Dynamics 365 Business Central entities in relational Tables, Views, and Stored Procedures. The table definitions are dynamically obtained from the OData service you connect to. Any changes in the metadata, such as added or removed columns or changes in data type, can be loaded by reconnecting.

Tables

The connector models the writable entities described in the service metadata document as bidirectional Tables.

Stored Procedures

Stored Procedures are function-like interfaces to the data source. They can be used to perform additional operations that fall outside of the standard CRUD model.

Miscellaneous information

Be aware that 'insert' statement on table SalesInvoiceLines works only when the status of the sales invoice is 'DRAFT'. If the status is 'PAID' or 'OPEN' then the 'insert' statement will not complete successfully. This is an API limitation.

Tables

Default Table Display

The Dynamics 365 Business Central connector only exposes tables configured as Web Services in your account. It uses the OData services of Dynamics 365 Business Central to dynamically obtain and display the list of tables after you connect. You can display additional tables; the next section describes the procedure.

Displaying Additional Tables

If you want to display tables (endpoints) other than the ones the Dynamics 365 Business Central connector has displayed, first configure the tables you want as a Web Service from your account. The connector then detects the exposed endpoints and displays them.

To do this, follow these steps:

1. Log in to your Dynamics 365 Business Central account.
2. Navige to Web Services and click New.
3. Under Object Type, select Page or Query. The Codeunit option is available in Dynamics 365 Business Central version 16.3 or later.
4. In the Object ID open the dropdown list and click Select from full list.
5. Select the tables you want to display from the Object Name column.
6. Specify the Service Name to define how the service is displayed.
7. Select the Published check box and wait until the ODat V4 URL field is populated.
8. Inspect the upper right corner of the page to make sure the changes are saved.
9. Repeat this procedure for any other tables (configured as web services) that you want to add.

Filtering with AL Enum objects

Some Business Central API pages, including most API v2.0 pages, have fields based on AL Enum objects.

Fields based on AL enum objects must have names that are consistent and always the same so that filters on the report always work no matter the language or OS you are using. For this reason, the fields based on AL enums are not translated and Buisness Central API requires them to be encoded to avoid any special character.

To be able to filter with an Enum value, you need to encode the value by refering to https://www.w3.org/Style/XSL/TestSuite/results/4/XEP/symbol.pdf documentation and appending _(underscore) before and after the symbol.

In particual, for space this would be "_x0020_". e.g: SELECT * FROM DimensionSetLines WHERE parentid={id} and parentType='Sales_x0020_Order'

To check if the field is an enum object you can refer to the IsEnumeration column of the sys_tablecolumns table.

Stored Procedures

Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.

Dynamics 365 Business Central Connector Stored Procedures

GetAdminConsentURL

Gets the admin consent URL that must be opened separately by an admin of a given domain to grant access to your application. Only needed when using custom OAuth credentials.

Input

Result Set Columns

GetOAuthAccessToken

Gets the auth token used to authenticate to the service.

Input

Result Set Columns

GetOAuthAuthorizationUrl

Gets an authorization URL from the data source. The authorization URL can be used to generate a verifier required to obtain the OAuth token.

Input

Result Set Columns

RefreshOAuthAccessToken

Obtains an updated OAuthAccessToken if passed a token to refresh.

Input

Result Set Columns

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Dynamics 365 Business Central:

• sys_catalogs: Lists the available databases.
• sys_schemas: Lists the available schemas.
• sys_tables: Lists the available tables and views.
• sys_tablecolumns: Describes the columns of the available tables and views.
• sys_procedures: Describes the available stored procedures.
• sys_procedureparameters: Describes stored procedure parameters.
• sys_keycolumns: Describes the primary and foreign keys.
• sys_indexes: Describes the available indexes.

Data Source Tables

The following tables return information about how to connect to and query the data source:

• sys_connection_props: Returns information on the available connection properties.
• sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries, including batch operations:

• sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs

Columns

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas

Columns

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables

Columns

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Accounts table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Accounts'

Columns

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Accounts table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Accounts'

Columns

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columns

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:d365businesscentral:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Collaborative Query Processing

When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity

Columns

Data Type Mapping

Data Type Mappings

The connector maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.

Advanced Configurations Properties

The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.

Authentication

Azure Authentication

OAuth

SSL

Schema

Miscellaneous

Authentication

This section provides a complete list of authentication properties you can configure.

AuthScheme

Whether to use OAuth Authentication or Access Key Authentication when connecting to Business Central.

Possible Values

Access Key, AzureAD, AzureServicePrincipal, AzureMSI, Auto

Data Type

string

Default Value

Auto

Remarks

Whether to use OAuth Authentication or Access Key Authentication when connecting to Business Central.

• Auto: Automatically try to determine an appropriate auth scheme to use based on other connection properties.
• Access Key: Set this to perform authenticating using an Access Key. Only works on endpoints designed for testing the service.
• AzureAD: Set this to perform Azure Active Directory OAuth authentication.
• AzureServicePrincipal: Set this to authenticate as an Azure Service Principal.
• AzureMSI: Set this to automatically obtain Managed Service Identity credentials when running on an Azure VM.

OrganizationURL

The URL to your Dynamics 365 organization. For instance, https://businesscentral.dynamics.com/abc123/.

Data Type

string

Default Value

""

Remarks

The URL you use to log into your Dynamics 365 organization. For instance, https://businesscentral.dynamics.com/abc123/.

This may also be known as the resource. To find this click on the Search icon and search for "Web Services". Monitor the OData v4 URL. The end value should be the web service endpoint (minus the Company), such as: https://api.businesscentral.dynamics.com/v1.0/businesscentralid/ODataV4/.

To connect to custom APIs set this property to the base URL to your Dynamics 365 custom API. For instance, https://api.businesscentral.dynamics.com/v2.0/{environmentName}/api/{API publisher}/{API group}/{API version} or https://api.businesscentral.dynamics.com/v2.0/{tenant}/{environmentName}/api/{API publisher}/{API group}/{API version}

User

The username of the Dynamics 365 OnPremise account used to authenticate to the Dynamics 365 Business Central server.

Data Type

string

Default Value

""

Remarks

Together with AccessKey, this field is used to authenticate to the Dynamics 365 Business Central server.

AccessKey

The access key used to authenticate to the Dynamics 365 Business Central.

Data Type

string

Default Value

""

Remarks

Together with User, this field is used to authenticate against the Dynamics 365 Business Central.

Company

The name of the Company being used for Dynamics 365 Business Central.

Data Type

string

Default Value

""

Remarks

The name of the Company being used for Dynamics 365 Business Central. This can be found under the Company Information page. The Company property must be specified if your organization has multiple companies. If you only have one company available in your organization, it does not need to be specified.

UseSandbox

A boolean indicating if a sandbox is being used. Set this to true if you have a sandbox name other than simply 'sandbox'.

Data Type

bool

Default Value

false

Remarks

A boolean indicating if a sandbox is being used. Set this to true if you have a sandbox name other than simply 'sandbox'.

Azure Authentication

This section provides a complete list of Azure authentication properties you can configure.

AzureTenant

The Microsoft Online tenant being used to access data. If not specified, your default tentant will be used.

Data Type

string

Default Value

""

Remarks

The Microsoft Online tenant being used to access data. For instance, contoso.onmicrosoft.com. Alternatively, specify the tenant Id. This value is the directory ID in the Azure Portal > Azure Active Directory > Properties.

Typically it is not necessary to specify the Tenant. This can be automatically determined by Microsoft when using the OAuthGrantType set to CODE (default). However, it may fail in the case that the user belongs to multiple tenants. For instance, if an Admin of domain A invites a user of domain B to be a guest user. The user will now belong to both tenants. It is a good practice to specify the Tenant, although in general things should normally work without having to specify it.

The AzureTenant is required when setting OAuthGrantType to CLIENT. When using client credentials, there is no user context. The credentials are taken from the context of the app itself. While Microsoft still allows client credentials to be obtained without specifying which Tenant, it has a much lower probability of picking the specific tenant you want to work with. For this reason, we require AzureTenant to be explicitly stated for all client credentials connections to ensure you get credentials that are applicable for the domain you intend to connect to.

AzureEnvironment

The Azure Environment to use when establishing a connection.

Possible Values

GLOBAL, CHINA, GERMANY, USGOVT

Data Type

string

Default Value

GLOBAL

Remarks

In most cases, leaving the environment set to global will work. However, if your Azure Account has been added to a different environment, the AzureEnvironment may be used to specify which environment.

OAuth

This section provides a complete list of OAuth properties you can configure.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

CallbackURL

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type

string

Default Value

""

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

SSL

This section provides a complete list of SSL properties you can configure.

SSLServerCert

The certificate to be accepted from the server when connecting using TLS/SSL.

Data Type

string

Default Value

""

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

If not specified, any certificate trusted by the machine is accepted.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Schema

This section provides a complete list of schema properties you can configure.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\D365BusinessCentral Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\D365BusinessCentral Data Provider\Schema" with %APPDATA% being set to the user's configuration directory:

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

EndpointType

The type of endpoint the OrganizationUrl should resolve to.

Possible Values

CSProduction, CSTesting, WSProduction, WSTesting

Data Type

string

Default Value

CSProduction

Remarks

Please see Business Central Endpoints for details on the types of endpoints in Dynamics 365 Business Central and what the appropriate value to set the EndpointType to based on your use case.

IncludeNavigationProperties

A boolean indicating if navigation properties should be included in the column listing.

Data Type

bool

Default Value

false

Remarks

Navigation properties will not populate with information when retrieving data. Instead, navigation properties may be used to bind to an existing resource during inserts or updates. For example:

INSERT INTO accounts (_primarycontactid_value) VALUES ('123456')

To specify multiple values, use a comma-separated list. For instance:

INSERT INTO accounts (lead_customer_accounts) VALUES ('123,456')

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.