Wiki source code of Event Streaming Data Model

Last modified by Eva Torken on 2023/08/31 13:24
Show last authors
1 {{container}}
2 {{container layoutStyle="columns"}}(((
3 In this microlearning, we will focus on learning about the Event Streaming Data model.
4 As with every integration, pattern eMagiz gives you the option to create your data model.
5 This data model can be based on standards, can be custom made or a combination of both.
6
7 For Event Streaming the data model represents the structure of messages that are exchanged between parties with the help of topics.
8
9 Should you have any questions, please contact [[academy@emagiz.com>>mailto:academy@emagiz.com]].
10
11 == 1. Prerequisites ==
12
13 * Basic knowledge of the eMagiz platform
14
15 == 2. Key concepts ==
16
17 This microlearning centers around the event streaming Data Model.
18 With event streaming we mean: A collection of topics to which data can be written or from which data can be consumed for further processing
19 With a data model we mean: A collection of elements (entities and attributes) that represent how you view those elements and how you want to converse about those elements
20
21 The data model consists of the following:
22
23 * Entities with their characteristics
24 * Relationships between entities
25
26 And has as a goal to create a landscape-wide overview of the collection of elements that are integrated via the eMagiz platform.
27
28 == 3. Event Streaming Data Model ==
29
30 As with every integration pattern eMagiz gives you the option to create your data model.
31 This data model can be based on standards, can be custom made or a combination of both.
32
33 For Event Streaming the data model represents the structure of messages that are exchanged between parties with the help of topics.
34
35 You can access the event streaming data model in the Design phase of eMagiz.
36 To do so you have to navigate to Design and open the context menu on the Event Streaming block in the center of your Design Overview
37
38 [[image:Main.Images.Microlearning.WebHome@intermediate-configuring-emagiz-event-streaming-data-model--access-data-model-in-design.png]]
39
40 When you select this option eMagiz will take you to the Event Streaming Data Model.
41 When you enter this overview for the first time you will see an empty canvas.
42
43 [[image:Main.Images.Microlearning.WebHome@intermediate-configuring-emagiz-event-streaming-data-model--data-model-in-design-empty.png]]
44
45 On this canvas, you can drag and drop items (just as we discussed in our Crash Course Platform * Creating a Message Definition). Before you can do so, you need to enter "Start Editing" mode.
46
47 So for example your data model could look like this after you have dragged and dropped some items on the canvas
48
49 [[image:Main.Images.Microlearning.WebHome@intermediate-configuring-emagiz-event-streaming-data-model--data-model-in-design-filled-in.png]]
50
51 === 3.1 Saving your changes ===
52
53 After you are done with editing on this data model you can press "Stop Editing" and you will be presented with the following pop-up
54
55 [[image:Main.Images.Microlearning.WebHome@intermediate-configuring-emagiz-event-streaming-data-model--create-new-version-pop-up.png]]
56
57 At this point, you have to make a choice. If you are satisfied with your work you press Save and create a new version.
58 If you are unsure of your work or simply need to stop because there is no more time left go for the option Save and continue.
59
60 ==== 3.1.1 Save and create new version ====
61
62 When you go for the option Save and create a new version you will see the following pop-up
63
64 [[image:Main.Images.Microlearning.WebHome@intermediate-configuring-emagiz-event-streaming-data-model--save-and-create-new-version-pop-up.png]]
65
66 Choose whether this was a major, minor, or patch upgrade and give a description of the version that tells you and others what you have changed. Something like this
67
68 [[image:Main.Images.Microlearning.WebHome@intermediate-configuring-emagiz-event-streaming-data-model--save-and-create-new-version-pop-up-filled-in.png]]
69
70 Press the button Create version and eMagiz will save your changes.
71
72 ==== 3.1.2 Save and continue ====
73
74 When you are not sure that the version you are currently working on is ready for Deploy you can select the other option called Save and continue.
75 When choosing this option eMagiz will automatically create a temporary version of your flow in its current state.
76 You can view who made what (temporary) version when you navigate to the History option on the Event Streaming Data Model level.
77
78 [[image:Main.Images.Microlearning.WebHome@intermediate-configuring-emagiz-event-streaming-data-model--history-of-data-model.png]]
79
80 This history of the changes on the Event Streaming Data Model is not only useful for auditing purposes but also helps you identify who you should ask about the latest changes.
81 As you can see the default description of an autosaved version is Autosaved version. You can give such a version a more descriptive name by selecting it and pressing Edit.
82
83 [[image:Main.Images.Microlearning.WebHome@intermediate-configuring-emagiz-event-streaming-data-model--edit-description-auto-saved-version.png]]
84
85 That action will lead you to the following pop-up. In this pop-up, you can change the description of the autosaved version to something that makes clear what you did.
86
87 [[image:Main.Images.Microlearning.WebHome@intermediate-configuring-emagiz-event-streaming-data-model--edit-description-auto-saved-version-pop-up.png]]
88
89 Simply press Save when you are done and the description will be changed
90
91 [[image:Main.Images.Microlearning.WebHome@intermediate-configuring-emagiz-event-streaming-data-model--edit-description-auto-saved-version-result.png]]
92
93 == 4. Key takeaways ==
94
95 * The event streaming data model can be based on standards, can be custom made, or a combination of both.
96 * The data model consists of the following:
97 ** Entities with their characteristics
98 ** Relationships between entities
99 * You can build and update your data model from scratch
100 * Changes on the event streaming data model are kept in History and it is up to the user to make it clear what has changed
101
102 == 5. Suggested Additional Readings ==
103
104 If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
105
106 )))((({{toc/}}))){{/container}}
107 {{/container}}