Install and Uninstall Extensions (Apps) in Business Central

Article
09/07/2023

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

Note

To install or uninstall apps from AppSource or add per-tenant apps, you must have the right permissions. You must either be a member of the D365 Extension MGT user group or you must have the EXTEND. MGT. - ADMIN permission set. If you're an administrator, you can assign user groups and permissions to other users in your company. To learn more about user groups and permissions, go to Assign Permissions to Users and Groups.

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.

To use an extension, you must be assigned the permission sets that come with it.

Install an extension

You manage apps and 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 apps from the marketplace at AppSource.microsoft.com. The marketplace offers all available apps for Business Central, plus apps 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 AppSource from Business Central. On the Extension Management page, you can see the apps that are currently installed, and you can open the Extension Marketplace page that shows the Business Central apps that are currently available in AppSource. If you choose the More apps link, you're taken to AppSource.microsoft.com.

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

After you install an app, you might have to set it up. Some apps require that you provide some information before you can use them. For example, after you install the PayPal Payments Standard app, you must specify the email or the Merchant account ID for your PayPal account. To set up an app, or to find out what information you'll need, on the Installed Extensions page, choose the Set up action.

Other apps simply add fields to an existing page, or they add a new page, for example.

If you uninstall an app, and you then change your mind, you can install it again. When you uninstall an app that you've been using your data isn't deleted. The data is available if you install the app again.

Some apps are provided by Microsoft, and other apps are provided by other companies. We recommend that you learn more about the app before you choose to install it.

Microsoft provides the following apps:

Set up an app

After you install an app, you might have to set it up. For example, for the PayPal Payments Standard for Business Central app you must specify the PayPal account to use. If that's the case, when installation completes Business Central will ask whether you want to set up the app right away. Setups can be required for the app to work, or optional.

If you choose to set up your app right away, and it has a required setup, Business Central will open the required setup. The setup can be either a page where you enter information, or an assisted setup guide that helps you through the steps. If you don't complete the setup in one go, you can use the Setups for name of app page, which lists all setups for the app. Required setups indicated by bold letters.

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 Schema Sync Mode choose the Force option. You'll get a confirmation dialog to accept before proceeding.

Uninstall an app

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

By default, when you uninstall an app that you've been using your data isn't deleted. If you're sure you won't install the app again, and you can delete the data when you uninstall it. To delete data when you uninstall an app, turn on the Delete Extension Data toggle. 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 app, and you'll be asked to reconfirm that you want to uninstall the app and delete the data.

Important

There might be apps that require or depend on the app that you want to uninstall. These apps are referred to as dependents. You can't uninstall an app unless you also uninstall its dependents. When you uninstall an app that has dependents, a dialog lists the dependents. To continue, you'll have to select Yes to uninstall the app and its dependents.
If you turn on the Delete Extension Data toggle, uninstalling the app will delete all data for the app plus data for all dependent apps. The action can't be undone.
Some apps are required and you can't delete them on the Extension Management page.

If you want to keep the data for an uninstalled app, you can delete the data later. The Delete Orphaned Extension Data page lists the apps that you still have data for. To delete the data, choose the app, and then choose Delete Data.

Start a free trial!

Find free e-learning modules for Business Central here

Share via