Skip to main content

Composer Settings Configuration

Overview​

Composer.settings.json defines the core configuration rules for the Composer platform. It controls UI visibility, edit permissions, dropdown options, and device-specific settings.

This file allows the system to dynamically render forms and enforce access rules without modifying application code.

Metadata​

FieldValue
NamePackage
TypePreconfigured
Version0.0.1
Bundle IDPackage_v0.0.0

License Check​

The licensecheck section defines which fields are:

  • Visible (View)
  • Editable (Edit)

Permissions are defined across different scopes and package categories.

Scopes​

  • Root
  • Line Item

Package Categories​

  • Standard
  • Application
  • Template
  • Object
  • Data Package
  • Content
  • Analytics

Each field is controlled using boolean flags:

  • true → Enabled
  • false → Disabled

Dropdowns ensure valid user selections in the UI.

Package Categories​

  • Standard
  • Application
  • Object
  • Template
  • Data
  • Content

Package Types​

Package types depend on the selected package category.

Example:

  • Standard → General, Connectors, File Types
  • Application → General, Public Site

Line Item Types​

Line item types are filtered based on:

  • Package Category
  • Package Type

Examples:

  • Standard / General → Activity, Logs
  • Data Package / Data → Python, DPL Pack, NetPack

Configuration Types​

Defines ownership and scope of configurations.

Supported types include:

  • Package
  • Org
  • User
  • Session
  • Space
  • Group
  • Application Package
  • Object Package
  • Template Package
  • Analytics Package

Device Configuration​

Defines device-specific user settings.

Supported Devices​

  • Web
  • Android
  • iOS
  • Windows
  • Hololens
  • Oculus
  • Magic Leap
  • RealWear

Common Settings​

  • Dark Theme
  • App Language
  • Push Notifications
  • Audio / Video controls
  • Storage & data options

Each device configuration includes:

  • configKey
  • configType
  • fieldType
  • configValue
  • alignment

Usage Notes​

  • Used for dynamic UI rendering
  • Controls field visibility and editability
  • Prevents hardcoded permission logic
  • Shared across frontend and backend

Best Practices​

  • Do not rename keys without updating UI/backend mappings
  • Use alignment to control display order
  • Extend configurations by adding new entries instead of modifying existing ones

Summary​

This configuration file acts as the single source of truth for:

  • UI permissions
  • Form behavior
  • Dropdown rules
  • Device-specific settings

It enables scalability, flexibility, and cleaner code architecture.