Configure Metadata

Configure Metadata Skill

1. Introduction

By default, the Platform generates UI labels from your SCL identifiers:

• table user -> "Users"
• field first_name -> "First Name"

Use Metadata Records in records/100_metadata.scl to override these defaults, reorder fields, or hide technical columns.

2. Prerequisites

You MUST define a var to look up Table and Field IDs, as they are required for all configuration records.

var meta {
  query ```
  query {
    tables: dev_simple_system__tables(where: { ... }) {
      id name
      fields { id name }
    }
  }

}

## 3. Table Configuration
Customize how a Table appears in the navigation.

```scl
set dev_simple_system.table, order_config {
  # 1. Target ID
  id `$var('meta') |> $jq('.tables[] | select(.name == "order") | .id')`

  # 2. UI Properties
  display_name "Sales Orders"
  description "Manage customer purchase orders"
  icon "shopping-cart"      # Feather Icon name
  hidden false              # Set true to hide from nav
}

4. Field Configuration

Customize how a Field appears in Forms and Lists.

set dev_simple_system.table_field, order_total_config {
  # 1. Target ID
  id `$var('meta') |> $jq('.tables[] | select(.name == "order") | .fields[] | select(.name == "total") | .id')`

  # 2. UI Properties
  display_name "Grand Total"
  help_text "Includes tax and shipping"
  
  # 3. Positioning (Lower = Higher in form)
  position 10 
  
  # 4. Visibility rules
  hidden false
  readonly true  # Note: Use Behaviors for conditional readonly logic; this sets a static readonly state.
}

5. Seed Data & Settings

Populate default data and application configuration (10_seed_data.scl).

App Data

set lead_status, status_new {
  label "New Lead"
}

App Settings

set dev_simple_system.setting, api_key {
  name "external.api.key"
  display_name "External API Key"
  secret_value "sk_test_12345" # Encrypted at rest
}

6. Cross-App Relationships

Link your table to a table in another application (records/30_links.scl).

set dev_simple_system.table_relationship, link_customers_to_orders {
  name "orders"
  display_name "Customer Orders"
  kind has          # 'has' or 'belongs'
  cardinality many  # 'one' or 'many'

  # Source = My Table (e.g., Customer in CRM)
  source_table_id `$var('meta') |> $jq('.source_table[0].id')`
  
  # Target = External Table (e.g., Order in Sales)
  target_table_id `$var('meta') |> $jq('.target_table[0].id')`
  
  # Target Field = Foreign Key on External Table
  target_field_id `$var('meta') |> $jq('.target_table[0].fields[0].id')`
}

7. View Configuration (Custom Views)

See the create-view skill for configuring list layouts and dashboards.

Converted and distributed by TomeVault — claim your Tome and manage your conversions.