Skip to content

Metadata Provision Agreement

A Metadata Provision Agreement links a Metadataflow to the Metadata Provider that reports metadata for it, optionally narrowing the structures the metadata can be reported against. Documents start ref: "MetadataProvisionAgreement=AGENCY:ID(1.0)".

Simple form

The document starts with the common header, followed by the metadataflow, the metadata provider and the target.

format: "fusion-yaml(1.0.0)"
ref: "MetadataProvisionAgreement=ACY:MDF_DP1(1.0.0)"
name: "TEST"
metadataflow: "ACY:MDF(1.0.0)"
metadataprovider: "ACY:METADATA_PROVIDERS(1.0).DP1"
target: "Any=*:*(*)"
Source: metadataprovisionagreement/testWildcardAnyStructure.yaml

  • metadataflow: short URN of the Metadataflow, see references.
  • metadataprovider: short URN of the Metadata Provider. The provider is an item in a Metadata Provider Scheme, so the short URN ends with the provider id.
  • target: the structure that metadata can be reported against, as a canonical value (Class=AGENCY:ID(VERSION), plus the item id for an identifiable target). Any=*:*(*) targets any structure.

Complex form

With more than one target, target becomes an array (value or array).

format: "fusion-yaml(1.0.0)"
ref: "MetadataProvisionAgreement=ACY:MDF_DP3(1.0.0)"
name: "TEST"
metadataflow: "ACY:MDF(1.0.0)"
metadataprovider: "ACY:METADATA_PROVIDERS(1.0).DP3"
target:
- "Dataflow=ACY:DF1(1.0.0)"
- "Code=ACY:CL_REF_AREA(1.0.0).UK"
- "Concept=ACY:CS(1.0.0).INDICATOR"
Source: metadataprovisionagreement/testMultipleTargets.yaml

Targets are written in the order held by the agreement; they are not sorted.

Field reference

Field Value Written when
metadataflow Short URN of the Metadataflow The metadataflow reference is set
metadataprovider Short URN of the Metadata Provider The metadata provider reference is set
target Canonical value, or an array of canonical values The agreement has one or more targets