Skip to main content

Documentation Technical documentation for the Get Information about Schools service.

Establishment Field Metadata And Mapping

This page explains how logical establishment fields are catalogued, displayed, validated, mapped and made applicable to establishment types.

Scope

This view focuses on:

  • logical establishment field metadata;
  • display grouping, tabs and positions;
  • establishment-type applicability;
  • validation rules;
  • extract and physical field mapping concepts.

How To Read This Model

  • EstablishmentField describes logical establishment fields, not the stored values themselves.
  • One logical field can drive display, validation, permissions, extracts and change workflow.
  • Field positioning controls where the field appears, not what value it stores.
  • Applicability tables define which establishment types a field applies to.
  • Validation rules attach reusable validation behaviour to logical fields.

Application-Derived Insights

  • Establishment fields are metadata-driven across display, editing, validation, extract and workflow behaviour.
  • The logical field catalogue hides a lot of application behaviour behind one short name.
  • Target modelling should not treat the wide Establishment table alone as the field model; the metadata controls how fields behave.
  • Type-specific field rules are essential because not every establishment field applies to every provider type.

Metadata Catalogue

erDiagram EstablishmentField { nvarchar shortName nvarchar oldShortName nvarchar displayName nvarchar path nvarchar fieldType nvarchar group_code nvarchar toeGroup_code tinyint active } FieldGroup { nvarchar code nvarchar name } ToeFieldGroup { nvarchar code nvarchar name } FieldGroup ||--o{ EstablishmentField : field_group ToeFieldGroup ||--o{ EstablishmentField : establishment_type_grouping

EstablishmentField

EstablishmentField is the central catalogue of establishment logical fields.

Business-friendly pattern:

For this logical establishment field,
what is it called,
where is the value found,
how should it be handled,
and is it active?

FieldGroup

FieldGroup groups establishment fields into broad functional areas.

Business-friendly pattern:

For this establishment field,
which broad field group does it belong to?

ToeFieldGroup

ToeFieldGroup groups fields by type-of-establishment applicability.

Business-friendly pattern:

For this establishment field,
which type-of-establishment field grouping applies?

Positioning, Applicability And Validation

erDiagram EstablishmentField { nvarchar shortName nvarchar displayName } FieldPosition { numeric id nvarchar shortName nvarchar tab_code int orderBy tinyint showInRightColumn } FieldTab { nvarchar code nvarchar name int orderBy } EstablishmentType { nvarchar code nvarchar name } EstablishmentFieldToTypeMapping { nvarchar fieldShortName nvarchar establishmentType_code } EstablishmentFieldValidation { numeric id nvarchar shortName nvarchar validationRuleCode nvarchar validationParam } ValidationRule { nvarchar code nvarchar name } EstablishmentField ||--o{ FieldPosition : positioned_field FieldTab ||--o{ FieldPosition : tab EstablishmentField ||--o{ EstablishmentFieldToTypeMapping : field_applicability EstablishmentType ||--o{ EstablishmentFieldToTypeMapping : applicable_type EstablishmentField ||--o{ EstablishmentFieldValidation : validated_field ValidationRule ||--o{ EstablishmentFieldValidation : validation_rule

FieldPosition

FieldPosition controls where establishment fields appear.

Business-friendly pattern:

For this logical establishment field,
where should it appear on the user interface?

FieldTab

FieldTab is the tab catalogue used for establishment field display.

Business-friendly pattern:

For this establishment field position,
which tab should contain the field?

EstablishmentFieldToTypeMapping

EstablishmentFieldToTypeMapping controls which establishment types a field applies to.

Business-friendly pattern:

For this logical establishment field,
which establishment types should use it?

EstablishmentFieldValidation

EstablishmentFieldValidation attaches validation rules to establishment logical fields.

Business-friendly pattern:

For this logical establishment field,
which validation rules apply?

ValidationRule

ValidationRule is the reusable validation rule catalogue.

Business-friendly pattern:

For this validation rule,
what reusable rule can be applied to a logical field?

Reading This Diagram

These ERDs are explanatory views. Logical field metadata is a control model for application behaviour, not just documentation about columns.