App Management overview
App Management provides a unified experience for installing, configuring, and managing App Builder applications in Adobe Commerce. Define your configuration schema once, and the system auto-generates the runtime actions and Admin UI, with no custom code required.
App developers define the configuration schema, metadata, and runtime actions for their applications. App managers associate and configure deployed apps within their Commerce instances.
The following diagram illustrates the workflow between app developers and app managers:
Key benefits
Auto-generated runtime actions. Define a configuration schema and the library automatically generates all required runtime actions.
Auto-generated Admin UI. Configuration forms are rendered dynamically based on your schema, eliminating custom UI development.
Event subscriptions. Subscribe to Commerce and external events with declarative configuration and automatic event registration.
Custom installation workflows. Define pre and post installation messages and custom scripts that run during app installation.
Unified lifecycle management. Associate, configure, and unassociate apps from a single interface.
Requirements
Before using App Management, ensure the following:
Admin UI SDK version 3.3.0 is required for App Management. Verify your version before proceeding.
App managers (Admin users) who associate apps must have App Management permissions. See Manage your app for more information.
App Builder applications with the following minimum library versions.
@adobe/aio-commerce-lib-configversion 0.11.1 or later.@adobe/aio-commerce-lib-appversion 0.6.0 or later.@adobe/aio-commerce-sdkversion 0.7.2 or later.
SDK libraries
App Management uses the Adobe Commerce SDK libraries:
| Library | Description |
|---|---|
@adobe/aio-commerce-lib-app | App definition, validation, and manifest generation. |
@adobe/aio-commerce-lib-config | Configuration management with scope trees and inheritance. |
How it works
All App Management configuration is defined in the app.commerce.config file at the root of your project. This single file contains your app metadata, business configuration schema, event subscriptions, and installation settings.
Follow these steps to set up and deploy an App Builder application with App Management:
Initialize your app. Run the initialization command to set up your project and create the
app.commerce.configfile.Define your app. Add your app metadata and business configuration.
Configure events. Set up events to respond to Commerce and external events.
Customize installation. Define installation messages and custom scripts that run when merchants install your app.
Build and deploy. Build and deploy your app with the
aio app build && aio app deploycommands.Link your app. Associate your app with a Commerce instance in the Admin.
Configure settings. Merchants configure settings through the auto-generated UI.
