Skip to main content

Dynamics 365 Finance and SCM

Dynamics 365 Finance and SCM is a data source that connects to your Dynamics 365 Finance and Supply Chain Management, or D365 Finance and Operations environment, through endpoints exposed by the Zap service package. The following sections guide you through installing the required Zap service package and connecting to your environment.

Install the Zap service package

A D365 Finance and SCM environment must have the Zap service package installed before a data source can be connected. This is done by downloading the Zap service package then deploying it to your environment using Lifecycle Services.

note

Customers using SaaS will need their Microsoft partner install the Zap service package for them, as LCS is presently available only to partners.

Download and deploy the Zap service package

The Zap service package is available from the Download Service Package link on the data source connection screen in Data Hub. Clicking this link will download a ZIP file named ZAP_AXDeployablePackage.

Deploy the Zap service package in Lifecycle Services by uploading the ZAP_AXDeployablePackage ZIP to your project’s Asset Library, then assign and publish a version. Finally, apply that update in your project environment to install the package.

important

If you have more than one third-party package to deploy to D365 you might need help from your D365 partner, as Microsoft now requires multiple packages to be deployed as part of an all-in-one D365 package. More details about that requirement and the process can be found from the Microsoft page below.

Learn about All-in-one package deployment

  1. Log in to Lifecycle Services.
  2. Select your D365 Finance and Operations project.
  3. On the Project page, click Asset library in the More Tools section.
  4. Select the Software deployable package asset type in the Asset type list on the left.
  5. Click the + icon under the Software deployable packages files section.
  6. Type a name for the Package (e.g. Data Hub D365 Service Package 2.2). Click Add a file.
  7. Navigate to the folder where you saved the ZAP_AXDeployablePackage2.2.zip downloaded file.
  8. Select the file and click Add. The Asset Library screen now displays the newly uploaded service package in the Software Deployable Packages files list.
  9. Take note that the newly uploaded package does not have a check under "Valid" and is in draft status.
  10. Select the package and in the menu above the table, select Versions. The Select From Available Versions screen appears.
  11. Select your version and click Get version. This assigns a version to your package, marked as published. It is now ready to be deployed to your Cloud AX7 Instance.
  12. Navigate to your Project Environment inside LCS and click Maintain to deploy the package.
  13. Select the update that you wish to deploy, and click Apply. Note that all previous updates remain in history.
  14. Once you click Apply, the update will begin. As the various steps are executing, they will be listed in the section "Failed and currently executing steps".

Zap service package security

The Zap service package creates API endpoints within your D365 environment that the data source uses to connect to your data. Those endpoints require specific permissions that the account used by the data source might not have. To grant those permissions, follow these steps in your Dynamics 365 Finance and SCM environment:

  1. Open System Administration > Security configuration.
  2. Open Privileges tab.
  3. Click Create new button.
  4. Select Service operations under References.
  5. Click Add references button.
  6. Select all “service operations” prefixed with Zapdataservice or Zapservice and grant.
  7. Open Roles tab.
  8. Create a new role.
  9. Select Privileges under References.
  10. Click Add references button.
  11. Select the new privilege created previously.
  12. Add the role to the user under System Administration > Users.

Create a native application in Azure Entra ID

An application in your Microsoft Entra ID tenant is required for Data Hub to authenticate to your Dynamics 365 Finance and SCM instance. Applications are created in the Azure Portal under Microsoft Entra ID > App Registrations. The redirect URI must be https://services.zapbi.com/OAuthLoginRedirect, and the application must have these API permissions found under the Dynamics ERP API permissions:

  • AX.FullAccess
  • CustomerService.FullAccess
  • Odata.FullAccess

After creating the application, you will need to provide these connection details on the data source connection screen:

  1. Copy the Application (client) ID and paste it into the Application Client ID (Azure AD) field.
  2. Create a client secret and paste the secret value into the Application Client Secret (Azure AD) field.

Direct database connection

Some environments let you connect directly to your Dynamics 365 SQL database instead of using the Zap service package. To enable this, check Read from database directly and configure:

  • Server: The SQL Server instance hosting your D365 database (e.g. ServerName\InstanceName or just ServerName).
  • Authentication:
    • Windows login: Use a Windows account and password.
    • SQL Server login: Use a SQL Server account and password.
  • User Name: The login name (domain\user or user@domain).
  • Password: The account password.
  • Database: The target database name, or select from the dropdown list.
note

Reading directly from the database is faster than using the Data Hub service, but may not be available for some off-premises or hosted D365 environments.

Troubleshooting errors

You may experience issues previewing or migrating data from Dynamics 365 Finance and SCM. These issues may be related to security privileges, authentication, or service package deployment. Zap provides the following resolutions for common errors:

ErrorReasonResolution

403 Forbidden

The account used by the data source does not exist in the D365 Finance and SCM environment.

Ensure the account exists within the D365 Finance and SCM environment user list (System Administration > Users).

401 Unauthorized

The account used by the data source does not have sufficient privileges to access the Zap service package endpoints.

Refer to Zap service package security to grant the required privileges.