Runtime actions reference
Adobe Commerce App Management is for Beta users only and is not yet accessible to all customers.
The @adobe/aio-commerce-lib-config library auto-generates runtime actions based on the businessConfig section in your configuration schema. The @adobe/aio-commerce-lib-app library generates an additional action for app metadata. These actions power the App Management UI with no required boilerplate code.
Initialize the library
Run the following command to set up your App Builder project with the configuration library. This command structures the required files, installs dependencies, and generates runtime actions based on your schema.
Copied to your clipboardnpx @adobe/aio-commerce-lib-config init
The initialization process:
- Creates
app.commerce.configwith a template schema if it does not exist, or uses your existing configuration - Installs
@adobe/aio-commerce-lib-configand@adobe/aio-commerce-sdk - Adds
postinstallscript topackage.json - Generates all required artifacts (schema and runtime actions)
- Updates
app.config.yamlwith the extension reference - Creates or updates
install.yamlwith the extension point reference - Creates or updates
.envfile with placeholder environment variables
Generated files
The initialization process creates the following files in your project:
| File | Description |
|---|---|
app.commerce.config | Your configuration schema |
src/commerce-configuration-1/.generated/ | Auto-generated runtime actions and schema |
src/commerce-configuration-1/ext.config.yaml | Action declarations for App Builder |
install.yaml | Extension point references |
Generated runtime actions
The libraries generate the following runtime actions to handle configuration and scope operations:
Scope management actions
Scopes define the hierarchical boundaries where configuration values can be set and inherited:
| Action | Description |
|---|---|
get-scope-tree | Retrieves scope hierarchies. |
sync-commerce-scopes | Syncs scopes from Adobe Commerce. |
set-custom-scope-tree | Defines custom scope hierarchies for external systems. |
Configuration management actions
These actions handle reading and writing configuration values:
| Action | Description |
|---|---|
get-config-schema | Retrieves the configuration schema. UI uses this to render the form. |
get-configuration | Gets configuration values with inheritance for a scope. |
set-configuration | Saves configuration values for a scope. |
App metadata action
The @adobe/aio-commerce-lib-app library generates an additional runtime action for retrieving app metadata:
| Action | Description |
|---|---|
get-app-config | Returns the app configuration including metadata and business config schema. |
This action is generated in src/commerce-extensibility-1/.generated/actions/ along with the extensibility manifest.
Do not manually edit files in src/commerce-configuration-1/ or src/commerce-extensibility-1/. They are regenerated when the library updates.
Build and deploy
After initializing the library, build and deploy your application to make it available in App Management:
Copied to your clipboardaio app buildaio app deploy
Once deployed, your app appears in App Management and can be associated with a Commerce instance.
Update the library
When a new version of the configuration library is available, update your project to get the latest features and fixes.
Update the libraries:
Copied to your clipboardnpm update @adobe/aio-commerce-lib-config
Copied to your clipboardnpm update @adobe/aio-commerce-lib-app
The postinstall script regenerates runtime actions when you update the library.
Then, rebuild and redeploy your application:
Copied to your clipboardaio app buildaio app deploy
Troubleshooting
Use the following solutions to resolve common issues with runtime actions.
Runtime actions not generated
Verify
app.commerce.configexists with a valid schema.Run manually:
npx @adobe/aio-commerce-lib-config generate all.
Schema validation fails
Run:
npx @adobe/aio-commerce-lib-config validate schema.Fix issues in
app.commerce.configand rebuild.
