Appearance
Plugin Manager
The Plugin Manager installs, upgrades, enables, disables and removes plugins in your workspace, shows their health and contents, and chooses how a plugin runs. It is the Plugin Manager node under Workspace > Solution (page title Plugins). The Extensions node opens the marketplace view of installable packages; see Administration and DevOps overview and the Extensions section of DevOps. Building a plugin is in Plugin Designer and Check, build and publish.
Where to find it
Workspace > Solution > Plugin Manager. If your user may not manage plugins, a message <reason> — install/upgrade/disable are unavailable. replaces the actions and the list is read only.
Install a package
| Control | Description |
|---|---|
| Upload plugin package | Installs a built .spk package. |
| Build from source | Uploads a plugin module's source tree (its build file and src/) as an archive and builds it on the server. A build log is shown while it runs, then success or Build failed. with the error. A successful build can be installed from the result. |
Installed plugins
The list shows each plugin by id with its state. Show uninstalled (n) includes removed plugins. Expanding a plugin shows its details; the buttons on the row depend on your rights and the plugin's tier. Plugins of the platform's own kernel tier cannot be managed here (Kernel-tier plugins cannot be managed here).
| Action | Effect |
|---|---|
| Customize | Starts a customisation of the installed plugin without changing it (see Customize an installed plugin). |
| Disable, Enable | Stops or restarts the plugin for the workspace. |
| Upgrade | Uploads a package of a newer version for the plugin. |
| Uninstall | Removes the plugin from the workspace. |
| Rollback | Returns to the previously installed version (in the details). |
Plugin details
| Section | Content |
|---|---|
| Health | Fresh health of the plugin on this server: a status chip and detail. Plugin state can change between list refreshes, so it is read when you expand. |
| Plugin runtime | Embedded (runs inside the platform) or Service (runs as its own process or container behind the gateway). For a service plugin the screen shows Runtime (language and framework), Service URL (not yet self-registered until the service announces itself), Last heartbeat, and whether it is reachable or stale/unreachable. The address is never typed by hand. |
| Deployment configuration (JSON) | Process, container, cluster or cloud parameters of a service plugin. Not valid JSON is shown while the text does not parse. Save deployment configuration stores it. |
| Feature flags | Toggles declared by the plugin. |
| Contents | Every artifact the installed version shipped (pages, forms, entities, rules and so on), read from the extracted package. Opening an item shows its definition. Items cannot be edited here: copy them with Customize. |
| Actions log | The plugin's install, upgrade, enable, disable and rollback history with who and when. No actions recorded yet. when empty. |
Behaviour
- A plugin installs per workspace. Its code loads once on the server and is shared; each workspace's install gets its own database objects, roles, workflows, menus and seed data.
- Upgrades keep what the workspace has changed: items shipped by a plugin are owned by it and read only, and changes are layered as overrides.
- A plugin whose service is
stale/unreachableshows that state and is not routed to.
Permissions
Installing, upgrading, enabling and disabling need the plugin management right. Without it the screen is read only.
API and CLI
/api/v1/plugins (list, upload, install, upgrade, enable, disable, uninstall, rollback, health, deployment). CLI: erp plugin list, search, install, publish, diff, force-unload; erp plugin op operations for the plugin workspace. See Operations reference.
Related
Plugin Designer, Customize an installed plugin, Backend services, Versioning and releases.