Skip to content

Commit e3326a1

Browse files
philecsphilecs
committed
Unifiy naming structure
1 parent d767020 commit e3326a1

8 files changed

+364
-0
lines changed

‎Protocols/2017-12-11WorkgroupCall.md

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Protocol
2+
3+
**Attendees:** Josef, Hansjörg, Lutz, Raphael, Andreas, Frank, Andy, Philipp (minute taker)
4+
5+
## Election Workgroup Manager
6+
- Initial suggestion (Lutz) was rejected
7+
- **Raphael** takes over the manager position for the Data & Domain Model Workgroup
8+
9+
## Workshop Protocol (from 29.11.2017)
10+
- Accepted. Can be merged into the master branch
11+
12+
## Lutz' Suggestion for the Data Model
13+
Suggested structure/model see: [OIHDataModels](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/OIHDataModels/OIHDataModels.md)
14+
15+
#### Lutz
16+
- The currently existing oih data model suggestion covers all existing use cases
17+
- To cover all future use cases, further domain & data models are needed (realizable with this suggested model)
18+
- Suggested model is applicable for the domains adresses and products
19+
- There won't be a perfect data model which covers all use cases
20+
- A pull synchronisation is only realizable with the smart data framework. If the smart data framework is not used, synchronization is only realizable via pushing.
21+
22+
#### Josef
23+
- In the first step the two domains adresses and product should be covered (by a master data model).
24+
- This helps to create learnings and further use cases e.g. invoices can be defined
25+
26+
## Regulations
27+
- Regulations are needed for different conventions like output format, naming, etc.
28+
- Regulations can also be understood as guidelines, e.g. adapter guidelines
29+
30+
## Current Results
31+
- Raphael presented his outputs and ideas
32+
- Lutz: The ideas and questions are good but they delve to deep right now (basics need to be clarified).
33+
- Thus the questions and ideas aim at a later stage, but we have to keep them in mind. We won't be able to develop the perfect model till the end of the year. The results for the first milestone will be more like a first draft
34+
- Josefs' results are currently in a textual form because of the missing UML modeling tool. The existing results can easily be transferred into an UML diagram.
35+
- The results are not the final model but a first draft
36+
- The results will be published on GitHub to provide insights for all project members
37+
- Hansjörg expanded the [MasterDataModelAdresses](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/MasterDataModels/MasterDataModelAdresses.md#423-person-specific-requirements) by chapter 4.2.3
38+
- Missing: Privacy- and digital rights management
39+
- A vizual representation such as the one by YQ can be derived from the existing MasterDataModelAdresses file
40+
41+
## Next Steps
42+
- [ ] Lutz and Josef will have a discussion about the regulations
43+
- [ ] Next **appointment** on **15.12.2017 at 10:30 am**

‎Protocols/2017-12-15WorkgroupCall.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Protocol
2+
3+
**Attendees:** Andreas G., Lutz, Hansjörg, Josef, Raphael, Philipp (minute taker)
4+
5+
**Absent:** Josef
6+
7+
## Workshop Protocol (from 11.12.2017)
8+
[2017-12-11Telko.md](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/Protocols/2017-12-11Telko.md) - accidentally merged already due to [DecisionsMade.md](https://github.com/openintegrationhub/Data-and-Domain-Models/pull/21)
9+
10+
- ...
11+
12+
## Results for the 1st milestone
13+
[Provide deliverables on basis of Lutz' suggestions (Tool + Schema)](https://github.com/openintegrationhub/Data-and-Domain-Models/issues/19)
14+
15+
### Lutz
16+
- Wasn't able to provide a json schema until now because of illness
17+
- JSON Schema has priority no.1 from now on
18+
- Provided a [Data Model](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/DataModels/DataModels.md) which includes the description of the OIH datasets.
19+
20+
### Hansjörg
21+
- Provided a [UML diagram](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/MasterDataModels/Assets/OIHDataModelAdressesUML.png) on basis of the previous elaborations and the provided by Lutz.
22+
- Lutz: Field (String, enumartion etc.) so specify the sort of the address.
23+
- Lutz: The Fields like _street_, _streetNumber_, _unit_, etc. can be modeled as attributes within the addresses
24+
- The idea behind the object `relations` shall be generic
25+
26+
## Regulations for the 1st milestone - official
27+
TBD [Provide the regulations on how to design a generic domain model](https://github.com/openintegrationhub/Data-and-Domain-Models/issues/22)
28+
29+
- What is the purpose of the `regulations`? What exactly is meant by `regulations`?
30+
- Define regulations per domain and/or define them for all models (such as UML, JSON etc.)
31+
- Regulations for the different domains have to be written down
32+
- Overarching regulation: `Header (OIH Dataset)` is set for all domains
33+
34+
35+
## Regular Meetings - calls
36+
Fixed GoToMeeting every two weeks - when?
37+
38+
- To be determined
39+
40+
## 1st Workshop in 2018
41+
Alternative date at the 3rd KW'18 - possible?
42+
43+
- To be determined
44+
45+
## Next Steps
46+
- [ ] Provide a JSON Schema **Lutz** till **early 19.12.2017**
47+
- [ ] Reconcilation of Hansjörg's results and afterwards provide the results on GitHub **Lutz, Hansjörg, Josef (Suggested)** till **15.12.2017**
48+
- [ ] [Provide the regulations on how to design a generic domain model](https://github.com/openintegrationhub/Data-and-Domain-Models/issues/22) by @lashauer @hschmidthh @JosefBraeuer till **15.12.2017**
49+
- [ ] Write down concrete attributes and update UML diagram **Hansjörg** till **15.12.2017**
50+
- [ ] Supplement from a subsequent converstion: the UML diagrams for addresses and products will be converted into the provisioned JSON 'tree structure' **Hansjörg, Josef** till **late 19.12.2017**
51+
- [ ] Remove ZenHub broadcast functionality about its Board activities - for Slack **Raphael** till **15.12.2017**
52+
- [ ] Next appointment **19.12.2017** at **10:00 am**

‎Protocols/2017-12-19WorkgroupCall.md

+67
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Protocol
2+
3+
**Attendees:** Lutz, Hansjörg, Josef, Raphael **Guests:** Jürgen, Andy, Philipp (minute taker)
4+
5+
**Absent:** Andreas G.
6+
7+
## Workshop Protocol (from 15.12.2017)
8+
[2017-12-15WorkgroupTelko.md](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/Protocols/2017-12-15WorkgroupTelko.md) - accidentally merged already due to [DecisionsMade.md](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/DecisionsMade.md)
9+
10+
- Accepted by all
11+
12+
## Final results for the 1st milestone
13+
[Provide deliverables on basis of Lutz' suggestions (Tool + Schema)](https://github.com/openintegrationhub/Data-and-Domain-Models/issues/19) by @hschmidthh @JosefBraeuer till **15.12.2017**
14+
15+
[Provide the regulations on how to design a generic domain model](https://github.com/openintegrationhub/Data-and-Domain-Models/issues/22) by @lashauer @hschmidthh @JosefBraeuer till **15.12.2017**
16+
17+
### Lutz
18+
- [x] JSON Schema 'tree structure' **by @lashauer till early 19.12.2017**
19+
- Provided a basis schema: [OihDataRecordSchema](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/src/main/schema/oih-data-record.schema.json)
20+
- Provided an example for the order example: [Order Example](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/src/examples/schema/order.schema.json)
21+
- Both schemas are work in progress and will be expanded e.g. by _description field_
22+
- Would like to provide snippets and explanations inline (in the markdown file) and refer to the rest of the schema
23+
- [ ] General regulations for generic data models **by @lashauer till 19.12.17**
24+
- Will provide regulations according to the needs of WICE and YQ
25+
26+
### Hansjörg
27+
- [x] Generic data model addresses in the shape of an UML class diagram (attached) **by @hschmidthh till 19.12.17**
28+
* Write down concrete attributes and update UML diagram **by @hschmidt till 15.12.2017**
29+
- [UML diagram](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/MasterDataModels/Assets/OIHDataModelAdressesUML.png) Lutz: Field (String, enumeration etc.) to specify the sort of the address.
30+
- [x] Specific regulations for the generic data model addresses **by @hschmidthh till 19.12.17**
31+
- [ ] Generic data model addresses in the shape of a JSON schema **by @hschmidthh till late 19.12.17**
32+
33+
#### UML Diagram
34+
- Classes like `phone` or `emails` are encapsulated to enable reusability, as e.g. a person can have more than one phone number and email
35+
- Categorization of e.g. phone numbers are done by categorizing the person
36+
- Base model is finished
37+
- Model will be expanded in later stages (e.g. adding attributes)
38+
39+
#### Regulations
40+
- Regulations for creating a new model are written down in [RulesAndRegulations.md](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/DataModels/RulesandRegulations.md)
41+
- Lutz/Raphael: Specific regulations and explanations (e.g. why is the categorization done for a person and not a phone number itself) is needed
42+
- Josef: These information are descriptions but not necessarily regulations. The information should be part of the MasterDataModel descriptions
43+
44+
#### JSON-Schema
45+
- JSON File needs to be and will be created manually (Visual Paradigms complexity for converting the UML diagram into xml is to high)
46+
47+
### Josef
48+
- [x] Generic data model products in the shape of an UML class diagram (attached) **by @JosefBraeuer till 19.12.17**
49+
- Provided a UML-Schema and will upload the result on GitHub
50+
- [ ] Specific regulations for the generic data model products **by @JosefBraeuer till 19.12.17**
51+
- [ ] Generic data model products in the shape of a JSON schema **by @JosefBraeuer till late 19.12.17**
52+
53+
## Regular Meetings - calls
54+
**Postponed:** Fixed GoToMeeting every two weeks - **when?**
55+
56+
## 1st Workshop in 2018
57+
**Postponed towards Doodle:** Alternative date at the 3rd KW'18 - **location?**
58+
59+
## Next Steps
60+
- [ ] Reconciliation of the base structure of the JSON Schema by WICE **Lutz and Hansjörg** till **late 19.12.2017**
61+
- [ ] Provide general regulations on basis of the preferences by WICE and YQ **Lutz** till **late 19.12.2017**
62+
- For this purpose one file will be created with a set of general regulations
63+
- [ ] Upload the UML diagram on GitHub **Josef** till **late 19.12.2017**
64+
- [ ] Upload JSON Schema and regulations on GitHub **Josef** till **late 19.12.2017**
65+
- [ ] Upload JSON Schema on GitHub **Hansjörg** till **late 19.12.2017**
66+
- [ ] Reconciliation of fix appointment for the 1st workshop in 2018 **Raphael**
67+
- [ ] Next appointment on **21.12.2017** at **10:00 am**

‎Protocols/2017-12-21WorkgroupCall.md

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# Protocol
2+
3+
**Attendees:** Lutz, Hansjörg, Josef, Raphael **Guests:** Frank, Philipp (minute taker) **Absent:** Andreas G.
4+
5+
## Workshop Protocol (from 19.12.2017)
6+
* Agreeing [2017-12-19WorkgroupTelko.md](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/Protocols/2017-12-19WorkgroupTelko.md)
7+
8+
- Agreed on protocol. Will be merged into master.
9+
10+
## Walkthrough results on GitHub
11+
- [x] JSON schema [addresses - organization](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/src/main/schema/addresses/organization.json) **by Hansjörg**
12+
- This schema decribes the object organization
13+
- Arrays of objects to represent the multiplicities e.g. an organization can have varying numbers of addresses
14+
- [x] JSON schema [addresses - person](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/src/main/schema/addresses/person.json) **by Hansjörg**
15+
- This schema decribes the object person
16+
- [x] JSON schema [addresses - relation](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/src/main/schema/addresses/relation.json) **by Hansjörg**
17+
- This schema decribes the object relation
18+
- Used to describe the different relation types e.g. organization to organization
19+
- [x] JSON schema [addresses - sharedDefinitions](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/src/main/schema/addresses/sharedDefinitions.json) **by Hansjörg**
20+
- The schema includes definitions which are used in the three other JSON schemas, e.g. category
21+
- [x] JSON schema [products](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/src/main/schema/products/product.json) **by Josef**
22+
- Create consistent wording between UML and JSON
23+
- [x] [Regulations](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/DataModels/DataModels.md#rules-and-regulation-for-mdms) **by Lutz**
24+
- Suggestion by Lutz: Always describe the first letter of a class in uppercase
25+
- Regulations which need to be fulfilled in order to create a new master data model that is contributed to the open integration hub
26+
- [DataModels.md](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/DataModels/DataModels.md) has been expanded and includes rules and regulations (some of them are derived from _Hansjörgs_ [RulesandRegulations.md](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/DataModels/RulesandRegulations.md)
27+
- Mandatory if a dataset is pushed into the open integration hub: _ApplicationDataRecord_
28+
- Snippets are used to explain and illustrate certain statements
29+
30+
## Provision results of our 1st milestone
31+
* Current results overview [of the Board](https://github.com/openintegrationhub/Board/blob/de265ec062beb0a293629bc5aa67320fb73de776/Milestones.md#result-3---generic-datamodel-for-addresses-and-products-including-guidelines-and-decision-processes)
32+
* Give [direct access](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/MilestoneOne.md) through our repo page
33+
- Provision an entry page to our MS1 results, for our repo - use permanent links.
34+
35+
## Align the files and folders naming syntax
36+
- Source Code (currently json schemas) is located within a **src** folder in the root
37+
- All files (excluding source code files) will be named in _Camel Case_ format
38+
39+
## 1st Workshop in 2018
40+
* We stick with the 17th Jan. '18 - **Hafenamt**
41+
42+
## Contribute to the next milestone
43+
- Expanding the prototype by including a smart data framework (datahub) component on the elastic.io platform
44+
- Test models with real data and adjust the model
45+
- Feedback by the architects & developers for further discussions
46+
- Adjust the existing results to the feedback
47+
48+
## Next Steps
49+
- [ ] Create consistent wording between UML and JSON **Josef** till **late 21.12.2017**
50+
- [ ] Create consistent wording across all master data model files **Hansjörg, Lutz, Josef** till **21.12.2017**
51+
- [ ] Find a date for regular status calls - postponed till Andreas G. is back from vacation
52+
- [ ] Exporting the final results for milestone 1 into the needed format latest **03.01.2018**
53+
- [ ] Next appointment on **02.01.2018** at **14:00 am**
54+
- [ ] Next workshop takes place on the **17th of January 2018** at **Altes Hafenamt - Cloud Ecosystem**

‎Protocols/2018-01-02WorkgroupCall.md

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Protocol
2+
3+
**Attendees:** Lutz, Hansjörg, Josef, Raphael **Guests:** Frank, Philipp (minute taker) **Absent:** Andreas G.
4+
5+
## Workshop Protocol (from 21.12.2017)
6+
* Has been accepted on GitHub [2017-12-21WorkgroupTelko.md](https://github.com/openintegrationhub/Data-and-Domain-Models/blob/master/Protocols/2017-12-21WorkgroupTelko.md)
7+
8+
## Schema definitions
9+
* Example excerpt [shared-definitions.json](https://github.com/openintegrationhub/Data-and-Domain-Models/issues/35#issuecomment-353558851) on how to distinguish multiple network IDs
10+
- Current type string for `social` doesn't restrict the input e.g. it can be an url, network name, etc. There will be a lot of different inputs. Therefore a restriction is not applicable.
11+
- The suggestion below [- see issue 35 (comment by Raphael) -](https://github.com/openintegrationhub/Data-and-Domain-Models/issues/35) is a proper way to model the entity social, so that there are loose restrictions but completeness is ensured.
12+
_Suggestion:_
13+
14+
```
15+
"Social": {
16+
"type": "object",
17+
"properties": {
18+
"network" : {
19+
"type" : "string",
20+
"description": "Provision name of social network"
21+
},
22+
"id": {
23+
"type": "string",
24+
"description": "Provision social network ID"
25+
}
26+
},
27+
```
28+
29+
## Unify/Merge VisualPradigm projects
30+
- Visual Paradigm _projects_ need to be part of the open integration hub project (not part of the single partner projects/repos), to enhance collaboration.
31+
- The solution finding process for this issue is moved to the workshop on the 17.01.2018
32+
- Provide a suggestion how to solve/handle this issue **Lutz**
33+
34+
## Workshop agenda planning
35+
* Expanding the prototype by including a smart data framework (data hub) component on the elastic.io platform
36+
- It must be clarified which functionalites can be implemented on the elastic.io platform / boundaries of the elastic.io platform must be clarified. (Keyword: Adapter)
37+
- _Josef:_ The "data hub component" is not problematic. Elastic.io needs to be asked for support, when it comes to the mapping of tree structures (aggregates)
38+
- A call with Igor needs to be arranged prior to the workshop to discuss the next steps of the prototype
39+
* Test models with real data and adjust the model
40+
* Explicit feedback by the architects & developers for further discussions
41+
- Roadmap for the next milestone (30.06.2018)
42+
- What needs to be done / provided?
43+
- What is the output of the "prototype 0.5"
44+
- ...
45+
46+
## Report to the DLR
47+
- Delete TOCs
48+
- JSON-Schemas will be reported as .json files
49+
50+
## Next Steps
51+
- [ ] Provide a suggestion how to solve/handle the visual paradigm projects **Lutz** till **17.01.2018**
52+
- [ ] Arrange call with Igor **Raphael** till **16.01.2018**
53+
- [ ] Next appointment on **17.01.2018** at **09:00 am** at **Cloud Ecosystem - Altes Hafenamt**

‎Protocols/2018-02-23WorkgroupCall.md

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Protocol 23.02.2018
2+
3+
**Attendees:** Elke, Andreas (IESE), Josef
4+
5+
## Updates on next steps
6+
* Upload SilverERP Adapter on GitHub **by Josef**
7+
* Done. Upload pending.
8+
* Commit to the OData documentation standard for public REST APIs - recommended **by Andy & Dieter**
9+
* Examined
10+
* Accepted
11+
* Induction phase
12+
* Build and share JSONata expressions - as technical mappings **by Shterion & Josef**
13+
* Not yet discussed
14+
* Discussion until next regular call (09.03.2018)
15+
* Convict and share that proprietary models mapping - as mapping table **by Andy & Josef**
16+
* Not yet started.
17+
* Exists issue? **@Raphael**
18+
* Document your findings of the development and runtime of the adapters at elastic.io **by Shterion & Josef**
19+
* Documentation by Shterion available
20+
* Not clear wheter already uploaded
21+
* Document the assessment of limitations for specialized models under consideration of versioning **by Elke**
22+
* Ideas added to corresponding issue
23+
* Review requested **@All**
24+
* Plan to challenge the standard data points under realistic conditions **by Raphael**
25+
* ?
26+
* Collect the data points according to actually transmitted data at integration scenarios **by Raphael**
27+
* Survey design in progress

0 commit comments

Comments
 (0)