Template format¶

A template describes one module of a DPM release: its tables, the cells of each table, and the rules a report must satisfy. It is a JSON document (UTF-8) in the dpm-synth-template/1 format, read by load_template. Any DPM source can produce one; see build a template from a DPM release and write a template by hand.

Example¶

{
  "format": "dpm-synth-template/1",
  "release": "4.3",
  "module": "COREP_OF",
  "entry_point": "http://www.eba.europa.eu/eu/fr/xbrl/crr/fws/corep/4.3/mod/corep_of.json",
  "reference_date": "2026-12-31",
  "decimals": {"m": 0, "p": 4, "i": 0, "r": 2},
  "tables": [
    {
      "code": "C_07.00.a",
      "filing_indicator": "C_07.00",
      "open_keys": [
        {"code": "qEBB", "column": "qEBB", "items": ["eba_qEC:qx16", "eba_qEC:qx23"]}
      ],
      "cells": [
        {"id": "table-cell:5", "row": "0010", "column": "0010", "sheet": "*",
         "datapoint": "dp12345", "data_type": "m"}
      ]
    }
  ],
  "rules": [
    {"source": "eba", "code": "v0001_m", "expression": "…", "precondition": "{v_C_07.00}"}
  ]
}

The module¶

Tables¶

Open keys¶

An open table has one row per combination of key values, such as one row per counterparty. Each key becomes a column of the table's file.

The generator gives every open table open_rows key rows (default 2). Enumerated keys take their items in order, row by row, so an enumerated key with fewer items than rows gives fewer distinct rows.

Cells¶

Rules select cells by table, row, column and sheet, as in {tC_07.00.a, r0010, c0010}; the generator answers such a selection with the template's cells, for every key row of an open table.

Data types¶

data_type is a DPM data type code. It decides the starting value, which repairs apply, how the value is rounded and how it is written.

Only numeric cells (m, p, i, r) take part in arithmetic repairs. Negative decimals round to tens, hundreds or thousands: with "m": -3 a monetary value is written as a multiple of 1,000.

Rules¶

Every table of the template counts as reported, so a precondition such as {v_C_07.00} holds when the template has that table or filing indicator. {vReportingLevel} is con or ind and {refPeriod} is the reference date. A rule that does not parse is not an error of the template: it is reported as not evaluated, with the syntax error.

Validation¶

load_template checks every field above and raises TemplateError for the first problem, naming the field by its path. Text that cannot be written as UTF-8, such as a lone surrogate escape \ud800 in the JSON, is rejected too, since the package is UTF-8:

import json
from pathlib import Path

from dpmsynth import TemplateError, load_template

document = json.loads(Path("minimal.json").read_text(encoding="utf-8"))
document["tables"][0]["cells"][1]["datapoint"] = 1002
try:
    load_template(document)
except TemplateError as error:
    print(error)

tables[0].cells[1].datapoint: expected a non-empty string, got the number 1002

A file that cannot be read or is not JSON raises TemplateError too, and the command line reports any of them with exit status 3.

Compatibility¶

Fields a version does not know are ignored, so a template with extra fields loads, and exports may carry more information than dpm-synth uses. A change that a reader of dpm-synth-template/1 cannot ignore gets a new format version, dpm-synth-template/2; see stability and versioning.