You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Removed the wording Master Data Model from the superordinate Data Models definition to define a Master Data Model in its own context as a community provided model.
Copy file name to clipboardExpand all lines: DataModels/DataModels.md
+12-12
Original file line number
Diff line number
Diff line change
@@ -6,11 +6,11 @@ One consequence is, that it must be possible to sent data records to and receive
6
6
7
7
A data model representing a certain professional domain normally consists of numerous entities. Hence, it is necessary to split such a data model into smaller parts to enable the transfer of optimized amounts of data through an OIH:
8
8
9
-
*__Every OIH-Master-Data-Model (MDM) consists of one or multiple _loosely coupled_ sub-models.__
9
+
*__Every OIHData-Model consists of one or multiple _loosely coupled_ sub-models.__
10
10
11
11
Although it is necessary to split (especially big) data models into smaller sub-models, it often does not make sense to send each entity on its own, when there is a _high cohesion_ between certain entities. Hence,
12
12
13
-
*__each sub-model of an MDM can consist of one _or more_ entities.__
13
+
*__each sub-model of an OIH Data-Model can consist of one _or more_ entities.__
14
14
15
15
## Aggregates
16
16
@@ -22,19 +22,19 @@ In case the model consists of multiple entities, it *must* be modeled as an __ag
To enable the OIH to follow its purpose, the data records being processed have to fulfill some criteria and follow some rules. Some of these rules have to be applied already on the modelling level.
28
28
29
29
## OIH Data Records
30
30
31
-
An OIH expects and needs, depending on the scenario and the involved components (e.g. with or without a Data Hub involved), more or less meta data on a data record to integrate two or more applications. This is achieved by modelling each sub-model of an MDM as a so called _OIH Data Record_. The OIHDataRecord defines a superset of mandatory and optional (meta) data for records processed by an OIH instance:
31
+
An OIH expects and needs, depending on the scenario and the involved components (e.g. with or without a Data Hub involved), more or less meta data on a data record to integrate two or more applications. This is achieved by modelling each sub-model of an OIH Data-Model as a so called _OIH Data Record_. The OIHDataRecord defines a superset of mandatory and optional (meta) data for records processed by an OIH instance:
32
32
33
33

34
34
35
-
*__Each of the the sub-models of a MDM has to be marked as an *OIHDataRecord*.__
35
+
*__Each of the the sub-models of a OIH Data-Model has to be marked as an *OIHDataRecord*.__
36
36
37
-
I.e., the root of an MDM's sub-model **must** inherit from / extend _OIHDataRecord_, no matter whether it is modeled as an
37
+
I.e., the root of an OIH Data-Model's sub-model **must** inherit from / extend _OIHDataRecord_, no matter whether it is modeled as an
38
38
aggregate or as a single entity.
39
39
40
40
*__Every record passed into an OIH instance must at least be provided with a reference to the record of the application or service being the source of the record__,
@@ -45,27 +45,27 @@ called an _OIHApplicationDataRecord_ containing ...
45
45
+ the record's ID within the application (both mandatory) and
46
46
+ optionally its creation and last modification dates within the application.
47
47
48
-
When receiving such a record from an OIH, there might also be entries of other applications being part of the integrations scenario with the same MDM in the same OIH.
48
+
When receiving such a record from an OIH, there might also be entries of other applications being part of the integrations scenario with the same OIH Data-Model in the same OIH.
49
49
50
50
Additionally, depending on the scenario and the involved components again, the OIH itself or a connector (according to rules provided by the OIH __==> TO BE DISCUSSED!__) may also provide an OIH-internal UID for the record, along with the creation and last modification dates of the record within the OIH.
51
51
52
52
## JSON-Schema
53
53
54
54
The OIH specifies JSON as the format that data is processed with. Accordingly,
55
55
56
-
*__[JSON Schema](http://json-schema.org) is the given format to describe MDMs__
56
+
*__[JSON Schema](http://json-schema.org) is the given format to describe OIH Data-Models__
57
57
58
-
in a way an OIH instance is able to validate data at runtime. And, as MDMs are split into sub-models and the records of those sub-models must be processable independently,
58
+
in a way an OIH instance is able to validate data at runtime. And, as OIH Data-Models are split into sub-models and the records of those sub-models must be processable independently,
59
59
60
-
*__for every sub-model of an MDM there must be a _seperate_ JSON schema describing the entity or aggregate.__
60
+
*__for every sub-model of an OIH Data-Model there must be a _seperate_ JSON schema describing the entity or aggregate.__
61
61
62
62
As there are situations where entities are reused in (i.e. are part of) two or more aggregates, it is of course adequat to encapsulate those entities in an additional schema file and reference them from the several sub-models to avoid redundancy.
63
63
64
-
### Making a sub-model of an MDM an OIH Data Record on the schema level
64
+
### Making a sub-model of an OIH Data-Model an OIH Data Record on the schema level
65
65
66
66
There is a predefined JSON-Schema defining the OIHDataRecord (s. [oih-data-record.json](../src/main/schema/oih-data-record.json)).
67
67
68
-
*__Every sub-model of an MDM must reference the OIHDataRecord schema and "inherit" from the defined type.__
68
+
*__Every sub-model of an OIH Data-Model must reference the OIHDataRecord schema and "inherit" from the defined type.__
69
69
70
70
This is done by adding an `allOf`-element to every sub-model's schema:
0 commit comments