Skip to main content
Version: 2.0-rc

Glossary

Model ManagementModel ManagementThe part of the platform that defines, versions and stores the data models and integration configuration (the model artifacts) from which the platform is configured. It is implemented by Model Forge, an embedded module of the Portal Backend. uses a small, fixed vocabulary. Code and documentation use only these terms, defined as below. The terms under Deprecated must not be used as domain concepts.

Core terms​

Model Artefakt (artifact)​

Umbrella term for any persistable CORE unit: DataStructure, Package, Mapping, DataSource, DataSink, Pipeline, DataSet. Every artifact has a stable CORE URN identity and is versioned.

DataStructure​

The umbrella for a single modelled domain type — a Class, an Enumeration, etc. A DataStructure is a JSON Schema 2020-12 document whose $id is a versioned CORE URNCORE URNThe global identity Model Management assigns to every model artifact: a unique, stable and versionable URN that exists independently of storage location, file names or registry technology.. It carries version, name, description, URN.

Package​

A stored grouping of DataStructures. Importing one JSON Schema document (a root, optionally with $defs) automatically creates one Package that references the resulting DataStructures by URN — the module / provenance grouping ("these DataStructures were authored and imported together"). The Package is named after the imported document's title and is managed under /api/v1/packages. A Package is a stored artifact, not a View — it carries no content of its own and its members resolve on read.

DataSet​

An integration composition: a manifest that references DataStructures, Mappings, Pipelines, DataSources and DataSinks by URN (the *Refs arrays). Where a Package groups DataStructures by provenance, a DataSet composes artifacts of all types into a deployable unit.

Bundle​

A View that renders an artifact together with the (complete) graph of the artifacts it connects to, as one self-contained document. The bundled (embedded $defs) and dereferenced (inlined) schema projections are both Bundles.

Formatierung (format)​

A View that serialises a DataStructure in a chosen representation — JSON Schema or XSDXML Schema DefinitionA W3C language for describing the structure of XML documents. Model Management imports XSD into JSON Schema and can serialize an Element as XSD.. A DataStructure's format is recorded per version.

View​

Umbrella for a read-side projection of stored artifacts — currently Bundle and Formatierung. Views are generated on demand and never stored.

Deprecated terms​

Do not use these as domain concepts:

TermUse instead
CollectionPackage (a group of DataStructures) or DataSet (a composition of artifacts)
DocumentDataStructure / Package / Artefakt — "document" is allowed only as a plain description of a JSON Schema file, never as a domain entity
DataModel / DatenmodellDataStructure (one type) or Package (a group)

Relationships at a glance​

  • Package and DataSet are both manifests of artifact URNs: Package is DataStructure-only and import-scoped; DataSet is all-types and composition-scoped.
  • A Bundle is a View over an artifact and its dependency graph; Formatierung is a View choosing the serialisation. Both are kinds of View.
  • The JSON-LD output was removed (no consumer) — there is no RDF/Linked-Data projection.