Application metadata defines the high-level container for a specific set of functionality (e.g., "Sales", "HR", "Admin"). It serves effectively as a grouping mechanism for menus and other resources.
Convention: [app_name].app.yml
Examples:
sales.app.ymladmin.app.yml
The structure is intentionally kept simple to allow for flexibility in frontend plugins and extensions.
name: sales
label: Sales App
description: Manage leads, opportunities, and customers.
icon: currency
logo: /assets/sales-logo.png
homepage: /app/sales
sort_no: 10
is_active: true| Property | Type | Required | Description |
|---|---|---|---|
name |
string | Yes | Unique identifier for the application. |
label |
string | Yes | Human-readable name displayed in the UI launcher. |
description |
string | No | Description of the application's purpose. |
icon |
string | No | Icon name (e.g., standard icon set name) for the app launcher. |
logo |
string | No | URL or path to a custom logo image. |
homepage |
string | No | The default path to navigate to when the app is opened. |
sort_no |
number | No | Integer for sorting applications in the launcher. |
is_active |
boolean | No | Whether the app is visible to users. Defaults to true. |
Application metadata serves as a container for grouping related functionality. The application definition is intentionally kept simple and lightweight to allow for:
- Organizing related objects, workflows, and actions
- Defining application-level configuration
- Frontend plugins to dynamically integrate with the application without modifying core definitions