Metamodel Schemas¶
As Data Stewardship Wizard evolves, the internal structures may change over 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. Since DSW 5.0, a package is identified by a single id and a separate version, while the metamodel version stays 20 and older files can still be imported. Files using this schema can be exported from Knowledge Model Library or Knowledge Model Detail and then used for Import a Knowledge Model.
Metamodel Version |
Schema file |
Changes (brief) |
Since |
|---|---|---|---|
20 |
New PluginIntegration replacing ApiLegacy and Widget |
4.29.0 |
|
19 |
Changed event structure internally |
4.25.0 |
|
18 |
New API integration, props to variables rename |
4.22.0 |
|
17 |
Value question validations |
4.13.0 |
|
16 |
File question |
4.12.0 |
|
15 |
Item select question, resource collections and pages |
4.10.0 |
|
14 |
Optional Integration fields |
4.1.0 |
|
13 |
New question value types |
3.12.0 |
|
12 |
Enhanced integration (e.g. widget type) |
3.10.0 |
|
11 |
Annotations and timestamps for events |
3.8.0 |
|
10 |
Integrations with item template |
3.6.0 |
|
9 |
Annotations |
3.5.0 |
|
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 |
Refactored KM, optional chapter text |
1.10.0 |
|
3 |
Changed integration question fields |
1.8.0 |
|
2 |
Changed phases representation |
1.7.0 |
|
1 |
Initial versioned metamodel |
1.6.0 |
Document Context¶
The server supplies the document context, and the document worker passes it to the template. 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, see Document Template Metamodel Versions. Understanding the context structure is especially useful when developing document templates.
Metamodel Version |
Schema file |
Changes (brief) |
Since |
|---|---|---|---|
19.0 |
Restructured context, projects and KM editors |
5.0.0 |
|
18.3 |
Document language and locale |
4.35.0 |
|
18.2 |
Language field added |
4.33.0 |
|
18.1 |
Python datetime and zoneinfo support |
4.31.0 |
|
18.0 |
Renaming project and KM package, PluginIntegration |
4.29.0 |
|
17.1 |
Configurable instance properties for Document Templates |
4.26.0 |
|
17.0 |
Semver, new API integration, props to variables |
4.22.0 |
|
16 |
Value question validations |
4.13.0 |
|
15 |
File question |
4.12.0 |
|
14 |
New KM entities, project details, and restructure |
4.10.0 |
|
13 |
Removed states from templates |
4.3.0 |
|
12 |
Optional Integration fields |
4.1.0 |
|
11 |
Change template metadata |
3.20.0 |
|
10 |
New question value types |
3.12.0 |
|
9 |
Enhanced integration (e.g. widget type) |
3.10.0 |
|
8 |
Annotations change |
3.8.0 |
|
7 |
Project tags and description |
3.7.0 |
|
6 |
Integrations with item template |
3.6.0 |
|
5 |
Annotations |
3.5.0 |
|
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 |
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… With local Document Template Development, we will need to manage the file according to the Document Template Specification; however, when Document Template Editors are used, we will define it using forms directly in DSW.
Metamodel Version |
Schema file |
Changes (brief) |
Since |
|---|---|---|---|
19.0 |
Single template ID, document context restructured |
5.0.0 |
|
18.3 |
Language of the template |
4.35.0 |
|
18.2 |
Language field added |
4.33.0 |
|
18.1 |
Python datetime and zoneinfo support |
4.31.0 |
|
18.0 |
Renaming project and KM package, PluginIntegration |
4.29.0 |
|
17.1 |
Configurable instance properties for Document Templates |
4.26.0 |
|
17.0 |
Value question validations |
4.22.0 |
|
16 |
Value question validations |
4.13.0 |
|
15 |
File question |
4.12.0 |
|
14 |
New KM entities, project details, and restructure |
4.10.0 |
|
13 |
Removed states from templates |
4.3.0 |
|
12 |
Optional Integration fields |
4.1.0 |
|
11 |
Change template metadata |
3.20.0 |
|
10 |
New question value types |
3.12.0 |
|
9 |
Enhanced integration (e.g. widget type) |
3.10.0 |
|
8 |
Annotations change |
3.8.0 |
|
7 |
Project tags and description |
3.7.0 |
|
6 |
Integrations with item template |
3.6.0 |
|
5 |
Annotations |
3.5.0 |
|
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 |