override/v1 Document

The mapping-override document format: schema, pair, rules, the transform list and the guardrails every document is checked against.

Shape

{
  "schema": "override/v1",
  "pair": { "from": "mt103", "to": "pacs.008" },
  "sr": "SR2025",
  "rules": [
    { "path": ":20:", "action": "transform", "transform": "truncate", "params": { "max": 16 } },
    { "path": "CdtTrfTxInf/PmtId/EndToEndId", "action": "default", "value": "NOTPROVIDED" },
    { "path": ":70:", "action": "suppress" }
  ]
}

Member	Required	Meaning
`schema`	yes	Exactly `override/v1`. Any other value is rejected
`pair.from`, `pair.to`	yes	Format ids of a conversion the engine offers (see `/v1/formats`)
`sr`	no	The Standards Release whose tables the document patches; absent means the default release
`rules`	yes, at least 1	The rules, applied together

Unknown members anywhere in the document are rejected.

Rules

Member	Meaning
`path`	A mapping-row path exactly as the mapping tables name it, for example `:20:` or `GrpHdr/MsgId`. It must match a row of the pair's source side or target side
`action`	`transform`, `default` or `suppress`
`transform` + `params`	(`transform` only) a name from the list below and its parameters
`value`	(`default` only) the literal to use when the target would otherwise be empty

Transforms

Name	Params	Effect
`truncate`	`{ "max": <integer ≥ 1> }`	Cut to `max` characters; the usual truncation warning is still reported
`fixed-value`	`{ "value": "<string>" }`	Always emit this value
`code-table`	`{ "table": "<registered table>", "entries": { "FROM": "TO" } }`	Substitute codes on top of a registered code table; every `TO` must be a valid code
`pass-through`	none	Copy unchanged, for example to lift a default truncation

The list is fixed. A document selects transforms; it can never define one.

Guardrails

A document that breaks any of these is rejected as a whole, nothing is partly applied:

Amount and currency fields cannot be overridden.
A row whose loss policy is "fail" cannot be weakened by transform or suppress.
pair must be a conversion the engine already offers.
sr only selects an existing Standards Release.
Converted output still passes the same schema validation as without an override.

Two rules (in one document or across your enabled documents) may not attach to the same row.

Warnings

Code	Severity	When
`OVERRIDE_APPLIED`	info	A rule changed this field. The detail names the action and transform, never values
`OVERRIDE_SUPPRESSED`	lossy	A `suppress` rule dropped this field

Manage documents with the Mapping Overrides routes.

Was this page helpful?