Changes for page Exercises

Last modified by Carlijn Kokkeler on 2022/10/19 13:32

From version 13.1
edited by Carlijn Kokkeler
on 2022/10/19 11:42
Change comment: There is no comment for this version
To version 1.1
edited by Carlijn Kokkeler
on 2022/09/30 09:23
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -9,35 +9,71 @@
9 9  
10 10  == 2. Key concepts ==
11 11  
12 -This microlearning centers around understanding the concept data modeling in design.
12 +This microlearning centers around understanding the concept of the message definition.
13 13  
14 -== 3. CDM, CDM & system message, message mapping ==
15 -By following the steps below, you should gain a better understanding of the differences between CDM, CDM messages, and system messages.
14 +With message definition we mean: A visual representation of how the elements are related to each other, whether they are mandatory and the data types they have that can be used in the message mapping
16 16  
17 -* Creating a CDM
18 - Please import the file Order.xsd in your CDM.
19 -* Creating a CDM message
20 - Now, go to your CDM message and select Order as root entity.
21 - Add all other entities and attributes from Order.xsd, which were imported into the CDM, to your CDM message definition.
22 -* Creating a system message
23 - In one of your System messages, import the file TransportOrder.xsd.
24 - Select CreateOrder as root entity and add all other entities and attributes to your system definition.
25 -* Complete message mapping
26 - Now that you have completed these steps, go to Message mapping and complete the mapping.
16 +In other words, the message definition defines the structure of the data that will be sent or received.
27 27  
28 -The solutions to these exercises can be found [[here>>doc:Main.eMagiz Academy.Use Cases.Data modeling in Design.Exercises.Solutions.WebHome||target="blank"]].
18 +== 3. What is a message definition ==
29 29  
30 -== 4. Key takeaways ==
20 +A message definition is a visual representation of how the elements are related to each other, whether they are mandatory and the data types they have that can be used in the message mapping.
21 +In all integration patterns (Messaging, API Gateway, and Event Streaming) we have message definitions.
31 31  
32 -* The CDM holds all entities and attributes that are relevant within the context of your complete integration landscape.
33 -* The CDM message is tailor-made for a specific piece of data and only holds the entities and attributes relevant for that piece of data.
34 -* A system message is specific to a system.
23 +On one hand, we have message definitions that relate to a system.
24 +These definitions tell us something about how the system will send or wants to receive messages (data).
25 +On the other hand, we have message definitions that relate to eMagiz.
26 +These are generic and consistent across systems (i.e. CDM messages, Gateway messages, Topic messages).
35 35  
28 +[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-what-is-a-message-definition--design-overview.png]]
36 36  
37 -== 5. Suggested Additional Readings ==
30 +In this phase, you can open the context menu on the integration level (remember, that is a line between eMagiz and an external system).
31 +The context menu will look slightly different based on the integration pattern. These differ as the use cases for each pattern differ slightly.
38 38  
39 -If you are interested in this topic and want more information on it please read the help text provided by eMagiz.
33 +[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-what-is-a-message-definition--context-menu-messaging-definition.png]]
40 40  
35 +[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-what-is-a-message-definition--context-menu-api-definition.png]]
41 41  
37 +[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-what-is-a-message-definition--context-menu-es-definition.png]]
42 42  
39 +Selecting one of the above options will lead you to an overview similar to the one that is shown below.
40 +
41 +[[image:Main.Images.Microlearning.WebHome@crashcourse-platform-design-what-is-a-message-definition--message-definition.png]]
42 +
43 +In this overview, you can import a definition or create one yourself.
44 +
45 +=== 3.1 eMagiz datamodels ===
46 +
47 +Above the focus was on the system messages (i.e. the definitions as defined by the external system). Within each of the patterns eMagiz supports (Messaging, API Management, and Event Streaming) we support an eMagiz data model. In these data models you can define how the messages should look like when they pass through the system of eMagiz. When creating a message transformation you always have atleast one eMagiz part that is based on an eMagiz data model. This is needed as you need to transform from the external system to the eMagiz data model for example.
48 +
49 +In messaging terms we call this eMagiz data model a CDM for example. Based on the pattern you are implementing the naming can change slightly but the conceptual idea is the same. For more information on the various data models we support for the patterns please check out the suggested additional readings section below.
50 +
51 +
52 +
53 +== 4. Assignment ==
54 +
55 +Navigate to Design and open the message definition option of at least one integration within your project.
56 +This assignment can be completed within the (Academy) project that you have created/used in the previous assignment.
57 +
58 +== 5. Key takeaways ==
59 +
60 +* A message definition is a visual representation of how the elements are related to each other, whether they are mandatory and the data types they have that can be used in the message mapping
61 +* Some message definitions are specific to a system. Others are generic across systems
62 +
63 +
64 +
65 +== 6. Suggested Additional Readings ==
66 +
67 +If you are interested in this topic and want more information on it please read the help text provided by eMagiz. Furthermore check out these links if you want a more in-depth knowledge of the eMagiz data models:
68 +
69 +* [API Gateway model](crashcourse-api-gateway-api-data-model.md)
70 +* [Understanding the eMagiz CDM](crashcourse-messaging-what-is-cdm.md)
71 +* [Event Streaming data model](intermediate-configuring-event-streaming-data-model.md)
72 +
73 +== 7. Silent demonstration video ==
74 +
75 +This video demonstrates a working solution and how you can validate whether you have successfully completed the assignment.
76 +
77 +{{video attachment="crashcourse-platform-design-what-is-a-message-definition.mp4" reference="Main.Videos.Microlearning.WebHome"/}}
78 +
43 43  )))((({{toc/}}))){{/container}}{{/container}}