Skip to main content

Documentation Technical documentation for the Get Information about Schools service.

Scheduled Extract Access

This page explains the access model for scheduled extracts.

Scope

This model covers:

  • scheduled extract ownership;
  • run-as group and run-as user context;
  • public extract access;
  • extract filter and callback relationships.

How To Read This Model

  • A scheduled extract has a creator group and optional run-as group.
  • Establishment-user access can depend on a specific creator or run-as username.
  • Public access can bypass normal read restrictions.
  • Scheduled extract access is separate from ordinary field permissions.

Application-Derived Insights

  • Scheduled extracts combine ownership, run-as identity, output generation and public accessibility.
  • Listing an extract and requesting a specific extract are separate access checks.
  • Run-as user identity depends on run-as group context.
  • Future design should treat scheduled extracts as their own access-control subdomain.

Scheduled Extract Access

erDiagram ScheduledExtract { numeric id PK nvarchar name nvarchar creatorUsername nvarchar creatorGroup FK nvarchar asGroup FK nvarchar asUserUsername tinyint publicAccessible numeric filter_id FK numeric callback_id FK datetime lastExtractionDate nvarchar type } UserGroup { nvarchar code PK nvarchar name nvarchar role nvarchar recordStatus_code } SystemUser { nvarchar username PK nvarchar UserGroupCode FK numeric saUserId tinyint enabled } EstablishmentFilter { numeric id PK nvarchar name nvarchar creatorGroup_code FK } Callback { numeric id PK nvarchar creator nvarchar creatorGroup FK tinyint public nvarchar status } UserGroup ||--o{ ScheduledExtract : creator_group UserGroup ||--o{ ScheduledExtract : run_as_group SystemUser ||..o{ ScheduledExtract : inferred_creator_username SystemUser ||..o{ ScheduledExtract : inferred_run_as_username EstablishmentFilter ||--o{ ScheduledExtract : extract_filter Callback ||--o{ ScheduledExtract : extract_callback

ScheduledExtract

Business-friendly pattern:

For this scheduled extract,
which group created it,
which group or user should it run as,
and is it public enough to bypass normal read restrictions?

EstablishmentFilter

Business-friendly pattern:

For this scheduled extract,
which saved establishment filter decides the records included?

Callback

Business-friendly pattern:

For this scheduled extract,
which generated file or callback record provides the downloadable artefact?

Reading This Diagram

Use this model to understand scheduled extract visibility. It combines group ownership, optional run-as context, specific establishment-user checks and public access behaviour.