Metamodel Schemas
As Data Stewardship Wizard evolves, the internal structures may change during the time. To support migration under the hood, we use metamodel versioning for KM and templates.

KM Package (.km file)

File for import and export of Knowledge Models is a JSON file that contains all KM packages (lists of change events with additional metadata). The structure of events is versioned using the KM metamodel version number and migrations in DSW automatically update the KMs when needed.
Metamodel Version
Schema file
Changes (brief)
Since DSW
8
Metrics and phases are part of KM
3.2.0
7
KM name attribute removed
2.13.0
6
Multi-choice question type added
2.11.0
5
Move event
2.0.0
4
TBD
TBD
1.10.0
3
TBD
TBD
1.8.0
2
TBD
TBD
1.7.0
1
TBD
Initial versioned metamodel
1.6.0

Document Context

Document Context is provided to the document templates by document worker. It contains all relevant data about project/questionnaire with replies, related knowledge model, author, and more. As KM evolves, the context may evolve as well. It is versioned using the Template metamodel version number. A document template must support the metamodel that is in the current DSW instance.
Metamodel Version
Schema file
Changes (brief)
Since DSW
4
Metrics and phases
3.2.0
3
Project versions
2.12.0
2
Reply provenance
2.6.0
1
TBD
Initial versioned metamodel
2.5.0

Template (.json file)

Each template has its descriptor file template.json which contains all the information about the template, its format(s) and steps how to produce the document(s). It is also versioned by the Template metamodel version number. This file also contains the actual number of the supported version...
Between versions 1 and 4, the structure of template.json is still the same. Only the document context has been changed.
Metamodel Version
Schema file
Changes (brief)
Since DSW
4
Metrics and phases
3.2.0
3
Project versions
2.12.0
2
Reply provenance
2.6.0
1
Initial versioned metamodel
2.5.0

How to use schemas

Last modified 24d ago