Install and Uninstall Extensions in Business Central

You can change Business Central by installing extensions that, for example, add functionality, changes behavior, or gives you access to new online services. For more information, see Customizing Business Central Using Extensions.

Note

To install or uninstall extensions from AppSource or add per-tenant extensions, you must have the right permissions. You must either be a member of the EXTEND. MGT. - ADMIN user group or you must have the EXTEND. MGT. - ADMIN permission set. If you are an administrator, you can assign user groups and permissions to other users in your company.

To use the functionality that is provided by an extension, such as opening pages, running reports, selecting actions, and so on, you must be assigned the permission sets that are installed as part of the extension.

Note

The EXTEND. MGT. - ADMIN permission set was introduced in Business Central 2021 release wave 1 as a replacement for the D365 EXTENSION MGT permission set in earlier versions.

Install an Extension

You manage extensions on the Extension Management page. You can access this page from Home. Alternatively, choose the Search for Page or Report icon Lightbulb that opens the Tell Me feature. in the top right corner, enter Extension, and then choose the related link.

You can get new extensions from the marketplace at AppSource.microsoft.com. Here, you can see all available extensions for Business Central, and you can get apps, extensions, and content packs for other Microsoft products. Set the relevant filters, take a look at the information for each extension, and get an extension for your Business Central.

Note

Sign in to AppSource.microsoft.com using the email account that you use for Business Central. Use the same email account for other services and products for a smooth experience.

You can also get to the marketplace from inside Business Central. On the Extension Management page, you can see the extensions that are currently installed, and you can open the Extension Marketplace page that shows the Business Central extensions that are currently available in AppSource. If you choose the More apps link, you're taken to AppSource.microsoft.com.

If you choose an extension, you can read about what the extension does, and you can access Help for the extension to learn more. When you choose to get an extension, you must agree to the terms of use. If you get the extension from the AppSource website, you'll be signed in to Business Central to complete the installation.

When you install an extension, you might have to set it up, such as specifying an account for use with the PayPal Payments Standard for Business Central extension. Other extensions simply add fields to an existing page, or they add a new page, for example.

If you uninstall an extension, and you then change your mind, you can install it again. When you uninstall an extension that you have been using, the data is preserved so that if you install the extension again, your data is still available. There are some extensions that are required. You're prevented from uninstalling these extensions from the Extension Management page. If you try, an error message appears.

Some extensions are provided by Microsoft, and other extensions are provided by other companies. All extensions are tested before they're made available to you, but we recommend that you access the links that are provided with each extension to learn more about the extension before you choose to install it.

Microsoft provides the following extensions:

Upload a Per-Tenant Extension (PTE)

You upload a PTE by using the Extension Management page. On the Extension Management page, go to Manage, then choose Upload Extension. On the Upload and Deploy Extension page, specify the .app file to upload. To proceed, choose the Accept button, and then the Deploy button, which will start the process of deploying the PTE.

If the PTE contains breaking schema changes, it's possible to force an upload of it. To do that, in the Schema Sync Mode choose the Force option. You'll get a confirmation dialog to accept before proceeding.

Uninstall an Extension

You uninstall an extension by using the Extension Management page. To uninstall an extension, select it on the page, then select the Uninstall action. If you uninstall an extension, and you then change your mind, you can install the extension again.

When you uninstall an extension that you've been using, data is by default preserved in case you install the extension again. You can instead choose to delete the data with the extension. This operation is controlled by the Delete Extension Data switch. By default, this switch is off. When you try to turn on the Delete Extension Data switch for the extension, you'll get a confirmation dialog, and you must choose Yes to turn it on. After the Delete Extension Data switch is turned on, you can uninstall the extension, and you'll be asked to reconfirm that you want to uninstall the extension and delete the data.

Important

  • There may be other extensions that require or depend on the extension that you want to uninstall in order to work. These other extensions are referred to as dependents. You can't uninstall an extension unless its dependents are also uninstalled.
  • When you choose to uninstall an extension that has one or more dependents, you'll get a confirmation dialog that lists the dependents and asks whether you want to uninstall the extension and all its dependents. You'll have to select Yes to continue.
  • If you turn on the Delete Extension Data switch, uninstalling the extension will delete all data for the extension plus data for all dependent extensions. The action cannot be undone.
  • Some extensions are required. You are prevented from uninstalling these from the Extension Management page. If you try, an error message appears.

See Also

Customize Business Central
Business Central Extensions by Other Providers
Set Up the Envestnet Yodlee Bank Feeds Service
Enable Customer Payment Through PayPal
Migrating Business Data from Other Finance Systems
Setting Up the GetAddress.io UK Postal Code extension
Business Central Extensions by Other Providers
Getting Ready for Doing Business

Start a free trial!

Business Central on Microsoft Learn