Configuration
Manage platform settings with a centralized key-value configuration store.
Bosca includes a configuration system that stores platform-wide settings as key-value pairs. This provides a central place to manage settings that can be read and updated through the GraphQL API or the Administration UI.
What you get
- Centralized Settings: Store platform configuration in a structured key-value store accessible through the API.
- Permission-Based Access: Configuration entries respect the platform's permission model, controlling who can view and modify settings.
- JSON Attributes: Each configuration entry supports JSON attributes for structured data beyond simple key-value pairs.
How it works
Configuration entries are identified by a unique key and store a value along with optional JSON attributes. The system provides standard CRUD operations:
- Get: Retrieve a configuration entry by key.
- Get All: List all configuration entries.
- Add: Create a new configuration entry.
- Edit: Update an existing configuration entry.
- Delete: Remove a configuration entry by key.
Typical uses
- Feature flags and platform toggles
- Default values for content templates or workflows
- Integration credentials and endpoint URLs
- UI customization settings
For developers
Related modules:
- Core interfaces:
backend/framework/core-configuration - Implementation:
backend/framework/configuration - GraphQL schema:
backend/framework/configuration/src/main/resources/graphql/configurations.graphqls
Related:
- Architecture: Architecture overview