Dynamics 365 Business Central Connection

See the Connector Marketplace topic. Please request your administrator to start a trial or subscribe to the Premium Dynamics 365 Business Central connector.

Dynamics 365 Business Central is Microsoft’s cloud-based ERP solution for small and medium-sized businesses, covering finance, sales, and more.

This topic describes how to authenticate to Dynamics 365 Business Central and configure any necessary connection properties in the Dynamics 365 Business Central connection connector.

Connection Configuration #

Each connection property available in the Dynamics 365 Business Central connector is explained below.

Connection Name #

The name of the connection to be created should be provided. This is the name that will display on the list of available connections.

Auth Scheme #

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

Note: OAuth Authentication is for cloud version only, but is expected to be supported for OnPrem in August 2021.

Possible Values:

• AzureAD: Set this to perform Azure Active Directory OAuth authentication. AzureServicePrincipal: Set this to authenticate as an Azure Service Principal using a Client Secret.

• AzureServicePrincipal: Set this to authenticate as an Azure Service Principal using a Certificate.

• AzureServicePrincipalCert: Set this to authenticate as an Azure Service Principal using a Certificate.

• AccessKey: Set this to perform authenticating using an Access Key. Only works on endpoints designed for testing the service.

• Auto: Automatically try to determine an appropriate auth scheme to use based on other connection properties.

OrganizationURL #

The URL to 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}

Company #

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

This can be found under the Company Information page. Specify the Microsoft Dynamics 365 Business Central company to connect with and retrieve data from. Leave this empty to retrieve all companies as separate schemas.

UseSandbox #

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

Azure Environment #

The Azure Environment to use when establishing a connection.

Possible Values:

GLOBAL, CHINA, USGOVT, USGOVTDOD

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

Azure Tenant #

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.

If not specified, your default tenant is used.

User #

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

Password #

The password used to authenticate the user.

Access Key #

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

OAuth Client ID #

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

OAuth Client Secret #

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

OAuth Access Token #

The access token for connecting using OAuth.

OAuth Refresh Token #

The OAuth refresh token for the corresponding OAuth access token.

OAuthJWT Certificate Type #

The type of key store containing the JWT Certificate.

This property can take one of the following values:

• PFX: The certificate store is the name of a PFX (PKCS12) file containing certificates.

• PFXBLOB: The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.

• JKSFILE: The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.

• JKSBLOB: The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.

• PEMKEY_FILE: The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.

• PEMKEY_BLOB: The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.

• PUBLIC_KEY_FILE: The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.

• PUBLIC_KEY_BLOB: The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.

• SSHPUBLIC_KEY_FILE: The certificate store is the name of a file that contains an SSH-style public key.

• SSHPUBLIC_KEY_BLOB: The certificate store is a string (base-64-encoded) that contains an SSH-style public key.

• P7BFILE: The certificate store is the name of a PKCS7 file containing certificates.

• PPKFILE: The certificate store is the name of a file that contains a PPK (PuTTY Private Key).

• XMLFILE: The certificate store is the name of a file that contains a certificate in XML format.

• XMLBLOB: The certificate store is a string that contains a certificate in XML format.

OAuthJWT Certificate Password #

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

OAuthJWT Certificate Subject #

The subject of the OAuth JWT certificate.

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value “*” picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance “CN=www.server.com, OU=test, C=US, E=support@gathr.one”.

Common fields and their meanings are displayed below:

If a field value contains a comma it must be quoted.

Upload OAuthJWTCert File #

Option to upload the OAuth JWT certificate file.

Add Configuration: Additional properties can be added using this option as key-value pairs.

After entering all the details, click on the TEST button.

If the connection service identification and authentication details are provided correctly, a success message stating “connection available” is generated.

Click on the CREATE button to save the changes.

If the details are incorrect or the server is down, you will get a message “Connection unavailable”.