Example Data Product

NOTE

these pages are primarily for internal audiences rather than users of the Data Platform; we will host user-facing documentation separately.

Data Product specification

Data Product governance


name: example_data_product
# A good title and description will help users find your data
description: >
  Example Data Product contains published prison population from 2001
  to present
# status: please specify one of:
# draft, development, testing, production, sunset, retired
status: production
email: data.product.contact@justice.gov.uk
tags: {"Sandbox": "True"}

# organisational unit the data belongs within
# e.g. HMCTS, HMPPS, LAA, OPG, HQ, ALB, OGD
domain: "HMPPS"
dataProductOwner: data.product.owner.name@justice.gov.uk
dataProductOwnerDisplayName: Data Product Owner
dataProductMaintainer: data.product.maintainer.name@justice.gov.uk
dataProductMaintainerDisplayName: Data Product Maintainer
retentionPeriod: 400
dpiaRequired: false
dpiaLocation: s3://data-platform-data/civil-courts-data/v1/
tags: {"Sandbox": "True"}

Table Schema

Data dictionary guidance

---
#-------------------------------------------------------------
# Implementation notes
#  - YAML validation required
#  - Warn on missing recommended attributes
#  - Warn on table & field names containing spaces or dashes
#-------------------------------------------------------------

# Add a description for your collection to help users find it.
# This is optional, as the data product description will also aid discoverability.
tableDescription: Prison population by offence.
# A column must contain at least a name and a data type.
columns:
  - name: row_id
    type: int
    description: primary key for this table. auto-incrementing integer
  - name: offence_code
    type: string
    description: code for the offence type
  - name: offence
    type: string
    description: offence type name
  - name: date
    type: date
    description: month for aggregation of prison population by offence
  - name: population
    type: int
    description: >
      number of prisoners with that offence_code at the start of that month

transformations

Data transformation definitions

Data cleansing definitions

Example Data Product

Table Schema

transformations

Further reading