Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
When you finish developing and testing your per-tenant extension (PTE), deploy the extension (.app file) containing the customization to your customer’s production tenant. You can upload and deploy PTEs to an environment by using App Management in the Admin Center or by using the Extension Management page in the environment.
Important
The recommended way to upload, install, and manage per-tenant extensions is now the Business Central Admin Center and its API. The in-product Extension Management upload flow and the Automation API extensionUpload endpoint are deprecated and planned for removal in 2027 release wave 1. Learn more in Deprecated features in the platform.
Note
You can only view scheduled installation details in the interface you use (Admin Center or Extension Management) to upload the PTE. To avoid confusion, use a single method consistently when deploying and installing PTEs for a given environment.
When you deploy an .app file for the next version, the extension is queued to be deployed as part of the customer’s tenant update to the next version. Typically, use this feature when you build an update of the extension to work with the next version.
Extension uniqueness requirements
If you're developing and deploying an updated version of a previously deployed extension, you must keep the app ID the same and increase the version number to successfully upgrade the extension. The deployment services require that uploaded extension packages be unique per tenant based on several sets of keys:
- Package ID
- App ID + Version
- Name + Publisher + Version
Note
These parameters are defined in the app.json file of the extension. Learn more in JSON files.
If you successfully deployed an extension to a tenant, and then recompile the extension’s source code without updating version number, this action generates a new extension package file with a new package ID. If you try to upload this new extension package file to a different tenant, the upload fails with the error similar to An extension with same App ID and version has already been uploaded. Resolve and deploy again.. Similarly, if an extension failed to deploy, and you try to upload a new extension package with the same version number, the upload fails as well.
Upload and schedule installation from the Admin Center
Administrators and applications can upload and schedule installation of PTEs from the Manage Apps page in the Admin Center or using its API. To upload a new PTE or an update to an existing PTE, choose Install Extension on the Manage Apps or App Details page. Uploading and deploying PTEs through the Admin Center requires internal, delegated, or application administrator permissions to access the Admin Center (API), but no more permissions are needed within the target environment itself.
For more information on required permissions, see The Business Central Admin Center. For more information on managing apps in the Admin Center, see App Management in the Admin Center.
Upload and schedule installation from the Extension Management page
Users and applications can upload and schedule installation of PTEs from the Extension Management page in the environment or by using the Automation API. You must be able to sign in to the customer’s tenant as a user with permissions to the Extension Management page to complete the deployment.
Under Manage, use the Upload Extension action to deploy the extension. You can deploy the extension for the current version or for the next version of the service. In most cases, select the current version, unless you developed the extension specifically for the next version.
The extension you're deploying might be the initial release of the customization or an upgrade to a previous version. Use the same steps for uploading a new extension or an extension upgrade. The service determines if the extension needs to be upgraded based on the extension’s app ID and version.
Steps for deploying your .app file
- Sign in to your customer’s Dynamics 365 Business Central tenant.
- Open the Extension Management page.
- Under Manage, choose the Upload Extension action.
- Select the browse button to select the .app file to upload. Browse to and select the extension’s .app file.
- Select if you want to deploy for the current version (most common) or next minor or major version. Select the language for the deployment.
- Choose the Schema Sync Mode and select whether to add schema changes or to force the schema changes.
- Select the option switch to on to accept the disclaimer.
- Choose the Deploy button.
- The extension is deployed in the background.
To check the status of the deployment, choose Deployment Status and then view the status of the extension deployment. Select the row to see other details.
In the deployment status details, there's a Refresh button in the actions you must select to retrieve the most recent status and details. - When the extension is successfully deployed, choose the Refresh button to see the new extension in the list of installed extensions.
Upgrades and per-tenant extensions
In some cases, Microsoft can't automatically upgrade a customer's production environment that includes a per-tenant extension. In those cases, Microsoft contacts the reselling partner and provides guidance for how to update the extension. However, if the extension remains impossible to update when the Business Central version the environment is on reaches its Enforced Update Period, the extension is uninstalled automatically to succeed the update. For more information, see Update Cycles.
Related information
Get started with AL
AL development environment
FAQ for developing in AL
Use Designer