Metadata Schema

Overview

The metadata schema in SolidX is designed to provide a flexible and extensible way to define the structure and behavior of various application components. By using a metadata-driven approach, developers can easily customize and extend the functionality of the SolidXplatform without modifying the core codebase.

SolidX allows configuring both backend and frontend functionality using metadata configuration.

The metadata can either be defined in JSON files or through the admin interface. When any metadata is created or updated through the admin interface, it is stored in the database as well as in the JSON file for the corresponding module. This allows for easy version control and migration of metadata changes across different environments.

Every module needs to have its own metadata file which is then seeded into the database.

Seeding Metadata

To apply metadata changes made in the JSON file directly, you must sync the database with the updated metadata files.

Seed metadata into the database:

solid seed

This command reads all metadata files and updates the SolidX database.

(Only for code generation changes) Refresh the generated code:

solid refresh-model -n <model name>

This step ensures the generated code reflects the latest metadata. Typical cases where this extra step is required:

Adding a new module
Adding fields to a model

Tip: Just running the solid seed command is sufficient for most cases, except the ones mentioned above, since the platform reads the metadata directly from the database at runtime.

Key Components

Below are the key components of the metadata schema. All the functionality concerning the below components is driven by the metadata schema.

Module Metadata

The root configuration for each module, defining its identity, scope, and lifecycle.

Model Metadata

Defines the data structures (entities) for each module.

Field Metadata

Specifies the individual fields for each model.

View Metadata

Configures how models are displayed (List, Form, Kanban views).

Action Metadata

Defines custom actions tied to models.

Menu Item Metadata

Configures the admin menu structure.

Roles & Permissions

Defines access control rules.

Users

Manages user accounts and profiles.

Email Templates

Configures email notification templates.

SMS Templates

Configures SMS notification templates.

Media Storage Providers

Defines storage backends for media assets.

Scheduled Jobs

Configures recurring background tasks.

Security Rules

Record-level access control rules.

List of Values

Manages reusable dropdown options.

Dashboard Metadata

Configures admin dashboard widgets and analytics.

Best Practices

Naming Conventions

Use kebab-case for internal names (fees-portal, institute-list-view)
Use PascalCase for display names (Fees Portal, Institute List View)
Use camelCase for field names (instituteName, feeAmount)

Security First

Always configure roles and security rules
Use principle of least privilege
Implement proper data filtering
Enable audit tracking for sensitive operations

Performance Optimization

Use database indexes for frequently queried fields

User Experience

Group related fields logically in forms
Use appropriate field types for data validation
Provide helpful field descriptions

Maintainability

Use consistent field configurations
Version control metadata changes
Test security rules thoroughly

Data Integrity

Configure proper field validations
Use appropriate data types
Ensure unique constraints where necessary
Choose appropriate user keys for models
Use appropriate relation cascading rules

What's Coming Up

In the upcoming sections, we'll walk through practical examples that use the metadata schema and explain each attribute in detail.

These examples are based on the Fees Portal Module (a Fee Collection Module for Educational Institutions).

If you'd like to learn more about the Fees Portal module itself, you can refer to the detailed guide here: School Fees Portal Tutorial